diff --git a/.github/workflows/auto-label-prs.yml b/.github/workflows/auto-label-prs.yml index 12aed3514b..a9d08b7186 100644 --- a/.github/workflows/auto-label-prs.yml +++ b/.github/workflows/auto-label-prs.yml @@ -17,6 +17,6 @@ jobs: runs-on: ubuntu-latest steps: # See labeling configuration in the `.github/labeler.yml` file - - uses: actions/labeler@5f867a63be70efff62b767459b009290364495eb + - uses: actions/labeler@e54e5b338fbd6e6cdb5d60f51c22335fc57c401e with: repo-token: '${{ secrets.GITHUB_TOKEN }}' diff --git a/.github/workflows/link-check-all.yml b/.github/workflows/link-check-all.yml index db3848d588..d983604699 100644 --- a/.github/workflows/link-check-all.yml +++ b/.github/workflows/link-check-all.yml @@ -53,6 +53,14 @@ jobs: # Don't care about CDN caching image URLs DISABLE_REWRITE_ASSET_URLS: true run: | + + # Note as of Aug 2022, we *don't* check external links + # on the pages you touched in the PR. We could enable that + # but it has the added risk of false positives blocking CI. + # We are using this script for the daily/nightly checker that + # checks external links too. Once we're confident it really works + # well, we can consider enabling it here on every content PR too. + ./script/rendered-content-link-checker.js \ --language en \ --max 100 \ diff --git a/assets/images/help/repository/code-scanning-analysis-not-found.png b/assets/images/enterprise/3.4/repository/code-scanning-analysis-not-found.png similarity index 100% rename from assets/images/help/repository/code-scanning-analysis-not-found.png rename to assets/images/enterprise/3.4/repository/code-scanning-analysis-not-found.png diff --git a/assets/images/enterprise/github-ae/enterprise-account-settings-authentication-security-tab.png b/assets/images/enterprise/github-ae/enterprise-account-settings-authentication-security-tab.png new file mode 100644 index 0000000000..b189dfed6c Binary files /dev/null and b/assets/images/enterprise/github-ae/enterprise-account-settings-authentication-security-tab.png differ diff --git a/assets/images/help/business-accounts/enterprise-account-settings-authentication-security-tab.png b/assets/images/help/business-accounts/enterprise-account-settings-authentication-security-tab.png new file mode 100644 index 0000000000..aa9e7ab466 Binary files /dev/null and b/assets/images/help/business-accounts/enterprise-account-settings-authentication-security-tab.png differ diff --git a/assets/images/help/business-accounts/restrict-personal-namespace-enabled-setting.png b/assets/images/help/business-accounts/restrict-personal-namespace-enabled-setting.png new file mode 100644 index 0000000000..82034212ca Binary files /dev/null and b/assets/images/help/business-accounts/restrict-personal-namespace-enabled-setting.png differ diff --git a/assets/images/help/business-accounts/restrict-personal-namespace-setting.png b/assets/images/help/business-accounts/restrict-personal-namespace-setting.png new file mode 100644 index 0000000000..9eae2f6247 Binary files /dev/null and b/assets/images/help/business-accounts/restrict-personal-namespace-setting.png differ diff --git a/assets/images/help/codespaces/codespaces-org-billing-add-users.png b/assets/images/help/codespaces/codespaces-org-billing-add-users.png new file mode 100644 index 0000000000..5e7f4a3e3e Binary files /dev/null and b/assets/images/help/codespaces/codespaces-org-billing-add-users.png differ diff --git a/assets/images/help/codespaces/codespaces-org-billing-settings.png b/assets/images/help/codespaces/codespaces-org-billing-settings.png new file mode 100644 index 0000000000..6e542cb529 Binary files /dev/null and b/assets/images/help/codespaces/codespaces-org-billing-settings.png differ diff --git a/assets/images/help/codespaces/org-user-permission-settings-outside-collaborators.png b/assets/images/help/codespaces/org-user-permission-settings-outside-collaborators.png deleted file mode 100644 index e28c239dfb..0000000000 Binary files a/assets/images/help/codespaces/org-user-permission-settings-outside-collaborators.png and /dev/null differ diff --git a/assets/images/help/commits/ssh-signed-commit-verified-details.png b/assets/images/help/commits/ssh-signed-commit-verified-details.png new file mode 100644 index 0000000000..63b69cfa4f Binary files /dev/null and b/assets/images/help/commits/ssh-signed-commit-verified-details.png differ diff --git a/assets/images/help/enterprises/audit-stream-choice-datadog.png b/assets/images/help/enterprises/audit-stream-choice-datadog.png new file mode 100644 index 0000000000..0d81cd0bc5 Binary files /dev/null and b/assets/images/help/enterprises/audit-stream-choice-datadog.png differ diff --git a/assets/images/help/enterprises/audit-stream-datadog-site.png b/assets/images/help/enterprises/audit-stream-datadog-site.png new file mode 100644 index 0000000000..05826e3230 Binary files /dev/null and b/assets/images/help/enterprises/audit-stream-datadog-site.png differ diff --git a/assets/images/help/enterprises/audit-stream-datadog-token.png b/assets/images/help/enterprises/audit-stream-datadog-token.png new file mode 100644 index 0000000000..68af0881e8 Binary files /dev/null and b/assets/images/help/enterprises/audit-stream-datadog-token.png differ diff --git a/assets/images/help/organizations/secret-scanning-custom-link.png b/assets/images/help/organizations/secret-scanning-custom-link.png new file mode 100644 index 0000000000..64f0399aa4 Binary files /dev/null and b/assets/images/help/organizations/secret-scanning-custom-link.png differ diff --git a/assets/images/help/pages/cancel-edit.png b/assets/images/help/pages/cancel-edit.png deleted file mode 100644 index 3ca5a0d84c..0000000000 Binary files a/assets/images/help/pages/cancel-edit.png and /dev/null differ diff --git a/assets/images/help/pages/choose-a-theme.png b/assets/images/help/pages/choose-a-theme.png deleted file mode 100644 index ad3c6ba01f..0000000000 Binary files a/assets/images/help/pages/choose-a-theme.png and /dev/null differ diff --git a/assets/images/help/pages/select-theme.png b/assets/images/help/pages/select-theme.png deleted file mode 100644 index c8993ab5ae..0000000000 Binary files a/assets/images/help/pages/select-theme.png and /dev/null differ diff --git a/assets/images/help/repository/dependabot-alerts-dismissal-comment.png b/assets/images/help/repository/dependabot-alerts-dismissal-comment.png new file mode 100644 index 0000000000..392cbf96ea Binary files /dev/null and b/assets/images/help/repository/dependabot-alerts-dismissal-comment.png differ diff --git a/assets/images/help/repository/publish-github-action-to-markeplace-button.png b/assets/images/help/repository/publish-github-action-to-markeplace-button.png deleted file mode 100644 index ef22246e9e..0000000000 Binary files a/assets/images/help/repository/publish-github-action-to-markeplace-button.png and /dev/null differ diff --git a/assets/images/help/repository/publish-github-action-to-marketplace-button.png b/assets/images/help/repository/publish-github-action-to-marketplace-button.png new file mode 100644 index 0000000000..275768be40 Binary files /dev/null and b/assets/images/help/repository/publish-github-action-to-marketplace-button.png differ diff --git a/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-blocked-banner-with-link.png b/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-blocked-banner-with-link.png new file mode 100644 index 0000000000..3734d88af9 Binary files /dev/null and b/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-blocked-banner-with-link.png differ diff --git a/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-blocked-banner.png b/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-blocked-banner.png index 3734d88af9..5756757b2e 100644 Binary files a/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-blocked-banner.png and b/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-blocked-banner.png differ diff --git a/assets/images/help/repository/secret-scanning-push-protection-with-custom-link.png b/assets/images/help/repository/secret-scanning-push-protection-with-custom-link.png new file mode 100644 index 0000000000..8b18a4493d Binary files /dev/null and b/assets/images/help/repository/secret-scanning-push-protection-with-custom-link.png differ diff --git a/assets/images/help/security/check-ip-address.png b/assets/images/help/security/check-ip-address.png new file mode 100644 index 0000000000..b9859c672a Binary files /dev/null and b/assets/images/help/security/check-ip-address.png differ diff --git a/assets/images/help/settings/ssh-add-key.png b/assets/images/help/settings/ssh-add-key.png index 0a007fb5e7..76ddfce73e 100644 Binary files a/assets/images/help/settings/ssh-add-key.png and b/assets/images/help/settings/ssh-add-key.png differ diff --git a/assets/images/help/settings/ssh-add-ssh-key-with-auth.png b/assets/images/help/settings/ssh-add-ssh-key-with-auth.png new file mode 100644 index 0000000000..f3fa237335 Binary files /dev/null and b/assets/images/help/settings/ssh-add-ssh-key-with-auth.png differ diff --git a/assets/images/help/settings/ssh-key-paste-with-type.png b/assets/images/help/settings/ssh-key-paste-with-type.png new file mode 100644 index 0000000000..1790631343 Binary files /dev/null and b/assets/images/help/settings/ssh-key-paste-with-type.png differ diff --git a/components/article/PlatformPicker.tsx b/components/article/PlatformPicker.tsx index 16ee3b9f0a..accb40ae3f 100644 --- a/components/article/PlatformPicker.tsx +++ b/components/article/PlatformPicker.tsx @@ -5,7 +5,7 @@ import { sendEvent, EventType } from 'components/lib/events' import { useRouter } from 'next/router' import { useArticleContext } from 'components/context/ArticleContext' -import parseUserAgent from 'components/lib/user-agent' +import { parseUserAgent } from 'components/lib/user-agent' const platforms = [ { id: 'mac', label: 'Mac' }, diff --git a/components/hooks/useTheme.ts b/components/hooks/useTheme.ts index b8134a0e57..b9f9d87111 100644 --- a/components/hooks/useTheme.ts +++ b/components/hooks/useTheme.ts @@ -81,7 +81,8 @@ export function getCssTheme(cookieValue = ''): CssColorTheme { darkTheme: filterTheme(dark_theme) || defaultCSSTheme.darkTheme, } } catch (err) { - console.warn("Unable to parse 'color_mode' cookie", err) + if (process.env.NODE_ENV === 'development') + console.warn("Unable to parse 'color_mode' cookie", err) return defaultCSSTheme } } diff --git a/components/lib/events.ts b/components/lib/events.ts index 2f65b8056a..7a1758342a 100644 --- a/components/lib/events.ts +++ b/components/lib/events.ts @@ -1,7 +1,7 @@ /* eslint-disable camelcase */ import { v4 as uuidv4 } from 'uuid' import Cookies from 'js-cookie' -import parseUserAgent from './user-agent' +import { parseUserAgent } from './user-agent' const COOKIE_NAME = '_docs-events' diff --git a/components/lib/get-rest-code-samples.ts b/components/lib/get-rest-code-samples.ts index 982c6945cb..27c6a7f4ec 100644 --- a/components/lib/get-rest-code-samples.ts +++ b/components/lib/get-rest-code-samples.ts @@ -45,7 +45,7 @@ export function getShellExample(operation: Operation, codeSample: CodeSample) { const args = [ operation.verb !== 'get' && `-X ${operation.verb.toUpperCase()}`, - `-H "Accept: ${defaultAcceptHeader}" \\ \n -H "Authorization: token "`, + `-H "Accept: ${defaultAcceptHeader}" \\ \n -H "Authorization: Bearer "`, `${operation.serverUrl}${requestPath}`, requestBodyParams, ].filter(Boolean) @@ -86,12 +86,12 @@ export function getGHExample(operation: Operation, codeSample: CodeSample) { requestBodyParams = Object.keys(codeSample.request.bodyParameters) .map((key) => { if (typeof codeSample.request.bodyParameters[key] === 'string') { - return `-f ${key}='${codeSample.request.bodyParameters[key]}'\n` + return `-f ${key}='${codeSample.request.bodyParameters[key]}' ` } else { - return `-F ${key}=${codeSample.request.bodyParameters[key]}\n` + return `-F ${key}=${codeSample.request.bodyParameters[key]} ` } }) - .join(' ') + .join('\\\n ') } const args = [ operation.verb !== 'get' && `--method ${operation.verb.toUpperCase()}`, @@ -141,11 +141,7 @@ export function getJSExample(operation: Operation, codeSample: CodeSample) { } } const comment = `// Octokit.js\n// https://github.com/octokit/core.js#readme\n` - const require = `const octokit = new Octokit(${stringify( - { auth: 'personal-access-token123' }, - null, - 2 - )})\n\n` + const require = `const octokit = new Octokit(${stringify({ auth: 'YOUR-TOKEN' }, null, 2)})\n\n` return `${comment}${require}await octokit.request('${operation.verb.toUpperCase()} ${ operation.requestPath diff --git a/components/lib/user-agent.ts b/components/lib/user-agent.ts index 60d52a14b7..377e765988 100644 --- a/components/lib/user-agent.ts +++ b/components/lib/user-agent.ts @@ -19,7 +19,7 @@ const BROWSER_REGEXPS = [ /ms(ie)\/([^\s)]+)/i, ] -export default function parseUserAgent(ua = navigator.userAgent) { +export function parseUserAgent(ua = navigator.userAgent) { ua = ua.toLowerCase() const osRe = OS_REGEXPS.find((re) => re.test(ua)) let [, os = 'other', os_version = '0'] = (osRe && ua.match(osRe)) || [] diff --git a/components/playground/ArticleMarkdown.tsx b/components/playground/ArticleMarkdown.tsx index 131825b59d..7f8a9fdc37 100644 --- a/components/playground/ArticleMarkdown.tsx +++ b/components/playground/ArticleMarkdown.tsx @@ -5,6 +5,7 @@ import ReactMarkdown from 'react-markdown' import { Prism as SyntaxHighlighter } from 'react-syntax-highlighter' import { vs, vscDarkPlus } from 'react-syntax-highlighter/dist/cjs/styles/prism' import gfm from 'remark-gfm' +import rehypeRaw from 'rehype-raw' import { MarkdownContent } from 'components/ui/MarkdownContent' @@ -22,6 +23,9 @@ export const ArticleMarkdown = ({ className, children }: Props) => { { diff --git a/components/playground/PlaygroundContentBlock.tsx b/components/playground/PlaygroundContentBlock.tsx index 5a3928f870..5f2bed328a 100644 --- a/components/playground/PlaygroundContentBlock.tsx +++ b/components/playground/PlaygroundContentBlock.tsx @@ -41,6 +41,7 @@ export const PlaygroundContentBlock = ({ sectionIndex, contentBlock }: Props) => const isActive = sectionIndex === activeSectionIndex const anchorLink = getAnchorLink(contentBlock.title || '') const showDivider = !isActive && activeSectionIndex - 1 !== sectionIndex + return (
Shift + Command + P / Ctrl + Shift + P), then start typing "dev container". Select **Codespaces: Add Development Container Configuration Files...**. ![Codespaces: Add Development Container Configuration Files... in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) 2. For this example, click **C# (.NET)**. If you need additional features you can select any container that’s specific to C# (.NET) or a combination of tools such as C# (.NET) and MS SQL. - + ![Select C# (.NET) option from the list](/assets/images/help/codespaces/add-dotnet-prebuilt-container.png) 3. Click the recommended version of .NET. ![.NET version selection](/assets/images/help/codespaces/add-dotnet-version.png) 4. Accept the default option to add Node.js to your customization. ![Add Node.js selection](/assets/images/help/codespaces/dotnet-options.png) 5. Select any additional features to install and click **OK**. - 6. Access the command palette (\`Shift + Command + P\`/ \`Ctrl + Shift + P\`), then start typing "rebuild". Select **Codespaces: Rebuild Container**. + 6. Access the command palette (Shift + Command + P / Ctrl + Shift + P), then start typing "rebuild". Select **Codespaces: Rebuild Container**. ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) `, }, @@ -189,15 +189,15 @@ const article: PlaygroundArticleT = { "streetsidesoftware.code-spell-checker" ], \`\`\` - + 3. Uncomment the \`postCreateCommand\` to restore dependencies as part of the codespace setup process. - + \`\`\`json{:copy} // Use 'postCreateCommand' to run commands after the container is created. "postCreateCommand": "dotnet restore", \`\`\` - 4. Access the command palette (\`Shift + Command + P\`/ \`Ctrl + Shift + P\`), then start typing "rebuild". Select **Codespaces: Rebuild Container**. + 4. Access the command palette (\`Shift + Command + P\`/ \`Ctrl + Shift + P\`), then start typing "rebuild". Select **Codespaces: Rebuild Container**. ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. @@ -253,26 +253,26 @@ const article: PlaygroundArticleT = { "INSTALL_AZURE_CLI": "false" } }, - + // Set *default* container specific settings.json values on container create. "settings": { "terminal.integrated.shell.linux": "/bin/bash" }, - + // Add the IDs of extensions you want installed when the container is created. "extensions": [ "ms-dotnettools.csharp" ], - + // Use 'forwardPorts' to make a list of ports inside the container available locally. // "forwardPorts": [5000, 5001], - + // Use 'postCreateCommand' to run commands after the container is created. // "postCreateCommand": "dotnet restore", - + // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. "remoteUser": "vscode" - } + } `, }, '1': { @@ -282,22 +282,22 @@ const article: PlaygroundArticleT = { # [Choice] .NET version: 5.0, 3.1, 2.1 ARG VARIANT="5.0" FROM mcr.microsoft.com/vscode/devcontainers/dotnetcore:0-\${VARIANT} - + # [Option] Install Node.js ARG INSTALL_NODE="true" ARG NODE_VERSION="lts/*" RUN if [ "\${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install \${NODE_VERSION} 2>&1"; fi - + # [Option] Install Azure CLI ARG INSTALL_AZURE_CLI="false" COPY library-scripts/azcli-debian.sh /tmp/library-scripts/ RUN if [ "$INSTALL_AZURE_CLI" = "true" ]; then bash /tmp/library-scripts/azcli-debian.sh; fi \ && apt-get clean -y && rm -rf /var/lib/apt/lists/* /tmp/library-scripts - + # [Optional] Uncomment this section to install additional OS packages. # RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ # && apt-get -y install --no-install-recommends - + # [Optional] Uncomment this line to install global node packages. # RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 `, diff --git a/components/playground/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces/python.tsx b/components/playground/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces/python.tsx index 3a3c01be12..7bba6a54a8 100644 --- a/components/playground/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces/python.tsx +++ b/components/playground/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces/python.tsx @@ -53,7 +53,7 @@ const article: PlaygroundArticleT = { To set up your repository to use a custom dev container, you will need to create one or more \`devcontainer.json\` files. You can add these either from a template, in Visual Studio Code, or you can write your own. For more information on dev container configurations, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - 1. Access the Command Palette (\`Shift+Command+P\` / \`Ctrl+Shift+P\`), then start typing "dev container". Select **Codespaces: Add Development Container Configuration Files...**. + 1. Access the command palette (\`Shift + Command + P\` / \`Ctrl + Shift + P\`), then start typing "dev container". Select **Codespaces: Add Development Container Configuration Files...**. !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) 2. For this example, click **Python 3**. If you need additional features you can select any container that’s specific to Python or a combination of tools such as Python 3 and PostgreSQL. ![Select Python option from the list](/assets/images/help/codespaces/add-python-prebuilt-container.png) @@ -62,7 +62,7 @@ const article: PlaygroundArticleT = { 4. Accept the default option to add Node.js to your customization. ![Add Node.js selection](/assets/images/help/codespaces/add-nodejs-selection.png) 5. Select any additional features to install and click **OK**. - 6. Access the command palette (\`Shift+Command+P\`/ \`Ctrl+Shift+P\`), then start typing "rebuild". Select **Codespaces: Rebuild Container**. + 6. Access the command palette (\`Shift + Command + P\` / \`Ctrl + Shift + P\`), then start typing "rebuild". Select **Codespaces: Rebuild Container**. ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) `, }, @@ -197,7 +197,7 @@ const article: PlaygroundArticleT = { "postCreateCommand": "pip3 install --user -r requirements.txt", \`\`\` - 4. Access the command palette (\`Shift+Command+P\`/ \`Ctrl+Shift+P\`), then start typing "rebuild". Select **Codespaces: Rebuild Container**. + 4. Access the command palette (\`Shift + Command + P\` / \`Ctrl + Shift + P\`), then start typing "rebuild". Select **Codespaces: Rebuild Container**. ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) diff --git a/components/playground/editor/Editor.tsx b/components/playground/editor/Editor.tsx index e94a751eb5..3ec8774c4a 100644 --- a/components/playground/editor/Editor.tsx +++ b/components/playground/editor/Editor.tsx @@ -102,7 +102,7 @@ export const Editor: React.FC = ({ article }) => { className = 'color-bg-accent' } } - return { style: { display: 'block' }, class: className } + return { style: { display: 'block' }, className } }} lineNumberStyle={{ minWidth: '3.25em' }} > diff --git a/components/rest/ChildBodyParametersRows.tsx b/components/rest/ChildBodyParametersRows.tsx index 4dc3219701..959fb45ed5 100644 --- a/components/rest/ChildBodyParametersRows.tsx +++ b/components/rest/ChildBodyParametersRows.tsx @@ -1,58 +1,57 @@ import { useTranslation } from 'components/hooks/useTranslation' import { ParameterRow } from './ParameterRow' -import type { ChildParamsGroup } from './types' +import type { ChildParameter } from './types' type Props = { slug: string - childParamsGroups?: ChildParamsGroup[] + childParamsGroups: ChildParameter[] + parentName: string + parentType: string } -export function ChildBodyParametersRows({ slug, childParamsGroups }: Props) { +export function ChildBodyParametersRows({ + slug, + parentName, + parentType, + childParamsGroups, +}: Props) { const { t } = useTranslation('products') return ( - + - {childParamsGroups?.map((childParamGroup) => ( -
- - - - - - - - - {childParamGroup.params.map((childParam, index) => ( +
+ +
- {`${t('rest.reference.name')}, ${t('rest.reference.type')}, ${t( - 'rest.reference.description' - )}`} -
+ + + + + + + {childParamsGroups.map((childParam) => { + return ( - ))} - -
+ {`${t('rest.reference.name')}, ${t('rest.reference.type')}, ${t( + 'rest.reference.description' + )}`} +
-
- ))} + ) + })} + + + ) diff --git a/components/rest/ParameterRow.tsx b/components/rest/ParameterRow.tsx index 7088d9d927..b89332f5db 100644 --- a/components/rest/ParameterRow.tsx +++ b/components/rest/ParameterRow.tsx @@ -1,44 +1,24 @@ import { useTranslation } from 'components/hooks/useTranslation' import { ChildBodyParametersRows } from './ChildBodyParametersRows' -import type { ChildParamsGroup } from './types' +import type { ChildParameter } from './types' type Props = { - name: string - type: string | string[] - description: string - isRequired?: boolean - defaultValue?: string - enumValues?: string[] + rowParams: ChildParameter slug: string - childParamsGroups?: ChildParamsGroup[] | null numPreviews?: number isChild?: boolean } -export function ParameterRow({ - name, - type, - description, - isRequired, - defaultValue, - enumValues, - slug, - childParamsGroups = null, - numPreviews = 0, - isChild = false, -}: Props) { +export function ParameterRow({ rowParams, slug, numPreviews = 0, isChild = false }: Props) { const { t } = useTranslation('products') - return ( <> - +
- {name} - - {Array.isArray(type) ? type.join(' or ') : type} - - {isRequired ? ( + {rowParams.name} + {rowParams.type} + {rowParams.isRequired ? ( {t('rest.reference.required')} @@ -46,7 +26,7 @@ export function ParameterRow({
-
+
{numPreviews > 0 && ( {numPreviews > 1 @@ -55,18 +35,18 @@ export function ParameterRow({ )}
- {defaultValue !== undefined && ( + {rowParams.default && (

{t('rest.reference.default')}: - {defaultValue.toString()} + {rowParams.default}

)} - {enumValues && ( + {rowParams.enum && rowParams.enum.length && (

{t('rest.reference.enum_description_title')}: - {enumValues.map((item, index) => { - return index !== enumValues.length - 1 ? ( + {rowParams.enum.map((item, index, array) => { + return index !== array.length - 1 ? ( {item},{' '} @@ -82,8 +62,13 @@ export function ParameterRow({

- {childParamsGroups && childParamsGroups.length > 0 && ( - + {rowParams.childParamsGroups && rowParams.childParamsGroups.length > 0 && ( + )} ) diff --git a/components/rest/RestOperation.module.scss b/components/rest/RestOperation.module.scss index 37efa6b34a..8d582d3a47 100644 --- a/components/rest/RestOperation.module.scss +++ b/components/rest/RestOperation.module.scss @@ -13,6 +13,6 @@ table-layout: fixed !important; } -.codeBlock code { +.codeBlock code:not(td *) { word-break: break-all; } diff --git a/components/rest/RestParameterTable.tsx b/components/rest/RestParameterTable.tsx index b56443bf4f..69ef3d93a0 100644 --- a/components/rest/RestParameterTable.tsx +++ b/components/rest/RestParameterTable.tsx @@ -42,10 +42,12 @@ export function RestParameterTable({ slug, numPreviews, parameters, bodyParamete Setting to application/vnd.github+json is recommended.

`} - isRequired={false} + rowParams={{ + name: 'accept', + type: 'string', + description: `

Setting to application/vnd.github+json is recommended.

`, + isRequired: false, + }} slug={slug} numPreviews={numPreviews} /> @@ -65,12 +67,14 @@ export function RestParameterTable({ slug, numPreviews, parameters, bodyParamete {pathParams.map((param, index) => ( @@ -95,12 +99,14 @@ export function RestParameterTable({ slug, numPreviews, parameters, bodyParamete {queryParams.map((param, index) => ( @@ -124,17 +130,7 @@ export function RestParameterTable({ slug, numPreviews, parameters, bodyParamete {bodyParameters.map((param, index) => ( - + ))} )} diff --git a/components/rest/types.ts b/components/rest/types.ts index 02a5ee798f..8c6093290d 100644 --- a/components/rest/types.ts +++ b/components/rest/types.ts @@ -54,26 +54,20 @@ export interface BodyParameter { name: string description: string type: string - isRequired: boolean + isRequired?: boolean default?: string enum?: Array - childParamsGroups?: Array -} - -export interface ChildParamsGroup { - id: string - params: Array - parentName: string - parentType: string + childParamsGroups?: Array } export interface ChildParameter { name: string description: string type: string - isRequired: boolean + isRequired?: boolean enum?: Array default?: string + childParamsGroups?: ChildParameter[] } export type ExampleT = { diff --git a/components/search/SearchError.tsx b/components/search/SearchError.tsx index a117fc959f..a26c60e0ce 100644 --- a/components/search/SearchError.tsx +++ b/components/search/SearchError.tsx @@ -13,7 +13,6 @@ export function SearchError({ error }: Props) { return (
- {' '} {t('search_error')}
diff --git a/components/sidebar/RestCollapsibleSection.tsx b/components/sidebar/RestCollapsibleSection.tsx index ca9e687039..db9d62ab5d 100644 --- a/components/sidebar/RestCollapsibleSection.tsx +++ b/components/sidebar/RestCollapsibleSection.tsx @@ -45,7 +45,8 @@ export const RestCollapsibleSection = (props: SectionProps) => { router.query.productId === 'rest' || // These pages need the Article Page mini tocs instead of the Rest Pages router.asPath.includes('/rest/guides') || - router.asPath.includes('/rest/overview') + router.asPath.includes('/rest/overview') || + router.asPath.includes('/rest/quickstart') ? [] : useAutomatedPageContext().miniTocItems @@ -66,7 +67,11 @@ export const RestCollapsibleSection = (props: SectionProps) => { }, []) useEffect(() => { - if (!router.asPath.includes('guides') && !router.asPath.includes('overview')) { + if ( + !router.asPath.includes('guides') && + !router.asPath.includes('overview') && + !router.asPath.includes('quickstart') + ) { const observer = new IntersectionObserver( (entries) => { entries.forEach((entry) => { diff --git a/components/sidebar/SidebarProduct.tsx b/components/sidebar/SidebarProduct.tsx index a4da2a05d8..1c2eadeedb 100644 --- a/components/sidebar/SidebarProduct.tsx +++ b/components/sidebar/SidebarProduct.tsx @@ -80,10 +80,16 @@ export const SidebarProduct = () => { const restSection = () => { const conceptualPages = currentProductTree.childPages.filter( - (page) => page.href.includes('guides') || page.href.includes('overview') + (page) => + page.href.includes('guides') || + page.href.includes('overview') || + page.href.includes('quickstart') ) const restPages = currentProductTree.childPages.filter( - (page) => !page.href.includes('guides') && !page.href.includes('overview') + (page) => + !page.href.includes('guides') && + !page.href.includes('overview') && + !page.href.includes('quickstart') ) return ( <> @@ -95,6 +101,7 @@ export const SidebarProduct = () => { const isActive = routePath.includes(childPage.href + '/') || routePath === childPage.href const defaultOpen = hasExactCategory ? isActive : false + return (
  • { data-is-current-page={isActive && isStandaloneCategory} className={cx('py-1', isActive && 'color-bg-inset')} > - + {childPage.href.includes('quickstart') ? ( + + {childTitle} + + ) : ( + + )}
    • ) })} diff --git a/components/ui/MiniTocs/MiniTocs.tsx b/components/ui/MiniTocs/MiniTocs.tsx index 81e49de99f..c1301d20a0 100644 --- a/components/ui/MiniTocs/MiniTocs.tsx +++ b/components/ui/MiniTocs/MiniTocs.tsx @@ -1,43 +1,42 @@ +import { Heading, NavList } from '@primer/react' import cx from 'classnames' -import { ActionList, Heading } from '@primer/react' -import type { MiniTocItem } from 'components/context/ArticleContext' +import { MiniTocItem } from 'components/context/ArticleContext' import { Link } from 'components/Link' import { useTranslation } from 'components/hooks/useTranslation' +import styles from './Minitocs.module.scss' + export type MiniTocsPropsT = { pageTitle: string miniTocItems: MiniTocItem[] } -const renderTocItem = (item: MiniTocItem) => { +function RenderTocItem(item: MiniTocItem) { return ( - li': { - ':hover': { - bg: 'var(--color-neutral-subtle) !important', - }, - }, - }} - > -
    - - {item.contents.title} - - {item.items && item.items.length > 0 ? ( -
      {item.items.map(renderTocItem)}
    - ) : null} -
    -     +
    + + {item.contents.title} + + {item.items && item.items.length > 0 && ( +
      + {item.items.map((toc) => ( + + ))} +
    + )} +
    ) } @@ -46,17 +45,22 @@ export function MiniTocs({ pageTitle, miniTocItems }: MiniTocsPropsT) { return ( <> - + {t('miniToc')} - -
    - {miniTocItems.map((items, i) => { - return
      {renderTocItem(items)}
    - })} -
    -     + + {miniTocItems.map((items, i) => { + return ( + + ) + })} + ) } diff --git a/components/ui/MiniTocs/Minitocs.module.scss b/components/ui/MiniTocs/Minitocs.module.scss new file mode 100644 index 0000000000..f1d6cec325 --- /dev/null +++ b/components/ui/MiniTocs/Minitocs.module.scss @@ -0,0 +1,12 @@ +.indentNested { + padding-inline-start: 0; +} + +.nested { + div ul div li { + padding-left: 4em; + } + div li { + padding-left: 2em; + } +} diff --git a/content/README.md b/content/README.md index 73a5127c20..139e1802d4 100644 --- a/content/README.md +++ b/content/README.md @@ -227,7 +227,7 @@ defaultPlatform: linux ### `defaultTool` -- Purpose: Override the initial tool selection for a page, where tool refers to the application the reader is using to work with GitHub (such as GitHub.com's web UI, the GitHub CLI, or GitHub Desktop) or the GitHub APIs (such as cURL or the GitHub CLI). For more information about the tool selector, see [Markup reference for GitHub Docs](../contributing/content-markup-reference.md#tool-tags). If this frontmatter is omitted, then the tool-specific content matching the GitHub web UI is shown by default. If a user has indicated a tool preference (by clicking on a tool tab), then the user's preference will be applied instead of the default value. +- Purpose: Override the initial tool selection for a page, where the tool refers to the application the reader is using to work with GitHub (such as GitHub.com's web UI, the GitHub CLI, or GitHub Desktop) or the GitHub APIs (such as cURL or the GitHub CLI). For more information about the tool selector, see [Markup reference for GitHub Docs](../contributing/content-markup-reference.md#tool-tags). If this frontmatter is omitted, then the tool-specific content matching the GitHub web UI is shown by default. If a user has indicated a tool preference (by clicking on a tool tab), then the user's preference will be applied instead of the default value. - Type: `String`, one of: `webui`, `cli`, `desktop`, `curl`, `codespaces`, `vscode`, `importer_cli`, `graphql`, `powershell`, `bash`, `javascript`. - Optional. @@ -263,9 +263,9 @@ includeGuides: - Optional. ### `topics` -- Purpose: Indicate the topics covered by the article. The topics are used to filter guides on some landing pages. For example, the guides at the bottom of [this page](https://docs.github.com/en/actions/guides) can be filtered by topics and the topics are listed under the guide intro. Topics are also added to all search records that get created for each page. The search records contain a `topics` property that is used to filter search results by topics. For more information, see the [Search](/contributing/search.md) contributing guide. Refer to the content models for more details around adding topics. A full list of existing topics is located in the [allowed topics file](/data/allowed-topics.js). If topics in article frontmatter and the allow-topics list become out of sync, the [topics CI test](/tests/unit/search/topics.js) will fail. +- Purpose: Indicate the topics covered by the article. The topics are used to filter guides on some landing pages. For example, the guides at the bottom of [this page](https://docs.github.com/en/actions/guides) can be filtered by topics, and the topics are listed under the guide intro. Topics are also added to all search records that get created for each page. The search records contain a `topics` property that is used to filter search results by topics. For more information, see the [Search](/contributing/search.md) contributing guide. Refer to the content models for more details about adding topics. A full list of existing topics is located in the [allowed topics file](/data/allowed-topics.js). If topics in article frontmatter and the allow-topics list become out of sync, the [topics CI test](/tests/unit/search/topics.js) will fail. - Type: Array of `String`s -- Optional: Topics are preferred for each article, but, there may be cases where existing articles don't yet have topics or adding a topic to a new article may not add value. +- Optional: Topics are preferred for each article, but, there may be cases where existing articles don't yet have topics, or adding a topic to a new article may not add value. ### `contributor` - Purpose: Indicate an article is contributed and maintained by a third-party organization, typically a GitHub Technology Partner. @@ -294,7 +294,7 @@ contributor: If you see two single quotes in a row (`''`) in YML frontmatter where you might expect to see one (`'`), this is the YML-preferred way to escape a single quote. From [the YAML spec](https://yaml.org/spec/history/2001-12-10.html): -> In single quoted leaves, a single quote character needs to be escaped. This is done by repeating the character. +> In single-quoted leaves, a single quote character needs to be escaped. This is done by repeating the character. As an alternative, you can change the single quotes surrounding the frontmatter field to double quotes and leave interior single quotes unescaped. @@ -314,7 +314,7 @@ Make sure not to add hardcoded "In this article" sections in the Markdown source A content file can have **two** types of versioning: * [`versions`](#versions) frontmatter (**required**) - * Determines in which the versions the page is available. See [contributing/permalinks](../contributing/permalinks.md) for more info. + * Determines in which versions the page is available. See [contributing/permalinks](../contributing/permalinks.md) for more info. * Liquid statements in content (**optional**) * Conditionally render content depending on the current version being viewed. See [contributing/liquid-helpers](../contributing/liquid-helpers.md) for more info. Note Liquid conditionals can also appear in `data` and `include` files. @@ -358,7 +358,7 @@ and when viewed on GitHub Enterprise Server docs, the version is included as wel ### Preventing transformations -Sometimes you want to link to a Dotcom-only article in Enterprise content and you don't want the link to be Enterprise-ified. To prevent the transformation, include the preferred version in the path. +Sometimes you want to link to a Dotcom-only article in Enterprise content and you don't want the link to be Enterprise-ified. To prevent the transformation, you should include the preferred version in the path. ```markdown "[GitHub's Terms of Service](/free-pro-team@latest/github/site-policy/github-terms-of-service)" @@ -388,8 +388,8 @@ The homepage is the main Table of Contents file for the docs site. The homepage To create a product guides page (e.g. [Actions' Guide page](https://docs.github.com/en/actions/guides)), create or modify an existing markdown file with these specific frontmatter values: -1. Use the product guides page template by referencing it `layout: product-guides` -2. (optional) Include the learning tracks in [`learningTracks`](#learningTracks) +1. Use the product guides page template by referencing `layout: product-guides`. +2. (optional) Include the learning tracks in [`learningTracks`](#learningTracks). 3. (optional) Define which articles to include with [`includeGuides`](#includeGuides). If using learning tracks, they need to be defined in [`data/learning-tracks/*.yml`](../data/learning-tracks/README.md). diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md index 5a437e284b..6c35133ec7 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md @@ -1,6 +1,6 @@ --- title: Setting up and managing your personal account on GitHub -intro: 'You can manage settings for your personal account on {% data variables.product.prodname_dotcom %}, including email preferences, collaborator access for personal repositories, and organization memberships.' +intro: You can manage settings for your personal account on {% ifversion fpt or ghec or ghes %}{% data variables.product.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %}, including email preferences, access to personal repositories, and organization memberships. You can also manage the account itself. shortTitle: Personal accounts redirect_from: - /categories/setting-up-and-managing-your-github-user-account @@ -15,6 +15,7 @@ topics: - Accounts children: - /managing-personal-account-settings + - /managing-your-personal-account - /managing-email-preferences - /managing-access-to-your-personal-repositories - /managing-your-membership-in-organizations diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md index 1cf21d4dcc..2f1b6925f7 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md @@ -1,6 +1,6 @@ --- title: Managing user account settings -intro: 'You can change several settings for your personal account, including changing your username and deleting your account.' +intro: 'You can manage settings for your personal account, including your theme, username, default branch, accessibility, and security settings.' redirect_from: - /categories/29/articles - /categories/user-accounts @@ -19,9 +19,6 @@ children: - /managing-your-theme-settings - /managing-your-tab-size-rendering-preference - /changing-your-github-username - - /merging-multiple-personal-accounts - - /converting-a-user-into-an-organization - - /deleting-your-personal-account - /permission-levels-for-a-personal-account-repository - /permission-levels-for-a-project-board-owned-by-a-personal-account - /managing-accessibility-settings @@ -29,7 +26,6 @@ children: - /managing-security-and-analysis-settings-for-your-personal-account - /managing-access-to-your-personal-accounts-project-boards - /integrating-jira-with-your-personal-projects - - /best-practices-for-leaving-your-company - /what-does-the-available-for-hire-checkbox-do shortTitle: Personal account settings --- diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md similarity index 95% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company.md rename to content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md index 0f84794666..155379d05f 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md @@ -6,6 +6,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/best-practices-for-leaving-your-company - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/best-practices-for-leaving-your-company - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/best-practices-for-leaving-your-company + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company versions: fpt: '*' ghec: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md similarity index 97% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization.md rename to content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md index 639a7206e7..73fc078a23 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md @@ -7,6 +7,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/converting-a-user-into-an-organization - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization intro: You can convert your personal account into an organization. This allows more granular permissions for repositories that belong to the organization. versions: fpt: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md similarity index 56% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account.md rename to content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md index ba6efc34ce..5ce32ba705 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md @@ -1,38 +1,53 @@ --- title: Deleting your personal account -intro: 'You can delete your personal account on {% data variables.product.product_name %} at any time.' +intro: 'You can delete your personal account on {% data variables.product.product_location %} at any time.' redirect_from: - /articles/deleting-a-user-account - /articles/deleting-your-user-account - /github/setting-up-and-managing-your-github-user-account/deleting-your-user-account - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account versions: fpt: '*' ghes: '*' ghec: '*' topics: - Accounts -shortTitle: Delete your personal account +shortTitle: Delete your account --- -Deleting your personal account removes all repositories, forks of private repositories, wikis, issues, pull requests, and pages owned by your account. {% ifversion fpt or ghec %} Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted - instead, they'll be associated with our [Ghost user](https://github.com/ghost).{% else %}Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted.{% endif %} -{% ifversion fpt or ghec %} When you delete your account we stop billing you. The email address associated with the account becomes available for use with a different account on {% data variables.product.product_location %}. After 90 days, the account name also becomes available to anyone else to use on a new account. {% endif %} +## About deletion of your personal account -If you’re the only owner of an organization, you must transfer ownership to another person or delete the organization before you can delete your personal account. If there are other owners in the organization, you must remove yourself from the organization before you can delete your personal account. +Deleting your personal account removes all repositories, forks of private repositories, wikis, issues, pull requests, and pages owned by your account. {% ifversion fpt or ghec %}Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted. Your resources and comments will become associated with the [ghost user](https://github.com/ghost).{% else %}Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted.{% endif %} + +{% ifversion ghec %} + +{% note %} + +**Note**: If your enterprise manages your account and you sign into {% data variables.product.product_location %} through your company's identity provider (IdP), you cannot delete your account. For more information, see "[About {% data variables.product.prodname_emus %}](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)." + +{% endnote %} + +{% endif %} + +{% ifversion fpt or ghec %}When you delete your account we stop billing you. The email address associated with the account becomes available for use with a different account on {% data variables.product.product_location %}. After 90 days, the account name also becomes available to anyone else to use on a new account. {% endif %} + +If you're the only owner of an organization, you must transfer ownership to another person or delete the organization before you can delete your personal account. If there are other owners in the organization, you must remove yourself from the organization before you can delete your personal account. + +For more information, see the following articles. -For more information, see: - "[Transferring organization ownership](/articles/transferring-organization-ownership)" - "[Deleting an organization account](/articles/deleting-an-organization-account)" - "[Removing yourself from an organization](/articles/removing-yourself-from-an-organization/)" ## Back up your account data -Before you delete your personal account, make a copy of all repositories, private forks, wikis, issues, and pull requests owned by your account. +Before you delete your personal account, make a copy of all repositories, private forks, wikis, issues, and pull requests owned by your account. For more information, see "[Backing up a repository](/repositories/archiving-a-github-repository/backing-up-a-repository)." {% warning %} -**Warning:** Once your personal account has been deleted, GitHub cannot restore your content. +**Warning:** Once your personal account has been deleted, {% ifversion fpt or ghec %}{% data variables.product.company_short %}{% elsif ghes or ghae %}an enterprise owner{% endif %} cannot restore your content. {% endwarning %} diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md new file mode 100644 index 0000000000..ab1c7a9394 --- /dev/null +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md @@ -0,0 +1,19 @@ +--- +title: Managing your personal account +intro: 'You can manage your personal account on {% ifversion fpt or ghec or ghes %}{% data variables.product.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %}. For example, you can {% ifversion fpt or ghec %}manage multiple accounts, {% endif %}convert an account to an organization{% ifversion fpt or ghec or ghes %}, or delete an account{% endif %}.' +shortTitle: Manage personal account +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - Accounts +children: + - /managing-multiple-accounts + - /merging-multiple-personal-accounts + - /converting-a-user-into-an-organization + - /best-practices-for-leaving-your-company + - /deleting-your-personal-account +--- + diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md new file mode 100644 index 0000000000..bab1201104 --- /dev/null +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md @@ -0,0 +1,105 @@ +--- +title: Managing multiple accounts +intro: 'If you use one workstation to contribute to projects for more than one account on {% data variables.product.product_location %}, you can modify your Git configuration to simplify the contribution process.' +versions: + feature: multiple-accounts-one-workstation +topics: + - Accounts + - Git + - GitHub +shortTitle: Manage multiple accounts +--- + +## About management of multiple accounts + +In some cases, you may need to use multiple accounts on {% data variables.product.product_location %}. For example, you may have a personal account for open source contributions, and your employer may also create and manage a user account for you within an enterprise. + +You cannot use your {% data variables.product.prodname_managed_user %} to contribute to public projects on {% data variables.product.product_location %}, so you must contribute to those resources using your personal account. For more information, see "[About {% data variables.product.prodname_emus %}]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#abilities-and-restrictions-of-managed-user-accounts){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% elsif ghec %}."{% endif %} + +If you want to use one workstation to contribute from both accounts, you can simplify contribution with Git by using a mixture of protocols to access repository data, or by using credentials on a per-repository basis. + +{% warning %} + +**Warning**: Be mindful when you use one workstation to contribute to two separate accounts. Management of two or more accounts can increase the chance of mistakenly leaking internal code to the public. + +{% endwarning %} + +If you aren't required to use a {% data variables.product.prodname_managed_user %}, {% data variables.product.company_short %} recommends that you use one personal account for all your work on {% data variables.product.product_location %}. With a single personal account, you can contribute to a combination of personal, open source, or professional projects using one identity. Other people can invite the account to contribute to both individual repositories and repositories owned by an organization, and the account can be a member of multiple organizations or enterprises. + +## Contributing to two accounts using HTTPS and SSH + +If you contribute with two accounts from one workstation, you can access repositories by using a different protocol and credentials for each account. + +Git can use either the HTTPS or SSH protocol to access and update data in repositories on {% data variables.product.product_location %}. The protocol you use to clone a repository determines which credentials your workstation will use to authenticate when you access the repository. With this approach to account management, you store the credentials for one account to use for HTTPS connections and upload an SSH key to the other account to use for SSH connections. + +You can find both the HTTPS or an SSH URLs for cloning a repository on {% data variables.product.product_name %}. For more information, see "[Cloning a repository](/repositories/creating-and-managing-repositories/cloning-a-repository)." + +For more information about the use of SSH to access repositories on {% data variables.product.product_name %}, see "[Connecting to {% data variables.product.prodname_dotcom %} with SSH](/authentication/connecting-to-github-with-ssh)." + +## Contributing to multiple accounts using HTTPS and PATs + +Alternatively, if you want to use the HTTPS protocol for both accounts, you can use different personal access tokens (PAT) for each account by configuring Git to store different credentials for each repository. + +{% mac %} + +{% data reusables.git.open-terminal %} +{% data reusables.git.confirm-credential-manager %} +{% data reusables.git.clear-the-stored-credentials %} + {% data reusables.git.no-credential-manager %} + - If the output is `osxkeychain`, you're using the macOS keychain. To clear the credentials, enter the following command. + + ```shell{:copy} + git credential-osxkeychain erase https://github.com + ``` + {% data reusables.git.clear-stored-gcm-credentials %} +{% data reusables.git.cache-on-repository-path %} +{% data reusables.accounts.create-personal-access-tokens %} +{% data reusables.git.provide-credentials %} + +{% endmac %} + +{% windows %} + +1. Open Git Bash. +{% data reusables.git.confirm-credential-manager %} +{% data reusables.git.clear-the-stored-credentials %} + {% data reusables.git.no-credential-manager %} + {% data reusables.git.clear-stored-gcm-credentials %} + - If the output is `wincred`, you're using the Windows Credential Manager. To clear the credentials, enter the following command. + + ```shell{:copy} + cmdkey /delete:LegacyGeneric:target=git:https://github.com + ``` +{% data reusables.git.cache-on-repository-path %} +{% data reusables.accounts.create-personal-access-tokens %} +{% data reusables.git.provide-credentials %} + +{% endwindows %} + +{% linux %} + +{% data reusables.git.open-terminal %} +{% data reusables.git.confirm-credential-manager %} +{% data reusables.git.clear-the-stored-credentials %} + {% data reusables.git.no-credential-manager %} + {% data reusables.git.clear-stored-gcm-credentials %} +{% data reusables.git.cache-on-repository-path %} +{% data reusables.accounts.create-personal-access-tokens %} +{% data reusables.git.provide-credentials %} + +{% endlinux %} + +## Contributing to multiple accounts using SSH and `GIT_SSH_COMMAND` + +If you want to use the SSH protocol for both accounts, you can use different SSH keys for each account. For more information about using SSH, see "[Connecting to {% data variables.product.prodname_dotcom %} with SSH](/authentication/connecting-to-github-with-ssh)." + +To use a different SSH key for different repositories that you clone to your workstation, you must write a shell wrapper function for Git operations. The function should perform the following steps. +1. Determine the repository's full name with owner, using a command such as `git config --get remote.origin.url`. +2. Choose the correct SSH key for authentication. +3. Modify `GIT_SSH_COMMAND` accordingly. For more information about `GIT_SSH_COMMAND`, see [Environment Variables](https://git-scm.com/docs/git#Documentation/git.txt-codeGITSSHCOMMANDcode) in the Git documentation. + +For example, the following command sets the `GIT_SSH_COMMAND` environment variable to specify an SSH command that uses the private key file at **_PATH/TO/KEY/FILE_** for authentication to clone the repository named **_OWNER_**/**_REPOSITORY_** on {% data variables.product.product_location %}. + +
    +GIT_SSH_COMMAND='ssh -i PATH/TO/KEY/FILE -o IdentitiesOnly=yes' git clone git@github.com:OWNER/REPOSITORY
+
    diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md similarity index 94% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts.md rename to content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md index b5ad8525d3..c386aa453f 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md @@ -8,12 +8,13 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/merging-multiple-user-accounts - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts versions: fpt: '*' ghec: '*' topics: - Accounts -shortTitle: Merge multiple personal accounts +shortTitle: Merge multiple accounts --- {% tip %} diff --git a/content/actions/creating-actions/metadata-syntax-for-github-actions.md b/content/actions/creating-actions/metadata-syntax-for-github-actions.md index 56b069acf1..e8b5b83607 100644 --- a/content/actions/creating-actions/metadata-syntax-for-github-actions.md +++ b/content/actions/creating-actions/metadata-syntax-for-github-actions.md @@ -354,7 +354,7 @@ runs: #### `runs.steps[*].with` -**Optional** A `map` of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case. +**Optional** A `map` of the input parameters defined by the action. Each input parameter is a key/value pair. For more information, see [Example: Specifying inputs](#example-specifying-inputs). ```yaml runs: diff --git a/content/actions/creating-actions/publishing-actions-in-github-marketplace.md b/content/actions/creating-actions/publishing-actions-in-github-marketplace.md index e264f2a72e..66ee2080e3 100644 --- a/content/actions/creating-actions/publishing-actions-in-github-marketplace.md +++ b/content/actions/creating-actions/publishing-actions-in-github-marketplace.md @@ -38,9 +38,10 @@ You can add the action you've created to {% data variables.product.prodname_mark To draft a new release and publish the action to {% data variables.product.prodname_marketplace %}, follow these instructions: {% data reusables.repositories.navigate-to-repo %} -1. When a repository contains an action metadata file (`action.yml` or `action.yaml`), you'll see a banner to publish the action to {% data variables.product.prodname_marketplace %}. Click **Draft a release**. -![Publish this action to markeplace button](/assets/images/help/repository/publish-github-action-to-markeplace-button.png) -1. Select **Publish this action to the {% data variables.product.prodname_marketplace %}**. If you can't select the **Publish this action to the {% data variables.product.prodname_marketplace %}** checkbox, you'll need to read and accept the {% data variables.product.prodname_marketplace %} agreement first. +1. Navigate to the action metadata file in your repository (`action.yml` or `action.yaml`), and you'll see a banner to publish the action to {% data variables.product.prodname_marketplace %}. Click **Draft a release**. + + ![Publish this action to marketplace button](/assets/images/help/repository/publish-github-action-to-marketplace-button.png) +1. Under "Release Action", select the checkbox to publish the action to the {% data variables.product.prodname_marketplace %}. If you can't select the checkbox, you must first click the link to read and accept the {% data variables.product.prodname_marketplace %} Developer Agreement. ![Select publish to Marketplace](/assets/images/help/repository/marketplace_actions_publish.png) 1. If the labels in your metadata file contain any problems, you will see an error message. ![See notification](/assets/images/help/repository/marketplace_actions_fixerrors.png) diff --git a/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md b/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md index 0e5e9f0b68..f3eecc8858 100644 --- a/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md +++ b/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md @@ -73,6 +73,7 @@ The following example OIDC token uses a subject (`sub`) that references a job en "repository": "octo-org/octo-repo", "repository_owner": "octo-org", "actor_id": "12", + "repo_visibility": private, "repository_id": "74", "repository_owner_id": "65", "run_id": "example-run-id", @@ -128,6 +129,7 @@ The token also includes custom claims provided by {% data variables.product.prod | `job_workflow_ref`| This is the ref path to the reusable workflow used by this job. For more information, see "["Using OpenID Connect with reusable workflows"](/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows)." | | `ref`| _(Reference)_ The git ref that triggered the workflow run. | | `ref_type`| The type of `ref`, for example: "branch". | +| `repo_visibility` | The visibility of the repository where the workflow is running. Accepts the following values: `internal`, `private`, or `public`. | | `repository`| The repository from where the workflow is running. | | `repository_id`| The ID of the repository from where the workflow is running. | | `repository_owner`| The name of the organization in which the `repository` is stored. | @@ -143,11 +145,11 @@ With OIDC, a {% data variables.product.prodname_actions %} workflow requires a t Audience and Subject claims are typically used in combination while setting conditions on the cloud role/resources to scope its access to the GitHub workflows. - **Audience**: By default, this value uses the URL of the organization or repository owner. This can be used to set a condition that only the workflows in the specific organization can access the cloud role. -- **Subject**: Has a predefined format and is a concatenation of some of the key metadata about the workflow, such as the {% data variables.product.prodname_dotcom %} organization, repository, branch, or associated [`job`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idenvironment) environment. See "[Example subject claims](#example-subject-claims)" to see how the subject claim is assembled from concatenated metadata. +- **Subject**: By default, has a predefined format and is a concatenation of some of the key metadata about the workflow, such as the {% data variables.product.prodname_dotcom %} organization, repository, branch, or associated [`job`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idenvironment) environment. See "[Example subject claims](#example-subject-claims)" to see how the subject claim is assembled from concatenated metadata. -There are also many additional claims supported in the OIDC token that can also be used for setting these conditions. +If you need more granular trust conditions, you can customize the issuer (`iss`) and subject (`sub`) claims that are included with the JWT. For more information, see "[Customizing the token claims](#customizing-the-token-claims)". -In addition, your cloud provider could allow you to assign a role to the access tokens, letting you specify even more granular permissions. +There are also many additional claims supported in the OIDC token that can be used for setting these conditions. In addition, your cloud provider could allow you to assign a role to the access tokens, letting you specify even more granular permissions. {% note %} @@ -238,6 +240,198 @@ curl -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" "$ACTIONS_ID_TOK {% data reusables.actions.oidc-permissions-token %} +{% ifversion actions-oidc-hardening-config %} +## Customizing the token claims + +You can security harden your OIDC configuration by customizing the claims that are included with the JWT. These customisations allow you to define more granular trust conditions on your cloud roles when allowing your workflows to access resources hosted in the cloud: + +{% ifversion ghec %} - For an additional layer of security, you can append the `issuer` url with your enterprise slug. This lets you set conditions on the issuer (`iss`) claim, configuring it to only accept JWT tokens from a unique `issuer` URL that must include your enterprise slug.{% endif %} +- You can standardize your OIDC configuration by setting conditions on the subject (`sub`) claim that require JWT tokens to originate from a specific repository, reusable workflow, or other source. +- You can define granular OIDC policies by using additional OIDC token claims, such as `repository_id` and `repo_visibility`. For more information, see "[Understanding the OIDC token](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#understanding-the-oidc-token)". + +To customize these claim formats, organization and repository admins can use the REST API endpoints described in the following sections. + +{% ifversion ghec %} + +### Switching to a unique token URL + +By default, the JWT is issued by {% data variables.product.prodname_dotcom %}'s OIDC provider at `https://token.actions.githubusercontent.com`. This path is presented to your cloud provider using the `iss` value in the JWT. + +Enterprise admins can security harden their OIDC configuration by configuring their enterprise to receive tokens from a unique URL at `https://api.github.com/enterprises//actions/oidc/customization/issuer`. Replace `` with the slug value of your enterprise. + +This configuration means that your enterprise will receive the OIDC token from a unique URL, and you can then configure your cloud provider to only accept tokens from that URL. This helps ensure that only the enterprise's repositories can access your cloud resources using OIDC. + +To activate this setting for your enterprise, an enterprise admin must use the `/enterprises/{enterprise}/actions/oidc/customization/issuer` endpoint and specify `"include_enterprise_slug": true` in the request body. For more information, see "[Set the {% data variables.product.prodname_actions %} OIDC custom issuer policy for an enterprise](/rest/actions/oidc#set-the-github-actions-oidc-custom-issuer-policy-for-an-enterprise)." + +After this setting is applied, the JWT will contain the updated `iss` value. In the following example, the `iss` key uses `octocat-inc` as its `enterpriseSlug` value: + +```json +{ + "jti": "6f4762ed-0758-4ccb-808d-ee3af5d723a8" + "sub": "repo:octocat-inc/private-server:ref:refs/heads/main" + "aud": "http://octocat-inc.example/octocat-inc" + "enterprise": "octocat-inc" + "iss": "https://api.github.com/enterprises/octocat-inc/actions/oidc/customization/issuer", + "bf": 1755350653, + "exp": 1755351553, + "iat": 1755351253 +} +``` + +{% endif %} + +### Customizing the subject claims for an organization + +To configure organization-wide security, compliance, and standardization, you can customize the standard claims to suit your required access conditions. If your cloud provider supports conditions on subject claims, you can create a condition that checks whether the `sub` value matches the path of the reusable workflow, such as `"job_workflow_ref: "octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main""`. The exact format will vary depending on your cloud provider's OIDC configuration. To configure the matching condition on {% data variables.product.prodname_dotcom %}, you can can use the REST API to require that the `sub` claim must always include a specific custom claim, such as `job_workflow_ref`. For more information, see "[Set the customization template for an OIDC subject claim for an organization](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization)." + +Customizing the claims results in a new format for the entire `sub` claim, which replaces the default predefined `sub` format in the token described in "[Example subject claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims)." + +The following example templates demonstrate various ways to customize the subject claim. To configure these settings on {% data variables.product.prodname_dotcom %}, organization admins use the REST API to specify a list of claims that must be included in the subject (`sub`) claim. {% data reusables.actions.use-request-body-api %} + +To customize your subject claims, you should first create a matching condition in your cloud provider's OIDC configuration, before customizing the configuration using the REST API. Once the configuration is completed, each time a new job runs, the OIDC token generated during that job will follow the new customization template. If the matching condition doesn't exist in the cloud provider's OIDC configuration before the job runs, the generated token might not be accepted by the cloud provider, since the cloud conditions may not be synchronized. + +{% note %} + +**Note**: When the organization template is applied, it will not affect any existing repositories that already use OIDC. For existing repositories, as well as any new repositories that are created after the template has been applied, the repository owner will need to opt-in to receive this configuration. For more information, see "[Set the opt-in flag of an OIDC subject claim customization for a repository](/rest/actions/oidc#set-the-opt-in-flag-of-an-oidc-subject-claim-customization-for-a-repository)." + +{% endnote %} + +#### Example: Allowing repository based on visibility and owner + +This example template allows the `sub` claim to have a new format, using `repository_owner` and `repository_visibility`: + +```json +{ + "include_claim_keys": [ + "repository_owner", + "repository_visibility" + ] +} +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repository_owner` and `repository_visibility`. For example: `"repository_owner: "monalisa":repository_visibility:private"`. The approach lets you restrict cloud role access to only private repositories within an organization or enterprise. + +#### Example: Allowing access to all repositories with a specific owner + +This example template enables the `sub` claim to have a new format with only the value of `repository_owner`. {% data reusables.actions.use-request-body-api %} + +```json +{ + "include_claim_keys": [ + "repository_owner" + ] +} + +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include a specific value for `repository_owner`. For example: `"repository_owner: "monalisa""` + +#### Example: Requiring a reusable workflow + +This example template allows the `sub` claim to have a new format that contains the value of the `job_workflow_ref` claim. This enables an enterprise to use [reusable workflows](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims) to enforce consistent deployments across its organizations and repositories. + +{% data reusables.actions.use-request-body-api %} + +```json + { + "include_claim_keys": [ + "job_workflow_ref" + ] + } +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include a specific value for `job_workflow_ref`. For example: `"job_workflow_ref: "octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main""`. + +#### Example: Requiring a reusable workflow and other claims + +The following example template combines the requirement of a specific reusable workflow with additional claims. {% data reusables.actions.use-request-body-api %} + +This example also demonstrates how to use `"context"` to define your conditions. This is the part that follows the repository in the [default `sub` format](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims). For example, when the job references an environment, the context contains: `environment:`. + +```json +{ + "include_claim_keys": [ + "repo", + "context", + "job_workflow_ref" + ] +} +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repo`, `context`, and `job_workflow_ref`. + +This customization template requires that the `sub` uses the following format: `repo::environment::job_workflow_ref:`. +For example: `"sub": "repo:octo-org/octo-repo:environment:prod:job_workflow_ref:octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main"` + +#### Example: Granting access to a specific repository + +This example template lets you grant cloud access to all the workflows in a specific repository, across all branches/tags and environments. To help improve security, combine this template with the custom issuer URL described in "[Customizing the token URL for an enterprise](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-url-for-an-enterprise)." + +{% data reusables.actions.use-request-body-api %} + +```json +{ + "include_claim_keys": [ + "repo" + ] +} +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require a `repo` claim that matches the required value. + +#### Example: Using system-generated GUIDs + +This example template enables predictable OIDC claims with system-generated GUIDs that do not change between renames of entities (such as renaming a repository). {% data reusables.actions.use-request-body-api %} + +```json + { + "include_claim_keys": [ + "repository_id" + ] + } +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require a `repository_id` claim that matches the required value. + +or: + +```json +{ + "include_claim_keys": [ + "repository_owner_id" + ] +} +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require a `repository_owner_id` claim that matches the required value. + +#### Resetting your customizations + +This example template resets the subject claims to the default format. {% data reusables.actions.use-request-body-api %} This template effectively opts out of any organization-level customization policy. + +```json +{ + "include_claim_keys": [ + "repo", + "context" + ] +} +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repo` and `context`. + +#### Using the default subject claims + +For repositories that can receive a subject claim policy from their organization, the repository owner can later choose to opt-out and instead use the default `sub` claim format. To configure this, the repository admin must use the REST API endpoint at "[Set the opt-out flag of an OIDC subject claim customization for a repository](/rest/actions/oidc#set-the-opt-out-flag-of-an-oidc-subject-claim-customization-for-a-repository)" with the following request body: + +```json +{ + "use_default": true +} +``` + +{% endif %} + ## Updating your workflows for OIDC You can now update your YAML workflows to use OIDC access tokens instead of secrets. Popular cloud providers have published their official login actions that make it easy for you to get started with OIDC. For more information about updating your workflows, see the cloud-specific guides listed below in "[Enabling OpenID Connect for your cloud provider](#enabling-openid-connect-for-your-cloud-provider)." diff --git a/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md b/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md index 3b10f509b2..fbcb0c2c53 100644 --- a/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md +++ b/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md @@ -32,10 +32,53 @@ This guide gives an overview of how to configure HashiCorp Vault to trust {% dat To use OIDC with HashiCorp Vault, you will need to add a trust configuration for the {% data variables.product.prodname_dotcom %} OIDC provider. For more information, see the HashiCorp Vault [documentation](https://www.vaultproject.io/docs/auth/jwt). -Configure the vault to accept JSON Web Tokens (JWT) for authentication: -- For the `oidc_discovery_url`, use {% ifversion ghes %}`https://HOSTNAME/_services/token`{% else %}`https://token.actions.githubusercontent.com`{% endif %} -- For `bound_issuer`, use {% ifversion ghes %}`https://HOSTNAME/_services/token`{% else %}`https://token.actions.githubusercontent.com`{% endif %} -- Ensure that `bound_subject` is correctly defined for your security requirements. For more information, see ["Configuring the OIDC trust with the cloud"](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#configuring-the-oidc-trust-with-the-cloud) and [`hashicorp/vault-action`](https://github.com/hashicorp/vault-action). +To configure your Vault server to accept JSON Web Tokens (JWT) for authentication: + +1. Enable the JWT `auth` method, and use `write` to apply the configuration to your Vault. + For `oidc_discovery_url` and `bound_issuer` parameters, use {% ifversion ghes %}`https://HOSTNAME/_services/token`{% else %}`https://token.actions.githubusercontent.com`{% endif %}. These parameters allow the Vault server to verify the received JSON Web Tokens (JWT) during the authentication process. + + ```sh{:copy} + vault auth enable jwt + ``` + + ```sh{:copy} + vault write auth/jwt/config \ + bound_issuer="{% ifversion ghes %}https://HOSTNAME/_services/token{% else %}https://token.actions.githubusercontent.com{% endif %}" \ + oidc_discovery_url="{% ifversion ghes %}https://HOSTNAME/_services/token{% else %}https://token.actions.githubusercontent.com{% endif %}" + ``` +2. Configure a policy that only grants access to the specific paths your workflows will use to retrieve secrets. For more advanced policies, see the HashiCorp Vault [Policies documentation](https://www.vaultproject.io/docs/concepts/policies). + + ```sh{:copy} + vault policy write myproject-production - <`: Replace this with the URL of your HashiCorp Vault. +- ``: Replace this with the Namespace you've set in HashiCorp Vault. For example: `admin`. - ``: Replace this with the role you've set in the HashiCorp Vault trust relationship. -- ``: Replace this with the audience you've defined in the HashiCorp Vault trust relationship. -- ``: Replace this with the path to the secret you're retrieving from HashiCorp Vault. For example: `secret/data/ci npmToken`. +- ``: Replace this with the path to the secret you're retrieving from HashiCorp Vault. For example: `secret/data/production/ci npmToken`. ```yaml{:copy} jobs: - retrieve-secret: - steps: - - name: Retrieve secret from Vault - uses: hashicorp/vault-action@v2.4.0 - with: - url: - role: - method: jwt - jwtGithubAudience: - secrets: + retrieve-secret: + runs-on: ubuntu-latest + permissions: + id-token: write + contents: read + steps: + - name: Retrieve secret from Vault + uses: hashicorp/vault-action@v2.4.0 + with: + method: jwt + url: + namespace: + role: + secrets: - - name: Use secret from Vault - run: | - # This step has access to the secret retrieved above; see hashicorp/vault-action for more details. + - name: Use secret from Vault + run: | + # This step has access to the secret retrieved above; see hashicorp/vault-action for more details. ``` + +{% note %} + +**Note**: + +- If your Vault server is not accessible from the public network, consider using a self-hosted runner with other available Vault [auth methods](https://www.vaultproject.io/docs/auth). For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)." +- `` must be set for a Vault Enterprise (including HCP Vault) deployment. For more information, see [Vault namespace](https://www.vaultproject.io/docs/enterprise/namespaces). + +{% endnote %} + +### Revoking the access token + +By default, the Vault server will automatically revoke access tokens when their TTL is expired, so you don't have to manually revoke the access tokens. However, if you do want to revoke access tokens immediately after your job has completed or failed, you can manually revoke the issued token using the [Vault API](https://www.vaultproject.io/api/auth/token#revoke-a-token-self). + +1. Set the `exportToken` option to `true` (default: `false`). This exports the issued Vault access token as an environment variable: `VAULT_TOKEN`. +2. Add a step to call the [Revoke a Token (Self)](https://www.vaultproject.io/api/auth/token#revoke-a-token-self) Vault API to revoke the access token. + +```yaml{:copy} +jobs: + retrieve-secret: + runs-on: ubuntu-latest + permissions: + id-token: write + contents: read + steps: + - name: Retrieve secret from Vault + uses: hashicorp/vault-action@v2.4.0 + with: + exportToken: true + method: jwt + url: + role: + secrets: + + - name: Use secret from Vault + run: | + # This step has access to the secret retrieved above; see hashicorp/vault-action for more details. + + - name: Revoke token + # This step always runs at the end regardless of the previous steps result + if: always() + run: | + curl -X POST -sv -H "X-Vault-Token: {% raw %}${{ env.VAULT_TOKEN }}{% endraw %}" \ + /v1/auth/token/revoke-self +``` \ No newline at end of file diff --git a/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md b/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md index 1fb177d065..25ba9d8db0 100644 --- a/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md +++ b/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md @@ -23,11 +23,18 @@ topics: Rather than copying and pasting deployment jobs from one workflow to another, you can create a reusable workflow that performs the deployment steps. A reusable workflow can be used by another workflow if it meets one of the access requirements described in "[Reusing workflows](/actions/learn-github-actions/reusing-workflows#access-to-reusable-workflows)." -When combined with OpenID Connect (OIDC), reusable workflows let you enforce consistent deployments across your repository, organization, or enterprise. You can do this by defining trust conditions on cloud roles based on reusable workflows. +You should be familiar with the concepts described in "[Reusing workflows](/actions/learn-github-actions/reusing-workflows" and "[About security hardening with OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)." -In order to create trust conditions based on reusable workflows, your cloud provider must support custom claims for `job_workflow_ref`. This allows your cloud provider to identify which repository the job originally came from. If your cloud provider only supports the standard claims (_audience_ and _subject_), it will not be able to determine that the job originated from the reusable workflow repository. Cloud providers that support `job_workflow_ref` include Google Cloud Platform and HashiCorp Vault. +## Defining the trust conditions -Before proceeding, you should be familiar with the concepts of [reusable workflows](/actions/learn-github-actions/reusing-workflows) and [OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect). +When combined with OpenID Connect (OIDC), reusable workflows let you enforce consistent deployments across your repository, organization, or enterprise. You can do this by defining trust conditions on cloud roles based on reusable workflows. The available options will vary depending on your cloud provider: + +- **Using `job_workflow_ref`**: + - To create trust conditions based on reusable workflows, your cloud provider must support custom claims for `job_workflow_ref`. This allows your cloud provider to identify which repository the job originally came from. + - For clouds that only support the standard claims (audience (`aud`) and subject (`sub`)), you can use the API to customize the `sub` claim to include `job_workflow_ref`. For more information, see "[Customizing the token claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". Support for custom claims is currently available for Google Cloud Platform and HashiCorp Vault. + +- **Customizing the token claims**: + - You can configure more granular trust conditions by customizing the issuer (`iss`) and subject (`sub`) claims included with the JWT. For more information, see "[Customizing the token claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". ## How the token works with reusable workflows diff --git a/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md b/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md index f3f28d5e15..f95896503d 100644 --- a/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md +++ b/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md @@ -18,15 +18,24 @@ shortTitle: Run runner app on startup {% capture service_first_step %}1. Stop the self-hosted runner application if it is currently running.{% endcapture %} {% capture service_non_windows_intro_shell %}On the runner machine, open a shell in the directory where you installed the self-hosted runner application. Use the commands below to install and manage the self-hosted runner service.{% endcapture %} -{% capture service_nonwindows_intro %}You must add a runner to {% data variables.product.product_name %} before you can configure the self-hosted runner application as a service. For more information, see "[Adding self-hosted runners](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)."{% endcapture %} -{% capture service_win_name %}actions.runner.*{% endcapture %} +{% capture service_nonwindows_intro %} + +{% note %} + +**Note:** You must add a runner to {% data variables.product.product_name %} before you can configure the self-hosted runner application as a service. +For more information, see "[Adding self-hosted runners](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)." + +{% endnote %} +{% endcapture %} + +{% capture service_win_name %}actions.runner.*{% endcapture %} {% linux %} {{ service_nonwindows_intro }} -For Linux systems that use `systemd`, you can use the `svc.sh` script distributed with the self-hosted runner application to install and manage using the application as a service. +For Linux systems that use `systemd`, you can use the `svc.sh` script that is created after successfully adding the runner to install and manage using the application as a service. {{ service_non_windows_intro_shell }} diff --git a/content/actions/learn-github-actions/contexts.md b/content/actions/learn-github-actions/contexts.md index 2cd8c3d9ac..a8abf6ce7e 100644 --- a/content/actions/learn-github-actions/contexts.md +++ b/content/actions/learn-github-actions/contexts.md @@ -38,6 +38,8 @@ You can access contexts using the expression syntax. For more information, see " | `github` | `object` | Information about the workflow run. For more information, see [`github` context](#github-context). | | `env` | `object` | Contains environment variables set in a workflow, job, or step. For more information, see [`env` context](#env-context). | | `job` | `object` | Information about the currently running job. For more information, see [`job` context](#job-context). | +{%- ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} +| `jobs` | `object` | For reusable workflows only, contains outputs of jobs from the reusable workflow. For more information, see [`jobs` context](#jobs-context). |{% endif %} | `steps` | `object` | Information about the steps that have been run in the current job. For more information, see [`steps` context](#steps-context). | | `runner` | `object` | Information about the runner that is running the current job. For more information, see [`runner` context](#runner-context). | | `secrets` | `object` | Contains the names and values of secrets that are available to a workflow run. For more information, see [`secrets` context](#secrets-context). | @@ -87,7 +89,7 @@ The following table indicates where each context and special function can be use | jobs.<job_id>.name | github, needs, strategy, matrix, inputs | | | jobs.<job_id>.outputs.<output_id> | github, needs, strategy, matrix, job, runner, env, secrets, steps, inputs | | | jobs.<job_id>.runs-on | github, needs, strategy, matrix, inputs | | -| jobs.<job_id>.secrets.<secrets_id> | github, needs, secrets{% ifversion actions-unified-inputs %}, inputs{% endif %} | | +| jobs.<job_id>.secrets.<secrets_id> | github, needs,{% ifversion actions-reusable-workflow-matrix %} strategy, matrix,{% endif %} secrets{% ifversion actions-unified-inputs %}, inputs{% endif %} | | | jobs.<job_id>.services | github, needs, strategy, matrix, inputs | | | jobs.<job_id>.services.<service_id>.credentials | github, needs, strategy, matrix, env, secrets, inputs | | | jobs.<job_id>.services.<service_id>.env.<env_id> | github, needs, strategy, matrix, job, runner, env, secrets, inputs | | @@ -101,7 +103,7 @@ The following table indicates where each context and special function can be use | jobs.<job_id>.steps.working-directory | github, needs, strategy, matrix, job, runner, env, secrets, steps, inputs | hashFiles | | jobs.<job_id>.strategy | github, needs, inputs | | | jobs.<job_id>.timeout-minutes | github, needs, strategy, matrix, inputs | | -| jobs.<job_id>.with.<with_id> | github, needs{% ifversion actions-unified-inputs %}, inputs{% endif %} | | +| jobs.<job_id>.with.<with_id> | github, needs{% ifversion actions-reusable-workflow-matrix %}, strategy, matrix{% endif %}{% ifversion actions-unified-inputs %}, inputs{% endif %} | | | on.workflow_call.inputs.<inputs_id>.default | github{% ifversion actions-unified-inputs %}, inputs{% endif %} | | | on.workflow_call.outputs.<output_id>.value | github, jobs, inputs | | {% else %} @@ -404,6 +406,72 @@ jobs: - run: ./run-tests ``` +{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} + +## `jobs` context + +The `jobs` context is only available in reusable workflows, and can only be used to set outputs for a reusable workflow. For more information, see "[Reusing workflows](/actions/using-workflows/reusing-workflows#using-outputs-from-a-reusable-workflow)." + +| Property name | Type | Description | +|---------------|------|-------------| +| `jobs` | `object` | This is only available in reusable workflows, and can only be used to set outputs for a reusable workflow. This object contains all the properties listed below. +| `jobs..result` | `string` | The result of a job in the reusable workflow. Possible values are `success`, `failure`, `cancelled`, or `skipped`. | +| `jobs..outputs` | `object` | The set of outputs of a job in a reusable workflow. | +| `jobs..outputs.` | `string` | The value of a specific output for a job in a reusable workflow. | + +### Example contents of the `jobs` context + +This example `jobs` context contains the result and outputs of a job from a reusable workflow run. + +```json +{ + example_job: { + result: success, + outputs: { + output1: hello, + output2: world + } + } +} +``` + +### Example usage of the `jobs` context + +This example reusable workflow uses the `jobs` context to set outputs for the reusable workflow. Note how the outputs flow up from the steps, to the job, then to the `workflow_call` trigger. For more information, see "[Reusing workflows](/actions/using-workflows/reusing-workflows#using-outputs-from-a-reusable-workflow)." + +{% raw %} +```yaml{:copy} +name: Reusable workflow + +on: + workflow_call: + # Map the workflow outputs to job outputs + outputs: + firstword: + description: "The first output string" + value: ${{ jobs.example_job.outputs.output1 }} + secondword: + description: "The second output string" + value: ${{ jobs.example_job.outputs.output2 }} + +jobs: + example_job: + name: Generate output + runs-on: ubuntu-latest + # Map the job outputs to step outputs + outputs: + output1: ${{ steps.step1.outputs.firstword }} + output2: ${{ steps.step2.outputs.secondword }} + steps: + - id: step1 + run: echo "::set-output name=firstword::hello" + - id: step2 + run: echo "::set-output name=secondword::world" +``` +{% endraw %} + +{% endif %} + ## `steps` context The `steps` context contains information about the steps in the current job that have an [`id`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsid) specified and have already run. diff --git a/content/actions/learn-github-actions/understanding-github-actions.md b/content/actions/learn-github-actions/understanding-github-actions.md index a92f932538..3ac38d19c6 100644 --- a/content/actions/learn-github-actions/understanding-github-actions.md +++ b/content/actions/learn-github-actions/understanding-github-actions.md @@ -93,7 +93,7 @@ For more information, see "[Creating actions](/actions/creating-actions)." - To continue learning about {% data variables.product.prodname_actions %}, see "[Finding and customizing actions](/actions/learn-github-actions/finding-and-customizing-actions)." {% ifversion fpt or ghec or ghes %} -- To understand how billing works for {% data variables.product.prodname_actions %}, see "[About billing for {% data variables.product.prodname_actions %}](/actions/reference/usage-limits-billing-and-administration#about-billing-for-github-actions)". +- To understand how billing works for {% data variables.product.prodname_actions %}, see "[About billing for {% data variables.product.prodname_actions %}](/actions/reference/usage-limits-billing-and-administration#about-billing-for-github-actions)." {% endif %} ## Contacting support diff --git a/content/actions/publishing-packages/publishing-nodejs-packages.md b/content/actions/publishing-packages/publishing-nodejs-packages.md index 50746929a6..0768413dbc 100644 --- a/content/actions/publishing-packages/publishing-nodejs-packages.md +++ b/content/actions/publishing-packages/publishing-nodejs-packages.md @@ -98,9 +98,9 @@ Each time you create a new release, you can trigger a workflow to publish your p ### Configuring the destination repository -If you don't provide the `repository` key in your *package.json* file, then {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the `name` field of the *package.json* file. For example, a package named `@my-org/test` is published to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. +Linking your package to {% data variables.product.prodname_registry %} using the `repository` key is optional. If you choose not to provide the `repository` key in your *package.json* file, then {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the `name` field of the *package.json* file. For example, a package named `@my-org/test` is published to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. If the `url` specified in the `repository` key is invalid, your package may still be published however it won't be linked to the repository source as intended. -However, if you do provide the `repository` key, then the repository in that key is used as the destination npm registry for {% data variables.product.prodname_registry %}. For example, publishing the below *package.json* results in a package named `my-amazing-package` published to the `octocat/my-other-repo` {% data variables.product.prodname_dotcom %} repository. +If you do provide the `repository` key in your *package.json* file, then the repository in that key is used as the destination npm registry for {% data variables.product.prodname_registry %}. For example, publishing the below *package.json* results in a package named `my-amazing-package` published to the `octocat/my-other-repo` {% data variables.product.prodname_dotcom %} repository. Once published, only the repository source is updated, and the package doesn't inherit any permissions from the destination repository. ```json { diff --git a/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md b/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md index f636895b40..2de67fe8e5 100644 --- a/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md +++ b/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md @@ -51,7 +51,7 @@ For more information on workflow run artifacts, see "[Persisting workflow data u A workflow can access and restore a cache created in the current branch, the base branch (including base branches of forked repositories), or the default branch (usually `main`). For example, a cache created on the default branch would be accessible from any pull request. Also, if the branch `feature-b` has the base branch `feature-a`, a workflow triggered on `feature-b` would have access to caches created in the default branch (`main`), `feature-a`, and `feature-b`. -Access restrictions provide cache isolation and security by creating a logical boundary between different branches. For example, a cache created for the branch `feature-a` (with the base `main`) would not be accessible to a pull request for the branch `feature-c` (with the base `main`). +Access restrictions provide cache isolation and security by creating a logical boundary between different branches or tags. For example, a cache created for the branch `feature-a` (with the base `main`) would not be accessible to a pull request for the branch `feature-c` (with the base `main`). On similar lines, a cache created for the tag `release-a` (from the base `main`) would not be accessible to a workflow triggered for the tag `release-b` (with the base `main`). Multiple workflows within a repository share cache entries. A cache created for a branch within a workflow can be accessed and restored from another workflow for the same repository and branch. diff --git a/content/actions/using-workflows/events-that-trigger-workflows.md b/content/actions/using-workflows/events-that-trigger-workflows.md index b46d076984..bacda6f228 100644 --- a/content/actions/using-workflows/events-that-trigger-workflows.md +++ b/content/actions/using-workflows/events-that-trigger-workflows.md @@ -812,6 +812,8 @@ Runs your workflow when activity on a pull request in the workflow's repository This event runs in the context of the base of the pull request, rather than in the context of the merge commit, as the `pull_request` event does. This prevents execution of unsafe code from the head of the pull request that could alter your repository or steal any secrets you use in your workflow. This event allows your workflow to do things like label or comment on pull requests from forks. Avoid using this event if you need to build or run code from the pull request. +To ensure repository security, branches with names that match certain patterns (such as those which look similar to SHAs) may not trigger workflows with the `pull_request_target` event. + {% warning %} **Warning:** For workflows that are triggered by the `pull_request_target` event, the `GITHUB_TOKEN` is granted read/write repository permission unless the `permissions` key is specified and the workflow can access secrets, even when it is triggered from a fork. Although the workflow runs in the context of the base of the pull request, you should make sure that you do not check out, build, or run untrusted code from the pull request with this event. Additionally, any caches share the same scope as the base branch. To help prevent cache poisoning, you should not save the cache if there is a possibility that the cache contents were altered. For more information, see "[Keeping your GitHub Actions and workflows secure: Preventing pwn requests](https://securitylab.github.com/research/github-actions-preventing-pwn-requests)" on the GitHub Security Lab website. diff --git a/content/actions/using-workflows/reusing-workflows.md b/content/actions/using-workflows/reusing-workflows.md index 54c07393ae..bbdf28e7fe 100644 --- a/content/actions/using-workflows/reusing-workflows.md +++ b/content/actions/using-workflows/reusing-workflows.md @@ -39,7 +39,7 @@ You can view the reused workflows referenced in your {% data variables.product.p ### Reusable workflows and starter workflows -Starter workflows allow everyone in your organization who has permission to create workflows to do so more quickly and easily. When people create a new workflow, they can choose a starter workflow and some or all of the work of writing the workflow will be done for them. Within a starter workflow, you can also reference reusable workflows to make it easy for people to benefit from reusing centrally managed workflow code. If you use a tag or branch name when referencing the reusable workflow, you can ensure that everyone who reuses that workflow will always be using the same YAML code. However, if you reference a reusable workflow by a tag or branch, be sure that you can trust that version of the workflow. For more information, see "[Security hardening for {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions#reusing-third-party-workflows)." +Starter workflows allow everyone in your organization who has permission to create workflows to do so more quickly and easily. When people create a new workflow, they can choose a starter workflow and some or all of the work of writing the workflow will be done for them. Within a starter workflow, you can also reference reusable workflows to make it easy for people to benefit from reusing centrally managed workflow code. If you use a commit SHA when referencing the reusable workflow, you can ensure that everyone who reuses that workflow will always be using the same YAML code. However, if you reference a reusable workflow by a tag or branch, be sure that you can trust that version of the workflow. For more information, see "[Security hardening for {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions#reusing-third-party-workflows)." For more information, see "[Creating starter workflows for your organization](/actions/learn-github-actions/creating-starter-workflows-for-your-organization)." @@ -69,10 +69,14 @@ Called workflows that are owned by the same user or organization{% ifversion ghe ## Limitations +{% ifversion nested-reusable-workflow %} +* You can connect up to four levels of workflows. For more information, see "[Calling a nested reusable workflow](#calling-a-nested-reusable-workflow)." +{% else %} * Reusable workflows can't call other reusable workflows. +{% endif %} * Reusable workflows stored within a private repository can only be used by workflows within the same repository. -* Any environment variables set in an `env` context defined at the workflow level in the caller workflow are not propagated to the called workflow. For more information about the `env` context, see "[Context and expression syntax for GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions#env-context)." -* The `strategy` property is not supported in any job that calls a reusable workflow. +* Any environment variables set in an `env` context defined at the workflow level in the caller workflow are not propagated to the called workflow. For more information about the `env` context, see "[Context and expression syntax for GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions#env-context)."{% ifversion actions-reusable-workflow-matrix %}{% else %} +* The `strategy` property is not supported in any job that calls a reusable workflow.{% endif %} ## Creating a reusable workflow @@ -105,7 +109,13 @@ You can define inputs and secrets, which can be passed from the caller workflow {% endraw %} For details of the syntax for defining inputs and secrets, see [`on.workflow_call.inputs`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callinputs) and [`on.workflow_call.secrets`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callsecrets). {% ifversion actions-inherit-secrets-reusable-workflows %} -1. In the reusable workflow, reference the input or secret that you defined in the `on` key in the previous step. If the secrets are inherited using `secrets: inherit`, you can reference them even if they are not defined in the `on` key. +1. In the reusable workflow, reference the input or secret that you defined in the `on` key in the previous step. + + {% note %} + + **Note**: If the secrets are inherited by using `secrets: inherit` in the calling workflow, you can reference them even if they are not explicitly defined in the `on` key. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit)." + + {% endnote %} {%- else %} 1. In the reusable workflow, reference the input or secret that you defined in the `on` key in the previous step. {%- endif %} @@ -164,7 +174,36 @@ jobs: token: ${{ secrets.token }} ``` {% endraw %} +{% ifversion actions-reusable-workflow-matrix %} +## Using a matrix strategy with a reusable workflow +Jobs using the matrix strategy can call a reusable workflow. + +A matrix strategy lets you use variables in a single job definition to automatically create multiple job runs that are based on the combinations of the variables. For example, you can use a matrix strategy to pass different inputs to a reusable workflow. For more information about matrices, see "[Using a matrix for your jobs](/actions/using-jobs/using-a-matrix-for-your-jobs)." + +### Example matrix strategy with a reusable workflow + +This workflow file references the matrix context by defining the variable `target` with the values `[dev, stage, prod]`. The workflow will run three jobs, one for each value in the variable. The workflow file also calls a reusable workflow by using the `uses` keyword. + +{% raw %} +```yaml{:copy} +name: Reusable workflow with matrix strategy + +on: + push: + +jobs: + ReuseableMatrixJobForDeployment: + strategy: + matrix: + target: [dev, stage, prod] + uses: octocat/octo-repo/.github/workflows/deployment.yml@main + with: + target: ${{ matrix.target }} +``` +{% endraw %} + +{% endif %} ## Calling a reusable workflow You call a reusable workflow by using the `uses` keyword. Unlike when you are using actions within a workflow, you call reusable workflows directly within a job, and not from within job steps. @@ -234,9 +273,62 @@ jobs: ``` {% endraw %} +{% ifversion nested-reusable-workflow %} +## Nesting reusable workflows + +You can connect a maximum of four levels of workflows - that is, the top-level caller workflow and up to three levels of reusable workflows. For example: _caller-workflow.yml_ → _called-workflow-1.yml_ → _called-workflow-2.yml_ → _called-workflow-3.yml_. Loops in the workflow tree are not permitted. + +From within a reusable workflow you can call another reusable workflow. + +{% raw %} +```yaml{:copy} +name: Reusable workflow + +on: + workflow_call: + +jobs: + call-another-reusable: + uses: octo-org/example-repo/.github/workflows/another-reusable.yml@v1 +``` +{% endraw %} + +### Passing secrets to nested workflows + +You can use `jobs..secrets` in a calling workflow to pass named secrets to a directly called workflow. Alternatively, you can use `jobs..secrets.inherit` to pass all of the calling workflow's secrets to a directly called workflow. For more information, see the section "[Passing inputs and secrets to a reusable workflow](/actions/using-workflows/reusing-workflows#passing-inputs-and-secrets-to-a-reusable-workflow)" above, and the reference article "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit)." Secrets are only passed to directly called workflow, so in the workflow chain A > B > C, workflow C will only receive secrets from A if they have been passed from A to B, and then from B to C. + +In the following example, workflow A passes all of its secrets to workflow B, by using the `inherit` keyword, but workflow B only passes one secret to workflow C. Any of the other secrets passed to workflow B are not available to workflow C. + +{% raw %} +```yaml +jobs: + workflowA-calls-workflowB: + uses: octo-org/example-repo/.github/workflows/B.yml@main + secrets: inherit # pass all secrets +``` + +```yaml +jobs: + workflowB-calls-workflowC: + uses: different-org/example-repo/.github/workflows/C.yml@main + secrets: + envPAT: ${{ secrets.envPAT }} # pass just this secret +``` +{% endraw %} + +### Access and permissions + +A workflow that contains nested reusable workflows will fail if any of the nested workflows is inaccessible to the initial caller workflow. For more information, see "[Access to reusable workflows](/actions/using-workflows/reusing-workflows#access-to-reusable-workflows)." + +`GITHUB_TOKEN` permissions can only be the same or more restrictive in nested workflows. For example, in the workflow chain A > B > C, if workflow A has `package: read` token permission, then B and C cannot have `package: write` permission. For more information, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." +{% endif %} + ## Using outputs from a reusable workflow -A reusable workflow may generate data that you want to use in the caller workflow. To use these outputs, you must specify them as the outputs of the reusable workflow. +A reusable workflow may generate data that you want to use in the caller workflow. To use these outputs, you must specify them as the outputs of the reusable workflow.{% ifversion actions-reusable-workflow-matrix %} + +If a reusable workflow that sets an output is executed with a matrix strategy, the output will be the output set by the last successful completing reusable workflow of the matrix which actually sets a value. +That means if the last successful completing reusable workflow sets an empty string for its output, and the second last successful completing reusable workflow sets an actual value for its output, the output will contain the value of the second last completing reusable workflow.{% endif %} The following reusable workflow has a single job containing two steps. In each of these steps we set a single word as the output: "hello" and "world." In the `outputs` section of the job, we map these step outputs to job outputs called: `output1` and `output2`. In the `on.workflow_call.outputs` section we then define two outputs for the workflow itself, one called `firstword` which we map to `output1`, and one called `secondword` which we map to `output2`. diff --git a/content/actions/using-workflows/workflow-syntax-for-github-actions.md b/content/actions/using-workflows/workflow-syntax-for-github-actions.md index 2607f856d8..f8ba221850 100644 --- a/content/actions/using-workflows/workflow-syntax-for-github-actions.md +++ b/content/actions/using-workflows/workflow-syntax-for-github-actions.md @@ -365,9 +365,9 @@ A name for your step to display on {% data variables.product.prodname_dotcom %}. Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a [published Docker container image](https://hub.docker.com/). -We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag number. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update. +We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update. - Using the commit SHA of a released action version is the safest for stability and security. -- Using the specific major action version allows you to receive critical fixes and security patches while still maintaining compatibility. It also assures that your workflow should still work. +- If the action publishes major version tags, you should expect to receive critical fixes and security patches while still retaining compatibility. Note that this behavior is at the discretion of the action's author. - Using the default branch of an action may be convenient, but if someone releases a new major version with a breaking change, your workflow could break. Some actions require inputs that you must set using the [`with`](#jobsjob_idstepswith) keyword. Review the action's README file to determine the inputs required. @@ -1037,15 +1037,23 @@ You can use special characters in path, branch, and tag filters. - `[]` Matches one character listed in the brackets or included in ranges. Ranges can only include `a-z`, `A-Z`, and `0-9`. For example, the range`[0-9a-z]` matches any digit or lowercase letter. For example, `[CB]at` matches `Cat` or `Bat` and `[1-2]00` matches `100` and `200`. - `!`: At the start of a pattern makes it negate previous positive patterns. It has no special meaning if not the first character. -The characters `*`, `[`, and `!` are special characters in YAML. If you start a pattern with `*`, `[`, or `!`, you must enclose the pattern in quotes. +The characters `*`, `[`, and `!` are special characters in YAML. If you start a pattern with `*`, `[`, or `!`, you must enclose the pattern in quotes. Also, if you use a [flow sequence](https://yaml.org/spec/1.2.2/#flow-sequences) with a pattern containing `[` and/or `]`, the pattern must be enclosed in quotes. ```yaml # Valid -- '**/README.md' +branches: + - '**/README.md' # Invalid - creates a parse error that # prevents your workflow from running. -- **/README.md +branches: + - **/README.md + +# Valid +branches: [ main, 'release/v[0-9].[0-9]' ] + +# Invalid - creates a parse error +branches: [ main, release/v[0-9].[0-9] ] ``` For more information about branch, tag, and path filter syntax, see "[`on..`](#onpushbranchestagsbranches-ignoretags-ignore)", "[`on..`](#onpull_requestpull_request_targetbranchesbranches-ignore)", and "[`on..paths`](#onpushpull_requestpull_request_targetpathspaths-ignore)." diff --git a/content/admin/configuration/configuring-github-connect/about-github-connect.md b/content/admin/configuration/configuring-github-connect/about-github-connect.md index 801d3c5066..4b900f7f44 100644 --- a/content/admin/configuration/configuring-github-connect/about-github-connect.md +++ b/content/admin/configuration/configuring-github-connect/about-github-connect.md @@ -8,6 +8,7 @@ type: overview topics: - Enterprise - GitHub Connect +miniTocMaxHeadingLevel: 3 --- ## About {% data variables.product.prodname_github_connect %} @@ -37,6 +38,16 @@ Unified contributions | Allow users to include anonymized contribution counts fo ## Data transmission for {% data variables.product.prodname_github_connect %} +When {% data variables.product.prodname_github_connect %} is enabled, a record on {% data variables.product.prodname_ghe_cloud %} stores information about the connection. If you enable individual features of {% data variables.product.prodname_github_connect %}, additional data is transmitted. + +{% note %} + +**Note:** No repositories, issues, or pull requests are ever transmitted from {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} by {% data variables.product.prodname_github_connect %}. + +{% endnote %} + +### Data transmitted when {% data variables.product.prodname_github_connect %} is enabled + When you enable {% data variables.product.prodname_github_connect %} or specific {% data variables.product.prodname_github_connect %} features, a record on {% data variables.product.prodname_ghe_cloud %} stores the following information about the connection. {% ifversion ghes %} - The public key portion of your {% data variables.product.prodname_ghe_server %} license @@ -54,11 +65,7 @@ When you enable {% data variables.product.prodname_github_connect %} or specific {% data variables.product.prodname_github_connect %} syncs the above connection data between {% data variables.product.product_location %} and {% data variables.product.prodname_ghe_cloud %} weekly, from the day and approximate time that {% data variables.product.prodname_github_connect %} was enabled. -{% note %} - -**Note:** No repositories, issues, or pull requests are ever transmitted from {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} by {% data variables.product.prodname_github_connect %}. - -{% endnote %} +### Data transmitted by individual features of {% data variables.product.prodname_github_connect %} Additional data is transmitted if you enable individual features of {% data variables.product.prodname_github_connect %}. @@ -68,7 +75,7 @@ Automatic user license sync | Each {% data variables.product.product_name %} use {% data variables.product.prodname_dependabot_alerts %} | Vulnerability alerts | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %} | {% data variables.product.product_name %} |{% endif %}{% ifversion dependabot-updates-github-connect %} {% data variables.product.prodname_dependabot_updates %} | Dependencies and the metadata for each dependency's repository

    If a dependency is stored in a private repository on {% data variables.product.prodname_dotcom_the_website %}, data will only be transmitted if {% data variables.product.prodname_dependabot %} is configured and authorized to access that repository. | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %} | {% data variables.product.product_name %} {% endif %} {% data variables.product.prodname_dotcom_the_website %} actions | Name of action, action (YAML file from {% data variables.product.prodname_marketplace %}) | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %}

    From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %}{% ifversion server-statistics %} -{% data variables.product.prodname_server_statistics %} | Aggregate {% data variables.product.prodname_ghe_server %} usage metrics
    For the list of aggregate metrics collected, see "[{% data variables.product.prodname_server_statistics %} data collected](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)." | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %}{% endif %} +{% data variables.product.prodname_server_statistics %} | Aggregate metrics about your usage of {% data variables.product.prodname_ghe_server %}. For the complete list of metrics, see "[About {% data variables.product.prodname_server_statistics %}](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)." | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %}{% endif %} Unified search | Search terms, search results | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %}

    From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %} | Unified contributions | Contribution counts | From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.prodname_dotcom_the_website %} | diff --git a/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md b/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md index 1652755f7b..5fa9384fb2 100644 --- a/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md +++ b/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md @@ -672,7 +672,7 @@ You can add the optional `--prune` argument to remove unreachable Git objects th {% warning %} -**Warning**: Before using the `--prune` argument to remove unreachable Git objects, put {% data variables.product.product_location %} into maintenance mode, or ensure the repository is offline. For more information, see "[Enabling and scheduling maintenance mode](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." +**Warning**: Before using the `--prune` argument to remove unreachable Git objects, put {% data variables.product.product_location %} into maintenance mode, or ensure all repositories within the same repository network are locked. For more information, see "[Enabling and scheduling maintenance mode](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." {% endwarning %} diff --git a/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md b/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md index 8b031cfece..bfdd817cca 100644 --- a/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md +++ b/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md @@ -30,12 +30,15 @@ For instance-level restrictions using Azure NSGs, contact {% data variables.cont ## Adding an allowed IP address +{% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} {% data reusables.identity-and-permissions.ip-allow-lists-add-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-add-description %} {% data reusables.identity-and-permissions.ip-allow-lists-add-entry %} +{% data reusables.identity-and-permissions.check-ip-address %} ## Allowing access by {% data variables.product.prodname_github_apps %} @@ -43,6 +46,8 @@ For instance-level restrictions using Azure NSGs, contact {% data variables.cont ## Enabling allowed IP addresses +{% data reusables.identity-and-permissions.about-enabling-allowed-ip-addresses %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} @@ -52,6 +57,8 @@ For instance-level restrictions using Azure NSGs, contact {% data variables.cont ## Editing an allowed IP address +{% data reusables.identity-and-permissions.about-editing-ip-allow-list-entries %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} @@ -59,6 +66,18 @@ For instance-level restrictions using Azure NSGs, contact {% data variables.cont {% data reusables.identity-and-permissions.ip-allow-lists-edit-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-description %} 8. Click **Update**. +{% data reusables.identity-and-permissions.check-ip-address %} + +{% ifversion ip-allow-list-address-check %} +## Checking if an IP address is permitted + +{% data reusables.identity-and-permissions.about-checking-ip-address %} + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.security-tab %} +{% data reusables.identity-and-permissions.check-ip-address-step %} +{% endif %} ## Deleting an allowed IP address diff --git a/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md b/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md index ccf5272e1b..c210522595 100644 --- a/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md +++ b/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md @@ -19,7 +19,7 @@ shortTitle: Create HA replica ## Creating a high availability replica 1. Set up a new {% data variables.product.prodname_ghe_server %} appliance on your desired platform. The replica appliance should mirror the primary appliance's CPU, RAM, and storage settings. We recommend that you install the replica appliance in an independent environment. The underlying hardware, software, and network components should be isolated from those of the primary appliance. If you are a using a cloud provider, use a separate region or zone. For more information, see ["Setting up a {% data variables.product.prodname_ghe_server %} instance"](/enterprise/admin/guides/installation/setting-up-a-github-enterprise-server-instance). -1. Ensure that both the primary appliance and the new replica appliance can communicate with each other over ports 122/TCP and 1194/UDP. For more information, see "[Network ports](/admin/configuration/configuring-network-settings/network-ports#administrative-ports)." +1. Ensure that the new appliance can communicate with all other appliances in this high availability environment over ports 122/TCP and 1194/UDP. For more information, see "[Network ports](/admin/configuration/configuring-network-settings/network-ports#administrative-ports)." 1. In a browser, navigate to the new replica appliance's IP address and upload your {% data variables.product.prodname_enterprise %} license. {% data reusables.enterprise_installation.replica-steps %} 1. Connect to the replica appliance's IP address using SSH. diff --git a/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md b/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md index a7b4759223..0ad52e007b 100644 --- a/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md +++ b/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md @@ -82,7 +82,11 @@ These restrictions are unacceptable for some enterprises. To determine whether { ### Do your developers rely on collaboration outside of your enterprise? -{% data variables.product.prodname_managed_users_caps %} can only contribute to repositories within your enterprise. If your developers need to collaborate in repositories outside your enterprise, even private repositories, to complete their work, {% data variables.product.prodname_emus %} may not be right for your enterprise, and SAML SSO may be a better solution. +{% data variables.product.prodname_managed_users_caps %} can only contribute to repositories within your enterprise. If your developers must contribute to both repositories within and outside of your enterprise, including private repositories, {% data variables.product.prodname_emus %} may not be right for your enterprise. SAML SSO may be a better solution. + +Some companies maintain repositories within an existing enterprise using SAML SSO on {% data variables.product.product_location %}, and also create an {% data variables.product.prodname_emu_enterprise %}. Developers who contribute to repositories owned by both enterprises from a single workstation must switch between the accounts on {% data variables.product.product_location %} within a single browser, or use a different browser for each account. The developer may also need to customize the workstation's Git configuration to accommodate the two accounts. The complexity of this workflow can increase the risk of mistakenly leaking internal code to the public. + +If you decide to create an {% data variables.product.prodname_emu_enterprise %} but require that developers contribute to resources outside of the enterprise from a single workstation, you can provide support for switching between the accounts in a developer's local Git configuration. For more information, see "[About {% data variables.product.prodname_emus %}](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#supporting-developers-with-multiple-user-accounts-on-githubcom)." ### Does your enterprise rely on outside collaborators? diff --git a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md index 86fa66eae0..b6a8459792 100644 --- a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md +++ b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md @@ -36,8 +36,6 @@ You can grant {% data variables.product.prodname_managed_users %} access to and The usernames of your enterprise's {% data variables.product.prodname_managed_users %} and their profile information, such as display names and email addresses, are set by through your IdP and cannot be changed by the users themselves. For more information, see "[Usernames and profile information](#usernames-and-profile-information)." -{% data reusables.enterprise-accounts.emu-forks %} - Enterprise owners can audit all of the {% data variables.product.prodname_managed_users %}' actions on {% data variables.product.prodname_dotcom %}. For more information, see "[Audit log events for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise#about-audit-log-events-for-your-enterprise)." To use {% data variables.product.prodname_emus %}, you need a separate type of enterprise account with {% data variables.product.prodname_emus %} enabled. For more information about creating this account, see "[About enterprises with managed users](#about-enterprises-with-managed-users)." @@ -75,7 +73,8 @@ To use {% data variables.product.prodname_emus %}, you need a separate type of e * {% data variables.product.prodname_managed_users_caps %} cannot create gists or comment on gists. * {% data variables.product.prodname_managed_users_caps %} cannot install {% data variables.product.prodname_github_apps %} on their user accounts. * Other {% data variables.product.prodname_dotcom %} users cannot see, mention, or invite a {% data variables.product.prodname_managed_user %} to collaborate. -* {% data variables.product.prodname_managed_users_caps %} can only own private repositories and {% data variables.product.prodname_managed_users %} can only invite other enterprise members to collaborate on their owned repositories. +* You can choose whether {% data variables.product.prodname_managed_users %} are able to create repositories owned by their user accounts. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-repository-creation)." +* If you allow {% data variables.product.prodname_managed_users %} to create repositories owned by their user accounts, they can only own private repositories and can only invite other enterprise members to collaborate on their user-owned repositories. * {% data reusables.enterprise-accounts.emu-forks %} * Only private and internal repositories can be created in organizations owned by an {% data variables.product.prodname_emu_enterprise %}, depending on organization and enterprise repository visibility settings. * {% data variables.product.prodname_managed_users_caps %} are limited in their use of {% data variables.product.prodname_pages %}. For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages#limitations-for-enterprise-managed-users)." @@ -113,6 +112,8 @@ Before your developers can use {% data variables.product.prodname_ghe_cloud %} w 5. Once authentication and provisioning are configured, you can start provisioning members and managing teams. For more information, see "[Managing team memberships with identity provider groups](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups)." +If members of your enterprise must use one workstation to contribute to repositories on {% data variables.product.product_location %} from both a {% data variables.product.prodname_managed_user %} and a personal account, you can provide support. For more information, see "[Supporting developers with multiple user accounts on {% data variables.product.prodname_dotcom_the_website %}](#supporting-developers-with-multiple-user-accounts-on-githubcom)." + ## Authenticating as a {% data variables.product.prodname_managed_user %} {% data variables.product.prodname_managed_users_caps %} must authenticate through their identity provider. To authenticate, a {% data variables.product.prodname_managed_user %} can visit their IdP application portal or use the login page on {% data variables.product.prodname_dotcom_the_website %}. @@ -135,3 +136,9 @@ Before your developers can use {% data variables.product.prodname_ghe_cloud %} w A conflict may occur when provisioning users if the unique parts of the identifier provided by your IdP are removed during normalization. If you're unable to provision a user due to a username conflict, you should modify the username provided by your IdP. For more information, see "[Resolving username conflicts](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication#resolving-username-conflicts)." The profile name and email address of a {% data variables.product.prodname_managed_user %} is also provided by the IdP. {% data variables.product.prodname_managed_users_caps %} cannot change their profile name or email address on {% data variables.product.prodname_dotcom %}, and the IdP can only provide a single email address. + +## Supporting developers with multiple user accounts on {% data variables.product.product_location %} + +People on your team may need to contribute to resources on {% data variables.product.product_location %} that are outside of your {% data variables.product.prodname_emu_enterprise %}. For example, you may wish to maintain a separate enterprise for your company's open source projects. Because a {% data variables.product.prodname_managed_user %} cannot contribute to public resources, users will need to maintain a separate, personal account for this work. + +People who must contribute from two user accounts on {% data variables.product.product_location %} using one workstation can configure Git to simplify the process. For more information, see "[Managing multiple accounts](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts)." diff --git a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md index 19aae3c4f6..28d9c00c89 100644 --- a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md +++ b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md @@ -22,9 +22,11 @@ CAP support is enabled automatically for any {% data variables.product.prodname_ For more information about using OIDC with {% data variables.product.prodname_emus %}, see "[Configuring OIDC for Enterprise Managed Users](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-oidc-for-enterprise-managed-users)" and "[Migrating from SAML to OIDC](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc)." -## About using CAP with IP allow lists +{% note %} -We recommend disabling your enterprise account's IP allow list and relying on your IdP's CAP. If you enable IP allow lists for your enterprise and also make use of your IdP's CAP, both the IP allow list and CAP will be enforced. If either restriction rejects a user's IP address, the request fails. For more information about IP allow lists, see "[Enforcing policies for security settings in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)." +**Note:** If you use Conditional Access (CA) network location policies in your Azure AD tenant, do not use the IP allow list feature on {% data variables.product.prodname_dotcom_the_website %}, with your enterprise account or with any of the organizations owned by the enterprise. Using both is unsupported and can result in the wrong policy applying. For more information about IP allow lists, see "[Enforcing security settings in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)" and "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization)." + +{% endnote %} ## Considerations for integrations and automations diff --git a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md index f31513ef68..f6e7cb1071 100644 --- a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md +++ b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md @@ -31,6 +31,7 @@ If you're new to {% data variables.product.prodname_emus %} and haven't yet conf {% endnote %} 1. Before you begin the migration, sign in to Azure and disable provisioning in the existing {% data variables.product.prodname_emu_idp_application %} application. +1. If you use [Conditional Access (CA) network location policies](https://docs.microsoft.com/en-us/azure/active-directory/conditional-access/location-condition) in Azure AD, and you're currently using an IP allow list with your enterprise account or any of the organizations owned by the enterprise account on {% data variables.product.prodname_dotcom_the_website %}, disable the IP allow lists. For more information, see "[Enforcing security settings in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)" and "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization)." 1. Sign into {% data variables.product.prodname_dotcom_the_website %} as the setup user for your enterprise with the username **@SHORT-CODE_admin**. 1. When prompted to continue to your identity provider, click **Use a recovery code** and sign in using one of your enterprise's recovery codes. {% data reusables.enterprise-accounts.access-enterprise %} diff --git a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md index 753fcca38a..d17cfa8c89 100644 --- a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md +++ b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md @@ -77,7 +77,7 @@ The following SAML attributes are available for {% data variables.product.produc | Name | Required? | Description | | :- | :- | :- | -| `NameID` | Yes | A persistent user identifier. Any persistent name identifier format may be used. {% ifversion ghec %}If you use an enterprise with {% data variables.product.prodname_emus %}, {% endif %}{% data variables.product.product_name %} will normalize the `NameID` element to use as a username unless one of the alternative assertions is provided. For more information, see "[Username considerations for external authentication](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication)." | +| `NameID` | Yes | A persistent user identifier. Any persistent name identifier format may be used. {% ifversion ghec %}If you use an enterprise with {% data variables.product.prodname_emus %}, {% endif %}{% data variables.product.product_name %} will normalize the `NameID` element to use as a username unless one of the alternative assertions is provided. For more information, see "[Username considerations for external authentication](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication)."

    {% note %}**Note:** It's important to use a human-readable, persistent identifier. Using a transient identifier format like `urn:oasis:names:tc:SAML:2.0:nameid-format:transient` will result in re-linking of accounts on every sign-in, which can be detrimental to authorization management.{% endnote %} | | `SessionNotOnOrAfter` | No | The date that {% data variables.product.product_name %} invalidates the associated session. After invalidation, the person must authenticate once again to access {% ifversion ghec or ghae %}your enterprise's resources{% elsif ghes %}{% data variables.product.product_location %}{% endif %}. For more information, see "[Session duration and timeout](#session-duration-and-timeout)." | {%- ifversion ghes or ghae %} | `administrator` | No | When the value is `true`, {% data variables.product.product_name %} will automatically promote the user to be a {% ifversion ghes %}site administrator{% elsif ghae %}enterprise owner{% endif %}. Setting this attribute to anything but `true` will result in demotion, as long as the value is not blank. Omitting this attribute or leaving the value blank will not change the role of the user. | diff --git a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md index daea61b47a..b34b1c60c3 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md +++ b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md @@ -44,7 +44,8 @@ You set up the audit log stream on {% data variables.product.product_name %} by - [Amazon S3](#setting-up-streaming-to-amazon-s3) - [Azure Blob Storage](#setting-up-streaming-to-azure-blob-storage) -- [Azure Event Hubs](#setting-up-streaming-to-azure-event-hubs) +- [Azure Event Hubs](#setting-up-streaming-to-azure-event-hubs){% ifversion streaming-datadog %} +- [Datadog](#setting-up-streaming-to-datadog){% endif %} - [Google Cloud Storage](#setting-up-streaming-to-google-cloud-storage) - [Splunk](#setting-up-streaming-to-splunk) @@ -60,7 +61,7 @@ You can set up streaming to S3 with access keys or, to avoid storing long-lived #### Setting up streaming to S3 with access keys {% endif %} -To stream audit logs to Amazon's S3 endpoint, you must have a bucket and access keys. For more information, see [Creating, configuring, and working with Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) in the the AWS documentation. Make sure to block public access to the bucket to protect your audit log information. +To stream audit logs to Amazon's S3 endpoint, you must have a bucket and access keys. For more information, see [Creating, configuring, and working with Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) in the AWS documentation. Make sure to block public access to the bucket to protect your audit log information. To set up audit log streaming from {% data variables.product.prodname_dotcom %} you will need: * The name of your Amazon S3 bucket @@ -231,6 +232,32 @@ You need two pieces of information about your event hub: its instance name and t {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +{% ifversion streaming-datadog %} +### Setting up streaming to Datadog + +To set up streaming to Datadog, you must create a client token or an API key in Datadog, then configure audit log streaming in {% data variables.product.product_name %} using the token for authentication. You do not need to create a bucket or other storage container in Datadog. + +After you set up streaming to Datadog, you can see your audit log data by filtering by "github.audit.streaming." For more information, see [Log Management](https://docs.datadoghq.com/logs/). + +1. If you don't already have a Datadog account, create one. +1. In Datadog, generate a client token or an API key, then click **Copy key**. For more information, see [API and Application Keys](https://docs.datadoghq.com/account_management/api-app-keys/) in Datadog Docs. +{% data reusables.enterprise.navigate-to-log-streaming-tab %} +1. Select the **Configure stream** dropdown menu and click **Datadog**. + + ![Screenshot of the "Configure stream" dropdown menu with "Datadog" highlighted](/assets/images/help/enterprises/audit-stream-choice-datadog.png) +1. Under "Token", paste the token you copied earlier. + + ![Screenshot of the "Token" field](/assets/images/help/enterprises/audit-stream-datadog-token.png) +1. Select the "Site" dropdown menu and click your Datadog site. To determine your Datadog site, compare your Datadog URL to the table in [Datadog sites](https://docs.datadoghq.com/getting_started/site/) in Datadog Docs. + + ![Screenshot of the "Site" dropdown menu](/assets/images/help/enterprises/audit-stream-datadog-site.png) +1. To verify that {% data variables.product.prodname_dotcom %} can connect and write to the Datadog endpoint, click **Check endpoint**. + + ![Check the endpoint](/assets/images/help/enterprises/audit-stream-check.png) +{% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +1. After a few minutes, confirm that audit log data is appearing on the **Logs** tab in Datadog. If audit log data is not appearing, confirm that your token and site are correct in {% data variables.product.prodname_dotcom %}. +{% endif %} + ### Setting up streaming to Google Cloud Storage To set up streaming to Google Cloud Storage, you must create a service account in Google Cloud with the appropriate credentials and permissions, then configure audit log streaming in {% data variables.product.product_name %} using the service account's credentials for authentication. @@ -292,6 +319,10 @@ To stream audit logs to Splunk's HTTP Event Collector (HEC) endpoint you must ma Pausing the stream allows you to perform maintenance on the receiving application without losing audit data. Audit logs are stored for up to seven days on {% data variables.product.product_location %} and are then exported when you unpause the stream. +{% ifversion streaming-datadog %} +Datadog only accepts logs from up to 18 hours in the past. If you pause a stream to a Datadog endpoint for more than 18 hours, you risk losing logs that Datadog won't accept after you resume streaming. +{% endif %} + {% data reusables.enterprise.navigate-to-log-streaming-tab %} 1. Click **Pause stream**. diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md index b1ed91a0ce..75b2044c67 100644 --- a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md +++ b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md @@ -79,12 +79,17 @@ You can also configure allowed IP addresses for an individual organization. For ### Adding an allowed IP address +{% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} + +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} {% data reusables.identity-and-permissions.ip-allow-lists-add-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-add-description %} {% data reusables.identity-and-permissions.ip-allow-lists-add-entry %} +{% data reusables.identity-and-permissions.check-ip-address %} ### Allowing access by {% data variables.product.prodname_github_apps %} @@ -92,6 +97,8 @@ You can also configure allowed IP addresses for an individual organization. For ### Enabling allowed IP addresses +{% data reusables.identity-and-permissions.about-enabling-allowed-ip-addresses %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} @@ -101,6 +108,8 @@ You can also configure allowed IP addresses for an individual organization. For ### Editing an allowed IP address +{% data reusables.identity-and-permissions.about-editing-ip-allow-list-entries %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} @@ -108,6 +117,18 @@ You can also configure allowed IP addresses for an individual organization. For {% data reusables.identity-and-permissions.ip-allow-lists-edit-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-description %} 8. Click **Update**. +{% data reusables.identity-and-permissions.check-ip-address %} + +{% ifversion ip-allow-list-address-check %} +### Checking if an IP address is permitted + +{% data reusables.identity-and-permissions.about-checking-ip-address %} + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.security-tab %} +{% data reusables.identity-and-permissions.check-ip-address-step %} +{% endif %} ### Deleting an allowed IP address diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md index 2231f44590..5382563665 100644 --- a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md +++ b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md @@ -72,24 +72,29 @@ If an enterprise owner disallows members from creating certain types of reposito {% endif %} -## Enforcing a policy for {% ifversion ghec or ghes or ghae %}base{% else %}default{% endif %} repository permissions +## Enforcing a policy for base repository permissions -Across all organizations owned by your enterprise, you can set a {% ifversion ghec or ghes or ghae %}base{% else %}default{% endif %} repository permission level (none, read, write, or admin) for organization members, or allow owners to administer the setting on the organization level. +Across all organizations owned by your enterprise, you can set a base repository permission level (none, read, write, or admin) for organization members, or allow owners to administer the setting on the organization level. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} -4. Under "{% ifversion ghec or ghes or ghae %}Base{% else %}Default{% endif %} permissions", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -5. Under "{% ifversion ghec or ghes or ghae %}Base{% else %}Default{% endif %} permissions", use the drop-down menu and choose a policy. - {% ifversion ghec or ghes or ghae %} +4. Under "Base permissions", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +5. Under "Base permissions", use the drop-down menu and choose a policy. ![Drop-down menu with repository permissions policy options](/assets/images/help/business-accounts/repository-permissions-policy-drop-down.png) - {% else %} - ![Drop-down menu with repository permissions policy options](/assets/images/enterprise/business-accounts/repository-permissions-policy-drop-down.png) - {% endif %} + ## Enforcing a policy for repository creation -Across all organizations owned by your enterprise, you can allow members to create repositories, restrict repository creation to organization owners, or allow owners to administer the setting on the organization level. If you allow members to create repositories, you can choose whether members can create any combination of public, private, and internal repositories. {% data reusables.repositories.internal-repo-default %} For more information about internal repositories, see "[Creating an internal repository](/articles/creating-an-internal-repository)." +Across all organizations owned by your enterprise, you can allow members to create repositories, restrict repository creation to organization owners, or allow owners to administer the setting on the organization level. + +If you allow members to create repositories in your organizations, you can choose which types of repositories (public, private, and internal) that members can create. + +{% ifversion enterprise-namespace-repo-setting %} +{% ifversion ghec %}If your enterprise uses {% data variables.product.prodname_emus %}, you{% else %}You{% endif %} can also prevent users from creating repositories owned by their user accounts. +{% endif %} + +{% data reusables.repositories.internal-repo-default %} For more information about internal repositories, see "[Creating an internal repository](/articles/creating-an-internal-repository)." {% data reusables.organizations.repo-creation-constants %} @@ -97,33 +102,33 @@ Across all organizations owned by your enterprise, you can allow members to crea {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} 5. Under "Repository creation", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -{% ifversion ghes or ghae or ghec %} {% data reusables.enterprise-accounts.repo-creation-policy %} -{% data reusables.enterprise-accounts.repo-creation-types %} -{% else %} -6. Under "Repository creation", use the drop-down menu and choose a policy. - - ![Drop-down menu with repository creation policies](/assets/images/enterprise/site-admin-settings/repository-creation-drop-down.png) -{% endif %} +{% data reusables.enterprise-accounts.repo-creation-types %}{% ifversion enterprise-namespace-repo-setting %} +1. Optionally, {% ifversion ghec %}if your enterprise uses {% data variables.product.prodname_emus %} and you want {% endif %}to prevent enterprise members from creating repositories owned by their user accounts, select **Block the creation of user namespace repositories**. + ![Screenshot showing the list of disabled options from forking policy](/assets/images/help/business-accounts/restrict-personal-namespace-enabled-setting.png){% endif %} ## Enforcing a policy for forking private or internal repositories Across all organizations owned by your enterprise, you can allow people with access to a private or internal repository to fork the repository, never allow forking of private or internal repositories, or allow owners to administer the setting on the organization level. +{% ifversion enterprise-namespace-repo-setting %} +{% note %} + +**Note:** If {% ifversion ghec %}your enterprise uses {% data variables.product.prodname_emus %} and {% endif %}your "Repository creation" policy prevents enterprise members from creating repositories owned by their user accounts, members will not be allowed to fork a repository in their user accounts, regardless of your "Repository forking" policy. + +{% endnote %} +{% endif %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} 3. Under "Repository forking", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} 4. Under "Repository forking", use the drop-down menu and choose a policy. - ![Drop-down menu with repository forking policy options](/assets/images/help/business-accounts/repository-forking-policy-drop-down.png) - -{% ifversion innersource-fork-policies %} + ![Drop-down menu with repository forking policy options](/assets/images/help/business-accounts/repository-forking-policy-drop-down.png){% ifversion innersource-fork-policies %} 5. If forking is enabled, you can specify where users are allowed to fork repositories. Review the information about changing the setting and choose a policy. - ![Screenshot showing the list of repository forking policy options](/assets/images/help/business-accounts/repository-forking-policy-settings.png) -{% endif %} - + ![Screenshot showing the list of repository forking policy options](/assets/images/help/business-accounts/repository-forking-policy-settings.png){% endif %} ## Enforcing a policy for inviting{% ifversion ghec %} outside{% endif %} collaborators to repositories @@ -140,8 +145,6 @@ Across all organizations owned by your enterprise, you can allow members to invi {% elsif ghes or ghae %} ![Drop-down menu with invitation policy options](/assets/images/enterprise/business-accounts/repository-invitation-policy-drop-down.png) {% endif %} - -{% ifversion ghec or ghes or ghae %} ## Enforcing a policy for the default branch name @@ -156,8 +159,6 @@ Across all organizations owned by your enterprise, you can set the default branc 5. Click **Update**. ![Update button](/assets/images/help/business-accounts/default-branch-name-update.png) -{% endif %} - ## Enforcing a policy for changes to repository visibility Across all organizations owned by your enterprise, you can allow members with admin access to change a repository's visibility, restrict repository visibility changes to organization owners, or allow owners to administer the setting on the organization level. When you prevent members from changing repository visibility, only enterprise owners can change the visibility of a repository. @@ -167,9 +168,9 @@ If an enterprise owner has restricted repository creation to organization owners {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} -5. Under "Repository visibility change", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} - -{% data reusables.enterprise-accounts.repository-visibility-policy %} +1. Under "Repository visibility change", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +1. Under "Repository visibility change", use the drop-down menu and choose a policy. + ![Drop-down menu with repository visibility policy options](/assets/images/help/business-accounts/repository-visibility-policy-drop-down.png) ## Enforcing a policy for repository deletion and transfer diff --git a/content/authentication/connecting-to-github-with-ssh/about-ssh.md b/content/authentication/connecting-to-github-with-ssh/about-ssh.md index a411922d2f..53b7c7225e 100644 --- a/content/authentication/connecting-to-github-with-ssh/about-ssh.md +++ b/content/authentication/connecting-to-github-with-ssh/about-ssh.md @@ -1,6 +1,6 @@ --- title: About SSH -intro: 'Using the SSH protocol, you can connect and authenticate to remote servers and services. With SSH keys, you can connect to {% data variables.product.product_name %} without supplying your username and personal access token at each visit.' +intro: 'Using the SSH protocol, you can connect and authenticate to remote servers and services. With SSH keys, you can connect to {% data variables.product.product_name %} without supplying your username and personal access token at each visit.{% ifversion ssh-commit-verification %} You can also use an SSH key to sign commits.{% endif %}' redirect_from: - /articles/about-ssh - /github/authenticating-to-github/about-ssh @@ -16,7 +16,7 @@ topics: {% data reusables.ssh.about-ssh %} For more information about SSH, see [Secure Shell](https://en.wikipedia.org/wiki/Secure_Shell) on Wikipedia. -When you set up SSH, you will need to generate a new private SSH key and add it to the SSH agent. You must also add the public SSH key to your account on {% data variables.product.product_name %} before you use the key to authenticate. For more information, see "[Generating a new SSH key and adding it to the ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)" and "[Adding a new SSH key to your {% data variables.product.prodname_dotcom %} account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)." +When you set up SSH, you will need to generate a new private SSH key and add it to the SSH agent. You must also add the public SSH key to your account on {% data variables.product.product_name %} before you use the key to authenticate{% ifversion ssh-commit-verification %} or sign commits{% endif %}. For more information, see "[Generating a new SSH key and adding it to the ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)"{% ifversion ssh-commit-verification %}, {% else %} and{% endif %} "[Adding a new SSH key to your {% data variables.product.prodname_dotcom %} account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account){% ifversion ssh-commit-verification %}" and "[About commit signature verification](/articles/about-commit-signature-verification){% endif %}." You can further secure your SSH key by using a hardware security key, which requires the physical hardware security key to be attached to your computer when the key pair is used to authenticate with SSH. You can also secure your SSH key by adding your key to the ssh-agent and using a passphrase. For more information, see "[Working with SSH key passphrases](/github/authenticating-to-github/working-with-ssh-key-passphrases)." @@ -33,7 +33,6 @@ Organizations that use {% data variables.product.prodname_ghe_cloud %} can provi {% else ghec or ghes or ghae %} If you're a member of an organization that provides SSH certificates, you can use your certificate to access that organization's repositories without adding the certificate to your account on {% data variables.product.product_name %}. You cannot use your certificate to access forks of the organization's repositories, if the forks is owned by your personal account. For more information, see "[About SSH certificate authorities](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities)." {% endif %} - ## Further reading - "[Troubleshooting SSH](/articles/troubleshooting-ssh)" diff --git a/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md b/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md index 0d0d83bc2c..a4569d589d 100644 --- a/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md +++ b/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md @@ -19,6 +19,8 @@ shortTitle: Add a new SSH key {% data reusables.ssh.about-ssh %} For more information, see "[About SSH](/authentication/connecting-to-github-with-ssh/about-ssh)." +{% ifversion ssh-commit-verification %}You can also use SSH to sign commits and tags. For more information about commit signing, see "[About commit signature verification](/articles/about-commit-signature-verification)."{% endif %} + After you generate an SSH key pair, you must add the public key to {% ifversion fpt or ghec or ghes %}{% data variables.product.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %} to enable SSH access for your account. ## Prerequisites @@ -30,120 +32,46 @@ Before adding a new SSH key to your account on {% ifversion ghae %}{% data varia ## Adding a new SSH key to your account -After adding a new SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you can reconfigure any local repositories to use SSH. For more information, see "[Switching remote URLs from HTTPS to SSH](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-https-to-ssh)." +After adding a new SSH authentication key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you can reconfigure any local repositories to use SSH. For more information, see "[Switching remote URLs from HTTPS to SSH](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-https-to-ssh)." {% data reusables.ssh.key-type-support %} -{% mac %} - {% webui %} -1. Copy the SSH public key to your clipboard. - - If your SSH public key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace. - - ```shell - $ pbcopy < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub - # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard - ``` - - {% tip %} - - **Tip:** If `pbcopy` isn't working, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. - - {% endtip %} - +{% data reusables.gpg.copy-ssh-public-key %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.ssh %} 4. Click **New SSH key** or **Add SSH key**. +{% ifversion ssh-commit-verification %} + ![SSH Key button](/assets/images/help/settings/ssh-add-ssh-key-with-auth.png) +{% else %} ![SSH Key button](/assets/images/help/settings/ssh-add-ssh-key.png) -5. In the "Title" field, add a descriptive label for the new key. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air". -6. Paste your key into the "Key" field. +{% endif %} +5. In the "Title" field, add a descriptive label for the new key. For example, if you're using a personal laptop, you might call this key "Personal laptop". +{% ifversion ssh-commit-verification %} +6. Select the type of key, either authentication or signing. For more information about commit signing, see "[About commit signature verification](/articles/about-commit-signature-verification)." +{% endif %} +7. Paste your key into the "Key" field. +{% ifversion ssh-commit-verification %} + ![The key field](/assets/images/help/settings/ssh-key-paste-with-type.png) +{% else %} ![The key field](/assets/images/help/settings/ssh-key-paste.png) -7. Click **Add SSH key**. +{% endif %} +8. Click **Add SSH key**. ![The Add key button](/assets/images/help/settings/ssh-add-key.png) {% data reusables.user-settings.sudo-mode-popup %} {% endwebui %} -{% endmac %} - -{% windows %} - -{% webui %} - -1. Copy the SSH public key to your clipboard. - - If your SSH public key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace. - - ```shell - $ clip < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub - # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard - ``` - - {% tip %} - - **Tip:** If `clip` isn't working, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. - - {% endtip %} - -{% data reusables.user-settings.access_settings %} -{% data reusables.user-settings.ssh %} -4. Click **New SSH key** or **Add SSH key**. - ![SSH Key button](/assets/images/help/settings/ssh-add-ssh-key.png) -5. In the "Title" field, add a descriptive label for the new key. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air". -6. Paste your key into the "Key" field. - ![The key field](/assets/images/help/settings/ssh-key-paste.png) -7. Click **Add SSH key**. - ![The Add key button](/assets/images/help/settings/ssh-add-key.png) -{% data reusables.user-settings.sudo-mode-popup %} - -{% endwebui %} - -{% endwindows %} - -{% linux %} - -{% webui %} - -1. Copy the SSH public key to your clipboard. - - If your SSH public key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace. - - ```shell - $ cat ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub - # Then select and copy the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file - # displayed in the terminal to your clipboard - ``` - - {% tip %} - - **Tip:** Alternatively, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. - - {% endtip %} - -{% data reusables.user-settings.access_settings %} -{% data reusables.user-settings.ssh %} -4. Click **New SSH key** or **Add SSH key**. - ![SSH Key button](/assets/images/help/settings/ssh-add-ssh-key.png) -5. In the "Title" field, add a descriptive label for the new key. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air". -6. Paste your key into the "Key" field. - ![The key field](/assets/images/help/settings/ssh-key-paste.png) -7. Click **Add SSH key**. - ![The Add key button](/assets/images/help/settings/ssh-add-key.png) -{% data reusables.user-settings.sudo-mode-popup %} - -{% endwebui %} - -{% endlinux %} - {% cli %} {% data reusables.cli.cli-learn-more %} Before you can use the {% data variables.product.prodname_cli %} to add an SSH key to your account, you must authenticate to the {% data variables.product.prodname_cli %}. For more information, see [`gh auth login`](https://cli.github.com/manual/gh_auth_login) in the {% data variables.product.prodname_cli %} documentation. -To add an SSH key to your GitHub account, use the `ssh-key add` subcommand, specifying your public key. +{% ifversion ssh-commit-verification %}At present, you can only use {% data variables.product.prodname_cli %} to add SSH authentication keys, you cannot add SSH signing keys.{% endif %} + +To add an SSH authentication key to your GitHub account, use the `ssh-key add` subcommand, specifying your public key. ```shell gh ssh-key add key-file diff --git a/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md b/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md index adb05a61f9..b2287d3a5e 100644 --- a/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md +++ b/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md @@ -1,6 +1,6 @@ --- title: About commit signature verification -intro: 'Using GPG or S/MIME, you can sign tags and commits locally. These tags or commits are marked as verified on {% data variables.product.product_name %} so other people can be confident that the changes come from a trusted source.' +intro: 'Using GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME, you can sign tags and commits locally. These tags or commits are marked as verified on {% data variables.product.product_name %} so other people can be confident that the changes come from a trusted source.' redirect_from: - /articles/about-gpg-commit-and-tag-signatures - /articles/about-gpg @@ -19,10 +19,18 @@ shortTitle: Commit signature verification --- ## About commit signature verification -You can sign commits and tags locally, to give other people confidence about the origin of a change you have made. If a commit or tag has a GPG or S/MIME signature that is cryptographically verifiable, GitHub marks the commit or tag {% ifversion fpt or ghec %}"Verified" or "Partially verified."{% else %}"Verified."{% endif %} +You can sign commits and tags locally, to give other people confidence about the origin of a change you have made. If a commit or tag has a GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME signature that is cryptographically verifiable, {% data variables.product.product_name %} marks the commit or tag {% ifversion fpt or ghec %}"Verified" or "Partially verified."{% else %}"Verified."{% endif %} ![Verified commit](/assets/images/help/commits/verified-commit.png) +{% ifversion ghes or ghae %} +If a commit or tag has a signature that can't be verified, {% data variables.product.product_name %} marks the commit or tag "Unverified." +{% endif %} + +{% ifversion ssh-commit-verification %} +For most individual users, GPG or SSH will be the best choice for signing commits. S/MIME signatures are usually required in the context of a larger organization. SSH signatures are the simplest to generate. You can even upload your existing authentication key to {% data variables.product.product_name %} to also use as a signing key. Generating a GPG signing key is more involved than generating an SSH key, but GPG has features that SSH does not. A GPG key can expire or be revoked when no longer used. {% data variables.product.product_name %} shows commits that were signed with such a key as "Verified" unless the key was marked as compromised. SSH keys don't have this capability. +{% endif %} + {% ifversion fpt or ghec %} Commits and tags have the following verification statuses, depending on whether you have enabled vigilant mode. By default vigilant mode is not enabled. For information on how to enable vigilant mode, see "[Displaying verification statuses for all of your commits](/github/authenticating-to-github/displaying-verification-statuses-for-all-of-your-commits)." @@ -47,10 +55,9 @@ For more information, see "[Rebasing and merging your commits](/repositories/con {% data reusables.identity-and-permissions.vigilant-mode-verification-statuses %} -{% else %} -If a commit or tag has a signature that can't be verified, {% data variables.product.product_name %} marks the commit or tag "Unverified." {% endif %} + Repository administrators can enforce required commit signing on a branch to block all commits that are not signed and verified. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-signed-commits)." {% data reusables.identity-and-permissions.verification-status-check %} @@ -59,7 +66,7 @@ Repository administrators can enforce required commit signing on a branch to blo {% ifversion ghes %}If a site administrator has enabled web commit signing, {% data variables.product.product_name %} will automatically use GPG to sign commits you make using the web interface. Commits signed by {% data variables.product.product_name %} will have a verified status. You can verify the signature locally using the public key available at `https://HOSTNAME/web-flow.gpg`. For more information, see "[Configuring web commit signing](/admin/configuration/configuring-your-enterprise/configuring-web-commit-signing)." {% else %}{% data variables.product.prodname_dotcom %} will automatically use GPG to sign commits you make using the web interface. Commits signed by {% data variables.product.prodname_dotcom %} will have a verified status. You can verify the signature locally using the public key available at https://github.com/web-flow.gpg. The full fingerprint of the key is `5DE3 E050 9C47 EA3C F04A 42D3 4AEE 18F8 3AFD EB23`. -You can optionally choose to have {% data variables.product.prodname_dotcom %} sign commits you make in {% data variables.product.prodname_github_codespaces %}. For more information about enabling GPG verification for your codespaces, see "[Managing GPG verification for {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)."{% endif %} +You can optionally choose to have {% data variables.product.prodname_dotcom %} GPG sign commits you make in {% data variables.product.prodname_github_codespaces %}. For more information about enabling GPG verification for your codespaces, see "[Managing GPG verification for {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)."{% endif %} {% endif %} ## GPG commit signature verification @@ -77,6 +84,26 @@ To sign commits using GPG and have those commits verified on {% data variables.p 5. [Sign commits](/articles/signing-commits) 6. [Sign tags](/articles/signing-tags) +{% ifversion ssh-commit-verification %} +## SSH commit signature verification + +You can use SSH to sign commits with an SSH public key that you generate yourself. If you already use an SSH key to authenticate with {% data variables.product.product_name %}, +you can also upload that same key again for use as a signing key. There's no limit on the number of signing keys you can add to your account. + +{% data variables.product.product_name %} uses [ssh_data](https://github.com/github/ssh_data), an open source Ruby library, to confirm that your locally signed commits and tags are cryptographically verifiable against a public key you have added to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. + +{% data reusables.gpg.ssh-git-version %} + +To sign commits using SSH and have those commits verified on {% data variables.product.product_name %}, follow these steps: + +1. [Check for existing SSH keys](/articles/checking-for-existing-ssh-keys) +2. [Generate a new SSH key](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) +3. [Add a SSH signing key to your GitHub account](/articles/adding-a-new-ssh-key-to-your-github-account) +4. [Tell Git about your signing key](/articles/telling-git-about-your-signing-key) +5. [Sign commits](/articles/signing-commits) +6. [Sign tags](/articles/signing-tags) + +{% endif %} ## S/MIME commit signature verification You can use S/MIME to sign commits with an X.509 key issued by your organization. diff --git a/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md b/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md index d85519e441..0094597708 100644 --- a/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md +++ b/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md @@ -18,7 +18,7 @@ redirect_from: When you work locally on your computer, Git allows you to set the author of your changes and the identity of the committer. This, potentially, makes it difficult for other people to be confident that commits and tags you create were actually created by you. To help solve this problem you can sign your commits and tags. For more information, see "[Signing commits](/github/authenticating-to-github/signing-commits)" and "[Signing tags](/github/authenticating-to-github/signing-tags)." {% data variables.product.prodname_dotcom %} marks signed commits and tags with a verification status. -By default commits and tags are marked "Verified" if they are signed with a GPG or S/MIME key that was successfully verified. If a commit or tag has a signature that can't be verified by {% data variables.product.prodname_dotcom %}, we mark the commit or tag "Unverified." In all other cases no verification status is displayed. +By default commits and tags are marked "Verified" if they are signed with a GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME key that was successfully verified. If a commit or tag has a signature that can't be verified by {% data variables.product.prodname_dotcom %}, we mark the commit or tag "Unverified." In all other cases no verification status is displayed. However, you can give other users increased confidence in the identity attributed to your commits and tags by enabling vigilant mode in your {% data variables.product.prodname_dotcom %} settings. With vigilant mode enabled, all of your commits and tags are marked with one of three verification statuses. diff --git a/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md b/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md index e1c8492c46..b7ece38d4e 100644 --- a/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md +++ b/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md @@ -28,11 +28,11 @@ topics: {% data reusables.command_line.open_the_multi_os_terminal %} 3. Generate a GPG key pair. Since there are multiple versions of GPG, you may need to consult the relevant [_man page_](https://en.wikipedia.org/wiki/Man_page) to find the appropriate key generation command. Your key must use RSA. - If you are on version 2.1.17 or greater, paste the text below to generate a GPG key pair. - ```shell + ```shell{:copy} $ gpg --full-generate-key ``` - If you are not on version 2.1.17 or greater, the `gpg --full-generate-key` command doesn't work. Paste the text below and skip to step 6. - ```shell + ```shell{:copy} $ gpg --default-new-key-algo rsa4096 --gen-key ``` 4. At the prompt, specify the kind of key you want, or press `Enter` to accept the default. @@ -51,10 +51,10 @@ topics: {% data reusables.gpg.list-keys-with-note %} {% data reusables.gpg.copy-gpg-key-id %} 10. Paste the text below, substituting in the GPG key ID you'd like to use. In this example, the GPG key ID is `3AA5C34371567BD2`: - ```shell - $ gpg --armor --export 3AA5C34371567BD2 - # Prints the GPG key ID, in ASCII armor format - ``` + ```shell{:copy} + $ gpg --armor --export 3AA5C34371567BD2 + # Prints the GPG key ID, in ASCII armor format + ``` 11. Copy your GPG key, beginning with `-----BEGIN PGP PUBLIC KEY BLOCK-----` and ending with `-----END PGP PUBLIC KEY BLOCK-----`. 12. [Add the GPG key to your GitHub account](/articles/adding-a-gpg-key-to-your-github-account). diff --git a/content/authentication/managing-commit-signature-verification/index.md b/content/authentication/managing-commit-signature-verification/index.md index cda54504d8..ba633a09a0 100644 --- a/content/authentication/managing-commit-signature-verification/index.md +++ b/content/authentication/managing-commit-signature-verification/index.md @@ -1,6 +1,6 @@ --- title: Managing commit signature verification -intro: 'You can sign your work locally using GPG or S/MIME. {% data variables.product.product_name %} will verify these signatures so other people will know that your commits come from a trusted source.{% ifversion fpt %} {% data variables.product.product_name %} will automatically sign commits you make using the {% data variables.product.product_name %} web interface.{% endif %}' +intro: '{% data variables.product.product_name %} will verify GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME signatures so other people will know that your commits come from a trusted source.{% ifversion fpt %} {% data variables.product.product_name %} will automatically sign commits you make using the {% data variables.product.product_name %} web interface.{% endif %}' redirect_from: - /articles/generating-a-gpg-key - /articles/signing-commits-with-gpg diff --git a/content/authentication/managing-commit-signature-verification/signing-commits.md b/content/authentication/managing-commit-signature-verification/signing-commits.md index 6363f778c0..cf7d059042 100644 --- a/content/authentication/managing-commit-signature-verification/signing-commits.md +++ b/content/authentication/managing-commit-signature-verification/signing-commits.md @@ -1,6 +1,6 @@ --- title: Signing commits -intro: You can sign commits locally using GPG or S/MIME. +intro: You can sign commits locally using GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME. redirect_from: - /articles/signing-commits-and-tags-using-gpg - /articles/signing-commits-using-gpg @@ -52,9 +52,5 @@ If you have multiple keys or are attempting to sign commits or tags with a key t ## Further reading -* "[Checking for existing GPG keys](/articles/checking-for-existing-gpg-keys)" -* "[Generating a new GPG key](/articles/generating-a-new-gpg-key)" -* "[Adding a GPG key to your GitHub account](/articles/adding-a-gpg-key-to-your-github-account)" * "[Telling Git about your signing key](/articles/telling-git-about-your-signing-key)" -* "[Associating an email with your GPG key](/articles/associating-an-email-with-your-gpg-key)" * "[Signing tags](/articles/signing-tags)" diff --git a/content/authentication/managing-commit-signature-verification/signing-tags.md b/content/authentication/managing-commit-signature-verification/signing-tags.md index 1809bef4ad..fac18fab40 100644 --- a/content/authentication/managing-commit-signature-verification/signing-tags.md +++ b/content/authentication/managing-commit-signature-verification/signing-tags.md @@ -1,6 +1,6 @@ --- title: Signing tags -intro: You can sign tags locally using GPG or S/MIME. +intro: You can sign tags locally using GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME. redirect_from: - /articles/signing-tags-using-gpg - /articles/signing-tags @@ -31,9 +31,6 @@ topics: ## Further reading - "[Viewing your repository's tags](/articles/viewing-your-repositorys-tags)" -- "[Checking for existing GPG keys](/articles/checking-for-existing-gpg-keys)" -- "[Generating a new GPG key](/articles/generating-a-new-gpg-key)" -- "[Adding a GPG key to your GitHub account](/articles/adding-a-gpg-key-to-your-github-account)" - "[Telling Git about your signing key](/articles/telling-git-about-your-signing-key)" - "[Associating an email with your GPG key](/articles/associating-an-email-with-your-gpg-key)" - "[Signing commits](/articles/signing-commits)" diff --git a/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md b/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md index b86b173566..9bb8eff1b1 100644 --- a/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md +++ b/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md @@ -1,6 +1,6 @@ --- title: Telling Git about your signing key -intro: 'To sign commits locally, you need to inform Git that there''s a GPG or X.509 key you''d like to use.' +intro: 'To sign commits locally, you need to inform Git that there''s a GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or X.509 key you''d like to use.' redirect_from: - /articles/telling-git-about-your-gpg-key - /articles/telling-git-about-your-signing-key @@ -51,8 +51,6 @@ If you have multiple GPG keys, you need to tell Git which one to use. $ killall gpg-agent ``` -{% data reusables.gpg.x-509-key %} - {% endmac %} {% windows %} @@ -74,8 +72,6 @@ If you have multiple GPG keys, you need to tell Git which one to use. {% data reusables.gpg.copy-gpg-key-id %} {% data reusables.gpg.paste-gpg-key-id %} -{% data reusables.gpg.x-509-key %} - {% endwindows %} {% linux %} @@ -100,15 +96,25 @@ If you have multiple GPG keys, you need to tell Git which one to use. ```bash $ [ -f ~/.bashrc ] && echo 'export GPG_TTY=$(tty)' >> ~/.bashrc ``` - {% endlinux %} +{% ifversion ssh-commit-verification %} +## Telling Git about your SSH key + +You can use an existing SSH key to sign commits and tags, or generate a new one specifically for signing. For more information, see "[Generating a new SSH key and adding it to the ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." + +{% data reusables.gpg.ssh-git-version %} + +{% data reusables.command_line.open_the_multi_os_terminal %} +{% data reusables.gpg.configure-ssh-signing %} +{% data reusables.gpg.copy-ssh-public-key %} +{% data reusables.gpg.paste-ssh-public-key %} + +{% endif %} + +{% data reusables.gpg.x-509-key %} ## Further reading -- "[Checking for existing GPG keys](/articles/checking-for-existing-gpg-keys)" -- "[Generating a new GPG key](/articles/generating-a-new-gpg-key)" -- "[Using a verified email address in your GPG key](/articles/using-a-verified-email-address-in-your-gpg-key)" -- "[Adding a GPG key to your GitHub account](/articles/adding-a-gpg-key-to-your-github-account)" -- "[Associating an email with your GPG key](/articles/associating-an-email-with-your-gpg-key)" +- "[Adding a new SSH key to your GitHub account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)." - "[Signing commits](/articles/signing-commits)" - "[Signing tags](/articles/signing-tags)" diff --git a/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md b/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md index 38e0b87865..df217b71a5 100644 --- a/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md +++ b/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md @@ -23,7 +23,12 @@ shortTitle: Check verification status 3. Next to your commit's abbreviated commit hash, there is a box that shows whether your commit signature is verified{% ifversion fpt or ghec %}, partially verified,{% endif %} or unverified. ![Signed commit](/assets/images/help/commits/gpg-signed-commit-verified-without-details.png) 4. To view more detailed information about the commit signature, click **Verified**{% ifversion fpt or ghec %}, **Partially verified**,{% endif %} or **Unverified**. -![Verified signed commit](/assets/images/help/commits/gpg-signed-commit_verified_details.png) + GPG signed commits will show the ID of the key that was used. + ![Verified GPG signed commit](/assets/images/help/commits/gpg-signed-commit_verified_details.png) +{% ifversion ssh-commit-verification %} + SSH signed commits will show the signature of the public key that was used. + ![Verified SSH signed commit](/assets/images/help/commits/ssh-signed-commit-verified-details.png) +{% endif %} ## Checking your tag signature verification status diff --git a/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md b/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md index e7fb70174a..81683b18f8 100644 --- a/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md +++ b/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md @@ -49,9 +49,9 @@ All data transferred out, when triggered by {% data variables.product.prodname_a Storage usage is shared with build artifacts produced by {% data variables.product.prodname_actions %} for repositories owned by your account. For more information, see "[About billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)." -{% data variables.product.prodname_dotcom %} charges usage to the account that owns the repository where the package is published. If your account's usage surpasses these limits and you have set a spending limit above $0 USD, you will pay $0.25 USD per GB of storage per day and $0.50 USD per GB of data transfer. +{% data variables.product.prodname_dotcom %} charges usage to the account that owns the repository where the package is published. If your account's usage surpasses these limits and you have set a spending limit above $0 USD, you will pay $0.008 USD per GB of storage per day and $0.50 USD per GB of data transfer. -For example, if your organization uses {% data variables.product.prodname_team %}, allows unlimited spending, uses 150GB of storage, and has 50GB of data transfer out during a month, the organization would have overages of 148GB for storage and 40GB for data transfer for that month. The storage overage would cost $0.25 USD per GB per day or $37 USD. The overage for data transfer would cost $0.50 USD per GB or $20 USD. +For example, if your organization uses {% data variables.product.prodname_team %}, allows unlimited spending, uses 150GB of storage, and has 50GB of data transfer out during a month, the organization would have overages of 148GB for storage and 40GB for data transfer for that month. The storage overage would cost $0.008 USD per GB per day or approximately $37 USD for a 31-day month. The overage for data transfer would cost $0.50 USD per GB or $20 USD. {% data reusables.dotcom_billing.pricing_calculator.pricing_cal_packages %} diff --git a/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md b/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md index a66a670f5f..c2cba44e7f 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md +++ b/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md @@ -32,7 +32,7 @@ There are a few approaches for tackling newly committed credentials, but one exa {% note %} - **Note:** You can automate this step. For large enterprises and organizations with hundreds of repositories, manually following up is unsustainable. You could incorporate automation into the webhook process defined in the first step. The webhook payload contains repository and organization information about the leaked secret. Using this information, you can contact the current maintainers on the repository and create a email/message to the responsible people or open an issue. + **Note:** You can automate this step. For large enterprises and organizations with hundreds of repositories, manually following up is unsustainable. You could incorporate automation into the webhook process defined in the first step. The webhook payload contains repository and organization information about the leaked secret. Using this information, you can contact the current maintainers on the repository and create an email/message to the responsible people or open an issue. {% endnote %} 3. **Educate**: Create an internal training document assigned to the developer who committed the secret. Within this training document, you can explain the risks created by committing secrets and direct them to your best practice information about using secrets securely in development. If the a developer doesn't learn from the experience and continues to commit secrets, you could create an escalation process, but education usually works well. diff --git a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md index a5948aba46..23e20a25a3 100644 --- a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md +++ b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md @@ -43,8 +43,8 @@ By default, the code scanning alerts page is filtered to show alerts for the def ![Summary of alerts](/assets/images/help/repository/code-scanning-click-alert.png) {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %} - {% data reusables.code-scanning.alert-default-branch %} - ![The "Affected branches" section in an alert](/assets/images/help/repository/code-scanning-affected-branches.png){% endif %} + {% data reusables.code-scanning.alert-default-branch %} + ![The "Affected branches" section in an alert](/assets/images/help/repository/code-scanning-affected-branches.png){% endif %} 1. Optionally, if the alert highlights a problem with data flow, click **Show paths** to display the path from the data source to the sink where it's used. {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %} ![The "Show paths" link on an alert](/assets/images/help/repository/code-scanning-show-paths.png) diff --git a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md index 8731e2c43d..51e5b899cc 100644 --- a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md +++ b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md @@ -32,6 +32,12 @@ If you're setting up {% data variables.product.prodname_code_scanning %} for a c You must run {% data variables.product.prodname_codeql %} inside the container in which you build your code. This applies whether you are using the {% data variables.product.prodname_codeql_cli %}{% ifversion codeql-runner-supported %}, the {% data variables.product.prodname_codeql_runner %},{% endif %} or {% data variables.product.prodname_actions %}. For the {% data variables.product.prodname_codeql_cli %} {% ifversion codeql-runner-supported %}or the {% data variables.product.prodname_codeql_runner %}{% endif %}, see "[Installing {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)"{% ifversion codeql-runner-supported %} or "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)"{% endif %} for more information. If you're using {% data variables.product.prodname_actions %}, configure your workflow to run all the actions in the same container. For more information, see "[Example workflow](#example-workflow)." +{% note %} + +**Note:** {% data reusables.code-scanning.non-glibc-linux-support %} + +{% endnote %} + ## Dependencies You may have difficulty running {% data variables.product.prodname_code_scanning %} if the container you're using is missing certain dependencies (for example, Git must be installed and added to the PATH variable). If you encounter dependency issues, review the list of software typically included on {% data variables.product.prodname_dotcom %}'s runner images. For more information, see the version-specific `readme` files in these locations: diff --git a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md index 52e0b98fd3..32cea9db26 100644 --- a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md +++ b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md @@ -151,25 +151,29 @@ The names of the {% data variables.product.prodname_code_scanning %} analysis ch ![{% data variables.product.prodname_code_scanning %} pull request checks](/assets/images/help/repository/code-scanning-pr-checks.png) -When the {% data variables.product.prodname_code_scanning %} jobs complete, {% data variables.product.prodname_dotcom %} works out whether any alerts were added by the pull request and adds the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" entry to the list of checks. After {% data variables.product.prodname_code_scanning %} has been performed at least once, you can click **Details** to view the results of the analysis. If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion fpt or ghes > 3.2 or ghae or ghec %}an "Analysis not found"{% else %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check. +When the {% data variables.product.prodname_code_scanning %} jobs complete, {% data variables.product.prodname_dotcom %} works out whether any alerts were added by the pull request and adds the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" entry to the list of checks. After {% data variables.product.prodname_code_scanning %} has been performed at least once, you can click **Details** to view the results of the analysis. -{% ifversion fpt or ghes > 3.2 or ghae or ghec %} - ![Analysis not found for commit message](/assets/images/help/repository/code-scanning-analysis-not-found.png) +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-7095 %} + +{% elsif ghes < 3.5 or ghae %} +If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion ghes > 3.2 or ghae %}an "Analysis not found"{% elsif ghes = 3.2 %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check. + +{% ifversion ghes > 3.2 or ghae %} + ![Analysis not found for commit message](/assets/images/enterprise/3.4/repository/code-scanning-analysis-not-found.png) The table lists one or more categories. Each category relates to specific analyses, for the same tool and commit, performed on a different language or a different part of the code. For each category, the table shows the two analyses that {% data variables.product.prodname_code_scanning %} attempted to compare to determine which alerts were introduced or fixed in the pull request. For example, in the screenshot above, {% data variables.product.prodname_code_scanning %} found an analysis for the merge commit of the pull request, but no analysis for the head of the main branch. -{% else %} - ![Missing analysis for commit message](/assets/images/enterprise/3.2/repository/code-scanning-missing-analysis.png) -{% endif %} -{% ifversion fpt or ghes > 3.2 or ghae or ghec %} ### Reasons for the "Analysis not found" message -{% else %} + +{% elsif ghes = 3.2 %} + ![Missing analysis for commit message](/assets/images/enterprise/3.2/repository/code-scanning-missing-analysis.png) + ### Reasons for the "Missing analysis" message {% endif %} -After {% data variables.product.prodname_code_scanning %} has analyzed the code in a pull request, it needs to compare the analysis of the topic branch (the branch you used to create the pull request) with the analysis of the base branch (the branch into which you want to merge the pull request). This allows {% data variables.product.prodname_code_scanning %} to compute which alerts are newly introduced by the pull request, which alerts were already present in the base branch, and whether any existing alerts are fixed by the changes in the pull request. Initially, if you use a pull request to add {% data variables.product.prodname_code_scanning %} to a repository, the base branch has not yet been analyzed, so it's not possible to compute these details. In this case, when you click through from the results check on the pull request you will see the {% ifversion fpt or ghes > 3.2 or ghae or ghec %}"Analysis not found"{% else %}"Missing analysis for base commit SHA-HASH"{% endif %} message. +After {% data variables.product.prodname_code_scanning %} has analyzed the code in a pull request, it needs to compare the analysis of the topic branch (the branch you used to create the pull request) with the analysis of the base branch (the branch into which you want to merge the pull request). This allows {% data variables.product.prodname_code_scanning %} to compute which alerts are newly introduced by the pull request, which alerts were already present in the base branch, and whether any existing alerts are fixed by the changes in the pull request. Initially, if you use a pull request to add {% data variables.product.prodname_code_scanning %} to a repository, the base branch has not yet been analyzed, so it's not possible to compute these details. In this case, when you click through from the results check on the pull request you will see the {% ifversion ghes > 3.2 or ghae %}"Analysis not found"{% elsif ghes = 3.2 %}"Missing analysis for base commit SHA-HASH"{% endif %} message. There are other situations where there may be no analysis for the latest commit to the base branch for a pull request. These include: @@ -177,7 +181,7 @@ There are other situations where there may be no analysis for the latest commit To check whether a branch has been scanned, go to the {% data variables.product.prodname_code_scanning_capc %} page, click the **Branch** drop-down and select the relevant branch. -![Choose a branch from the Branch drop-down menu](/assets/images/help/repository/code-scanning-branch-dropdown.png) + ![Choose a branch from the Branch drop-down menu](/assets/images/help/repository/code-scanning-branch-dropdown.png) The solution in this situation is to add the name of the base branch to the `on:push` and `on:pull_request` specification in the {% data variables.product.prodname_code_scanning %} workflow on that branch and then make a change that updates the open pull request that you want to scan. @@ -189,6 +193,8 @@ There are other situations where there may be no analysis for the latest commit Merge a trivial change into the base branch to trigger {% data variables.product.prodname_code_scanning %} on this latest commit, then push a change to the pull request to retrigger {% data variables.product.prodname_code_scanning %}. +{% endif %} + ## Next steps After setting up {% data variables.product.prodname_code_scanning %}, and allowing its actions to complete, you can: diff --git a/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md index daeb17e483..74df7049d2 100644 --- a/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md +++ b/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md @@ -45,9 +45,15 @@ If you upload a second SARIF file for a commit with the same category and from t If you're new to SARIF and want to learn more, see Microsoft's [`SARIF tutorials`](https://github.com/microsoft/sarif-tutorials) repository. -## Preventing duplicate alerts using fingerprints +## Providing data to track {% data variables.product.prodname_code_scanning %} alerts across runs -Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the right line of code when files are edited. +Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the correct line of code when files are edited. The `ruleID` for a result has to be the same across analysis. + +### Reporting consistent filepaths + +The filepath has to be consistent across the runs to enable a computation of a stable fingerprint. If the filepaths differ for the same result, each time there is a new analysis a new alert will be created, and the old one will be closed. This will cause having multiple alerts for the same result. + +### Including data for fingerprint generation {% data variables.product.prodname_dotcom %} uses the `partialFingerprints` property in the OASIS standard to detect when two results are logically identical. For more information, see the "[partialFingerprints property](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" entry in the OASIS documentation. @@ -77,6 +83,12 @@ You can check a SARIF file is compatible with {% data variables.product.prodname If you use a code analysis engine other than {% data variables.product.prodname_codeql %}, you can review the supported SARIF properties to optimize how your analysis results will appear on {% data variables.product.prodname_dotcom %}. +{% note %} + +**Note:** You must supply an explicit value for any property marked as "required". The empty string is not supported for required properties. + +{% endnote %} + Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.product.prodname_code_scanning %} will only use the following supported properties. ### `sarifLog` object @@ -138,7 +150,7 @@ Each `result` object contains details for one alert in the codebase. Within the | `level`| **Optional.** The severity of the result. This level overrides the default severity defined by the rule. {% data variables.product.prodname_code_scanning_capc %} uses the level to filter results by severity on {% data variables.product.prodname_dotcom %}. | `message.text`| **Required.** A message that describes the result. {% data variables.product.prodname_code_scanning_capc %} displays the message text as the title of the result. Only the first sentence of the message will be displayed when visible space is limited. | `locations[]`| **Required.** The set of locations where the result was detected up to a maximum of 10. Only one location should be included unless the problem can only be corrected by making a change at every specified location. **Note:** At least one location is required for {% data variables.product.prodname_code_scanning %} to display a result. {% data variables.product.prodname_code_scanning_capc %} will use this property to decide which file to annotate with the result. Only the first value of this array is used. All other values are ignored. -| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Preventing duplicate alerts using fingerprints](#preventing-duplicate-alerts-using-fingerprints)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. +| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Providing data to track code scanning alerts across runs](#providing-data-to-track-code-scanning-alerts-across-runs)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. | `codeFlows[].threadFlows[].locations[]`| **Optional.** An array of `location` objects for a `threadFlow` object, which describes the progress of a program through a thread of execution. A `codeFlow` object describes a pattern of code execution used to detect a result. If code flows are provided, {% data variables.product.prodname_code_scanning %} will expand code flows on {% data variables.product.prodname_dotcom %} for the relevant result. For more information, see the [`location` object](#location-object). | `relatedLocations[]`| A set of locations relevant to this result. {% data variables.product.prodname_code_scanning_capc %} will link to related locations when they are embedded in the result message. For more information, see the [`location` object](#location-object). @@ -204,7 +216,7 @@ These example SARIF output files show supported properties and example values. ### Example with minimum required properties -This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties or don't include values, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. +This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties, omit values, or use an empty string, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. ```json { diff --git a/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md b/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md index 1e03a239f3..193ee54f5a 100644 --- a/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md +++ b/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md @@ -58,7 +58,7 @@ For more information see the [`upload-sarif` action](https://github.com/github/c The `upload-sarif` action can be configured to run when the `push` and `scheduled` event occur. For more information about {% data variables.product.prodname_actions %} events, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#preventing-duplicate-alerts-using-fingerprints)." +If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#providing-data-to-track-code-scanning-alerts-across-runs)." {% data reusables.code-scanning.upload-sarif-alert-limit %} diff --git a/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md b/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md index f7ece2d3dc..146c44a368 100644 --- a/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md +++ b/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md @@ -37,21 +37,40 @@ You can enable automatic security updates for any repository that uses {% data v {% data variables.product.product_name %} generates {% data variables.product.prodname_dependabot_alerts %} when we detect that your codebase is using dependencies with known security risks. For repositories where {% data variables.product.prodname_dependabot_security_updates %} are enabled, when {% data variables.product.product_name %} detects a vulnerable dependency in the default branch, {% data variables.product.prodname_dependabot %} creates a pull request to fix it. The pull request will upgrade the dependency to the minimum possible secure version needed to avoid the vulnerability. -{% ifversion dependabot-most-important-sort-option %} By default, {% data variables.product.prodname_dependabot_alerts %} are displayed in the {% data variables.product.prodname_dependabot_alerts %} tab in order of importance, but you can sort alerts by other criteria. {% endif %}{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5638 %}You can sort and filter {% data variables.product.prodname_dependabot_alerts %} with the dropdown menus in the {% data variables.product.prodname_dependabot_alerts %} tab or by typing filters as `key:value` pairs into the search bar. The available filters are repository (for example, `repo:my-repository`), package (for example, `package:django`), ecosystem (for example, `ecosystem:npm`), manifest (for example, `manifest:webwolf/pom.xml`), state (for example, `is:open`), and whether an advisory has a patch (for example, `has: patch`).{% ifversion dependabot-alerts-development-label %} You can also filter alerts with dependency scope data using `scope`, for example: `scope:development` or `scope:runtime`. With `scope:development`, the list of alerts will only show dependencies used during development, not production.{% endif %} - Each {% data variables.product.prodname_dependabot %} alert has a unique numeric identifier and the {% data variables.product.prodname_dependabot_alerts %} tab lists an alert for every detected vulnerability. Legacy {% data variables.product.prodname_dependabot_alerts %} grouped vulnerabilities by dependency and generated a single alert per dependency. If you navigate to a legacy {% data variables.product.prodname_dependabot %} alert, you will be redirected to a {% data variables.product.prodname_dependabot_alerts %} tab filtered for that package. {% endif %} + +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5638 %} +You can filter and sort {% data variables.product.prodname_dependabot_alerts %} using a variety of filters and sort options available on the user interface. For more information, see "[Prioritizing {% data variables.product.prodname_dependabot_alerts %}](#prioritizing-across--data-variablesproductprodname_dependabot_alerts-)" below. + +## Prioritizing {% data variables.product.prodname_dependabot_alerts %} + +{% data variables.product.company_short %} helps you prioritize fixing {% data variables.product.prodname_dependabot_alerts %}. {% ifversion dependabot-most-important-sort-option %} By default, {% data variables.product.prodname_dependabot_alerts %} are sorted by importance. The "Most important" sort order helps you prioritize which {% data variables.product.prodname_dependabot_alerts %} to focus on first. Alerts are ranked based on their potential impact, actionability, and relevance. Our prioritization calculation is constantly being improved and includes factors like CVSS score, dependency scope, and whether vulnerable function calls are found for the alert. + +![Screenshot of Sort dropdown with "Most important" sort](/assets/images/help/dependabot/dependabot-alerts-sort-dropdown.png) {% endif %} +{% data reusables.dependabot.dependabot-alerts-filters %} + +In addition to the filters available via the search bar, you can sort and filter {% data variables.product.prodname_dependabot_alerts %} using the dropdown menus at the top of the alert list. The search bar also allows for full text searching of alerts and related security advisories. You can search for part of a security advisory name or description to return the alerts in your repository that relate to that security advisory. For example, searching for `yaml.load() API could execute arbitrary code` will return {% data variables.product.prodname_dependabot_alerts %} linked to "[PyYAML insecurely deserializes YAML strings leading to arbitrary code execution](https://github.com/advisories/GHSA-rprw-h62v-c2w7)" as the search string appears in the advisory description. + +{% endif %} + +{% ifversion dependabot-bulk-alerts %} + ![Screenshot of the filter and sort menus in the {% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/help/graphs/dependabot-alerts-filters-checkbox.png){% elsif ghes = 3.5 %} +You can select a filter in a dropdown menu at the top of the list, then click the filter that you would like to apply. + ![Screenshot of the filter and sort menus in the {% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/enterprise/3.5/dependabot/dependabot-alerts-filters.png){% endif %} + {% ifversion dependabot-alerts-development-label %} ## Supported ecosystems and manifests for dependency scope - {% data reusables.dependabot.dependabot-alerts-dependency-scope %} Alerts for packages listed as development dependencies are marked with the `Development` label on the {% data variables.product.prodname_dependabot_alerts %} page and are also available for filtering via the `scope` filter. + ![Screenshot showing the "Development" label in the list of alerts](/assets/images/help/repository/dependabot-alerts-development-label.png) The alert details page of alerts on development-scoped packages shows a "Tags" section containing a `Development` label. + ![Screenshot showing the "Tags" section in the alert details page](/assets/images/help/repository/dependabot-alerts-tags-section.png) {% endif %} @@ -92,20 +111,7 @@ For more information, see "[Reviewing and fixing alerts](#reviewing-and-fixing-a {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-dependabot-alerts %} -1. Optionally, to filter alerts, select the **Repository**, **Package**, **Ecosystem**, or **Manifest** dropdown menu then click the filter that you would like to apply. You can also type filters into the search bar. For example, `ecosystem:npm`{% ifversion ghes < 3.7 or ghae-issue-5638 %} or `has:patch`{% endif %}{% ifversion dependabot-alerts-development-label %}, `has:patch` or `scope:development`{% endif %}. To sort alerts, select the **Sort** dropdown menu then click the option that you would like to sort by, or type `sort:` into the search bar and choose an option from the suggestions (for example, `sort:newest`). - - {% ifversion dependabot-most-important-sort-option %} - {% note %} - - **Note:** By default, {% data variables.product.prodname_dependabot_alerts %} are sorted by importance. The "Most important" sort helps you prioritize which {% data variables.product.prodname_dependabot_alerts %} to focus on first. Alerts are ranked based on their potential impact, actionability, and relevance. Our prioritization calculation is constantly being improved and includes factors like CVSS score, dependency scope, and whether vulnerable function calls are found for the alert. - {% endnote %} - - ![Screenshot of Sort dropdown with "Most important" sort](/assets/images/help/dependabot/dependabot-alerts-sort-dropdown.png) - {% endif %} - - You can also click a label on an alert to only show alerts of that type.{% ifversion dependabot-alerts-development-label %} For example, clicking the `Development` label in the list of alerts will only show alerts relating to dependencies used in development, not production. For information about the list of ecosystems supported, see "[Supported ecosystems and manifests for dependency scope ](#supported-ecosystems-and-manifests-for-dependency-scope)." - -{% endif %} +1. Optionally, to filter alerts, select a filter in a dropdown menu then click the filter that you would like to apply. You can also type filters into the search bar. For more information about filtering and sorting alerts, see "[Prioritizing {% data variables.product.prodname_dependabot_alerts %}](#prioritizing-across--data-variablesproductprodname_dependabot_alerts-)." {%- ifversion dependabot-bulk-alerts %} ![Screenshot of the filter and sort menus in the {% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/help/graphs/dependabot-alerts-filters-checkbox.png){% else %} ![Screenshot of the filter and sort menus in the {% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/enterprise/3.5/dependabot/dependabot-alerts-filters.png){% endif %} @@ -162,7 +168,11 @@ If you schedule extensive work to upgrade a dependency, or decide that an alert 1. View the details for an alert. For more information, see "[Viewing vulnerable dependencies](#viewing-dependabot-alerts)" (above). 1. Select the "Dismiss" dropdown, and click a reason for dismissing the alert.{% ifversion reopen-dependabot-alerts %} Unfixed dismissed alerts can be reopened later.{% endif %} - ![Choosing reason for dismissing the alert via the "Dismiss" drop-down](/assets/images/help/repository/dependabot-alert-dismiss-drop-down-ungrouped.png) +{% ifversion dependabot-alerts-dismissal-comment %}1. Optionally, add a dismissal comment. The dismissal comment will be added to the alert timeline and can be used as justification during auditing and reporting. You can retrieve or set a comment by using the GraphQL API. The comment is contained in the `dismissComment` field. For more information, see "[{% data variables.product.prodname_dependabot_alerts %}](/graphql/reference/objects#repositoryvulnerabilityalert)" in the GraphQL API documentation. + ![Screenshot showing how to dismiss an alert via the "Dismiss" drop-down, with the option to add a dismissal comment](/assets/images/help/repository/dependabot-alerts-dismissal-comment.png) +1. Click **Dismiss alert**. +{% else %} + ![Choosing reason for dismissing the alert via the "Dismiss" drop-down](/assets/images/help/repository/dependabot-alert-dismiss-drop-down-ungrouped.png){% endif %} {% ifversion dependabot-bulk-alerts %} ### Dismissing multiple alerts at once diff --git a/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md b/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md index 141e720d52..60bf852121 100644 --- a/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md +++ b/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md @@ -417,7 +417,7 @@ updates: ### `open-pull-requests-limit` -By default, {% data variables.product.prodname_dependabot %} opens a maximum of five pull requests for version updates. Once there are five open pull requests, new requests are blocked until you merge or close some of the open requests, after which new pull requests can be opened on subsequent updates. Use `open-pull-requests-limit` to change this limit. This also provides a simple way to temporarily disable version updates for a package manager. +By default, {% data variables.product.prodname_dependabot %} opens a maximum of five pull requests for version updates. Once there are five open pull requests from {% data variables.product.prodname_dependabot %}, {% data variables.product.prodname_dependabot %} will not open any new requests until some of those open requests are merged or closed. Use `open-pull-requests-limit` to change this limit. This also provides a simple way to temporarily disable version updates for a package manager. This option has no impact on security updates, which have a separate, internal limit of ten open pull requests. diff --git a/content/code-security/secret-scanning/about-secret-scanning.md b/content/code-security/secret-scanning/about-secret-scanning.md index 481ec138e4..0110c45c23 100644 --- a/content/code-security/secret-scanning/about-secret-scanning.md +++ b/content/code-security/secret-scanning/about-secret-scanning.md @@ -39,7 +39,7 @@ Service providers can partner with {% data variables.product.company_short %} to {% ifversion secret-scanning-push-protection %} -You can also enable {% data variables.product.prodname_secret_scanning %} as a push protection for a repository or an organization. When you enable this feature, {% data variables.product.prodname_secret_scanning %} prevents contributors from pushing code with a detected secret. To proceed, contributors must either remove the secret(s) from the push or, if needed, bypass the protection. For more information, see "[Protecting pushes with {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." +You can also enable {% data variables.product.prodname_secret_scanning %} as a push protection for a repository or an organization. When you enable this feature, {% data variables.product.prodname_secret_scanning %} prevents contributors from pushing code with a detected secret. To proceed, contributors must either remove the secret(s) from the push or, if needed, bypass the protection. {% ifversion push-protection-custom-link-orgs %}Admins can also specify a custom link that is displayed to the contributor when a push is blocked; the link can contain resources specific to the organization to aid contributors. {% endif %}For more information, see "[Protecting pushes with {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." {% endif %} diff --git a/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md b/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md index bc66e8cbe7..155c455d38 100644 --- a/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md +++ b/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md @@ -60,8 +60,20 @@ Organization owners, security managers, and repository administrators can enable Up to five detected secrets will be displayed at a time on the command line. If a particular secret has already been detected in the repository and an alert already exists, {% data variables.product.prodname_dotcom %} will not block that secret. +{% ifversion push-protection-custom-link-orgs %} + +Organization admins can provide a custom link that will be displayed when a push is blocked. This custom link can contain organization-specific resources and advice, such as directions on using a recommended secrets vault or who to contact for questions relating to the blocked secret. + +{% ifversion push-protection-custom-link-orgs-beta %}{% data reusables.advanced-security.custom-link-beta %}{% endif %} + +![Screenshot showing that a push is blocked when a user attempts to push a secret to a repository](/assets/images/help/repository/secret-scanning-push-protection-with-custom-link.png) + +{% else %} + ![Screenshot showing that a push is blocked when a user attempts to push a secret to a repository](/assets/images/help/repository/secret-scanning-push-protection-with-link.png) +{% endif %} + {% data reusables.secret-scanning.push-protection-remove-secret %} For more information about remediating blocked secrets, see "[Pushing a branch blocked by push protection](/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection#resolving-a-blocked-push-on-the-command-line)." If you confirm a secret is real and that you intend to fix it later, you should aim to remediate the secret as soon as possible. For example, you might revoke the secret and remove the secret from the repository's commit history. Real secrets that have been exposed must be revoked to avoid unauthorized access. You might consider first rotating the secret before revoking it. For more information, see "[Removing sensitive data from a repository](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)." @@ -89,6 +101,14 @@ If {% data variables.product.prodname_dotcom %} blocks a secret that you believe {% data variables.product.prodname_dotcom %} will only display one detected secret at a time in the web UI. If a particular secret has already been detected in the repository and an alert already exists, {% data variables.product.prodname_dotcom %} will not block that secret. +{% ifversion push-protection-custom-link-orgs %} + +Organization admins can provide a custom link that will be displayed when a push is blocked. This custom link can contain resources and advice specific to your organization. For example, the custom link can point to a README file with information about the organization's secret vault, which teams and individuals to escalate questions to, or the organization's approved policy for working with secrets and rewriting commit history. + +{% ifversion push-protection-custom-link-orgs-beta %}{% data reusables.advanced-security.custom-link-beta %}{% endif %} + +{% endif %} + You can remove the secret from the file using the web UI. Once you remove the secret, the banner at the top of the page will change and tell you that you can now commit your changes. ![Screenshot showing commit in web ui allowed after secret fixed](/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-allowed.png) diff --git a/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md b/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md index 63fddd8cba..e6ece077b1 100644 --- a/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md +++ b/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md @@ -27,6 +27,14 @@ If {% data variables.product.prodname_dotcom %} blocks a secret that you believe {% endtip %} +{% ifversion push-protection-custom-link-orgs %} + +Organization admins can provide a custom link that will be included in the message from {% data variables.product.product_name %} when your push is blocked. This custom link can contain resources and advice specific to your organization and its policies. + +{% ifversion push-protection-custom-link-orgs-beta %}{% data reusables.advanced-security.custom-link-beta %}{% endif %} + +{% endif %} + ## Resolving a blocked push on the command line {% data reusables.secret-scanning.push-protection-command-line-choice %} diff --git a/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md b/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md index 7e5c96aa99..24fca3adc8 100644 --- a/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md +++ b/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md @@ -12,25 +12,25 @@ shortTitle: Private image registry ## About private image registries and {% data variables.product.prodname_github_codespaces %} -A registry is a secure space for storing, managing, and fetching private container images. You may use one to store one or more images. There are many examples of registries, such as {% data variables.product.prodname_dotcom %} Container Registry, Azure Container Registry, or DockerHub. +A registry is a secure space for storing, managing, and fetching private container images. You may use one to store one or more images. There are many examples of registries, such as {% data variables.product.prodname_container_registry %}, {% data variables.product.prodname_npm_registry %}, Azure Container Registry, or DockerHub. -{% data variables.product.prodname_dotcom %} Container Registry can be configured to pull container images seamlessly, without having to provide any authentication credentials to {% data variables.product.prodname_github_codespaces %}. For other image registries, you must create secrets in {% data variables.product.prodname_dotcom %} to store the access details, which will allow {% data variables.product.prodname_codespaces %} to access images stored in that registry. +{% data variables.product.prodname_ghcr_and_npm_registry %} can be configured to allow container images to be pulled seamlessly into {% data variables.product.prodname_github_codespaces %} during codespace creation, without having to provide any authentication credentials. For other image registries, you must create secrets in {% data variables.product.prodname_dotcom %} to store the access details, which will allow {% data variables.product.prodname_codespaces %} to access images stored in that registry. -## Accessing images stored in {% data variables.product.prodname_dotcom %} Container Registry +## Accessing images stored in {% data variables.product.prodname_ghcr_and_npm_registry %} -{% data variables.product.prodname_dotcom %} Container Registry is the easiest way for {% data variables.product.prodname_codespaces %} to consume devcontainer container images. +{% data variables.product.prodname_ghcr_and_npm_registry %} provide the easiest way for {% data variables.product.prodname_codespaces %} to consume dev container images. -For more information, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)". +For more information, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)" and "[Working with the npm registry](/packages/working-with-a-github-packages-registry/working-with-the-npm-registry)". ### Accessing an image published to the same repository as the codespace -If you publish a container image to {% data variables.product.prodname_dotcom %} Container Registry in the same repository that the codespace is being launched in, you will automatically be able to fetch that image on codespace creation. You won't have to provide any additional credentials, unless the **Inherit access from repo** option was unselected when the container image was published. +If you publish a container image to {% data variables.product.prodname_ghcr_or_npm_registry %} in the same repository that the codespace is being launched in, you will automatically be able to fetch that image on codespace creation. You won't have to provide any additional credentials, unless the **Inherit access from repo** option was unselected when the container image was published. #### Inheriting access from the repository from which an image was published -By default, when you publish a container image to {% data variables.product.prodname_dotcom %} Container Registry, the image inherits the access setting of the repository from which the image was published. For example, if the repository is public, the image is also public. If the repository is private, the image is also private, but is accessible from the repository. +By default, when you publish a container image to {% data variables.product.prodname_ghcr_or_npm_registry %}, the image inherits the access setting of the repository from which the image was published. For example, if the repository is public, the image is also public. If the repository is private, the image is also private, but is accessible from the repository. -This behavior is controlled by the **Inherit access from repo** option. **Inherit access from repo** is selected by default when publishing via {% data variables.product.prodname_actions %}, but not when publishing directly to {% data variables.product.prodname_dotcom %} Container Registry using a Personal Access Token (PAT). +This behavior is controlled by the **Inherit access from repo** option. **Inherit access from repo** is selected by default when publishing via {% data variables.product.prodname_actions %}, but not when publishing directly to {% data variables.product.prodname_ghcr_or_npm_registry %} using a Personal Access Token (PAT). If the **Inherit access from repo** option was not selected when the image was published, you can manually add the repository to the published container image's access controls. For more information, see "[Configuring a package's access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#inheriting-access-for-a-container-image-from-a-repository)." @@ -46,13 +46,13 @@ If you want to allow a subset of an organization's repositories to access a cont ### Publishing a container image from a codespace -Seamless access from a codespace to {% data variables.product.prodname_dotcom %} Container Registry is limited to pulling container images. If you want to publish a container image from inside a codespace, you must use a personal access token (PAT) with the `write:packages` scope. +Seamless access from a codespace to {% data variables.product.prodname_ghcr_or_npm_registry %} is limited to pulling container images. If you want to publish a container image from inside a codespace, you must use a personal access token (PAT) with the `write:packages` scope. -We recommend publishing images via {% data variables.product.prodname_actions %}. For more information, see "[Publishing Docker images](/actions/publishing-packages/publishing-docker-images)." +We recommend publishing images via {% data variables.product.prodname_actions %}. For more information, see "[Publishing Docker images](/actions/publishing-packages/publishing-docker-images)" and "[Publishing Node.js packages](/actions/publishing-packages/publishing-nodejs-packages)." ## Accessing images stored in other container registries -If you are accessing a container image from a registry that isn't {% data variables.product.prodname_dotcom %} Container Registry, {% data variables.product.prodname_codespaces %} checks for the presence of three secrets, which define the server name, username, and personal access token (PAT) for a container registry. If these secrets are found, {% data variables.product.prodname_github_codespaces %} will make the registry available inside your codespace. +If you are accessing a container image from a registry that isn't {% data variables.product.prodname_ghcr_or_npm_registry %}, {% data variables.product.prodname_codespaces %} checks for the presence of three secrets, which define the server name, username, and personal access token (PAT) for a container registry. If these secrets are found, {% data variables.product.prodname_github_codespaces %} will make the registry available inside your codespace. - `<*>_CONTAINER_REGISTRY_SERVER` - `<*>_CONTAINER_REGISTRY_USER` diff --git a/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md b/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md index 77bd7be249..9781ece278 100644 --- a/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md +++ b/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md @@ -90,15 +90,13 @@ You can add further script, preferences, configuration files to your dotfiles re If your codespace fails to pick up configuration settings from dotfiles, see "[Troubleshooting dotfiles for {% data variables.product.prodname_codespaces %}](/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces)." -## Other available settings - You can also personalize {% data variables.product.prodname_codespaces %} using additional [{% data variables.product.prodname_codespaces %} settings](https://github.com/settings/codespaces): -- To set your default region, see "[Setting your default region for {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces)." -- To set your editor, see "[Setting your default editor for {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces)." -- To add encrypted secrets, see "[Managing encrypted secrets for {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces)." - To enable GPG verification, see "[Managing GPG verification for {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)." -- To allow your codespaces to access other repositories, see "[Managing repository access for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces)." +- To set your editor, see "[Setting your default editor for {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces)." +- To set how long a codespace can remain unused before it is automatically stopped, see "[Setting your timeout period for GitHub Codespaces](/codespaces/customizing-your-codespace/setting-your-timeout-period-for-github-codespaces)." +- To set the period for which your unused codespaces are retained, see "[Configuring automatic deletion of your codespaces](/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces)." +- To set your default region, see "[Setting your default region for {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces)." ## Further reading diff --git a/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/content/codespaces/developing-in-codespaces/creating-a-codespace.md index 5e5378d571..f626933523 100644 --- a/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ b/content/codespaces/developing-in-codespaces/creating-a-codespace.md @@ -46,23 +46,20 @@ If you want to use Git hooks for your codespace, then you should set up hooks us When you have access to {% data variables.product.prodname_github_codespaces %}, you'll see a "Codespaces" tab within the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu when you view a repository. -You'll have access to codespaces under the following conditions: +You'll have access to {% data variables.product.prodname_github_codespaces %} under the following conditions: -* You are a member of an organization that has enabled {% data variables.product.prodname_codespaces %} and set a spending limit. -* An organization owner has granted you access to {% data variables.product.prodname_codespaces %}. -* The repository is owned by the organization that has enabled {% data variables.product.prodname_codespaces %}. +Either all of these are true: +* You are a member, or outside collaborator, of an organization that has enabled {% data variables.product.prodname_codespaces %} and set a spending limit. +* The organization owner has allowed you to create codespaces at the organization's expense. +* The repository for which you want to create a codespace is owned by this organization. -{% note %} - -**Note:** Individuals who have already joined the beta with their personal {% data variables.product.prodname_dotcom %} account will not lose access to {% data variables.product.prodname_codespaces %}, however {% data variables.product.prodname_codespaces %} for individuals will continue to remain in beta. - -{% endnote %} - -Organization owners can allow all members of the organization to create codespaces, limit codespace creation to selected organization members, or disable codespace creation. For more information about managing access to codespaces within your organization, see "[Enable Codespaces for users in your organization](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization#enable-codespaces-for-users-in-your-organization)." +Or both of these are true: +* You are participating in the beta of {% data variables.product.prodname_codespaces %} for individual users. +* Either you own the repository for which you want to create a codespace, or it is owned by an organization of which you are either a member or an outside collaborator. Before {% data variables.product.prodname_codespaces %} can be used in an organization, an owner or billing manager must have set a spending limit. For more information, see "[About spending limits for Codespaces](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces#about-spending-limits-for-codespaces)." -If you would like to create a codespace for a repository owned by your personal account or another user, and you have permission to create repositories in an organization that has enabled {% data variables.product.prodname_github_codespaces %}, you can fork user-owned repositories to that organization and then create a codespace for the fork. +Organization owners can specify who can create and use codespaces at the organization's expense. Organization owners can also prevent any codespace usage being charged to the organization. For more information, see "[Enabling {% data variables.product.prodname_github_codespaces %} for your organization](/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization#choose-who-can-create-codespaces-that-are-billed-to-your-organization)." ## Creating a codespace diff --git a/content/codespaces/developing-in-codespaces/renaming-a-codespace.md b/content/codespaces/developing-in-codespaces/renaming-a-codespace.md index 75527a37cf..b296745717 100644 --- a/content/codespaces/developing-in-codespaces/renaming-a-codespace.md +++ b/content/codespaces/developing-in-codespaces/renaming-a-codespace.md @@ -27,7 +27,9 @@ To find the display name of a codespace: ![Screenshot of the Remote Explorer in VS Code](/assets/images/help/codespaces/codespaces-remote-explorer.png) +{% indented_data_reference reusables.codespaces.remote-explorer spaces=2 %} - In a terminal window on your local machine, use this {% data variables.product.prodname_cli %} command: `gh codespace list`. + ### Permanent codespace names In addition to the display name, when you create a codespace, a permanent name is also assigned to the codespace. The name is a combination of your {% data variables.product.company_short %} handle, the repository name, and some random characters. For example: `octocat-myrepo-gmc7`. You can't change this name. diff --git a/content/codespaces/guides.md b/content/codespaces/guides.md index 48891ee276..2b53d516b3 100644 --- a/content/codespaces/guides.md +++ b/content/codespaces/guides.md @@ -40,7 +40,6 @@ includeGuides: - /codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization - /codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization - /codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces - - /codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces - /codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types - /codespaces/managing-codespaces-for-your-organization/retricting-the-idle-timeout-period - /codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces diff --git a/content/codespaces/index.md b/content/codespaces/index.md index 889b9861e6..42316a4dc5 100644 --- a/content/codespaces/index.md +++ b/content/codespaces/index.md @@ -7,11 +7,11 @@ introLinks: quickstart: /codespaces/getting-started/quickstart featuredLinks: guides: - - /billing/managing-billing-for-github-codespaces/about-billing-for-codespaces - /codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization - - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project - - /codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces - /codespaces/developing-in-codespaces/codespaces-lifecycle + - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project + - /codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces + - /billing/managing-billing-for-github-codespaces/about-billing-for-codespaces popular: - /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces - /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces diff --git a/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md b/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md index 8d8d58ac5a..ff040d9a82 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md +++ b/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md @@ -1,9 +1,9 @@ --- title: Enabling GitHub Codespaces for your organization -shortTitle: Enable Codespaces -intro: 'You can control which users in your organization can use {% data variables.product.prodname_github_codespaces %}.' +shortTitle: 'Enable {% data variables.product.prodname_codespaces %}' +intro: "You can control which users in your organization can use {% data variables.product.prodname_github_codespaces %} at the organization's expense." product: '{% data reusables.gated-features.codespaces %}' -permissions: 'To manage user permissions for {% data variables.product.prodname_github_codespaces %} for an organization, you must be an organization owner.' +permissions: "To alter an organization's billing settings, you must be an organization owner." redirect_from: - /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization - /codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization @@ -13,25 +13,23 @@ versions: type: how_to topics: - Codespaces - - Permissions + - Billing - Administrator --- - ## About enabling {% data variables.product.prodname_github_codespaces %} for your organization -Organization owners can control which users in your organization can create and use codespaces. +Organization owners can control which users in your organization can create and use codespaces at the organization's expense. -To use codespaces in your organization, you must do the following: +Only people who can clone a repository can create a codespace for that repository. To allow people to create codespaces for repositories owned by your organization, you must: + +- Ensure that users have at least write access to the repositories where they want to use a codespace. For more information, see "[Managing teams and people with access to your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." +- Ensure that your organization does not have an IP address allow list enabled. For more information, see "[Managing allowed IP addresses for your organization](/{% ifversion fpt %}enterprise-cloud@latest/{% endif %}organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} + +To allow people to create codespaces for which your organization will be billed, you must: -- Ensure that users have [at least write access](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization) to the repositories where they want to use a codespace. -- [Enable {% data variables.product.prodname_github_codespaces %} for users in your organization](#enable-codespaces-for-users-in-your-organization). You can choose to allow {% data variables.product.prodname_codespaces %} for selected users or only for specific users. - [Set a spending limit](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces) -- Ensure that your organization does not have an IP address allow list enabled. For more information, see "[Managing allowed IP addresses for your organization](/{% ifversion fpt %}enterprise-cloud@latest/{% endif %}organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} - -By default, a codespace can only access the repository from which it was created. If you want codespaces in your organization to be able to access other organization repositories that the codespace creator can access, see "[Managing access and security for {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)." - -## Enable {% data variables.product.prodname_codespaces %} for users in your organization +- [Choose who can create codespaces that are billed to your organization](#choose-who-can-create-codespaces-that-are-billed-to-your-organization) {% ifversion fpt %} {% note %} @@ -40,31 +38,44 @@ By default, a codespace can only access the repository from which it was created {% endnote %} {% endif %} + +By default, a codespace can only access the repository from which it was created. If you want codespaces in your organization to be able to access other organization repositories that the codespace creator can access, see "[Managing repository access for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces)." + +## Choose who can create codespaces that are billed to your organization + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.click-codespaces %} -1. Under "User permissions", select one of the following options: +1. Under "Billing," select one of the following options: - * **Selected users** to select specific organization members to use {% data variables.product.prodname_codespaces %}. - * **Allow for all members** to allow all your organization members to use {% data variables.product.prodname_codespaces %}. - * **Allow for all members and outside collaborators** to allow all your organization members as well as outside collaborators to use {% data variables.product.prodname_codespaces %}. + * **Disabled** - Your organization will not be charged for codespace usage. {% data variables.product.prodname_codespaces %} created for your organization's repositories will be billed to the individual users who create them. + * **Selected members** - {% data variables.product.prodname_codespaces %} created for your organization's repositories by selected members will be billed to the organization. + * **All members** - {% data variables.product.prodname_codespaces %} created for your organization's repositories by members of your organization will be billed to the organization. + * **All members and outside collaborators** - {% data variables.product.prodname_codespaces %} created for your organization's repositories by organization members and outside collaborators will be billed to the organization. - ![Radio buttons for "User permissions"](/assets/images/help/codespaces/org-user-permission-settings-outside-collaborators.png) + ![Radio buttons for "Billing"](/assets/images/help/codespaces/codespaces-org-billing-settings.png) {% note %} - **Note:** When you select **Allow for all members and outside collaborators**, all outside collaborators who have been added to specific repositories can create and use {% data variables.product.prodname_codespaces %}. Your organization will be billed for all usage incurred by outside collaborators. For more information on managing outside collaborators, see "[About outside collaborators](/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization#about-outside-collaborators)." + **Note:** When you select **All members and outside collaborators**, all outside collaborators who have been added to specific repositories can create and use {% data variables.product.prodname_codespaces %} for those repositories, and your organization will be billed for this usage. For more information on managing outside collaborators, see "[About outside collaborators](/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization#about-outside-collaborators)." {% endnote %} 1. Click **Save**. +1. If you chose **Selected members**, an input box is displayed for you to enter the names of users you want to select. + + ![Input box for selecting users](/assets/images/help/codespaces/codespaces-org-billing-add-users.png) ## Disabling {% data variables.product.prodname_codespaces %} for your organization +You can prevent the creation and use of codespaces billable to your organization. + +{% data reusables.codespaces.codespaces-disabling-org-billing %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.click-codespaces %} -1. Under "User permissions", select **Disabled**. +1. Under "Billing," select **Disabled**. ## Setting a spending limit diff --git a/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-github-codespaces-in-your-organization.md b/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-github-codespaces-in-your-organization.md index 1d29b756d6..cc3203c924 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-github-codespaces-in-your-organization.md +++ b/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-github-codespaces-in-your-organization.md @@ -35,11 +35,15 @@ You can set a usage limit for the codespaces in your organization or repository. ## Disabling or limiting {% data variables.product.prodname_codespaces %} -You can disable the use of {% data variables.product.prodname_codespaces %} in your organization or repository. For more information, see "[Managing repository access for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)." +You can disable all use of {% data variables.product.prodname_github_codespaces %} that would be billed to your organization. Alternatively, you can specify which organization members or collaborators can use {% data variables.product.prodname_codespaces %} at your organization's expense. For more information, see "[Enabling {% data variables.product.prodname_github_codespaces %} for your organization](/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization)." -You can also limit the individual users who can use {% data variables.product.prodname_codespaces %}. For more information, see "[Managing user permissions for your organization](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)." +{% data reusables.codespaces.codespaces-disabling-org-billing %} -You can limit the choice of machine types that are available for repositories owned by your organization. This allows you to prevent people using overly resourced machines for their codespaces. For more information, see "[Restricting access to machine types](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types)." +You can configure which repositories can be accessed from codespaces created for a particular repository. For more information, see "[Managing access to other repositories within your codespace](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)." + +You can limit the choice of types of machine that are available for codespaces created from repositories owned by your organization. This allows you to prevent people using overly resourced machines for their codespaces, and incurring unnecessary charges. For more information, see "[Restricting access to machine types](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types)." + +You can also restrict how long a codespace can remain unused before it is automatically deleted. This can help to reduce storage costs for {% data variables.product.prodname_codespaces %}. For more information, see "[Restricting the retention period for codespaces](/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces)." ## Deleting unused codespaces @@ -47,6 +51,6 @@ Your users can delete their codespaces in https://github.com/codespaces and from {% note %} -**Note:** Only the person who created a codespace can delete it. There is currently no way for organization owners to delete codespaces created within their organization. +**Note:** Codespaces are automatically deleted after they have been stopped and have remained inactive for a defined number of days. For more information, see "[Restricting the retention period for codespaces](/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces)." A codespace can only be manually deleted by the person who created the codespace. {% endnote %} diff --git a/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md b/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md index 0f5f11dbd1..5460d78ed6 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md +++ b/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md @@ -20,7 +20,7 @@ redirect_from: {% warning %} -**Deprecation note**: The access and security setting described below is now deprecated and is documented here for reference only. To enable expanded access to other repositories, add the requested permissions to your dev container definition. For more information, see "[Managing access to other repositories within your codespace](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)." +**Deprecation note**: The access and security setting described below is now deprecated and is documented here for reference only. To enable expanded access to other repositories, add the requested permissions to your `devcontainer.json` configuration file. For more information, see "[Managing access to other repositories within your codespace](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)." {% endwarning %} diff --git a/content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md b/content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md index 87c0759571..7521ee7661 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md +++ b/content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md @@ -43,6 +43,8 @@ For example, you could create an organization-wide policy that restricts the mac If you add an organization-wide policy, you should set it to the largest choice of machine types that will be available for any repository in your organization. You can then add repository-specific policies to further restrict the choice. +{% data reusables.codespaces.codespaces-org-policies-note %} + ## Adding a policy to limit the available machine types {% data reusables.profile.access_org %} diff --git a/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md b/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md index 9bde5042e8..685dfd1db2 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md +++ b/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md @@ -40,6 +40,8 @@ When you create a policy, you choose whether it applies to all repositories in y If you add an organization-wide policy with a timeout constraint, you should set the timeout to the longest acceptable period. You can then add separate policies that set the maximum timeout to a shorter period for specific repositories in your organization. +{% data reusables.codespaces.codespaces-org-policies-note %} + ## Adding a policy to set a maximum idle timeout period {% data reusables.profile.access_org %} diff --git a/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md b/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md index 06d0b8f5e8..68dda36c9c 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md +++ b/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md @@ -26,6 +26,8 @@ When you create a policy, you choose whether it applies to all repositories in y If you add an organization-wide policy with a retention constraint, you should set the retention period to the longest acceptable period. You can then add separate policies that set the maximum retention to a shorter period for specific repositories in your organization. +{% data reusables.codespaces.codespaces-org-policies-note %} + ## Adding a policy to set a maximum codespace retention period {% data reusables.profile.access_org %} diff --git a/content/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md b/content/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md index 562db559ea..ee23806884 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md +++ b/content/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md @@ -36,6 +36,8 @@ For example, you could create an organization-wide policy that restricts the vis If you add an organization-wide policy, you should set it to the most lenient visibility option that will be available for any repository in your organization. You can then add repository-specific policies to further restrict the choice. +{% data reusables.codespaces.codespaces-org-policies-note %} + ## Adding a policy to limit the port visibility options {% data reusables.profile.access_org %} diff --git a/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md b/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md index 199a6e4554..689293eaff 100644 --- a/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md +++ b/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md @@ -132,7 +132,3 @@ When you enable access and security for a repository owned by your personal acco 1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories you own. Repeat for all repositories whose codespaces you want to access other repositories you own. !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) - -## Further reading - -- "[Managing repository access for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces)" diff --git a/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md b/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md index 42b9c218ea..8c7d89240c 100644 --- a/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md +++ b/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md @@ -32,7 +32,8 @@ The name the codespace is also included in many of the log files. For example, i Every codespace also has an ID (identifier). This is not shown by default in {% data variables.product.prodname_vscode %} so you may need to update the settings for the {% data variables.product.prodname_github_codespaces %} extension before you can access the ID. 1. In {% data variables.product.prodname_vscode %}, browser or desktop, in the Activity Bar on the left, click **Remote Explorer** to show details for the codespace. -2. If the sidebar includes a "Codespace Performance" section, hover over the "Codespace ID" and click the clipboard icon to copy the ID. -3. If the information is not shown, click {% octicon "gear" aria-label="The gear icon" %}, in the bottom-left corner of the Activity Bar, to display the "Settings" tab. -4. Expand **Extensions** and click **{% data variables.product.prodname_github_codespaces %}** to display the settings for the extension. Then enable **Show Performance Explorer** to display the "Codespace Performance" section in the sidebar. +{% indented_data_reference reusables.codespaces.remote-explorer spaces=3 %} +1. If the sidebar includes a "Codespace Performance" section, hover over the "Codespace ID" and click the clipboard icon to copy the ID. +1. If the information is not shown, click {% octicon "gear" aria-label="The gear icon" %}, in the bottom-left corner of the Activity Bar, to display the "Settings" tab. +1. Expand **Extensions** and click **{% data variables.product.prodname_github_codespaces %}** to display the settings for the extension. Then enable **Show Performance Explorer** to display the "Codespace Performance" section in the sidebar. ![Codespace ID and settings required to display performance information](/assets/images/help/codespaces/find-codespace-id.png) diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md index 4ecbfdafc5..0a2094b9cf 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md @@ -539,7 +539,7 @@ Errors with `body` will be prefixed with `body[i]` where `i` represents the inde ### Example -``` +```yaml body: - type: dropdown attributes: @@ -552,7 +552,7 @@ body: The error can be fixed by ensuring that no duplicate choices exist in the `options` array. -``` +```yaml body: - type: dropdown attributes: @@ -570,7 +570,7 @@ Errors with `body` will be prefixed with `body[i]` where `i` represents the inde ### Example -``` +```yaml body: - type: dropdown attributes: @@ -585,7 +585,7 @@ body: The error can be fixed by removing "None" as an option. If you want a contributor to be able to indicate that they like none of those types of pies, you can additionally remove the `required` validation. -``` +```yaml body: - type: dropdown attributes: @@ -605,7 +605,7 @@ Errors with `body` will be prefixed with `body[i]` where `i` represents the inde ### Example -``` +```yaml body: - type: dropdown attributes: @@ -618,7 +618,7 @@ body: The error can be fixed by wrapping each offending option in quotes, to prevent them from being processed as Boolean values. -``` +```yaml body: - type: dropdown attributes: @@ -629,6 +629,36 @@ body: - Maybe ``` +## Body cannot be empty + +The template body `key:value` pair can not be empty. For more information about which top-level keys are required, see "[Syntax for issue forms](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax)." + +The error can be fixed by adding the `body:` section. + +### Example + +```yaml +name: Support Request +description: Something went wrong and you need help? +--- +body: +- type: textarea + attributes: + label: "What's wrong?" +``` + +In this example, the error can be fixed by deleting the `---` (document separator) between the headers and the `body` section. + +```yaml +name: Support Request +description: Something went wrong and you need help? + +body: +- type: textarea + attributes: + label: "What's wrong?" +``` + ## Further reading - [YAML](https://yaml.org/) diff --git a/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md b/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md index d0e1dd4592..52e1519479 100644 --- a/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md +++ b/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md @@ -23,6 +23,8 @@ When an organization has an allow list, third-party applications that connect vi ## Adding an IP address allow list to a {% data variables.product.prodname_github_app %} +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.apps.settings-step %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} diff --git a/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md b/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md index ca89fbc56b..151c640b90 100644 --- a/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md +++ b/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md @@ -47,7 +47,7 @@ Rate limits for {% data variables.product.prodname_github_apps %} and {% data va {% ifversion fpt or ghec %} -{% data variables.product.prodname_github_apps %} that are installed on an organization or a repository within an enterprise on {% data variables.product.product_location %} are subject to a limit of 15,000 requests per hour. +{% data variables.product.prodname_github_apps %} that are installed on an organization within an enterprise on {% data variables.product.product_location %} are subject to a limit of 15,000 requests per hour per organization that has installed the app. {% endif %} diff --git a/content/developers/index.md b/content/developers/index.md index 742e708baf..ad686d6dcd 100644 --- a/content/developers/index.md +++ b/content/developers/index.md @@ -1,6 +1,29 @@ --- title: Developers -intro: 'Go deeper with {% data variables.product.prodname_dotcom %} by integrating with our APIs, customizing your {% data variables.product.prodname_dotcom %} workflow, and building and sharing apps with the community.' +intro: 'Go deeper with {% data variables.product.prodname_dotcom %} by integrating with our APIs and webhooks, customizing your {% data variables.product.prodname_dotcom %} workflow, and building and sharing apps with the community.' +introLinks: + "About apps": /developers/apps/getting-started-with-apps/about-apps +layout: product-landing +featuredLinks: + guides: + - /developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps + - /developers/apps/building-github-apps/creating-a-github-app + - /developers/apps/building-github-apps/authenticating-with-github-apps + - /developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps + popular: + - /developers/webhooks-and-events/webhooks/webhook-events-and-payloads + - /developers/apps/building-github-apps/creating-a-github-app + - /developers/apps/building-github-apps/authenticating-with-github-apps + - /developers/webhooks-and-events/webhooks/about-webhooks + - /developers/apps/building-oauth-apps/creating-an-oauth-app + - /developers/apps/building-oauth-apps/authorizing-oauth-apps + - /developers/github-marketplace/github-marketplace-overview/about-github-marketplace + guideCards: + - /developers/webhooks-and-events/webhooks/creating-webhooks + - /developers/apps/guides/using-the-github-api-in-your-app + - /developers/apps/guides/creating-ci-tests-with-the-checks-api +changelog: + label: apps versions: fpt: '*' ghes: '*' diff --git a/content/developers/overview/about-githubs-apis.md b/content/developers/overview/about-githubs-apis.md index d7b42f146d..9889891805 100644 --- a/content/developers/overview/about-githubs-apis.md +++ b/content/developers/overview/about-githubs-apis.md @@ -14,18 +14,4 @@ topics: - API --- -There are two stable versions of the GitHub API: the [REST API](/rest) and the [GraphQL API](/graphql). - -## Deprecated versions - -### beta - -We deprecated the beta API on April 22, 2014. - -### v2 - -We removed support for API v2 on June 12, 2012. - -### v1 - -We removed support for API v1 on June 12, 2012. +There are two stable versions of the GitHub API: the [REST API](/rest) and the [GraphQL API](/graphql). \ No newline at end of file diff --git a/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md b/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md index df2281c42d..4bfb12f6f5 100644 --- a/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md +++ b/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md @@ -37,12 +37,12 @@ $ export SECRET_TOKEN=your_token ## Validating payloads from GitHub -When your secret token is set, {% data variables.product.product_name %} uses it to create a hash signature with each payload. This hash signature is included with the headers of each request as `X-Hub-Signature-256`. +When your secret token is set, {% data variables.product.product_name %} uses it to create a hash signature with each payload. This hash signature is included with the headers of each request as `x-hub-signature-256`. {% ifversion fpt or ghes or ghec %} {% note %} -**Note:** For backward-compatibility, we also include the `X-Hub-Signature` header that is generated using the SHA-1 hash function. If possible, we recommend that you use the `X-Hub-Signature-256` header for improved security. The example below demonstrates using the `X-Hub-Signature-256` header. +**Note:** For backward-compatibility, we also include the `x-hub-signature` header that is generated using the SHA-1 hash function. If possible, we recommend that you use the `x-hub-signature-256` header for improved security. The example below demonstrates using the `x-hub-signature-256` header. {% endnote %} {% endif %} diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/index.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/index.md index 14cac091a2..ca3223d786 100644 --- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/index.md +++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/index.md @@ -9,8 +9,8 @@ redirect_from: versions: fpt: '*' children: - - /use-github-at-your-educational-institution - /github-global-campus-for-students - /github-global-campus-for-teachers + - /use-github-at-your-educational-institution --- diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md index 4a39811e9e..bf7d11e742 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md @@ -54,7 +54,7 @@ For a group assignment, {% data variables.product.prodname_classroom %} names re ### Choosing an assignment type -Under "Individual or group assignment", select the drop-down menu, then click **Group assignment**. You can't change the assignment type after you create the assignment. If you'd rather create a individual assignment, see "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)." +Under "Individual or group assignment", select the drop-down menu, then click **Group assignment**. You can't change the assignment type after you create the assignment. If you'd rather create an individual assignment, see "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)." ### Defining teams for an assignment diff --git a/content/get-started/exploring-projects-on-github/following-organizations.md b/content/get-started/exploring-projects-on-github/following-organizations.md index 64d7144396..b3e02489ca 100644 --- a/content/get-started/exploring-projects-on-github/following-organizations.md +++ b/content/get-started/exploring-projects-on-github/following-organizations.md @@ -7,15 +7,11 @@ topics: - Profile --- -{% note %} - -**Note:** The ability to follow organizations is currently in public beta and subject to change. - -{% endnote %} +{% data reusables.organizations.follow-organizations-beta %} ## About followers on {% data variables.product.product_name %} -When you follow organizations, you'll see their public activity on your personal dashboard. For more information, see "[About your personal dashboard](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community)." +{% data reusables.organizations.about-following-organizations %} For more information, see "[About your personal dashboard](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community)." You can unfollow an organization if you do not wish to see their {% ifversion fpt or ghec %}public{% endif %} activity on {% data variables.product.product_name %}. diff --git a/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md b/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md index 97b049d2de..30a25ec8ae 100644 --- a/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md +++ b/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md @@ -58,11 +58,21 @@ If you have existing source code or repositories stored locally on your computer ![Create New Repository drop-down](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Change the current working directory to your local project. -4. Initialize the local directory as a Git repository. - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. Add the files in your new local repository. This stages them for the first commit. + ```shell $ git add . # Adds the files in the local repository and stages them for commit. {% data reusables.git.unstage-codeblock %} @@ -95,10 +105,19 @@ If you have existing source code or repositories stored locally on your computer ![Create New Repository drop-down](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Change the current working directory to your local project. -4. Initialize the local directory as a Git repository. - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. Add the files in your new local repository. This stages them for the first commit. ```shell $ git add . @@ -132,10 +151,19 @@ If you have existing source code or repositories stored locally on your computer ![Create New Repository drop-down](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Change the current working directory to your local project. -4. Initialize the local directory as a Git repository. - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. Add the files in your new local repository. This stages them for the first commit. ```shell $ git add . diff --git a/content/get-started/quickstart/be-social.md b/content/get-started/quickstart/be-social.md index 9938fad6cb..27cfae157f 100644 --- a/content/get-started/quickstart/be-social.md +++ b/content/get-started/quickstart/be-social.md @@ -57,7 +57,23 @@ From your dashboard, click the drop down menu of your username on the left side ![Switch account context dropdown](/assets/images/help/overview/dashboard-contextswitcher.png) -### Exploring other projects on {% data variables.product.prodname_dotcom %} +{% ifversion for-you-feed %} + +## Following organizations + +{% data reusables.organizations.follow-organizations-beta %} + +{% data reusables.organizations.about-following-organizations %} + +To follow an organization, in the header of the organization's page, click **Follow**. + +![Screenshot of the organization header, with the follow button highlighted](/assets/images/help/profile/organization-profile-following.png) + +For more information, see "[Following organizations](/get-started/exploring-projects-on-github/following-organizations)." + +{% endif %} + +## Exploring other projects on {% data variables.product.prodname_dotcom %} You can discover new and interesting projects on {% data variables.product.prodname_dotcom %}'s Explore page. You can star interesting projects to make them easy to find again later. Visit your stars page to see all your starred projects. For more information about stars, see "[Saving repositories with stars](/get-started/exploring-projects-on-github/saving-repositories-with-stars)." diff --git a/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md b/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md index 7e46a5395c..cfd6821b28 100644 --- a/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md +++ b/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md @@ -23,7 +23,7 @@ To transfer an open issue to another repository, you must have write access to t {% endnote %} -When you transfer an issue, comments, labels and assignees are retained. The issue's milestones are not retained. This issue will stay on any user-owned or organization-wide project boards and be removed from any repository project boards. For more information, see "[About project boards](/articles/about-project-boards)." +When you transfer an issue, comments and assignees are retained. Labels and milestones are also retained if they're present in the target repository, with labels matching by name and milestones matching by both name and due date. This issue will stay on any user-owned or organization-wide project boards and be removed from any repository project boards. For more information, see "[About project boards](/articles/about-project-boards)." People or teams who are mentioned in the issue will receive a notification letting them know that the issue has been transferred to a new repository. The original URL redirects to the new issue's URL. People who don't have read permissions in the new repository will see a banner letting them know that the issue has been transferred to a new repository that they can't access. diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md index 09c42afce9..be572c1816 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md @@ -36,15 +36,22 @@ You can also configure allowed IP addresses for the organizations in an enterpri ## Adding an allowed IP address +{% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} + +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} {% data reusables.identity-and-permissions.ip-allow-lists-add-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-add-description %} {% data reusables.identity-and-permissions.ip-allow-lists-add-entry %} +{% data reusables.identity-and-permissions.check-ip-address %} ## Enabling allowed IP addresses +{% data reusables.identity-and-permissions.about-enabling-allowed-ip-addresses %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} @@ -71,6 +78,8 @@ For more information about how to create an allow list for a {% data variables.p ## Editing an allowed IP address +{% data reusables.identity-and-permissions.about-editing-ip-allow-list-entries %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} @@ -78,6 +87,18 @@ For more information about how to create an allow list for a {% data variables.p {% data reusables.identity-and-permissions.ip-allow-lists-edit-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-description %} 1. Click **Update**. +{% data reusables.identity-and-permissions.check-ip-address %} + +{% ifversion ip-allow-list-address-check %} +## Checking if an IP address is permitted + +{% data reusables.identity-and-permissions.about-checking-ip-address %} + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +{% data reusables.organizations.security %} +{% data reusables.identity-and-permissions.check-ip-address-step %} +{% endif %} ## Deleting an allowed IP address diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md index d5cee8b617..686a427ea5 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md @@ -740,7 +740,7 @@ For more information, see "[Managing the publication of {% data variables.produc | Action | Description |------------------|------------------- |`create` | Triggered when an organization owner creates a new custom repository role. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." -|`destroy` | Triggered when a organization owner deletes a custom repository role. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." +|`destroy` | Triggered when an organization owner deletes a custom repository role. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." |`update` | Triggered when an organization owner edits an existing custom repository role. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." {% endif %} diff --git a/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md b/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md index 36d4f7a49f..ca48cc9a2a 100644 --- a/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md +++ b/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md @@ -1,6 +1,6 @@ --- title: Enabling or disabling GitHub Discussions for an organization -intro: 'You can use {% data variables.product.prodname_discussions %} in a organization as a place for your organization to have conversations that aren''t specific to a single repository within your organization.' +intro: 'You can use {% data variables.product.prodname_discussions %} in an organization as a place for your organization to have conversations that aren''t specific to a single repository within your organization.' permissions: 'Organization owners can enable {% data variables.product.prodname_discussions %} for their organization.' versions: feature: discussions diff --git a/content/packages/index.md b/content/packages/index.md index 7999a46e7f..135fbcf6bc 100644 --- a/content/packages/index.md +++ b/content/packages/index.md @@ -18,6 +18,7 @@ featuredLinks: guideCards: - '{% ifversion docker-ghcr-enterprise-migration %}/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry{% endif %}' - '{% ifversion fpt or ghec or ghes > 3.4 %}/packages/working-with-a-github-packages-registry/working-with-the-container-registry{% else %}/packages/working-with-a-github-packages-registry/working-with-the-docker-registry{% endif %}' + - '{% ifversion packages-npm-v2 %}/packages/working-with-a-github-packages-registry/working-with-the-npm-registry{% endif %}' - /packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry changelog: label: packages diff --git a/content/packages/learn-github-packages/about-permissions-for-github-packages.md b/content/packages/learn-github-packages/about-permissions-for-github-packages.md index 7b27d76936..18235d4ef4 100644 --- a/content/packages/learn-github-packages/about-permissions-for-github-packages.md +++ b/content/packages/learn-github-packages/about-permissions-for-github-packages.md @@ -18,20 +18,22 @@ The permissions for packages are either repository-scoped or user/organization-s A repository-scoped package inherits the permissions and visibility of the repository that owns the package. You can find a package scoped to a repository by going to the main page of the repository and clicking the **Packages** link to the right of the page. {% ifversion fpt or ghec %}For more information, see "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)."{% endif %} -The {% data variables.product.prodname_registry %} registries below use repository-scoped permissions: +The {% data variables.product.prodname_registry %} registries below **only** use repository-scoped permissions: {% ifversion not fpt or ghec %}- Docker registry (`docker.pkg.github.com`){% endif %} - - npm registry + {% ifversion packages-npm-v2 %}{% else %}- npm registry{% endif %} - RubyGems registry - Apache Maven registry - NuGet registry +{% ifversion packages-npm-v2 %}For {% data variables.product.prodname_ghcr_and_npm_registry %}, you can choose to allow packages to be scoped to a user, an organization, or linked to a repository.{% endif %} + {% ifversion fpt or ghec %} ## Granular permissions for user/organization-scoped packages Packages with granular permissions are scoped to a personal user or organization account. You can change the access control and visibility of the package separately from a repository that is connected (or linked) to a package. -Currently, only the {% data variables.product.prodname_container_registry %} offers granular permissions for your container image packages. +Currently, the {% data variables.product.prodname_ghcr_and_npm_registry %} offer granular permissions for your container image packages. ## Visibility and access permissions for container images diff --git a/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md b/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md index 9105c5e7bc..3c34034960 100644 --- a/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md +++ b/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md @@ -15,7 +15,7 @@ shortTitle: Access control & visibility Packages with granular permissions are scoped to a personal user or organization account. You can change the access control and visibility of a package separately from the repository that it is connected (or linked) to. -Currently, you can only use granular permissions with the {% data variables.product.prodname_container_registry %}. Granular permissions are not supported in our other package registries, such as the npm registry.{% ifversion docker-ghcr-enterprise-migration %} For more information about migration to the {% data variables.product.prodname_container_registry %}, see "[Migrating to the {% data variables.product.prodname_container_registry %} from the Docker registry](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)."{% endif %} +Currently, you can only use granular permissions with the {% data variables.product.prodname_ghcr_and_npm_registry %}. Granular permissions are not supported in our other package registries, such as the RubyGems registry.{% ifversion docker-ghcr-enterprise-migration %} For more information about migration to the {% data variables.product.prodname_container_registry %}, see "[Migrating to the {% data variables.product.prodname_container_registry %} from the Docker registry](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)."{% endif %} For more information about permissions for repository-scoped packages, packages-related scopes for PATs, or managing permissions for your actions workflows, see "[About permissions for GitHub Packages](/packages/learn-github-packages/about-permissions-for-github-packages)." @@ -105,7 +105,7 @@ To further customize access to your container image, see "[Configuring access to {% ifversion fpt or ghec %} ## Ensuring {% data variables.product.prodname_codespaces %} access to your package -By default, a codespace can seamlessly access certain packages in the {% data variables.product.prodname_dotcom %} Container Registry, such as those published in the same repository with the **Inherit access** option selected. For more information on which access is automatically configured, see "[Accessing images stored in {% data variables.product.prodname_dotcom %} Container Registry](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-images-stored-in-github-container-registry)." +By default, a codespace can seamlessly access certain packages in the {% data variables.product.prodname_ghcr_and_npm_registry %}, such as those published in the same repository with the **Inherit access** option selected. For more information on which access is automatically configured, see "[Allowing your codespace to access a private image registry](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-images-stored-in-container-registry-and-npm-registry)." Otherwise, to ensure that a codespace has access to your package, you must grant access to the repository where the codespace is being launched. diff --git a/content/packages/learn-github-packages/deleting-and-restoring-a-package.md b/content/packages/learn-github-packages/deleting-and-restoring-a-package.md index d4e95b8159..456eca2565 100644 --- a/content/packages/learn-github-packages/deleting-and-restoring-a-package.md +++ b/content/packages/learn-github-packages/deleting-and-restoring-a-package.md @@ -23,12 +23,12 @@ On {% data variables.product.prodname_dotcom %} if you have the required access, - an entire private package - an entire public package, if there's not more than 5000 downloads of any version of the package - a specific version of a private package -- a specific version of a public package, if the package version doesn't have more than 5000 downloads +- a specific version of a public package, if the package version doesn't have more than 5,000 downloads {% note %} **Note:** -- You cannot delete a public package if any version of the package has more than 5000 downloads. In this scenario, contact [GitHub support](https://support.github.com/contact?tags=docs-packages) for further assistance. +- You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact [GitHub support](https://support.github.com/contact?tags=docs-packages) for further assistance. - When deleting public packages, be aware that you may break projects that depend on your package. {% endnote %} @@ -46,7 +46,7 @@ You can use the REST API to manage your packages. For more information, see the {% endif %} -For packages that inherit their permissions and access from repositories, you can use GraphQL to delete a specific package version.{% ifversion fpt or ghec %} The {% data variables.product.prodname_registry %} GraphQL API does not support containers or Docker images that use the package namespace `https://ghcr.io/OWNER/PACKAGE-NAME`.{% endif %} For more information about GraphQL support, see "[Deleting a version of a repository-scoped package with GraphQL](#deleting-a-version-of-a-repository-scoped-package-with-graphql)." +For packages that inherit their permissions and access from repositories, you can use GraphQL to delete a specific package version.{% data reusables.package_registry.no-graphql-to-delete-packages %} For more information about GraphQL support, see "[Deleting a version of a repository-scoped package with GraphQL](#deleting-a-version-of-a-repository-scoped-package-with-graphql)." {% endif %} @@ -54,18 +54,19 @@ For packages that inherit their permissions and access from repositories, you ca For packages that inherit their access permissions from repositories, you can delete a package if you have admin permissions to the repository. -Repository-scoped packages on {% data variables.product.prodname_registry %} include these packages: -- npm -- RubyGems -- maven -- Gradle -- NuGet -{% ifversion not fpt or ghec %}- Docker images at `docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`{% endif %} +The {% data variables.product.prodname_registry %} registries below **only** use repository-scoped permissions: + + {% ifversion not fpt or ghec %}- Docker images at `docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`{% endif %} + {% ifversion packages-npm-v2 %}{% else %}- npm{% endif %} + - RubyGems registry + - Apache Maven registry + - NuGet registry + +{% ifversion packages-npm-v2 %}For {% data variables.product.prodname_ghcr_and_npm_registry %}, you can choose to allow packages to be scoped to a user, an organization, or linked to a repository.{% endif %} {% ifversion fpt or ghec %} -To delete a package that has granular permissions separate from a repository, such as container images stored at `https://ghcr.io/OWNER/PACKAGE-NAME`, you must have admin access to the package. -For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." +To delete a package that has granular permissions separate from a repository, such as container images stored at `https://ghcr.io/OWNER/PACKAGE-NAME` or `https://npm.pkg.github.com/OWNER/PACKAGE-NAME`, you must have admin access to the package. For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." {% endif %} @@ -89,9 +90,7 @@ To delete a version of a repository-scoped package, you must have admin permissi For packages that inherit their permissions and access from repositories, you can use the GraphQL to delete a specific package version. -{% ifversion fpt or ghec %} -For containers or Docker images at `ghcr.io`, GraphQL is not supported but you can use the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." -{% endif %} +{% data reusables.package_registry.no-graphql-to-delete-packages %}{% ifversion fpt or ghec %} You can however use the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)."{% endif %} Use the `deletePackageVersion` mutation in the GraphQL API. You must use a token with the `read:packages`, `delete:packages`, and `repo` scopes. For more information about tokens, see "[About {% data variables.product.prodname_registry %}](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)." diff --git a/content/packages/learn-github-packages/introduction-to-github-packages.md b/content/packages/learn-github-packages/introduction-to-github-packages.md index fc5090006e..5450ffcff9 100644 --- a/content/packages/learn-github-packages/introduction-to-github-packages.md +++ b/content/packages/learn-github-packages/introduction-to-github-packages.md @@ -51,7 +51,7 @@ For more information about the configuration of {% data variables.product.prodna | | | |--------------------|--------------------| -| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_container_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

    For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | +| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_ghcr_and_npm_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

    For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | | Visibility | {% data reusables.package_registry.public-or-private-packages %} | For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." @@ -101,7 +101,9 @@ For more information about Docker and the {% data variables.product.prodname_con ## Managing packages {% ifversion fpt or ghec %} -You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." +You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." + +{% data reusables.package_registry.no-graphql-to-delete-packages %} {% endif %} {% ifversion ghes %} @@ -112,7 +114,9 @@ You can delete a private or public package in the {% data variables.product.prod You can delete a version of a package in the {% data variables.product.product_name %} user interface or using the GraphQL API. {% endif %} -When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and "[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." +When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. + +For more information, see {% ifversion ghes or ghae %}"[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and {% endif %}"[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "[`package` webhook event](/webhooks/event-payloads/#package)." diff --git a/content/packages/learn-github-packages/viewing-packages.md b/content/packages/learn-github-packages/viewing-packages.md index 4723416942..4c67fda41e 100644 --- a/content/packages/learn-github-packages/viewing-packages.md +++ b/content/packages/learn-github-packages/viewing-packages.md @@ -21,17 +21,17 @@ versions: ## About package views -Your ability to view a package depends on several factors. By default, you can view all packages you have published. +Your ability to view a package depends on several factors. By default, you can view all packages you have published. -Repository-scoped packages inherit their permissions and visibility from the repository that owns the package. The registries below use this type of permissions:{% ifversion not fpt or ghec %} +Repository-scoped packages inherit their permissions and visibility from the repository that owns the package. The registries below **only** use this type of permissions:{% ifversion not fpt or ghec %} - Docker registry (`docker.pkg.github.com`){% endif %} -- npm registry +{% ifversion packages-npm-v2 %}{% else %}- npm registry{% endif %} - RubyGems registry - Apache Maven registry - NuGet registry {% ifversion fpt or ghec %} -The Container registry offers you the option of granular permissions and visibility settings that can be customized for each package owned by a personal user or organization account. You can choose to use granular permissions or connect the package to a repository and inherit it's permissions. For more information, see "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)." +The {% data variables.product.prodname_ghcr_and_npm_registry %} offer you the option of granular permissions and visibility settings that can be customized for each package owned by a personal user or organization account. You can choose to use granular permissions or connect the package to a repository and inherit it's permissions. For more information, see "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)." {% endif %} For more information, see "[About permissions for GitHub Packages](/packages/learn-github-packages/about-permissions-for-github-packages){% ifversion fpt or ghec %}" and "[Configuring a package's access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility){% endif %}." diff --git a/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md b/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md index abf40d8435..6b3f8fc7cd 100644 --- a/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md +++ b/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md @@ -24,9 +24,9 @@ shortTitle: Publish & install with Actions You can extend the CI and CD capabilities of your repository by publishing or installing packages as part of your workflow. {% ifversion fpt or ghec %} -### Authenticating to the {% data variables.product.prodname_container_registry %} +### Authenticating to the {% data variables.product.prodname_ghcr_and_npm_registry %} -{% data reusables.package_registry.authenticate_with_pat_for_container_registry %} +{% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} {% endif %} @@ -40,7 +40,7 @@ You can reference the `GITHUB_TOKEN` in your workflow file using the {% raw %}`{ {% note %} -**Note:** Repository-owned packages include RubyGems, npm, Apache Maven, NuGet, {% ifversion fpt or ghec %}and Gradle. {% else %}Gradle, and Docker packages that use the package namespace `docker.pkg.github.com`.{% endif %} +**Note:** Some registries, such as RubyGems, {% ifversion packages-npm-v2 %}{% else %}npm, {% endif %}Apache Maven, NuGet, {% ifversion fpt or ghec %}and Gradle{% else %}Gradle, and Docker packages that use the package namespace `docker.pkg.github.com`{% endif %}, only allow repository-owned packages. With {% data variables.product.prodname_ghcr_and_npm_registry_full %} you can choose to allow packages to be owned by a user, an organization, or linked to a repository. {% endnote %} @@ -49,11 +49,11 @@ When you enable GitHub Actions, GitHub installs a GitHub App on your repository. {% data variables.product.prodname_registry %} allows you to push and pull packages through the `GITHUB_TOKEN` available to a {% data variables.product.prodname_actions %} workflow. {% ifversion fpt or ghec %} -## About permissions and package access for {% data variables.product.prodname_container_registry %} +## About permissions and package access for {% data variables.product.prodname_ghcr_and_npm_registry %} -The {% data variables.product.prodname_container_registry %} (`ghcr.io`) allows users to create and administer containers as free-standing resources at the organization level. Containers can be owned by an organization or personal account and you can customize access to each of your containers separately from repository permissions. +The {% data variables.product.prodname_ghcr_and_npm_registry_full %} allows users to create and administer packages as free-standing resources at the organization level. Packages can be owned by an organization or personal account and you can customize access to each of your packages separately from repository permissions. -All workflows accessing the {% data variables.product.prodname_container_registry %} should use the `GITHUB_TOKEN` instead of a personal access token. For more information about security best practices, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)." +All workflows accessing the {% data variables.product.prodname_ghcr_and_npm_registry %} should use the `GITHUB_TOKEN` instead of a personal access token. For more information about security best practices, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)." ## Default permissions and access settings for containers modified through workflows @@ -484,9 +484,9 @@ Installing packages hosted by {% data variables.product.prodname_registry %} thr {% data reusables.package_registry.actions-configuration %} {% ifversion fpt or ghec %} -## Upgrading a workflow that accesses `ghcr.io` +## Upgrading a workflow that accesses a registry using a PAT -The {% data variables.product.prodname_container_registry %} supports the `GITHUB_TOKEN` for easy and secure authentication in your workflows. If your workflow is using a personal access token (PAT) to authenticate to `ghcr.io`, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. +The {% data variables.product.prodname_ghcr_and_npm_registry %} support the `GITHUB_TOKEN` for easy and secure authentication in your workflows. If your workflow is using a personal access token (PAT) to authenticate to the registry, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. For more information about the `GITHUB_TOKEN`, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)." @@ -504,9 +504,9 @@ Using the `GITHUB_TOKEN` instead of a PAT, which includes the `repo` scope, incr {% endnote %} 1. Optionally, using the "role" drop-down menu, select the default access level that you'd like the repository to have to your container image. ![Permission access levels to give to repositories](/assets/images/help/package-registry/repository-permission-options-for-package-access-through-actions.png) -1. Open your workflow file. On the line where you log in to `ghcr.io`, replace your PAT with {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. +1. Open your workflow file. On the line where you log in to the registry, replace your PAT with {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. -For example, this workflow publishes a Docker image using {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} to authenticate. +For example, this workflow publishes a Docker image to the {% data variables.product.prodname_container_registry %} and uses {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} to authenticate. ```yaml{:copy} name: Demo Push diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md index 02708a404d..98ac905c0a 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md @@ -42,7 +42,9 @@ When installing or publishing a Docker image, the {% data variables.product.prod ## Authenticating to the {% data variables.product.prodname_container_registry %} -{% data reusables.package_registry.authenticate_with_pat_for_container_registry %} +{% ifversion fpt or ghec or ghes > 3.4 %} +To authenticate to the {% data variables.product.prodname_container_registry %} (`ghcr.io`) within a {% data variables.product.prodname_actions %} workflow, use the `GITHUB_TOKEN` for the best security and experience. {% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} +{% endif %} {% ifversion ghes %}Ensure that you replace `HOSTNAME` with {% data variables.product.product_location_enterprise %} hostname or IP address in the examples below.{% endif %} diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md index 6714384e4d..8007cd2b6f 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -21,6 +21,8 @@ shortTitle: npm registry {% data reusables.package_registry.admins-can-configure-package-types %} +{% ifversion packages-npm-v2 %} +{% else %} ## Limits for published npm versions If you publish over 1,000 npm package versions to {% data variables.product.prodname_registry %}, you may see performance issues and timeouts occur during usage. @@ -28,12 +30,17 @@ If you publish over 1,000 npm package versions to {% data variables.product.prod In the future, to improve performance of the service, you won't be able to publish more than 1,000 versions of a package on {% data variables.product.prodname_dotcom %}. Any versions published before hitting this limit will still be readable. If you reach this limit, consider deleting package versions or contact Support for help. When this limit is enforced, our documentation will be updated with a way to work around this limit. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" or "[Contacting Support](/packages/learn-github-packages/about-github-packages#contacting-support)." +{% endif %} ## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} -{% data reusables.package_registry.authenticate-packages-github-token %} +{% ifversion packages-npm-v2 %} +{% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} + +You can also choose to give access permissions to packages independently for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_actions %}. For more information, see "[Ensuring Codespaces access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-codespaces-access-to-your-package) and [Ensuring workflow access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package)." +{% endif %} ### Authenticating with a personal access token @@ -94,12 +101,24 @@ $ npm login --scope=@OWNER --registry=https://HOSTNAME/_regist {% endnote %} -By default, {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the name field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. You can add a summary for the package listing page by including a *README.md* file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. +{% ifversion packages-npm-v2 %} +The {% data variables.product.prodname_registry %} registry stores npm packages within your organization or personal account, and allows you to associate a package with a repository. You can choose whether to inherit permissions from a repository, or set granular permissions independently of a repository. +{% endif %} + +By default, {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the name field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. If you're running [npm v8.5.3](https://github.com/npm/cli/releases/tag/v8.5.3) or later, you can add a summary for the package listing page by including a *README.md* file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. You can publish multiple packages to the same {% data variables.product.prodname_dotcom %} repository by including a `URL` field in the *package.json* file. For more information, see "[Publishing multiple packages to the same repository](#publishing-multiple-packages-to-the-same-repository)." +{% ifversion fpt or ghec %} +When a package is published, it isn't automatically linked to a repository. You can however choose to link your published package to a repository using the user interface or command line. For more information, see "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)." +{% endif %} + You can set up the scope mapping for your project using either a local *.npmrc* file in the project or using the `publishConfig` option in the *package.json*. {% data variables.product.prodname_registry %} only supports scoped npm packages. Scoped packages have names with the format of `@owner/name`. Scoped packages always begin with an `@` symbol. You may need to update the name in your *package.json* to use the scoped name. For example, `"name": "@codertocat/hello-world-npm"`. +{% ifversion packages-npm-v2 %} +When you first publish a package, the default visibility is private. When a package is linked to repository, the package visibility is dependent on the repository's visibility. To change the visibility or set access permissions, see "[Configuring a package's access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." +{% endif %} + {% data reusables.package_registry.viewing-packages %} ### Publishing a package using a local *.npmrc* file diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index b844e2251b..05e0b384b9 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -47,7 +47,7 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl {% data reusables.pages.sidebar-pages %} 4. Under "Custom domain", type your custom domain, then click **Save**. If you are publishing your site from a branch, this will create a commit that adds a `CNAME` file to the root of your source branch. If you are publishing your site with a custom {% data variables.product.prodname_actions %} workflow , no `CNAME` file is created. For more information about your publishing source, see "[Configuring a publishing source for your GitHub Pages site](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." ![Save custom domain button](/assets/images/help/pages/save-custom-subdomain.png) -5. Navigate to your DNS provider and create a `CNAME` record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `www.example.com` for your user site, create a `CNAME` record that points `www.example.com` to `.github.io`. If you want to use the subdomain `www.anotherexample.com` for your organization site, create a `CNAME` record that points `www.anotherexample.com` to `.github.io`. The `CNAME` record should always point to `.github.io` or `.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} +5. Navigate to your DNS provider and create a `CNAME` record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `www.example.com` for your user site, create a `CNAME` record that points `www.example.com` to `.github.io`. If you want to use the subdomain `another.example.com` for your organization site, create a `CNAME` record that points `another.example.com` to `.github.io`. The `CNAME` record should always point to `.github.io` or `.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} {% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %} {% data reusables.command_line.open_the_multi_os_terminal %} diff --git a/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md b/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md deleted file mode 100644 index af19845c4e..0000000000 --- a/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: Adding a theme to your GitHub Pages site with the theme chooser -intro: 'You can add a theme to your {% data variables.product.prodname_pages %} site to customize your site’s look and feel.' -redirect_from: - - /articles/creating-a-github-pages-site-with-the-jekyll-theme-chooser - - /articles/adding-a-jekyll-theme-to-your-github-pages-site-with-the-jekyll-theme-chooser - - /articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser - - /github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser -product: '{% data reusables.gated-features.pages %}' -versions: - fpt: '*' - ghec: '*' -topics: - - Pages -shortTitle: Add theme to a Pages site -permissions: People with admin permissions for a repository can use the theme chooser to add a theme to a {% data variables.product.prodname_pages %} site. ---- - -## About the theme chooser - -{% ifversion pages-custom-workflow %} - -{% note %} - -**Note**: The Jekyll theme chooser is not supported for {% data variables.product.prodname_pages %} sites that are published with a custom {% data variables.product.prodname_actions %} workflow. If you build your site with Jekyll and publish your site with a custom {% data variables.product.prodname_actions %} workflow, you can add a theme by editing the `_config.yml` file. For more information, see "[Adding a theme to your GitHub Pages site using Jekyll](/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll)." - -{% endnote %} - -{% endif %} - -The theme chooser adds a Jekyll theme to your repository. For more information about Jekyll, see "[About {% data variables.product.prodname_pages %} and Jekyll](/articles/about-github-pages-and-jekyll)." - -How the theme chooser works depends on whether your repository is public or private. - - If {% data variables.product.prodname_pages %} is already enabled for your repository, the theme chooser will add your theme to the current publishing source. - - If your repository is public and {% data variables.product.prodname_pages %} is disabled for your repository, using the theme chooser will enable {% data variables.product.prodname_pages %} and configure the default branch as your publishing source. - - If your repository is private and {% data variables.product.prodname_pages %} is disabled for your repository, you must enable {% data variables.product.prodname_pages %} by configuring a publishing source before you can use the theme chooser. - -For more information about publishing sources, see "[About {% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)." - -If you manually added a Jekyll theme to your repository in the past, those files may be applied even after you use the theme chooser. To avoid conflicts, remove all manually added theme folders and files before using the theme chooser. For more information, see "[Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)." - -## Adding a theme with the theme chooser - -{% data reusables.pages.navigate-site-repo %} -{% data reusables.repositories.sidebar-settings %} -{% data reusables.pages.sidebar-pages %} -3. Under "{% data variables.product.prodname_pages %}," click **Choose a theme** or **Change theme**. - ![Choose a theme button](/assets/images/help/pages/choose-a-theme.png) -4. On the top of the page, click the theme you want, then click **Select theme**. - ![Theme options and Select theme button](/assets/images/help/pages/select-theme.png) -5. You may be prompted to edit your site's *README.md* file. - - To edit the file later, click **Cancel**. - ![Cancel link when editing a file](/assets/images/help/pages/cancel-edit.png) - - To edit the file now, see "[Editing files](/repositories/working-with-files/managing-files/editing-files)." - -Your chosen theme will automatically apply to markdown files in your repository. To apply your theme to HTML files in your repository, you need to add YAML front matter that specifies a layout to each file. For more information, see "[Front Matter](https://jekyllrb.com/docs/front-matter/)" on the Jekyll site. - -## Further reading - -- [Themes](https://jekyllrb.com/docs/themes/) on the Jekyll site diff --git a/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md b/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md index 4c6ebdd4e5..6316dc931b 100644 --- a/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md +++ b/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md @@ -60,9 +60,9 @@ shortTitle: Create a GitHub Pages site You can add more pages to your site by creating more new files. Each file will be available on your site in the same directory structure as your publishing source. For example, if the publishing source for your project site is the `gh-pages` branch, and you create a new file called `/about/contact-us.md` on the `gh-pages` branch, the file will be available at {% ifversion fpt or ghec %}`https://.github.io//{% else %}`http(s):///pages///{% endif %}about/contact-us.html`. -You can also add a theme to customize your site’s look and feel. For more information, see {% ifversion fpt or ghec %}"[Adding a theme to your {% data variables.product.prodname_pages %} site with the theme chooser](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser){% else %}"[Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll){% endif %}." +You can also add a theme to customize your site’s look and feel. For more information, see "[Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)". -To customize your site even more, you can use Jekyll, a static site generator with built-in support for {% data variables.product.prodname_pages %}. For more information, see "[About {% data variables.product.prodname_pages %} and Jekyll](/articles/about-github-pages-and-jekyll)." +To customize your site even more, you can use Jekyll, a static site generator with built-in support for {% data variables.product.prodname_pages %}. For more information, see "[About {% data variables.product.prodname_pages %} and Jekyll](/articles/about-github-pages-and-jekyll)". ## Further reading diff --git a/content/pages/getting-started-with-github-pages/index.md b/content/pages/getting-started-with-github-pages/index.md index b391a4458c..3abb166163 100644 --- a/content/pages/getting-started-with-github-pages/index.md +++ b/content/pages/getting-started-with-github-pages/index.md @@ -17,7 +17,6 @@ topics: children: - /about-github-pages - /creating-a-github-pages-site - - /adding-a-theme-to-your-github-pages-site-with-the-theme-chooser - /configuring-a-publishing-source-for-your-github-pages-site - /changing-the-visibility-of-your-github-pages-site - /creating-a-custom-404-page-for-your-github-pages-site @@ -26,4 +25,3 @@ children: - /unpublishing-a-github-pages-site shortTitle: Get started --- - diff --git a/content/pages/index.md b/content/pages/index.md index 39b8e7df97..9b5f192f7f 100644 --- a/content/pages/index.md +++ b/content/pages/index.md @@ -12,7 +12,6 @@ featuredLinks: - '{% ifversion fpt or ghec %}/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site{% endif %}' - '{% ifversion ghes or ghae %}/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll{% endif %}' - '{% ifversion ghec %}/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site{% endif %}' - - '{% ifversion fpt %}/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser{% endif %}' - '{% ifversion ghes or ghae %}/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll{% endif %}' popular: - '{% ifversion fpt or ghec %}/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages{% endif %}' @@ -51,4 +50,3 @@ children: - /setting-up-a-github-pages-site-with-jekyll - /configuring-a-custom-domain-for-your-github-pages-site --- - diff --git a/content/pages/quickstart.md b/content/pages/quickstart.md index 519a6f0085..30362440dd 100644 --- a/content/pages/quickstart.md +++ b/content/pages/quickstart.md @@ -27,13 +27,12 @@ This guide will lead you through creating a user site at `username.github.io`. ![Repository name field](/assets/images/help/pages/create-repository-name-pages.png) {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -1. Click **Choose a theme**. - ![Choose a theme button](/assets/images/help/pages/choose-theme.png) -2. The Theme Chooser will open. Browse the available themes, then click **Select theme** to select a theme. It's easy to change your theme later, so if you're not sure, just choose one for now. - ![Theme options and Select theme button](/assets/images/help/pages/select-theme.png) -3. After you select a theme, your repository's `README.md` file will open in the file editor. The `README.md` file is where you will write the content for your site. You can edit the file or keep the default content for now. -4. When you are done editing the file, click **Commit changes**. -5. Visit `username.github.io` to view your new website. **Note:** It can take up to 20 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}. +1. Under "Build and deployment", under "Source", select **Deploy from a branch**. +1. Under "Build and deployment", under "Branch", use the **None** or **Branch** drop-down menu and select a publishing source. + + ![Drop-down menu to select a publishing source](/assets/images/help/pages/publishing-source-drop-down.png) +1. Optionally, open the `README.md` file of your repository. The `README.md` file is where you will write the content for your site. You can edit the file or keep the default content for now. +1. Visit `username.github.io` to view your new website. **Note:** It can take up to 10 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}. ## Changing the title and description diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md index 9491879d40..68434b0b94 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md @@ -75,9 +75,9 @@ You can add `site.github` to a post or page to add any repository references met {% data reusables.pages.add-jekyll-theme %} For more information, see "[Themes](https://jekyllrb.com/docs/themes/)" in the Jekyll documentation. {% ifversion fpt or ghec %} -You can add a supported theme to your site on {% data variables.product.prodname_dotcom %}. For more information, see "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site and "[Adding a theme to your {% data variables.product.prodname_pages %} site with the theme chooser](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser)." +You can add a supported theme to your site on {% data variables.product.prodname_dotcom %}. For more information, see "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site and [Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll"](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll). -To use any other open source Jekyll theme hosted on {% data variables.product.prodname_dotcom %}, you can add the theme manually.{% else %} You can add a theme to your site manually.{% endif %} For more information, see{% ifversion fpt or ghec %} [themes hosted on {% data variables.product.prodname_dotcom %}](https://github.com/topics/jekyll-theme) and{% else %} "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site and{% endif %} "[Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)." +To use any other open source Jekyll theme hosted on {% data variables.product.prodname_dotcom %}, you can add the theme manually.{% else %} You can add a theme to your site manually.{% endif %} For more information, see{% ifversion fpt or ghec %} [themes hosted on {% data variables.product.prodname_dotcom %}](https://github.com/topics/jekyll-theme) and{% else %} "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site and{% endif %} "[Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)". You can override any of your theme's defaults by editing the theme's files. For more information, see your theme's documentation and "[Overriding your theme's defaults](https://jekyllrb.com/docs/themes/#overriding-theme-defaults)" in the Jekyll documentation. @@ -96,7 +96,7 @@ You can download or create Jekyll plugins to extend the functionality of Jekyll - [`jekyll-titles-from-headings`](https://github.com/benbalter/jekyll-titles-from-headings) - [`jekyll-relative-links`](https://github.com/benbalter/jekyll-relative-links) -You can enable additional plugins by adding the plugin's gem to the `plugins` setting in your *_config.yml* file. For more information, see "[Configuration](https://jekyllrb.com/docs/configuration/)" in the Jekyll documentation. +You can enable additional plugins by adding the plugin's gem to the `plugins` setting in your *_config.yml* file. For more information, see "[Configuration](https://jekyllrb.com/docs/configuration/)" in the Jekyll documentation. For a list of supported plugins, see "[Dependency versions](https://pages.github.com/versions/)" on the {% data variables.product.prodname_pages %} site. For usage information for a specific plugin, see the plugin's documentation. diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md index 9e84172aa2..8579be29e2 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md @@ -26,7 +26,7 @@ shortTitle: Jekyll build errors for Pages {% note %} -**Note:** It can take up to 20 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}. +**Note:** It can take up to 10 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}. {% endnote %} diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md index 0f99b32644..3ef2f5709f 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md @@ -6,6 +6,7 @@ redirect_from: - /articles/adding-a-jekyll-theme-to-your-github-pages-site - /articles/adding-a-theme-to-your-github-pages-site-using-jekyll - /github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-using-jekyll + - /pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser product: '{% data reusables.gated-features.pages %}' versions: fpt: '*' diff --git a/content/rest/apps/installations.md b/content/rest/apps/installations.md index 52384aab04..3f06ce80d6 100644 --- a/content/rest/apps/installations.md +++ b/content/rest/apps/installations.md @@ -17,4 +17,4 @@ versions: An _installation_ refers to any user or organization account that has installed the app. For information on how to authenticate as an installation and limit access to specific repositories, see "[Authenticating as an installation](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)." -To list all GitHub App installations for an organization, see "[List app installations for an organization](/rest/reference/orgs#list-app-installations-for-an-organization)." +To list all GitHub App installations for an organization, see "[List app installations for an organization](/rest/orgs/orgs#list-app-installations-for-an-organization)." diff --git a/content/rest/deployments/deployments.md b/content/rest/deployments/deployments.md index c371a1c819..0cd2b42859 100644 --- a/content/rest/deployments/deployments.md +++ b/content/rest/deployments/deployments.md @@ -20,7 +20,7 @@ Deployment statuses allow external services to mark deployments with an `error`, Deployment statuses can also include an optional `description` and `log_url`, which are highly recommended because they make deployment statuses more useful. The `log_url` is the full URL to the deployment output, and the `description` is a high-level summary of what happened with the deployment. -GitHub dispatches `deployment` and `deployment_status` events when new deployments and deployment statuses are created. These events allows third-party integrations to receive respond to deployment requests and update the status of a deployment as progress is made. +GitHub dispatches `deployment` and `deployment_status` events when new deployments and deployment statuses are created. These events allow third-party integrations to receive and respond to deployment requests, and update the status of a deployment as progress is made. Below is a simple sequence diagram for how these interactions would work. diff --git a/content/rest/guides/getting-started-with-the-checks-api.md b/content/rest/guides/getting-started-with-the-checks-api.md index 2c60bf90f8..7388ae96bb 100644 --- a/content/rest/guides/getting-started-with-the-checks-api.md +++ b/content/rest/guides/getting-started-with-the-checks-api.md @@ -41,7 +41,7 @@ A check run is an individual test that is part of a check suite. Each run includ ![Check runs workflow](/assets/images/check_runs.png) -If a check run is in a incomplete state for more than 14 days, then the check run's `conclusion` becomes `stale` and appears on {% data variables.product.prodname_dotcom %} as stale with {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Only {% data variables.product.prodname_dotcom %} can mark check runs as `stale`. For more information about possible conclusions of a check run, see the [`conclusion` parameter](/rest/reference/checks#create-a-check-run--parameters). +If a check run is in an incomplete state for more than 14 days, then the check run's `conclusion` becomes `stale` and appears on {% data variables.product.prodname_dotcom %} as stale with {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Only {% data variables.product.prodname_dotcom %} can mark check runs as `stale`. For more information about possible conclusions of a check run, see the [`conclusion` parameter](/rest/reference/checks#create-a-check-run--parameters). As soon as you receive the [`check_suite`](/webhooks/event-payloads/#check_suite) webhook, you can create the check run, even if the check is not complete. You can update the `status` of the check run as it completes with the values `queued`, `in_progress`, or `completed`, and you can update the `output` as more details become available. A check run can contain timestamps, a link to more details on your external site, detailed annotations for specific lines of code, and information about the analysis performed. diff --git a/content/rest/guides/getting-started-with-the-rest-api.md b/content/rest/guides/getting-started-with-the-rest-api.md index e4f9dfe075..dd9545f30b 100644 --- a/content/rest/guides/getting-started-with-the-rest-api.md +++ b/content/rest/guides/getting-started-with-the-rest-api.md @@ -1,9 +1,6 @@ --- title: Getting started with the REST API -intro: 'Learn the foundations for using the REST API, starting with authentication and some endpoint examples.' -redirect_from: - - /guides/getting-started - - /v3/guides/getting-started +intro: 'Learn how to use the {% data variables.product.prodname_dotcom %} REST API.' versions: fpt: '*' ghes: '*' @@ -11,477 +8,754 @@ versions: ghec: '*' topics: - API -shortTitle: Get started - REST API +shortTitle: Using the API +miniTocMaxHeadingLevel: 3 --- +## About the {% data variables.product.prodname_dotcom %} REST API -Let's walk through core API concepts as we tackle some everyday use cases. +This article describes how to use the {% data variables.product.prodname_dotcom %} REST API using {% data variables.product.prodname_cli %}, JavaScript, or cURL. For a quickstart guide, see "[Quickstart for GitHub REST API](/rest/quickstart)." -{% data reusables.rest-api.dotcom-only-guide-note %} +When you make a request to the REST API, you will specify an HTTP method and a path. Additionally, you might also specify request headers and path, query, or body parameters. The API will return the response status code, response headers, and potentially a response body. -## Overview +The REST API reference documentation describes the HTTP method, path, and parameters for every operation. It also displays example requests and responses for each operation. For more information, see the [REST reference documentation](/rest). -Most applications will use an existing [wrapper library][wrappers] in the language -of your choice, but it's important to familiarize yourself with the underlying API -HTTP methods first. +## Making a request -There's no easier way to kick the tires than through [cURL][curl].{% ifversion fpt or ghec %} If you are using -an alternative client, note that you are required to send a valid -[User Agent header](/rest/overview/resources-in-the-rest-api#user-agent-required) in your request.{% endif %} +To make a request, first find the HTTP method and the path for the operation that you want to use. For example, the "Get Octocat" operation uses the `GET` method and the `/octocat` path. For the full reference documentation for this operation, see "[Get Octocat](/rest/meta#get-octocat)." -### Hello World +{% cli %} -Let's start by testing our setup. Open up a command prompt and enter the -following command: +{% note %} + +**Note**: You must install {% data variables.product.prodname_cli %} in order to use the commands in the {% data variables.product.prodname_cli %} examples. For installation instructions, see the [{% data variables.product.prodname_cli %} repository](https://github.com/cli/cli#installation). + +{% endnote %} + +If you are not already authenticated to {% data variables.product.prodname_cli %}, you must use the `gh auth login` subcommand to authenticate before making any requests. For more information, see "[Authenticating](#authenticating)." + +To make a request using {% data variables.product.prodname_cli %}, use the `api` subcommand along with the path. Use the `--method` or `-X` flag to specify the method. ```shell -$ curl https://api.github.com/zen - -> Keep it logically awesome. +gh api /octocat --method GET ``` -The response will be a random selection from our design philosophies. +{% endcli %} -Next, let's `GET` [Chris Wanstrath's][defunkt github] [GitHub profile][users api]: +{% javascript %} + +{% note %} + +**Note**: You must install and import `octokit` in order to use the Octokit.js library used in the JavaScript examples. For more information, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). + +{% endnote %} + +To make a request using JavaScript, you can use Octokit.js. For more information, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). + +First, create an instance of `Octokit`.{% ifversion ghes or ghae %} Set the base URL to `{% data variables.product.api_url_code %}`. Replace `[hostname]` with the name of {% data variables.product.product_location %}.{% endif %} + +```javascript +const octokit = new Octokit({ {% ifversion ghes or ghae %} + baseUrl: "{% data variables.product.api_url_code %}", +{% endif %}}); +``` + +Then, use the `request` method to make requests. Pass the HTTP method and path as the first argument. + +```javascript +await octokit.request("GET /octocat", {}); +``` + +{% endjavascript %} + +{% curl %} + +Prepend the base URL for the {% data variables.product.prodname_dotcom %} REST API, `{% data variables.product.api_url_code %}`, to the path to get the full URL: `{% data variables.product.api_url_code %}/octocat`.{% ifversion ghes or ghae %} Replace `[hostname]` with the name of {% data variables.product.product_location %}.{% endif %} + +Use the `curl` command in your command line. Use the `--request` or `-X` flag followed by the HTTP method. Use the `--url` flag followed by the full URL. ```shell -# GET /users/defunkt -$ curl https://api.github.com/users/defunkt - -> { -> "login": "defunkt", -> "id": 2, -> "node_id": "MDQ6VXNlcjI=", -> "avatar_url": "https://avatars.githubusercontent.com/u/2?v=4", -> "gravatar_id": "", -> "url": "https://api.github.com/users/defunkt", -> "html_url": "https://github.com/defunkt", -> ... -> } +curl --request GET \ +--url "https://api.github.com/octocat" ``` -Mmmmm, tastes like [JSON][json]. Let's add the `-i` flag to include headers: +{% note %} + +**Note**: If you get a message similar to "command not found: curl", you may need to download and install cURL. For more information, see [the cURL project download page](https://curl.se/download.html). + +{% endnote %} + +{% endcurl %} + +Continue reading to learn how to authenticate, send parameters, and use the response. + +## Authenticating + +Many operations require authentication or return additional information if you are authenticated. Additionally, you can make more requests per hour when you are authenticated.{% cli %} Although some REST API operations are accessible without authentication, you must authenticate to {% data variables.product.prodname_cli %} in order to use the `api` subcommand.{% endcli %} + +### About tokens + +You can authenticate your request by adding a token. + +If you want to use the {% data variables.product.company_short %} REST API for personal use, you can create a personal access token (PAT). The REST API operations used in this article require `repo` scope for personal access tokens. Other operations may require different scopes. For more information about creating a personal access token, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + +If you want to use the API on behalf of an organization or another user, {% data variables.product.company_short %} recommends that you use a {% data variables.product.prodname_github_app %}. If an operation is available to {% data variables.product.prodname_github_apps %}, the REST reference documentation for that operation will say "Works with GitHub Apps." The REST API operations used in this article require `issues` read and write permissions for {% data variables.product.prodname_github_apps %}. Other operations may require different permissions. For more information, see "[Creating a GitHub App](/developers/apps/building-github-apps/creating-a-github-app)", "[Authenticating with GitHub Apps](/developers/apps/building-github-apps/authenticating-with-github-apps), and "[Identifying and authorizing users for GitHub Apps](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps)." + +If you want to use the API in a {% data variables.product.prodname_actions %} workflow, {% data variables.product.company_short %} recommends that you authenticate with the built-in `GITHUB_TOKEN` instead of creating a token. You can grant permissions to the `GITHUB_TOKEN` with the `permissions` key. For more information, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token)." + +### Authentication example + +{% cli %} + +With {% data variables.product.prodname_cli %}, you don't need to create an access token in advance. Use the `auth login` subcommand to authenticate to {% data variables.product.prodname_cli %}: ```shell -$ curl -i https://api.github.com/users/defunkt - -> HTTP/2 200 -> server: GitHub.com -> date: Thu, 08 Jul 2021 07:04:08 GMT -> content-type: application/json; charset=utf-8 -> cache-control: public, max-age=60, s-maxage=60 -> vary: Accept, Accept-Encoding, Accept, X-Requested-With -> etag: W/"61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0" -> last-modified: Fri, 01 Nov 2019 21:56:00 GMT -> x-github-media-type: github.v3; format=json -> access-control-expose-headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, Deprecation, Sunset -> access-control-allow-origin: * -> strict-transport-security: max-age=31536000; includeSubdomains; preload -> x-frame-options: deny -> x-content-type-options: nosniff -> x-xss-protection: 0 -> referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin -> content-security-policy: default-src 'none' -> x-ratelimit-limit: 60 -> x-ratelimit-remaining: 53 -> x-ratelimit-reset: 1625731053 -> x-ratelimit-resource: core -> x-ratelimit-used: 7 -> accept-ranges: bytes -> content-length: 1305 -> x-github-request-id: 9F60:7019:ACC5CD5:B03C931:60E6A368 -> -> { -> "login": "defunkt", -> "id": 2, -> "node_id": "MDQ6VXNlcjI=", -> "avatar_url": "https://avatars.githubusercontent.com/u/2?v=4", -> "gravatar_id": "", -> "url": "https://api.github.com/users/defunkt", -> "html_url": "https://github.com/defunkt", -> -> ... -> } +gh auth login ``` -There are a few interesting bits in the response headers. As expected, the -`Content-Type` is `application/json`. +You can use the `--scopes` flag to specify what scopes you want. If you want to authenticate with a token that you created, you can use the `--with-token` flag. For more information, see the [{% data variables.product.prodname_cli %} `auth login` documentation](https://cli.github.com/manual/gh_auth_login). -Any headers beginning with `X-` are custom headers, and are not included in the -HTTP spec. For example, take note of the `X-RateLimit-Limit` and `X-RateLimit-Remaining` headers. This -pair of headers indicate [how many requests a client can make][rate-limiting] in -a rolling time period (typically an hour) and how many of those requests the -client has already spent. +{% endcli %} -## Authentication - -Unauthenticated clients can make 60 requests per hour. To get more requests per hour, we'll need to -_authenticate_. In fact, doing anything interesting with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API requires -[authentication][authentication]. - -### Using personal access tokens - -The easiest and best way to authenticate with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API is by using Basic Authentication [via OAuth tokens](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens). OAuth tokens include [personal access tokens][personal token]. - -Use a `-u` flag to set your username: - -```shell -$ curl -i -u your_username {% data variables.product.api_url_pre %}/users/octocat - -``` - -When prompted, you can enter your OAuth token, but we recommend you set up a variable for it: - -You can use `-u "your_username:$token"` and set up a variable for `token` to avoid leaving your token in shell history, which should be avoided. - -```shell -$ curl -i -u your_username:$token {% data variables.product.api_url_pre %}/users/octocat - -``` - -When authenticating, you should see your rate limit bumped to 5,000 requests an hour, as indicated in the `X-RateLimit-Limit` header. In addition to providing more calls per hour, authentication enables you to read and write private information using the API. - -You can easily [create a **personal access token**][personal token] using your [Personal access tokens settings page][tokens settings]: +{% javascript %} {% warning %} -To help keep your information secure, we highly recommend setting an expiration for your personal access tokens. +**Warning**: Treat your access token like a password. + +To keep your token secure, you can store your token as a secret and run your script through {% data variables.product.prodname_actions %}. For more information, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." + +{% ifversion ghec or fpt %}You can also store your token as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} + +If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. {% endwarning %} -{% ifversion fpt or ghes or ghec %} -![Personal Token selection](/assets/images/personal_token.png) +To authenticate with the Octokit.js library, you can pass your token when you create an instance of `Octokit`. Replace `YOUR-TOKEN` with your token.{% ifversion ghes or ghae %} Replace `[hostname]` with the name of {% data variables.product.product_location %}.{% endif %} + +```javascript +const octokit = new Octokit({ {% ifversion ghes or ghae %} + baseUrl: "{% data variables.product.api_url_code %}",{% endif %} + auth: 'YOUR-TOKEN', +}); +``` + +{% endjavascript %} + +{% curl %} + +{% warning %} + +**Warning**: Treat your access token like a password. + +To help keep your account secure, you can use {% data variables.product.prodname_cli %} instead of cURL. {% data variables.product.prodname_cli %} will take care of authentication for you. For more information, see the {% data variables.product.prodname_cli %} version of this page. + +{% ifversion ghec or fpt %}You can also store your token as a {% data variables.product.prodname_codespaces %} secret and use the command line through {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} + +If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. + +{% endwarning %} + +With cURL, you will send an `Authorization` header with your token. Replace `YOUR-TOKEN` with your token: + +```shell +curl --request GET \ +--url "https://api.github.com/octocat" \ +--header "Authorization: Bearer YOUR-TOKEN" +``` + +{% note %} + +**Note:** In most cases, you can use `Authorization: Bearer` or `Authorization: token`. JSON web tokens (JWTs) will only work with `Authorization: Bearer`. + +{% endnote %} + +{% endcurl %} + +### Authentication example for {% data variables.product.prodname_actions %} + +{% cli %} + +You can also use the `run` keyword to execute {% data variables.product.prodname_cli %} commands in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." + +Instead of using the `gh auth login` command, pass your token as an environment variable called `GH_TOKEN`. {% data variables.product.prodname_dotcom %} recommends that you authenticate with the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." + +```yaml +jobs: + use_api: + runs-on: ubuntu-latest + permissions: {} + steps: + - env: + GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + gh api /octocat +``` + +{% endcli %} + +{% javascript %} + +You can also use the `run` keyword to execute your JavaScript scripts in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." + +{% data variables.product.prodname_dotcom %} recommends that you authenticate with the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." + +The following example workflow: + +1. Checks out the repository content +1. Sets up Node.js +1. Installs `octokit` +1. Stores the value of `GITHUB_TOKEN` as an environment variable called `TOKEN` and runs `.github/actions-scripts/use-the-api.mjs`, which can access that environment variable as `process.env.TOKEN` + +Example workflow: + +```yaml +on: + workflow_dispatch: +jobs: + use_api_via_script: + runs-on: ubuntu-latest + permissions: {} + steps: + - name: Check out repo content + uses: {% data reusables.actions.action-checkout %} + + - name: Setup Node + uses: {% data reusables.actions.action-setup-node %} + with: + node-version: '16.15.0' + cache: npm + + - name: Install dependencies + run: npm install octokit + + - name: Run script + env: + TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + node .github/actions-scripts/use-the-api.mjs +``` + +Example JavaScript script, with the file path `.github/actions-scripts/use-the-api.mjs`: + +```javascript +import { Octokit } from "octokit"; + +const octokit = new Octokit({ {% ifversion ghes or ghae %} + baseUrl: "{% data variables.product.api_url_code %}",{% endif %} + auth: process.env.TOKEN, +}); + +await octokit.request("GET /octocat", {}); +``` + +Instead of storing your script in a separate file and executing the script from your workflow, you can use the `actions/github-script` action to run a script. For more information, see the [actions/github-script README](https://github.com/actions/github-script). + +```yaml +jobs: + use_api_via_script: + runs-on: ubuntu-latest + permissions: {} + steps: + - uses: {% data reusables.actions.action-github-script %} + with: + github-token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + script: | + await github.request('GET /octocat', {}) +``` + +{% endjavascript %} + +{% curl %} + +You can also use the `run` keyword to execute cURL commands in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." + +{% data variables.product.prodname_dotcom %} recommends that you authenticate with the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." + +```yaml +jobs: + use_api: + runs-on: ubuntu-latest + permissions: {} + steps: + - env: + GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + curl --request GET \ + --url "https://api.github.com/octocat" \ + --header "Authorization: Bearer $GH_TOKEN" +``` + +{% endcurl %} + +## Using headers + +Most operations specify that you should pass an `Accept` header with a value of `application/vnd.github.v3+json`. Other operations may specify that you should send a different `Accept` header or additional headers. + +{% cli %} + +To send a header with {% data variables.product.prodname_cli %}, use the `--header` or `-H` flag followed by the header in `key: value` format. + +```shell +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /octocat +``` + +{% endcli %} + +{% javascript %} + +The Octokit.js library automatically passes the `Accept: application/vnd.github.v3+json` header. To pass additional headers or a different `Accept` header, add a `headers` property to the object that is passed as a second argument to the `request` method. The value of the `headers` property is an object with the header names as keys and header values as values. For example, to send a `content-type` header with a value of `text/plain`: + +```javascript +await octokit.request("GET /octocat", { + headers: { + "content-type": "text/plain", + }, +}); +``` + +{% endjavascript %} + +{% curl %} + +To send a header with cURL, use the `--header` or `-H` flag followed by the header in `key: value` format. + +```shell +curl --request GET \ +--url "https://api.github.com/octocat" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" +``` + +{% endcurl %} + +## Using path parameters + +Path parameters modify the operation path. For example, the "List repository issues" path is `/repos/{owner}/{repo}/issues`. The curly brackets `{}` denote path parameters that you need to specify. In this case, you must specify the repository owner and name. For the reference documentation for this operation, see "[List repository issues](/rest/issues/issues#list-repository-issues)." + +{% cli %} + +{% ifversion ghes or ghae %} +{% note %} + +**Note:** In order for this command to work for {% data variables.product.product_location %}, replace `octocat/Spoon-Knife` with a repository owned by {% data variables.product.product_location %}. Otherwise, rerun the `gh auth login` command to authenticate to {% data variables.product.prodname_dotcom_the_website %} instead of {% data variables.product.product_location %}. + +{% endnote %} {% endif %} -{% ifversion ghae %} -![Personal Token selection](/assets/images/help/personal_token_ghae.png) +To get issues from the `octocat/Spoon-Knife` repository, replace `{owner}` with `octocat` and `{repo}` with `Spoon-Knife`. + +```shell +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues +``` + +{% endcli %} + +{% javascript %} + +{% ifversion ghes or ghae %} +{% note %} + +**Note:** In order for this example to work for {% data variables.product.product_location %}, replace `octocat/Spoon-Knife` with a repository owned by {% data variables.product.product_location %}. Otherwise, create a new `Octokit` instance and do not specify `baseURL`. + +{% endnote %} {% endif %} -API requests using an expiring personal access token will return that token's expiration date via the `GitHub-Authentication-Token-Expiration` header. You can use the header in your scripts to provide a warning message when the token is close to its expiration date. +When you make a request with Octokit.js, all parameters, including path parameters, are passed in an object as the second argument to the `request` method. To get issues from the `octocat/Spoon-Knife` repository, specify `owner` as `octocat` and `repo` as `Spoon-Knife`. -### Get your own user profile - -When properly authenticated, you can take advantage of the permissions -associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. For example, try getting -[your own user profile][auth user api]: - -```shell -$ curl -i -u your_username:your_token {% data variables.product.api_url_pre %}/user - -> { -> ... -> "plan": { -> "space": 2516582, -> "collaborators": 10, -> "private_repos": 20, -> "name": "medium" -> } -> ... -> } +```javascript +await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife" +}); ``` -This time, in addition to the same set of public information we -retrieved for [@defunkt][defunkt github] earlier, you should also see the non-public information for your user profile. For example, you'll see a `plan` object in the response which gives details about the {% data variables.product.product_name %} plan for the account. +{% endjavascript %} -### Using OAuth tokens for apps +{% curl %} -Apps that need to read or write private information using the API on behalf of another user should use [OAuth][oauth]. +To get issues from the `octocat/Spoon-Knife` repository, replace `{owner}` with `octocat` and `{repo}` with `Spoon-Knife`. To build the full path, prepend the base URL for the {% data variables.product.prodname_dotcom %} REST API, `https://api.github.com`: `https://api.github.com/repos/octocat/Spoon-Knife/issues`. -OAuth uses _tokens_. Tokens provide two big features: +{% ifversion ghes or ghae %} +{% note %} -* **Revokable access**: users can revoke authorization to third party apps at any time -* **Limited access**: users can review the specific access that a token - will provide before authorizing a third party app +**Note:** If you want to use {% data variables.product.product_location %} instead of {% data variables.product.prodname_dotcom_the_website %}, use `{% data variables.product.api_url_code %}` instead of `https://api.github.com` and replace `[hostname]` with the name of {% data variables.product.product_location %}. Replace `octocat/Spoon-Knife` with a repository owned by {% data variables.product.product_location %}. -Tokens should be created via a [web flow][webflow]. An application -sends users to {% data variables.product.product_name %} to log in. {% data variables.product.product_name %} then presents a dialog -indicating the name of the app, as well as the level of access the app -has once it's authorized by the user. After a user authorizes access, {% data variables.product.product_name %} -redirects the user back to the application: - -![GitHub's OAuth Prompt](/assets/images/oauth_prompt.png) - -**Treat OAuth tokens like passwords!** Don't share them with other users or store -them in insecure places. The tokens in these examples are fake and the names have -been changed to protect the innocent. - -Now that we've got the hang of making authenticated calls, let's move along to -the [Repositories API][repos-api]. - -## Repositories - -Almost any meaningful use of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API will involve some level of Repository -information. We can [`GET` repository details][get repo] in the same way we fetched user -details earlier: +{% endnote %} +{% endif %} ```shell -$ curl -i {% data variables.product.api_url_pre %}/repos/twbs/bootstrap +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" ``` -In the same way, we can [view repositories for the authenticated user][user repos api]: +{% endcurl %} + +The operation returns a list of issues and data about each issue. For more information about using the response, see the "[Using the response](#using-the-response)" section. + +## Using query parameters + +Query parameters allow you to control what data is returned for a request. For example, a query parameter may let you specify how many items are returned when the response is paginated. + +By default, the "List repository issues" operation returns thirty issues, sorted in descending order by the date they were created. You can use the `per_page` parameter to return two issues instead of 30. You can use the `sort` parameter to sort the issues by the date they were last updated instead of by the date they were created. You can use the `direction` parameter to sort the results in ascending order instead of descending order. + +{% cli %} + +For {% data variables.product.prodname_cli %}, use the `-F` flag to pass a parameter that is a number, Boolean, or null. Use `-f` to pass string parameters. + +{% note %} + +**Note**: {% data variables.product.prodname_cli %} does not currently accept parameters that are arrays. For more information, see [this issue](https://github.com/cli/cli/issues/1484). + +{% endnote %} ```shell -$ curl -i -H "Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a" \ - {% data variables.product.api_url_pre %}/user/repos +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 -f sort=updated -f direction=asc ``` -Or, we can [list repositories for another user][other user repos api]: +{% endcli %} + +{% javascript %} + +When you make a request with Octokit.js, all parameters, including query parameters, are passed in an object as the second argument to the `request` method. + +```javascript +await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + per_page: 2, + sort: "updated", + direction: "asc", +}); +``` + +{% endjavascript %} + +{% curl %} + +For cURL, add a `?` to the end of the path, then append your query parameter name and value in the form `parameter_name=value`. Separate multiple query parameters with `&`. ```shell -$ curl -i {% data variables.product.api_url_pre %}/users/octocat/repos +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2&sort=updated&direction=asc" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" ``` -Or, we can [list repositories for an organization][org repos api]: +{% endcurl %} + +The operation returns a list of issues and data about each issue. For more information about using the response, see the "[Using the response](#using-the-response)" section. + +## Using body parameters + +Body parameters allow you to pass additional data to the API. For example, the "Create an issue" operation requires you to specify a title for the new issue. It also lets you specify other information, such as text to put in the issue body. For the full reference documentation for this operation, see "[Create an issue](/rest/issues/issues#create-an-issue)." + +The "Create an issue" operation uses the same path as the "List repository issues" operation in the examples above, but it uses a `POST` method instead of a `GET` method. + +{% cli %} + +For {% data variables.product.prodname_cli %}, use the `-F` flag to pass a parameter that is a number, Boolean, or null. Use `-f` to pass string parameters. + +{% note %} + +**Note**: {% data variables.product.prodname_cli %} does not currently accept parameters that are arrays. For more information, see [this issue](https://github.com/cli/cli/issues/1484). + +{% endnote %} ```shell -$ curl -i {% data variables.product.api_url_pre %}/orgs/octo-org/repos +gh api --header 'Accept: application/vnd.github.v3+json' --method POST /repos/octocat/Spoon-Knife/issues -f title="Created with the REST API" -f body="This is a test issue created by the REST API" ``` -The information returned from these calls will depend on which scopes our token has when we authenticate: +{% endcli %} -{%- ifversion fpt or ghec or ghes %} -* A token with `public_repo` [scope][scopes] returns a response that includes all public repositories we have access to see on {% data variables.product.product_location %}. -{%- endif %} -* A token with `repo` [scope][scopes] returns a response that includes all {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories we have access to see on {% data variables.product.product_location %}. +{% javascript %} -As the [docs][repos-api] indicate, these methods take a `type` parameter that -can filter the repositories returned based on what type of access the user has -for the repository. In this way, we can fetch only directly-owned repositories, -organization repositories, or repositories the user collaborates on via a team. +When you make a request with Octokit.js, all parameters, including body parameters, are passed in an object as the second argument to the `request` method. + +```javascript +await octokit.request("POST /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + title: "Created with the REST API", + body: "This is a test issue created by the REST API", +}); +``` + +{% endjavascript %} + +{% curl %} + +For cURL, use the `--data` flag to pass the body parameters in a JSON object. ```shell -$ curl -i "{% data variables.product.api_url_pre %}/users/octocat/repos?type=owner" +curl --request POST \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" \ +--data '{ + "title": "Created with the REST API", + "body": "This is a test issue created by the REST API" +}' ``` -In this example, we grab only those repositories that octocat owns, not the -ones on which she collaborates. Note the quoted URL above. Depending on your -shell setup, cURL sometimes requires a quoted URL or else it ignores the -query string. +{% endcurl %} -### Create a repository +The operation creates an issue and returns data about the new issue. In the response, find the `html_url` of your issue and navigate to your issue in the browser. For more information about using the response, see the "[Using the response](#using-the-response)" section. -Fetching information for existing repositories is a common use case, but the -{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API supports creating new repositories as well. To [create a repository][create repo], -we need to `POST` some JSON containing the details and configuration options. +## Using the response + +### About the response code and headers + +Every request will return an HTTP status code that indicates the success of the response. For more information about response codes, see [the MDN HTTP response status code documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status). + +Additionally, the response will include headers that give more details about the response. Headers that start with `X-` or `x-` are custom to {% data variables.product.company_short %}. For example, the `x-ratelimit-remaining` and `x-ratelimit-reset` headers tell you how many requests you can make in a time period. + +{% cli %} + +To view the status code and headers, use the `--include` or `--i` flag when you send your request. + +For example, this request: ```shell -$ curl -i -H "Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a" \ - -d '{ - "name": "blog", - "auto_init": true, - "private": true, - "gitignore_template": "nanoc" - }' \ - {% data variables.product.api_url_pre %}/user/repos +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 --include ``` -In this minimal example, we create a new private repository for our blog (to be served -on [GitHub Pages][pages], perhaps). Though the blog {% ifversion not ghae %}will be public{% else %}is accessible to all enterprise members{% endif %}, we've made the repository private. In this single step, we'll also initialize it with a README and a [nanoc][nanoc]-flavored [.gitignore template][gitignore templates]. - -The resulting repository will be found at `https://github.com//blog`. -To create a repository under an organization for which you're -an owner, just change the API method from `/user/repos` to `/orgs//repos`. - -Next, let's fetch our newly created repository: +returns the response code and headers like: ```shell -$ curl -i {% data variables.product.api_url_pre %}/repos/pengwynn/blog - -> HTTP/2 404 - -> { -> "message": "Not Found" -> } +HTTP/2.0 200 OK +Access-Control-Allow-Origin: * +Access-Control-Expose-Headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset +Cache-Control: private, max-age=60, s-maxage=60 +Content-Security-Policy: default-src 'none' +Content-Type: application/json; charset=utf-8 +Date: Thu, 04 Aug 2022 19:56:41 GMT +Etag: W/"a63dfbcfdb73621e9d2e89551edcf9856731ced534bd7f1e114a5da1f5f73418" +Link: ; rel="next", ; rel="last" +Referrer-Policy: origin-when-cross-origin, strict-origin-when-cross-origin +Server: GitHub.com +Strict-Transport-Security: max-age=31536000; includeSubdomains; preload +Vary: Accept, Authorization, Cookie, X-GitHub-OTP, Accept-Encoding, Accept, X-Requested-With +X-Accepted-Oauth-Scopes: repo +X-Content-Type-Options: nosniff +X-Frame-Options: deny +X-Github-Api-Version-Selected: 2022-08-09 +X-Github-Media-Type: github.v3; format=json +X-Github-Request-Id: 1C73:26D4:E2E500:1EF78F4:62EC2479 +X-Oauth-Client-Id: 178c6fc778ccc68e1d6a +X-Oauth-Scopes: gist, read:org, repo, workflow +X-Ratelimit-Limit: 15000 +X-Ratelimit-Remaining: 14996 +X-Ratelimit-Reset: 1659645499 +X-Ratelimit-Resource: core +X-Ratelimit-Used: 4 +X-Xss-Protection: 0 ``` -Oh noes! Where did it go? Since we created the repository as _private_, we need -to authenticate in order to see it. If you're a grizzled HTTP user, you might -expect a `403` instead. Since we don't want to leak information about private -repositories, the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API returns a `404` in this case, as if to say "we can -neither confirm nor deny the existence of this repository." +In this example, the response code is `200`, which indicates a successful request. -## Issues +{% endcli %} -The UI for Issues on {% data variables.product.product_name %} aims to provide 'just enough' workflow while -staying out of your way. With the {% data variables.product.product_name %} [Issues API][issues-api], you can pull -data out or create issues from other tools to create a workflow that works for -your team. +{% javascript %} -Just like github.com, the API provides a few methods to view issues for the -authenticated user. To [see all your issues][get issues api], call `GET /issues`: +When you make a request with Octokit.js, the `request` method returns a promise. If the request was successful, the promise resolves to an object that includes the HTTP status code of the response (`status`) and the response headers (`headers`). If an error occurs, the promise resolves to an object that includes the HTTP status code of the response (`status`) and the response headers (`response.headers`). + +You can use a `try/catch` block to catch an error if it occurs. For example, if the request in the following script is successful, the script will log the status code and the value of the `x-ratelimit-remaining` header. If the request was not successful, the script will log the status code, the value of the `x-ratelimit-remaining` header, and the error message. + +```javascript +try { + const result = await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + per_page: 2, + }); + + console.log(`Success! Status: ${result.status}. Rate limit remaining: ${result.headers["x-ratelimit-remaining"]}`) + +} catch (error) { + console.log(`Error! Status: ${error.status}. Rate limit remaining: ${error.headers["x-ratelimit-remaining"]}. Message: ${error.response.data.message}`) +} +``` + +{% endjavascript %} + +{% curl %} + +To view the status code and headers, use the `--include` or `--i` flag when you send your request. + +For example, this request: ```shell -$ curl -i -H "Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a" \ - {% data variables.product.api_url_pre %}/issues +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" \ +--include ``` -To get only the [issues under one of your {% data variables.product.product_name %} organizations][get issues api], call `GET -/orgs//issues`: +returns the response code and headers like: ```shell -$ curl -i -H "Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a" \ - {% data variables.product.api_url_pre %}/orgs/rails/issues +HTTP/2 200 +server: GitHub.com +date: Thu, 04 Aug 2022 20:07:51 GMT +content-type: application/json; charset=utf-8 +cache-control: public, max-age=60, s-maxage=60 +vary: Accept, Accept-Encoding, Accept, X-Requested-With +etag: W/"7fceb7e8c958d3ec4d02524b042578dcc7b282192e6c939070f4a70390962e18" +x-github-media-type: github.v3; format=json +link: ; rel="next", ; rel="last" +access-control-expose-headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset +access-control-allow-origin: * +strict-transport-security: max-age=31536000; includeSubdomains; preload +x-frame-options: deny +x-content-type-options: nosniff +x-xss-protection: 0 +referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin +content-security-policy: default-src 'none' +x-ratelimit-limit: 15000 +x-ratelimit-remaining: 14996 +x-ratelimit-reset: 1659645535 +x-ratelimit-resource: core +x-ratelimit-used: 4 +accept-ranges: bytes +content-length: 4936 +x-github-request-id: 14E0:4BC6:F1B8BA:208E317:62EC2715 ``` -We can also get [all the issues under a single repository][repo issues api]: +In this example, the response code is `200`, which indicates a successful request. + +{% endcurl %} + +### About the response body + +Many operations will return a response body. Unless otherwise specified, the response body is in JSON format. For example, this request returns a list of issues with data about each issue: + +{% cli %} ```shell -$ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 ``` -### Pagination +{% endcli %} -A project the size of Rails has thousands of issues. We'll need to [paginate][pagination], -making multiple API calls to get the data. Let's repeat that last call, this -time taking note of the response headers: +{% javascript %} + +```javascript +await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + per_page: 2, +}); +``` + +{% endjavascript %} + +{% curl %} ```shell -$ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues - -> HTTP/2 200 - -> ... -> Link: <{% data variables.product.api_url_pre %}/repositories/8514/issues?page=2>; rel="next", <{% data variables.product.api_url_pre %}/repositories/8514/issues?page=30>; rel="last" -> ... +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" ``` -The [`Link` header][link-header] provides a way for a response to link to -external resources, in this case additional pages of data. Since our call found -more than thirty issues (the default page size), the API tells us where we can -find the next page and the last page of results. +{% endcurl %} -### Creating an issue +Unlike the GraphQL API where you specify what information you want, the REST API typically returns more information than you need. If desired, you can parse the response to pull out specific pieces of information. -Now that we've seen how to paginate lists of issues, let's [create an issue][create issue] from -the API. +{% cli %} -To create an issue, we need to be authenticated, so we'll pass an -OAuth token in the header. Also, we'll pass the title, body, and labels in the JSON -body to the `/issues` path underneath the repository in which we want to create -the issue: +For example, you can use `>` to redirect the response to a file: ```shell -$ curl -i -H 'Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a' \ -$ -d '{ \ -$ "title": "New logo", \ -$ "body": "We should have one", \ -$ "labels": ["design"] \ -$ }' \ -$ {% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/issues - -> HTTP/2 201 -> Location: {% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/issues/17 -> X-RateLimit-Limit: 5000 - -> { -> "pull_request": { -> "patch_url": null, -> "html_url": null, -> "diff_url": null -> }, -> "created_at": "2012-11-14T15:25:33Z", -> "comments": 0, -> "milestone": null, -> "title": "New logo", -> "body": "We should have one", -> "user": { -> "login": "pengwynn", -> "gravatar_id": "7e19cd5486b5d6dc1ef90e671ba52ae0", -> "avatar_url": "https://secure.gravatar.com/avatar/7e19cd5486b5d6dc1ef90e671ba52ae0?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", -> "id": 865, -> "url": "{% data variables.product.api_url_pre %}/users/pengwynn" -> }, -> "closed_at": null, -> "updated_at": "2012-11-14T15:25:33Z", -> "number": 17, -> "closed_by": null, -> "html_url": "https://github.com/pengwynn/api-sandbox/issues/17", -> "labels": [ -> { -> "color": "ededed", -> "name": "design", -> "url": "{% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/labels/design" -> } -> ], -> "id": 8356941, -> "assignee": null, -> "state": "open", -> "url": "{% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/issues/17" -> } +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 > data.json ``` -The response gives us a couple of pointers to the newly created issue, both in -the `Location` response header and the `url` field of the JSON response. - -## Conditional requests - -A big part of being a good API citizen is respecting rate limits by caching information that hasn't changed. The API supports [conditional -requests][conditional-requests] and helps you do the right thing. Consider the -first call we made to get defunkt's profile: +Then you can use jq to get the title and author ID of each issue: ```shell -$ curl -i {% data variables.product.api_url_pre %}/users/defunkt - -> HTTP/2 200 -> etag: W/"61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0" +jq '.[] | {title: .title, authorID: .user.id}' data.json ``` -In addition to the JSON body, take note of the HTTP status code of `200` and -the `ETag` header. -The [ETag][etag] is a fingerprint of the response. If we pass that on subsequent calls, -we can tell the API to give us the resource again, only if it has changed: +The previous two commands return something like: + +``` +{ + "title": "Update index.html", + "authorID": 10701255 +} +{ + "title": "Edit index file", + "authorID": 53709285 +} +``` + +For more information about jq, see [the jq documentation](https://stedolan.github.io/jq/) and [jq play](https://jqplay.org/). + +{% endcli %} + +{% javascript %} + +For example, you can get the title and author ID of each issue: + +```javascript +try { + const result = await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + per_page: 2, + }); + + const titleAndAuthor = result.data.map(issue => {title: issue.title, authorID: issue.user.id}) + + console.log(titleAndAuthor) + +} catch (error) { + console.log(`Error! Status: ${error.status}. Message: ${error.response.data.message}`) +} +``` + +{% endjavascript %} + +{% curl %} + +For example, you can use `>` to redirect the response to a file: ```shell -$ curl -i -H 'If-None-Match: "61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0"' \ -$ {% data variables.product.api_url_pre %}/users/defunkt - -> HTTP/2 304 +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" > data.json ``` -The `304` status indicates that the resource hasn't changed since the last time -we asked for it and the response will contain no body. As a bonus, `304` responses don't count against your [rate limit][rate-limiting]. +Then you can use jq to get the title and author ID of each issue: -Now you know the basics of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API! +```shell +jq '.[] | {title: .title, authorID: .user.id}' data.json +``` -* Basic & OAuth authentication -* Fetching and creating repositories and issues -* Conditional requests +The previous two commands return something like: -Keep learning with the next API guide [Basics of Authentication][auth guide]! +``` +{ + "title": "Update index.html", + "authorID": 10701255 +} +{ + "title": "Edit index file", + "authorID": 53709285 +} +``` -[wrappers]: /libraries/ -[curl]: http://curl.haxx.se/ -[media types]: /rest/overview/media-types -[oauth]: /apps/building-integrations/setting-up-and-registering-oauth-apps/ -[webflow]: /apps/building-oauth-apps/authorizing-oauth-apps/ -[scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ -[repos-api]: /rest/reference/repos -[pages]: http://pages.github.com -[nanoc]: http://nanoc.ws/ -[gitignore templates]: https://github.com/github/gitignore -[issues-api]: /rest/reference/issues -[link-header]: https://www.w3.org/wiki/LinkHeader -[conditional-requests]: /rest#conditional-requests -[rate-limiting]: /rest/overview/resources-in-the-rest-api#rate-limit-http-headers -[users api]: /rest/reference/users#get-a-user -[auth user api]: /rest/reference/users#get-the-authenticated-user -[defunkt github]: https://github.com/defunkt -[json]: http://en.wikipedia.org/wiki/JSON -[authentication]: /rest#authentication -[2fa]: /articles/about-two-factor-authentication -[2fa header]: /rest/overview/other-authentication-methods#working-with-two-factor-authentication -[oauth section]: /rest/guides/getting-started-with-the-rest-api#oauth -[personal token]: /articles/creating-an-access-token-for-command-line-use -[tokens settings]: https://github.com/settings/tokens -[pagination]: /rest#pagination -[get repo]: /rest/reference/repos#get-a-repository -[create repo]: /rest/reference/repos#create-a-repository-for-the-authenticated-user -[create issue]: /rest/reference/issues#create-an-issue -[auth guide]: /guides/basics-of-authentication -[user repos api]: /rest/reference/repos#list-repositories-for-the-authenticated-user -[other user repos api]: /rest/reference/repos#list-repositories-for-a-user -[org repos api]: /rest/reference/repos#list-organization-repositories -[get issues api]: /rest/reference/issues#list-issues-assigned-to-the-authenticated-user -[repo issues api]: /rest/reference/issues#list-repository-issues -[etag]: http://en.wikipedia.org/wiki/HTTP_ETag -[2fa section]: /rest/guides/getting-started-with-the-rest-api#two-factor-authentication +For more information about jq, see [the jq documentation](https://stedolan.github.io/jq/) and [jq play](https://jqplay.org/). + +{% endcurl %} + +## Next steps + +This article demonstrated how to list and create issues in a repository. For more practice, try to comment on an issue, edit the title of an issue, or close an issue. For more information about these operations, see "[Create an issue comment](/rest/issues#create-an-issue-comment)" and "[Update an issue](/rest/issues/issues#update-an-issue)." + +For more information about the operations that you can use, see the [REST reference documentation](/rest). diff --git a/content/rest/index.md b/content/rest/index.md index 7320c21937..1a00bb2133 100644 --- a/content/rest/index.md +++ b/content/rest/index.md @@ -3,7 +3,8 @@ title: GitHub REST API shortTitle: REST API intro: 'To create integrations, retrieve data, and automate your workflows, build with the {% data variables.product.prodname_dotcom %} REST API.' introLinks: - quickstart: /rest/guides/getting-started-with-the-rest-api + quickstart: /rest/quickstart + overview: /rest/guides/getting-started-with-the-rest-api featuredLinks: guides: - /rest/guides/getting-started-with-the-rest-api @@ -31,6 +32,7 @@ versions: ghae: '*' ghec: '*' children: + - /quickstart - /overview - /guides - /actions diff --git a/content/rest/quickstart.md b/content/rest/quickstart.md new file mode 100644 index 0000000000..b8bf64cd32 --- /dev/null +++ b/content/rest/quickstart.md @@ -0,0 +1,351 @@ +--- +title: Quickstart for GitHub REST API +intro: 'Learn how to get started with the {% data variables.product.prodname_dotcom %} REST API.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +shortTitle: Quickstart +topics: + - API +redirect_from: + - /guides/getting-started + - /v3/guides/getting-started +miniTocMaxHeadingLevel: 3 +--- + +This article describes how to quickly get started with the {% data variables.product.prodname_dotcom %} REST API using {% data variables.product.prodname_cli %}, JavaScript, or cURL. For a more detailed guide, see "[Getting started with the REST API](/rest/guides/getting-started-with-the-rest-api)." + +{% cli %} + +## Getting started using {% data variables.product.prodname_cli %} + +### Using {% data variables.product.prodname_cli %} in the command line + +{% data variables.product.prodname_cli %} is the easiest way to use the {% data variables.product.prodname_dotcom %} REST API from the command line. + +1. Install {% data variables.product.prodname_cli %} if you haven't installed it yet. For installation instructions, see the [{% data variables.product.prodname_cli %} repository](https://github.com/cli/cli#installation). +1. Use the `auth login` subcommand to authenticate to {% data variables.product.prodname_cli %}. For more information, see the [{% data variables.product.prodname_cli %} `auth login` documentation](https://cli.github.com/manual/gh_auth_login). + + ```shell + gh auth login + ``` + +1. Use the `api` subcommand to make your API request. For more information, see the [{% data variables.product.prodname_cli %} `api` documentation](https://cli.github.com/manual/gh_api). + + ```shell + gh api repos/octocat/Spoon-Knife/issues + ``` + +### Using {% data variables.product.prodname_cli %} in {% data variables.product.prodname_actions %} + +You can also use {% data variables.product.prodname_cli %} in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Using GitHub CLI in workflows](/actions/using-workflows/using-github-cli-in-workflows)." + +Instead of using the `gh auth login` command, pass an access token as an environment variable called `GH_TOKEN`. {% data variables.product.prodname_dotcom %} recommends that you use the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." + +```yaml +on: + workflow_dispatch: +jobs: + use_api: + runs-on: ubuntu-latest + permissions: + issues: read + steps: + - env: + GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + gh api repos/octocat/Spoon-Knife/issues +``` + +If you are authenticating with a {% data variables.product.prodname_github_app %}, you can create an installation access token within your workflow: + +1. Store your {% data variables.product.prodname_github_app %}'s ID as a secret. In the following example, replace `APP_ID` with the name of the secret. You can find your app ID on the settings page for your app or through the App API. For more information, see "[Apps](/rest/apps/apps#get-an-app)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." +1. Generate a private key for your app. Store the contents of the resulting file as a secret. (Store the entire contents of the file, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`.) In the following example, replace `APP_PEM` with the name of the secret. For more information, see "[Authenticating with {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)." +1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. For example: + +```yaml +{% data reusables.actions.actions-not-certified-by-github-comment %} + +on: + workflow_dispatch: +jobs: + track_pr: + runs-on: ubuntu-latest + steps: + - name: Generate token + id: generate_token + uses: tibdex/github-app-token@36464acb844fc53b9b8b2401da68844f6b05ebb0 + with: + app_id: {% raw %}${{ secrets.APP_ID }}{% endraw %} + private_key: {% raw %}${{ secrets.APP_PEM }}{% endraw %} + + - name: Use API + env: + GH_TOKEN: {% raw %}${{ steps.generate_token.outputs.token }}{% endraw %} + run: | + gh api repos/octocat/Spoon-Knife/issues +``` + +{% endcli %} + +{% javascript %} + +## Getting started using JavaScript + +You can use Octokit.js to interact with the {% data variables.product.prodname_dotcom %} REST API in your JavaScript scripts. For more information, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). + +### Using Octokit.js + +1. Create an access token. For example, create a personal access token (PAT) or a {% data variables.product.prodname_github_app %} user-to-server access token. For more information, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)" or "[Identifying and authorizing users for GitHub Apps](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps)." + + {% warning %} + + **Warning**: Treat your access token like a password. + + To keep your token secure, you can store your token as a secret and run your script through {% data variables.product.prodname_actions %}. For more information, see the "[Using Octokit.js in {% data variables.product.prodname_actions %}](#using-octokitjs-in-github-actions)" section. + + {%- ifversion fpt or ghec %} + + You can also store your token as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} + + If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. + + {% endwarning %} + +1. Install `octokit`. For example, `npm install octokit`. For other ways to install or load `octokit`, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). +1. Import `octokit` in your script. For example, `import { Octokit } from "octokit";`. For other ways to import `octokit`, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). +1. Create an instance of `Octokit` with your token. Replace `YOUR-TOKEN` with your token. + + ```javascript + const octokit = new Octokit({ + auth: 'YOUR-TOKEN' + }); + ``` + +1. Use `octokit.request` to execute your request. Send the HTTP method and path as the first argument. Specify any path, query, and body parameters in an object as the second argument. For example, in the following request the HTTP method is `GET`, the path is `/repos/{owner}/{repo}/issues`, and the parameters are `owner: "octocat"` and `repo: "Spoon-Knife"`. + + ```javascript + await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + }); + ``` + +### Using Octokit.js in {% data variables.product.prodname_actions %} + +You can also execute your JavaScript scripts in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." + +{% data variables.product.prodname_dotcom %} recommends that you use the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." + +The following example workflow: + +1. Checks out the repository content +1. Sets up Node.js +1. Installs `octokit` +1. Stores the value of `GITHUB_TOKEN` as an environment variable called `TOKEN` and runs `.github/actions-scripts/use-the-api.mjs`, which can access that environment variable as `process.env.TOKEN` + +Example workflow: + +```yaml +on: + workflow_dispatch: +jobs: + use_api_via_script: + runs-on: ubuntu-latest + permissions: + issues: read + steps: + - name: Check out repo content + uses: {% data reusables.actions.action-checkout %} + + - name: Setup Node + uses: {% data reusables.actions.action-setup-node %} + with: + node-version: '16.15.0' + cache: npm + + - name: Install dependencies + run: npm install octokit + + - name: Run script + run: | + node .github/actions-scripts/use-the-api.mjs + env: + TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} +``` + +Example JavaScript script, with the file path `.github/actions-scripts/use-the-api.mjs`: + +```javascript +import { Octokit } from "octokit" + +const octokit = new Octokit({ + auth: process.env.TOKEN +}); + +try { + const result = await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + }); + + const titleAndAuthor = result.data.map(issue => {title: issue.title, authorID: issue.user.id}) + + console.log(titleAndAuthor) + +} catch (error) { + console.log(`Error! Status: ${error.status}. Message: ${error.response.data.message}`) +} +``` + +If you are authenticating with a {% data variables.product.prodname_github_app %}, you can create an installation access token within your workflow: + +1. Store your {% data variables.product.prodname_github_app %}'s ID as a secret. In the following example, replace `APP_ID` with the name of the secret. You can find your app ID on the settings page for your app or through the App API. For more information, see "[Apps](/rest/apps/apps#get-an-app)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." +1. Generate a private key for your app. Store the contents of the resulting file as a secret. (Store the entire contents of the file, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`.) In the following example, replace `APP_PEM` with the name of the secret. For more information, see "[Authenticating with {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)." +1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. For example: + +```yaml +{% data reusables.actions.actions-not-certified-by-github-comment %} + +on: + workflow_dispatch: +jobs: + use_api_via_script: + runs-on: ubuntu-latest + steps: + - name: Check out repo content + uses: {% data reusables.actions.action-checkout %} + + - name: Setup Node + uses: {% data reusables.actions.action-setup-node %} + with: + node-version: '16.15.0' + cache: npm + + - name: Install dependencies + run: npm install octokit + + - name: Generate token + id: generate_token + uses: tibdex/github-app-token@36464acb844fc53b9b8b2401da68844f6b05ebb0 + with: + app_id: {% raw %}${{ secrets.APP_ID }}{% endraw %} + private_key: {% raw %}${{ secrets.APP_PEM }}{% endraw %} + + - name: Run script + run: | + node .github/actions-scripts/use-the-api.mjs + env: + TOKEN: {% raw %}${{ steps.generate_token.outputs.token }}{% endraw %} +``` + +{% endjavascript %} + +{% curl %} + +## Getting started using cURL + +### Using cURL in the command line + +{% note %} + +**Note:** If you want to make API requests from the command line, {% data variables.product.prodname_dotcom %} recommends that you use {% data variables.product.prodname_cli %}, which simplifies authentication and requests. For more information about getting started with the REST API using {% data variables.product.prodname_cli %}, see the {% data variables.product.prodname_cli %} version of this article. + +{% endnote %} + +1. Install cURL if cURL isn't already installed on your machine. To check if cURL is installed, execute `curl --version` in the command line. If the output is information about the cURL version, cURL is installed. If you get a message similar to `command not found: curl`, you need to download and install cURL. For more information, see [the cURL project download page](https://curl.se/download.html). +1. Create an access token. For example, create a personal access token (PAT) or a {% data variables.product.prodname_github_app %} user-to-server access token. For more information, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)" or "[Identifying and authorizing users for GitHub Apps](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps)." + + {% warning %} + + **Warning**: Treat your access token like a password. + + {%- ifversion fpt or ghec %} + + To keep your token secure, you can store your token as a {% data variables.product.prodname_codespaces %} secret and use the command line through {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} + + You can also use {% data variables.product.prodname_cli %} instead of cURL. {% data variables.product.prodname_cli %} will take care of authentication for you. For more information, see the {% data variables.product.prodname_cli %} version of this page. + + If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. + + {% endwarning %} + +1. Use the `cURL` command to make your request. Pass your token in an `Authorization` header. Replace `YOUR-TOKEN` with your token. + + ```shell + curl --request GET \ + --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ + --header "Accept: application/vnd.github.v3+json" \ + --header "Authorization: Bearer YOUR-TOKEN" + ``` + + {% note %} + + **Note:** In most cases, you can use `Authorization: Bearer` or `Authorization: token`. JSON web tokens (JWTs) only work with `Authorization: Bearer`. + + {% endnote %} + +### Using cURL in {% data variables.product.prodname_actions %} + +You can also use cURL in your {% data variables.product.prodname_actions %} workflows. + +{% data variables.product.prodname_dotcom %} recommends that you use the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." + +```yaml +on: + workflow_dispatch: +jobs: + use_api: + runs-on: ubuntu-latest + permissions: + issues: read + steps: + - env: + GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + curl --request GET \ + --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ + --header "Accept: application/vnd.github.v3+json" \ + --header "Authorization: Bearer $GH_TOKEN" +``` + +If you are authenticating with a {% data variables.product.prodname_github_app %}, you can create an installation access token within your workflow: + +1. Store your {% data variables.product.prodname_github_app %}'s ID as a secret. In the following example, replace `APP_ID` with the name of the secret. You can find your app ID on the settings page for your app or through the App API. For more information, see "[Apps](/rest/apps/apps#get-an-app)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." +1. Generate a private key for your app. Store the contents of the resulting file as a secret. (Store the entire contents of the file, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`.) In the following example, replace `APP_PEM` with the name of the secret. For more information, see "[Authenticating with {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)." +1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. For example: + +```yaml +{% data reusables.actions.actions-not-certified-by-github-comment %} + +on: + workflow_dispatch: +jobs: + use_api: + runs-on: ubuntu-latest + steps: + - name: Generate token + id: generate_token + uses: tibdex/github-app-token@36464acb844fc53b9b8b2401da68844f6b05ebb0 + with: + app_id: {% raw %}${{ secrets.APP_ID }}{% endraw %} + private_key: {% raw %}${{ secrets.APP_PEM }}{% endraw %} + + - name: Use API + env: + GH_TOKEN: {% raw %}${{ steps.generate_token.outputs.token }}{% endraw %} + run: | + curl --request GET \ + --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ + --header "Accept: application/vnd.github.v3+json" \ + --header "Authorization: Bearer $GH_TOKEN" +``` + +{% endcurl %} + +## Next steps + +For a more detailed guide, see "[Getting started with the REST API](/rest/guides/getting-started-with-the-rest-api)." diff --git a/content/rest/teams/external-groups.md b/content/rest/teams/external-groups.md index 2ac2295d45..fd5644a84b 100644 --- a/content/rest/teams/external-groups.md +++ b/content/rest/teams/external-groups.md @@ -19,7 +19,7 @@ To use this API, the authenticated user must be a team maintainer or an owner of **Notes:** -- The external groups API is only available for organizations that are part of a enterprise using {% data variables.product.prodname_emus %}. For more information, see "[About Enterprise Managed Users](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." +- The external groups API is only available for organizations that are part of an enterprise using {% data variables.product.prodname_emus %}. For more information, see "[About Enterprise Managed Users](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." - If your organization uses team synchronization, you can use the Team Synchronization API. For more information, see "[Team synchronization API](#team-synchronization)." {% endnote %} diff --git a/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md b/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md index dabf0fcdcb..bb966aba1b 100644 --- a/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md +++ b/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md @@ -25,7 +25,7 @@ shortTitle: Sponsor a contributor You can sponsor an account on behalf of your personal account to invest in projects that you personally benefit from. You can sponsor an account on behalf of your organization for many reasons. - Sustaining specific libraries that your organization's work depends on -- Investing in the ecosystem you rely on as a organization (such as blockchain) +- Investing in the ecosystem you rely on as an organization (such as blockchain) - Developing brand awareness as an organization that values open source - Thanking open source developers for building libraries that complement the product your organization offers diff --git a/contributing/content-style-guide.md b/contributing/content-style-guide.md index cacfca2802..72c51cb965 100644 --- a/contributing/content-style-guide.md +++ b/contributing/content-style-guide.md @@ -500,11 +500,29 @@ Format checkbox names in bold and omit the word “checkbox.” To describe choo - **Use:** Select **Enable for all new repositories**. - **Avoid:** Check the “Enable for all new repositories” checkbox. +### Directory names + +Use sentence style capitalization. You can use internal capital letters in directory and folder names for readability. Format directory names in bold if you direct someone to select, type, or otherwise interact with the name. + +- **Use:** In your .github/workflows directory, create a new file. +- **Use:** Select your **.github/workflows** directory. +- **Avoid:** In your *.github/workflows* directory, select the workflow you wish to edit. +- **Avoid:** In your `.github/workflows` directory, select the workflow you wish to edit. + ### Dynamic text Use capital letters to indicate text that changes in the user interface or that the user needs to supply in a command or code snippet. - **Use:** Click **Add USERNAME to REPONAME**. +### File names + +Use title style capitalization. If a file type generally follows a different capitalization convention, such as all caps for README files, use the established convention. You can use internal capital letters in file names for readability. Format file names in bold if you direct someone to select, type, or otherwise interact with the name. + +- **Use:** In your README.md file, add info about your repository. +- **Use:** Enter **MyWorkflow.yml**. +- **Avoid:** In your *README.md* file, add info about your repository. +- **Avoid:** In your `README.md` file, add info about your repository. + ### Lists and list items Format lists and clickable list items in bold. To describe interacting with a list, such as a dropdown menu or UI element that expands, regardless of whether the list name is a word or an octicon, write "select." To describe choosing a list item, write "click." diff --git a/data/features/actions-oidc-hardening-config.yml b/data/features/actions-oidc-hardening-config.yml new file mode 100644 index 0000000000..bd23498113 --- /dev/null +++ b/data/features/actions-oidc-hardening-config.yml @@ -0,0 +1,6 @@ +# Reference: #7336 +# General versioning for oidc hardening options +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' diff --git a/data/features/actions-reusable-workflow-matrix.yml b/data/features/actions-reusable-workflow-matrix.yml new file mode 100644 index 0000000000..cf3b99d4f9 --- /dev/null +++ b/data/features/actions-reusable-workflow-matrix.yml @@ -0,0 +1,7 @@ +# Reference: #7094 +# Documentation for allowing matrix jobs to call reusable workflows. +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7094' diff --git a/data/features/dependabot-alerts-dismissal-comment.yml b/data/features/dependabot-alerts-dismissal-comment.yml new file mode 100644 index 0000000000..255ea4a959 --- /dev/null +++ b/data/features/dependabot-alerts-dismissal-comment.yml @@ -0,0 +1,7 @@ +# Reference: Issue #7673 - Dependabot alerts: optional comment with dismissal - [GA] + +versions: + fpt: '*' + ghec: '*' + ghes: '>3.6' + ghae: 'issue-7673' diff --git a/data/features/dependabot-alerts-vulnerable-calls.yml b/data/features/dependabot-alerts-vulnerable-calls.yml index 671ac05630..5b3645f3c5 100644 --- a/data/features/dependabot-alerts-vulnerable-calls.yml +++ b/data/features/dependabot-alerts-vulnerable-calls.yml @@ -2,5 +2,4 @@ versions: fpt: '*' ghec: '*' - ghes: '>3.5' ghae: 'issue-6076' diff --git a/data/features/enterprise-namespace-repo-setting.yml b/data/features/enterprise-namespace-repo-setting.yml new file mode 100644 index 0000000000..0902b94af9 --- /dev/null +++ b/data/features/enterprise-namespace-repo-setting.yml @@ -0,0 +1,6 @@ +# Reference: #7757 +# Setting to disable personal namespace repo creation for EMUs, GHES 3.7+ and GHAE 3.7+ users +versions: + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7757' diff --git a/data/features/ip-allow-list-address-check.yml b/data/features/ip-allow-list-address-check.yml new file mode 100644 index 0000000000..c4dda87a70 --- /dev/null +++ b/data/features/ip-allow-list-address-check.yml @@ -0,0 +1,3 @@ +versions: + ghec: '*' + ghae: 'issue-7818' diff --git a/data/features/multiple-accounts-one-workstation.yml b/data/features/multiple-accounts-one-workstation.yml new file mode 100644 index 0000000000..8f0bbb69e8 --- /dev/null +++ b/data/features/multiple-accounts-one-workstation.yml @@ -0,0 +1,6 @@ +# Issue #7330 +# Documentation for managing multiple GitHub accounts on one workstation + +versions: + fpt: '*' + ghec: '*' diff --git a/data/features/nested-reusable-workflow.yml b/data/features/nested-reusable-workflow.yml new file mode 100644 index 0000000000..702f7ac1c1 --- /dev/null +++ b/data/features/nested-reusable-workflow.yml @@ -0,0 +1,7 @@ +# Issues 7093 +# Reusable workflows can call other reusable workflows +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7093' diff --git a/data/features/packages-npm-v2.yml b/data/features/packages-npm-v2.yml new file mode 100644 index 0000000000..aaebb7fbfc --- /dev/null +++ b/data/features/packages-npm-v2.yml @@ -0,0 +1,5 @@ +# Issue 7039 +# npm Package Registry Improvements (v2) GA +versions: + fpt: '*' + ghec: '*' diff --git a/data/features/push-protection-custom-link-orgs-beta.yml b/data/features/push-protection-custom-link-orgs-beta.yml new file mode 100644 index 0000000000..c418fb2a45 --- /dev/null +++ b/data/features/push-protection-custom-link-orgs-beta.yml @@ -0,0 +1,8 @@ +# Issue 7299 +# Push protection custom links beta flags +# See "push-protection-custom-link-orgs" for the feature +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7299' diff --git a/data/features/push-protection-custom-link-orgs.yml b/data/features/push-protection-custom-link-orgs.yml new file mode 100644 index 0000000000..56d088a28e --- /dev/null +++ b/data/features/push-protection-custom-link-orgs.yml @@ -0,0 +1,8 @@ +# Issue 7299 +# Push protection custom links +# See "push-protection-custom-link-orgs-beta" for the beta flags +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7299' diff --git a/data/features/ssh-commit-verification.yml b/data/features/ssh-commit-verification.yml new file mode 100644 index 0000000000..87f1f3d243 --- /dev/null +++ b/data/features/ssh-commit-verification.yml @@ -0,0 +1,8 @@ +# Reference: github/docs-content#6709 +# Initial docs for showing SSH signed commits as verified and +# uploading SSH signing keys +versions: + fpt: '*' + ghec: '*' + ghes: '>= 3.7' + ghae: '*' diff --git a/data/features/streaming-datadog.yml b/data/features/streaming-datadog.yml new file mode 100644 index 0000000000..9c099525c1 --- /dev/null +++ b/data/features/streaming-datadog.yml @@ -0,0 +1,4 @@ +# Reference #7495 +# Documentation for audit log streaming to a Datadog endpoint +versions: + ghec: '*' diff --git a/data/graphql/ghae/schema.docs-ghae.graphql b/data/graphql/ghae/schema.docs-ghae.graphql index 9d14fb3c82..57ecfac539 100644 --- a/data/graphql/ghae/schema.docs-ghae.graphql +++ b/data/graphql/ghae/schema.docs-ghae.graphql @@ -4114,7 +4114,9 @@ type CommitComment implements Comment & Deletable & Minimizable & Node & Reactab lastEditedAt: DateTime """ - Returns why the comment was minimized. + Returns why the comment was minimized. One of `abuse`, `off-topic`, + `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and + formatting of these values differs from the inputs to the `MinimizeComment` mutation. """ minimizedReason: String @@ -8866,7 +8868,9 @@ type DiscussionComment implements Comment & Deletable & Minimizable & Node & Rea lastEditedAt: DateTime """ - Returns why the comment was minimized. + Returns why the comment was minimized. One of `abuse`, `off-topic`, + `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and + formatting of these values differs from the inputs to the `MinimizeComment` mutation. """ minimizedReason: String @@ -12490,7 +12494,9 @@ type GistComment implements Comment & Deletable & Minimizable & Node & Updatable lastEditedAt: DateTime """ - Returns why the comment was minimized. + Returns why the comment was minimized. One of `abuse`, `off-topic`, + `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and + formatting of these values differs from the inputs to the `MinimizeComment` mutation. """ minimizedReason: String @@ -14045,7 +14051,9 @@ type IssueComment implements Comment & Deletable & Minimizable & Node & Reactabl lastEditedAt: DateTime """ - Returns why the comment was minimized. + Returns why the comment was minimized. One of `abuse`, `off-topic`, + `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and + formatting of these values differs from the inputs to the `MinimizeComment` mutation. """ minimizedReason: String @@ -16283,20 +16291,10 @@ enum MigrationSourceType { """ BITBUCKET_SERVER - """ - A GitHub migration source. - """ - GITHUB - """ A GitHub Migration API source. """ GITHUB_ARCHIVE - - """ - A GitLab migration source. - """ - GITLAB } """ @@ -16646,7 +16644,9 @@ interface Minimizable { isMinimized: Boolean! """ - Returns why the comment was minimized. + Returns why the comment was minimized. One of `abuse`, `off-topic`, + `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and + formatting of these values differs from the inputs to the `MinimizeComment` mutation. """ minimizedReason: String @@ -26222,7 +26222,9 @@ type PullRequestReviewComment implements Comment & Deletable & Minimizable & Nod lastEditedAt: DateTime """ - Returns why the comment was minimized. + Returns why the comment was minimized. One of `abuse`, `off-topic`, + `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and + formatting of these values differs from the inputs to the `MinimizeComment` mutation. """ minimizedReason: String @@ -38728,6 +38730,11 @@ input TransferIssueInput { """ clientMutationId: String + """ + Whether to create labels if they don't exist in the target repository (matched by name) + """ + createLabelsIfMissing: Boolean = false + """ The Node ID of the issue to be transferred """ diff --git a/data/graphql/ghec/graphql_upcoming_changes.public.yml b/data/graphql/ghec/graphql_upcoming_changes.public.yml index 8cde85c4b6..ed9ed69239 100644 --- a/data/graphql/ghec/graphql_upcoming_changes.public.yml +++ b/data/graphql/ghec/graphql_upcoming_changes.public.yml @@ -1385,6 +1385,16 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: breaking owner: lukewar + - location: ProjectView.groupedItems + description: + '`groupedItems` will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, + to find a suitable replacement.' + reason: + The `ProjectNext` API is deprecated in favour of the more capable `ProjectV2` + API. + date: '2022-10-01T00:00:00+00:00' + criticality: breaking + owner: lukewar - location: ProjectView.items description: '`items` will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, diff --git a/data/graphql/ghec/schema.docs.graphql b/data/graphql/ghec/schema.docs.graphql index dcdb2ef09b..9331ff1fd0 100644 --- a/data/graphql/ghec/schema.docs.graphql +++ b/data/graphql/ghec/schema.docs.graphql @@ -4544,7 +4544,9 @@ type CommitComment implements Comment & Deletable & Minimizable & Node & Reactab lastEditedAt: DateTime """ - Returns why the comment was minimized. + Returns why the comment was minimized. One of `abuse`, `off-topic`, + `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and + formatting of these values differs from the inputs to the `MinimizeComment` mutation. """ minimizedReason: String @@ -9906,7 +9908,9 @@ type DiscussionComment implements Comment & Deletable & Minimizable & Node & Rea lastEditedAt: DateTime """ - Returns why the comment was minimized. + Returns why the comment was minimized. One of `abuse`, `off-topic`, + `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and + formatting of these values differs from the inputs to the `MinimizeComment` mutation. """ minimizedReason: String @@ -14085,7 +14089,9 @@ type GistComment implements Comment & Deletable & Minimizable & Node & Updatable lastEditedAt: DateTime """ - Returns why the comment was minimized. + Returns why the comment was minimized. One of `abuse`, `off-topic`, + `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and + formatting of these values differs from the inputs to the `MinimizeComment` mutation. """ minimizedReason: String @@ -15921,7 +15927,9 @@ type IssueComment implements Comment & Deletable & Minimizable & Node & Reactabl lastEditedAt: DateTime """ - Returns why the comment was minimized. + Returns why the comment was minimized. One of `abuse`, `off-topic`, + `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and + formatting of these values differs from the inputs to the `MinimizeComment` mutation. """ minimizedReason: String @@ -18543,20 +18551,10 @@ enum MigrationSourceType { """ BITBUCKET_SERVER - """ - A GitHub migration source. - """ - GITHUB - """ A GitHub Migration API source. """ GITHUB_ARCHIVE - - """ - A GitLab migration source. - """ - GITLAB } """ @@ -18906,7 +18904,9 @@ interface Minimizable { isMinimized: Boolean! """ - Returns why the comment was minimized. + Returns why the comment was minimized. One of `abuse`, `off-topic`, + `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and + formatting of these values differs from the inputs to the `MinimizeComment` mutation. """ minimizedReason: String @@ -33069,7 +33069,9 @@ type PullRequestReviewComment implements Comment & Deletable & Minimizable & Nod lastEditedAt: DateTime """ - Returns why the comment was minimized. + Returns why the comment was minimized. One of `abuse`, `off-topic`, + `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and + formatting of these values differs from the inputs to the `MinimizeComment` mutation. """ minimizedReason: String @@ -47737,6 +47739,11 @@ input TransferIssueInput { """ clientMutationId: String + """ + Whether to create labels if they don't exist in the target repository (matched by name) + """ + createLabelsIfMissing: Boolean = false + """ The Node ID of the issue to be transferred """ diff --git a/data/graphql/graphql_upcoming_changes.public.yml b/data/graphql/graphql_upcoming_changes.public.yml index 8cde85c4b6..ed9ed69239 100644 --- a/data/graphql/graphql_upcoming_changes.public.yml +++ b/data/graphql/graphql_upcoming_changes.public.yml @@ -1385,6 +1385,16 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: breaking owner: lukewar + - location: ProjectView.groupedItems + description: + '`groupedItems` will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, + to find a suitable replacement.' + reason: + The `ProjectNext` API is deprecated in favour of the more capable `ProjectV2` + API. + date: '2022-10-01T00:00:00+00:00' + criticality: breaking + owner: lukewar - location: ProjectView.items description: '`items` will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, diff --git a/data/graphql/schema.docs.graphql b/data/graphql/schema.docs.graphql index dcdb2ef09b..9331ff1fd0 100644 --- a/data/graphql/schema.docs.graphql +++ b/data/graphql/schema.docs.graphql @@ -4544,7 +4544,9 @@ type CommitComment implements Comment & Deletable & Minimizable & Node & Reactab lastEditedAt: DateTime """ - Returns why the comment was minimized. + Returns why the comment was minimized. One of `abuse`, `off-topic`, + `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and + formatting of these values differs from the inputs to the `MinimizeComment` mutation. """ minimizedReason: String @@ -9906,7 +9908,9 @@ type DiscussionComment implements Comment & Deletable & Minimizable & Node & Rea lastEditedAt: DateTime """ - Returns why the comment was minimized. + Returns why the comment was minimized. One of `abuse`, `off-topic`, + `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and + formatting of these values differs from the inputs to the `MinimizeComment` mutation. """ minimizedReason: String @@ -14085,7 +14089,9 @@ type GistComment implements Comment & Deletable & Minimizable & Node & Updatable lastEditedAt: DateTime """ - Returns why the comment was minimized. + Returns why the comment was minimized. One of `abuse`, `off-topic`, + `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and + formatting of these values differs from the inputs to the `MinimizeComment` mutation. """ minimizedReason: String @@ -15921,7 +15927,9 @@ type IssueComment implements Comment & Deletable & Minimizable & Node & Reactabl lastEditedAt: DateTime """ - Returns why the comment was minimized. + Returns why the comment was minimized. One of `abuse`, `off-topic`, + `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and + formatting of these values differs from the inputs to the `MinimizeComment` mutation. """ minimizedReason: String @@ -18543,20 +18551,10 @@ enum MigrationSourceType { """ BITBUCKET_SERVER - """ - A GitHub migration source. - """ - GITHUB - """ A GitHub Migration API source. """ GITHUB_ARCHIVE - - """ - A GitLab migration source. - """ - GITLAB } """ @@ -18906,7 +18904,9 @@ interface Minimizable { isMinimized: Boolean! """ - Returns why the comment was minimized. + Returns why the comment was minimized. One of `abuse`, `off-topic`, + `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and + formatting of these values differs from the inputs to the `MinimizeComment` mutation. """ minimizedReason: String @@ -33069,7 +33069,9 @@ type PullRequestReviewComment implements Comment & Deletable & Minimizable & Nod lastEditedAt: DateTime """ - Returns why the comment was minimized. + Returns why the comment was minimized. One of `abuse`, `off-topic`, + `outdated`, `resolved`, `duplicate` and `spam`. Note that the case and + formatting of these values differs from the inputs to the `MinimizeComment` mutation. """ minimizedReason: String @@ -47737,6 +47739,11 @@ input TransferIssueInput { """ clientMutationId: String + """ + Whether to create labels if they don't exist in the target repository (matched by name) + """ + createLabelsIfMissing: Boolean = false + """ The Node ID of the issue to be transferred """ diff --git a/data/release-notes/enterprise-server/3-6/0.yml b/data/release-notes/enterprise-server/3-6/0.yml index 4ca434c041..399fb51fc1 100644 --- a/data/release-notes/enterprise-server/3-6/0.yml +++ b/data/release-notes/enterprise-server/3-6/0.yml @@ -294,3 +294,4 @@ sections: - In a repository's settings, enabling the option to allow users with read access to create discussions does not enable this functionality. - In some cases, users cannot convert existing issues to discussions. - Custom patterns for secret scanning have `.*` as an end delimiter, specifically in the "After secret" field. This delimiter causes inconsistencies in scans for secrets across repositories, and you may notice gaps in a repository's history where no scans completed. Incremental scans may also be impacted. To prevent issues with scans, modify the end of the pattern to remove the `.*` delimiter. + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' \ No newline at end of file diff --git a/data/reusables/accounts/create-personal-access-tokens.md b/data/reusables/accounts/create-personal-access-tokens.md new file mode 100644 index 0000000000..8e3a7e1dc1 --- /dev/null +++ b/data/reusables/accounts/create-personal-access-tokens.md @@ -0,0 +1 @@ +1. For each of your accounts, create a dedicated PAT with `repo` scope. For more information, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." \ No newline at end of file diff --git a/data/reusables/actions/contacting-support.md b/data/reusables/actions/contacting-support.md index c7378cdaf8..9224419e82 100644 --- a/data/reusables/actions/contacting-support.md +++ b/data/reusables/actions/contacting-support.md @@ -5,5 +5,5 @@ If you have feedback or feature requests for {% data variables.product.prodname_ Contact {% data variables.contact.contact_support %} for any of the following, whether your use or intended use falls into the usage limit categories: * If you believe your account has been incorrectly restricted -* If you encounter an unexpected error when executing one of your Actions, for example: a unique ID +* If you encounter an unexpected error when executing one of your actions * If you encounter a situation where existing behavior contradicts expected, but not always documented, behavior diff --git a/data/reusables/actions/use-request-body-api.md b/data/reusables/actions/use-request-body-api.md new file mode 100644 index 0000000000..1d37d0c4f0 --- /dev/null +++ b/data/reusables/actions/use-request-body-api.md @@ -0,0 +1 @@ +To apply this configuration, submit a request to the API endpoint and include the required configuration in the request body. For more information, see "[Set the customization template for an OIDC subject claim for an organization](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization)". \ No newline at end of file diff --git a/data/reusables/advanced-security/custom-link-beta.md b/data/reusables/advanced-security/custom-link-beta.md new file mode 100644 index 0000000000..a79fc22417 --- /dev/null +++ b/data/reusables/advanced-security/custom-link-beta.md @@ -0,0 +1,5 @@ +{% note %} + +**Note:** The ability to add resource links to blocked push messages is currently in public beta and subject to change. + +{% endnote %} \ No newline at end of file diff --git a/data/reusables/advanced-security/secret-scanning-push-protection-org.md b/data/reusables/advanced-security/secret-scanning-push-protection-org.md index 92b7f4e392..136b2017e1 100644 --- a/data/reusables/advanced-security/secret-scanning-push-protection-org.md +++ b/data/reusables/advanced-security/secret-scanning-push-protection-org.md @@ -1,3 +1,7 @@ 1. Under "{% data variables.product.prodname_secret_scanning_caps %}", under "Push protection", click **Enable all**. ![Screenshot showing how to enable push protection for {% data variables.product.prodname_secret_scanning %} for an organization](/assets/images/help/organizations/secret-scanning-enable-push-protection.png) -1. Optionally, click "Automatically enable for private repositories added to {% data variables.product.prodname_secret_scanning %}." +1. Optionally, click "Automatically enable for private repositories added to {% data variables.product.prodname_secret_scanning %}."{% ifversion push-protection-custom-link-orgs %} +1. Optionally, to include a custom link in the message that members will see when they attempt to push a secret, select **Add a resource link in the CLI and web UI when a commit is blocked**, then type a URL, and click **Save link**. + {% ifversion push-protection-custom-link-orgs-beta %}{% indented_data_reference reusables.advanced-security.custom-link-beta spaces=3 %}{% endif %} + + ![Screenshot showing checkbox and text field for enabling a custom link](/assets/images/help/organizations/secret-scanning-custom-link.png){% endif %} \ No newline at end of file diff --git a/data/reusables/code-scanning/licensing-note.md b/data/reusables/code-scanning/licensing-note.md index ad0ec0192d..ede099e6be 100644 --- a/data/reusables/code-scanning/licensing-note.md +++ b/data/reusables/code-scanning/licensing-note.md @@ -1,8 +1,12 @@ {% note %} -**Note:** {% ifversion fpt %} -The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories. The {% data variables.product.prodname_codeql_cli %} is also available in private repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." -{%- elsif ghec %} The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories that are maintained on {% data variables.product.prodname_dotcom_the_website %}, and available to use on private repositories that are owned by customers with an {% data variables.product.prodname_advanced_security %} license. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." -{%- elsif ghes or ghae %}The {% data variables.product.prodname_codeql_cli %} is available to customers with an {% data variables.product.prodname_advanced_security %} license. +**Notes:** {% ifversion fpt %} +- The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories. The {% data variables.product.prodname_codeql_cli %} is also available in private repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." +{%- elsif ghec %} +- The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories that are maintained on {% data variables.product.prodname_dotcom_the_website %}, and available to use on private repositories that are owned by customers with an {% data variables.product.prodname_advanced_security %} license. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." +{%- elsif ghes or ghae %} +- The {% data variables.product.prodname_codeql_cli %} is available to customers with an {% data variables.product.prodname_advanced_security %} license. {% endif %} +- {% data reusables.code-scanning.non-glibc-linux-support %} + {% endnote %} diff --git a/data/reusables/code-scanning/non-glibc-linux-support.md b/data/reusables/code-scanning/non-glibc-linux-support.md new file mode 100644 index 0000000000..2a1c2a8e53 --- /dev/null +++ b/data/reusables/code-scanning/non-glibc-linux-support.md @@ -0,0 +1 @@ +The {% data variables.product.prodname_codeql_cli %} is currently not compatible with non-glibc Linux distributions such as (musl-based) Alpine Linux. \ No newline at end of file diff --git a/data/reusables/codespaces/click-remote-explorer-icon-vscode.md b/data/reusables/codespaces/click-remote-explorer-icon-vscode.md index 83bf494e4d..37d359b854 100644 --- a/data/reusables/codespaces/click-remote-explorer-icon-vscode.md +++ b/data/reusables/codespaces/click-remote-explorer-icon-vscode.md @@ -1,2 +1,5 @@ 1. In {% data variables.product.prodname_vscode_shortname %}, in the left sidebar, click the Remote Explorer icon. - ![The Remote Explorer icon in {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png) + + ![The Remote Explorer icon in {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png) + +{% indented_data_reference reusables.codespaces.remote-explorer spaces=3 %} \ No newline at end of file diff --git a/data/reusables/codespaces/codespaces-disabling-org-billing.md b/data/reusables/codespaces/codespaces-disabling-org-billing.md new file mode 100644 index 0000000000..a3d7ca0c7a --- /dev/null +++ b/data/reusables/codespaces/codespaces-disabling-org-billing.md @@ -0,0 +1,5 @@ +{% note %} + +**Note**: If you disable billable codespaces use for your organization, anyone who can create codespaces as an individual user, and can clone a repository in your organization, will still be able to create a codespace for that repository. However, this will not incur any charge for your organization. For information about restricting access to a repository, see "[Managing teams and people with access to your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." + +{% endnote %} \ No newline at end of file diff --git a/data/reusables/codespaces/codespaces-org-policies-note.md b/data/reusables/codespaces/codespaces-org-policies-note.md new file mode 100644 index 0000000000..69e6530791 --- /dev/null +++ b/data/reusables/codespaces/codespaces-org-policies-note.md @@ -0,0 +1,5 @@ +{% note %} + +**Note**: Organization policies you define for {% data variables.product.prodname_codespaces %} only apply to codespaces for which your organization will be billed. If an individual user creates a codespace for a repository in your organization, and the organization is not billed, then the codespace will not be bound by these policies. For information on how to choose who can create codespaces that are billed to your organization, see "[Enabling {% data variables.product.prodname_github_codespaces %} for your organization](https://docs-internal-29134-ad7bd8.preview.ghdocs.com/en/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization#choose-who-can-create-codespaces-that-are-billed-to-your-organization)." + +{% endnote %} \ No newline at end of file diff --git a/data/reusables/codespaces/codespaces-spending-limit-requirement.md b/data/reusables/codespaces/codespaces-spending-limit-requirement.md index 61e7031435..69820f0878 100644 --- a/data/reusables/codespaces/codespaces-spending-limit-requirement.md +++ b/data/reusables/codespaces/codespaces-spending-limit-requirement.md @@ -1,9 +1,9 @@ {% note %} -**Note:** You must set a spending limit before you can use {% data variables.product.prodname_codespaces %}. +**Note:** You must set a non-zero spending limit before you can use {% data variables.product.prodname_codespaces %}. {% endnote %} -By default, your organization or enterprise will have a {% data variables.product.prodname_github_codespaces %} spending limit of $0, which prevents new codespaces from being created or existing codespaces from being opened. To allow your users to create codespaces in your organization, set the limit to a value higher than $0. +By default, your organization or enterprise will have a {% data variables.product.prodname_github_codespaces %} spending limit of $0. This prevents new codespaces from being created, or existing codespaces from being opened, if this would incur a billable cost to your organization or enterprise. To allow your users to create codespaces in your organization, set the limit to a value higher than $0. {% data reusables.billing.overages-billed-monthly %} diff --git a/data/reusables/codespaces/remote-explorer.md b/data/reusables/codespaces/remote-explorer.md new file mode 100644 index 0000000000..c46ed9b539 --- /dev/null +++ b/data/reusables/codespaces/remote-explorer.md @@ -0,0 +1,9 @@ +{% note %} + +**Note**: If the Remote Explorer is not displayed in the Activity Bar: + +1. Access the command palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux). +1. Type: `codespaces`. +1. Click **Codespaces: Details**. + +{% endnote %} diff --git a/data/reusables/dependabot/dependabot-alerts-filters.md b/data/reusables/dependabot/dependabot-alerts-filters.md new file mode 100644 index 0000000000..016833a8bd --- /dev/null +++ b/data/reusables/dependabot/dependabot-alerts-filters.md @@ -0,0 +1,14 @@ +You can sort and filter {% data variables.product.prodname_dependabot_alerts %} by typing filters as `key:value` pairs into the search bar. + +| Option | Description | Example | +|:---|:---|:---| +| `ecosystem` | Displays alerts for the selected ecosystem | Use `ecosystem:npm` to show {% data variables.product.prodname_dependabot_alerts %} for npm |{% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-7891 %} +| `has` | Displays alerts meeting the selected filter criteria | Use `has:patch` to show alerts related to advisories that have a patch{% ifversion dependabot-alerts-vulnerable-calls %}
    Use `has:vulnerable-calls` to show alerts relating to calls to vulnerable functions{% endif %} |{% endif %} +| `is` | Displays alerts based on their state | Use `is:open` to show open alerts | +| `manifest` | Displays alerts for the selected manifest | Use `manifest:webwolf/pom.xml` to show alerts on the pom.xml file of the webwolf application | +| `package` | Displays alerts for the selected package | Use `package:django` to show alerts for django | +| `resolution` | Displays alerts of the selected resolution status | Use `resolution:no-bandwidth` to show alerts previously parked due to lack of resources or time to fix them | +| `repo` | Displays alerts based on the repository they relate to
    Note that this filter is only available on the security overview. For more information, see "[About the security overview](/code-security/security-overview/about-the-security-overview)" | Use `repo:octocat-repo` to show alerts in the repository called `octocat-repo` |{%- ifversion dependabot-alerts-development-label %} +| `scope` | Displays alerts based on the scope of the dependency they relate to | Use `scope:development` to show alerts for dependencies that are only used during development |{% endif %} +| `severity` | Displays alerts based on their level of severity | Use `severity:high` to show alerts with a severity of High |{%- ifversion dependabot-most-important-sort-option %} +| `sort` | Displays alerts according to the selected sort order | The default sorting option for alerts is `sort:most-important`, which ranks alerts by importance
    Use `sort:newest` to show the latest alerts reported by {% data variables.product.prodname_dependabot %} |{% endif %} diff --git a/data/reusables/discussions/starting-a-poll.md b/data/reusables/discussions/starting-a-poll.md index 4b89da6fd7..790fbf08b1 100644 --- a/data/reusables/discussions/starting-a-poll.md +++ b/data/reusables/discussions/starting-a-poll.md @@ -10,7 +10,7 @@ ![Screenshot showing text fields for the poll's question](/assets/images/help/discussions/new-poll-question.png) 1. Type at least two options for your poll. ![Screenshot showing text fields for the poll's options](/assets/images/help/discussions/new-poll-options.png) -1. Optionally, to add a extra poll options, click **Add an option**. +1. Optionally, to add an extra poll option, click **Add an option**. ![Screenshot showing "Add an option" button](/assets/images/help/discussions/new-poll-add-option.png) 1. Click **Start poll**. ![Screenshot showing the "Start poll" button](/assets/images/help/discussions/new-poll-start-poll-button.png) diff --git a/data/reusables/enterprise-accounts/repo-creation-policy.md b/data/reusables/enterprise-accounts/repo-creation-policy.md index 8a2ecf2c43..c7033dd8d0 100644 --- a/data/reusables/enterprise-accounts/repo-creation-policy.md +++ b/data/reusables/enterprise-accounts/repo-creation-policy.md @@ -1,2 +1,6 @@ 1. Under "Repository creation", select a policy. - ![Drop-down menu with repository creation policy options](/assets/images/help/business-accounts/repository-creation-policy-drop-down.png) + {% ifversion enterprise-namespace-repo-setting %} + ![Drop-down menu with repository creation policy options](/assets/images/help/business-accounts/restrict-personal-namespace-setting.png) + {% else %} + ![Drop-down menu with repository creation policy options](/assets/images/help/business-accounts/repository-creation-policy-drop-down.png) + {% endif %} diff --git a/data/reusables/enterprise-accounts/repository-visibility-policy.md b/data/reusables/enterprise-accounts/repository-visibility-policy.md deleted file mode 100644 index 912287dd82..0000000000 --- a/data/reusables/enterprise-accounts/repository-visibility-policy.md +++ /dev/null @@ -1,2 +0,0 @@ -1. Under "Repository visibility change", use the drop-down menu and choose a policy. - ![Drop-down menu with repository visibility policy options](/assets/images/help/business-accounts/repository-visibility-policy-drop-down.png) diff --git a/data/reusables/enterprise-accounts/security-tab.md b/data/reusables/enterprise-accounts/security-tab.md index 021adcca4a..36f2a01533 100644 --- a/data/reusables/enterprise-accounts/security-tab.md +++ b/data/reusables/enterprise-accounts/security-tab.md @@ -1,2 +1,7 @@ +{%- ifversion ghec or ghes > 3.4 or ghae-issue-7875 %} +1. In the left sidebar, click **Authentication security**. + {% ifversion ghae %}![Security tab in the enterprise account settings sidebar](/assets/images/enterprise/github-ae/enterprise-account-settings-authentication-security-tab.png){% else %}![Security tab in the enterprise account settings sidebar](/assets/images/help/business-accounts/enterprise-account-settings-authentication-security-tab.png){% endif %} +{%- else %} 1. In the left sidebar, click **Security**. {% ifversion ghae %}![Security tab in the enterprise account settings sidebar](/assets/images/enterprise/github-ae/enterprise-account-settings-security-tab.png){% else %}![Security tab in the enterprise account settings sidebar](/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png){% endif %} +{%- endif %} \ No newline at end of file diff --git a/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md b/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md index c5d6100063..d9e308eee9 100644 --- a/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md +++ b/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md @@ -1,4 +1,4 @@ -1. Define the key as a environment variable for {% data variables.product.product_name %}, replacing `` with the GPG key ID. +1. Define the key as an environment variable for {% data variables.product.product_name %}, replacing `` with the GPG key ID. ```bash{:copy} ghe-config "secrets.gpgverify.web-signing-key" "$(gpg --export-secret-keys -a | awk '{printf "%s\\n", $0}')" diff --git a/data/reusables/git/cache-on-repository-path.md b/data/reusables/git/cache-on-repository-path.md new file mode 100644 index 0000000000..ced81ebbd9 --- /dev/null +++ b/data/reusables/git/cache-on-repository-path.md @@ -0,0 +1,5 @@ +1. To configure Git to cache credentials for each local directory where you clone a repository, enter the following command. + + ```shell{:copy} + git config --global credential.useHttpPath true + ``` diff --git a/data/reusables/git/clear-stored-gcm-credentials.md b/data/reusables/git/clear-stored-gcm-credentials.md new file mode 100644 index 0000000000..04e3de748e --- /dev/null +++ b/data/reusables/git/clear-stored-gcm-credentials.md @@ -0,0 +1,5 @@ +- If the output is `manager-core`, you're using Git Credential Manager. To clear the credentials, run the following command. + + ```shell{:copy} + git credential-manager reject https://github.com + ``` diff --git a/data/reusables/git/clear-the-stored-credentials.md b/data/reusables/git/clear-the-stored-credentials.md new file mode 100644 index 0000000000..f723d7ab97 --- /dev/null +++ b/data/reusables/git/clear-the-stored-credentials.md @@ -0,0 +1 @@ +1. If the output confirms that you're using a credential manager, clear the stored credentials for the credential manager. diff --git a/data/reusables/git/confirm-credential-manager.md b/data/reusables/git/confirm-credential-manager.md new file mode 100644 index 0000000000..68c6e99397 --- /dev/null +++ b/data/reusables/git/confirm-credential-manager.md @@ -0,0 +1,5 @@ +1. To confirm your use of a credential manager, enter the following command and note the output. + + ```shell{:copy} + git config --get credential.helper + ``` diff --git a/data/reusables/git/no-credential-manager.md b/data/reusables/git/no-credential-manager.md new file mode 100644 index 0000000000..fe79c2ff04 --- /dev/null +++ b/data/reusables/git/no-credential-manager.md @@ -0,0 +1 @@ +- If the output doesn't include the name of a credential manager, there is no credential manager configured, and you can proceed to the next step. \ No newline at end of file diff --git a/data/reusables/git/open-terminal.md b/data/reusables/git/open-terminal.md new file mode 100644 index 0000000000..7e53780c32 --- /dev/null +++ b/data/reusables/git/open-terminal.md @@ -0,0 +1 @@ +1. Open Terminal. diff --git a/data/reusables/git/provide-credentials.md b/data/reusables/git/provide-credentials.md new file mode 100644 index 0000000000..351a1e87d1 --- /dev/null +++ b/data/reusables/git/provide-credentials.md @@ -0,0 +1,3 @@ +1. The first time that you use Git to clone a repository or access data in a repository that you've already cloned, Git will request credentials. Provide the PAT for the account with access to the repository. + + Git will cache the PAT for the directory you're in, and you'll be able to access and write repository data on {% data variables.product.product_location %} using the correct account. diff --git a/data/reusables/gpg/configure-ssh-signing.md b/data/reusables/gpg/configure-ssh-signing.md new file mode 100644 index 0000000000..f0f489a73a --- /dev/null +++ b/data/reusables/gpg/configure-ssh-signing.md @@ -0,0 +1,4 @@ +1. Configure Git to use SSH to sign commits and tags: + ```bash + $ git config --global gpg.format ssh + ``` \ No newline at end of file diff --git a/data/reusables/gpg/copy-gpg-key-id.md b/data/reusables/gpg/copy-gpg-key-id.md index 944dd0f138..327fc59509 100644 --- a/data/reusables/gpg/copy-gpg-key-id.md +++ b/data/reusables/gpg/copy-gpg-key-id.md @@ -1,9 +1,9 @@ 1. From the list of GPG keys, copy the long form of the GPG key ID you'd like to use. In this example, the GPG key ID is `3AA5C34371567BD2`: - ```shell + ```shell{:copy} $ gpg --list-secret-keys --keyid-format=long /Users/hubot/.gnupg/secring.gpg ------------------------------------ sec 4096R/3AA5C34371567BD2 2016-03-10 [expires: 2017-03-10] uid Hubot ssb 4096R/42B317FD4BA89E7A 2016-03-10 - ``` + ``` diff --git a/data/reusables/gpg/copy-ssh-public-key.md b/data/reusables/gpg/copy-ssh-public-key.md new file mode 100644 index 0000000000..3306792aba --- /dev/null +++ b/data/reusables/gpg/copy-ssh-public-key.md @@ -0,0 +1,43 @@ +1. Copy the SSH public key to your clipboard. + + If your SSH public key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace. +{% mac %} + + ```shell + $ pbcopy < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub + # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard + ``` + + {% tip %} + + **Tip:** If `pbcopy` isn't working, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. + + {% endtip %} +{% endmac %} +{% windows %} + + ```shell + $ clip < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub + # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard + ``` + + {% tip %} + + **Tip:** If `clip` isn't working, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. + + {% endtip %} +{% endwindows %} +{% linux %} + + ```shell + $ cat ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub + # Then select and copy the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file + # displayed in the terminal to your clipboard + ``` + + {% tip %} + + **Tip:** Alternatively, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. + + {% endtip %} +{% endlinux %} diff --git a/data/reusables/gpg/list-keys-with-note.md b/data/reusables/gpg/list-keys-with-note.md index 3dfe6910ca..ed154975cb 100644 --- a/data/reusables/gpg/list-keys-with-note.md +++ b/data/reusables/gpg/list-keys-with-note.md @@ -1,10 +1,11 @@ - 1. Use the `gpg --list-secret-keys --keyid-format=long` command to list the long form of the GPG keys for which you have both a public and private key. A private key is required for signing commits or tags. - ```shell - $ gpg --list-secret-keys --keyid-format=long -``` - {% note %} - **Note:** Some GPG installations on Linux may require you to use `gpg2 --list-keys --keyid-format LONG` to view a list of your existing keys instead. In this case you will also need to configure Git to use `gpg2` by running `git config --global gpg.program gpg2`. + ```shell{:copy} + $ gpg --list-secret-keys --keyid-format=long + ``` + + {% note %} - {% endnote %} + **Note:** Some GPG installations on Linux may require you to use `gpg2 --list-keys --keyid-format LONG` to view a list of your existing keys instead. In this case you will also need to configure Git to use `gpg2` by running `git config --global gpg.program gpg2`. + + {% endnote %} diff --git a/data/reusables/gpg/paste-ssh-public-key.md b/data/reusables/gpg/paste-ssh-public-key.md new file mode 100644 index 0000000000..1274a0acb5 --- /dev/null +++ b/data/reusables/gpg/paste-ssh-public-key.md @@ -0,0 +1,4 @@ +1. To set your SSH signing key in Git, paste the text below, substituting the contents of your clipboard for the key you'd like to use. Since the key contains spaces, you must wrap it in quotes: + ```bash + $ git config --global user.signingkey 'ssh-ed25519 AAAAC3(...) user@example.com' + ``` \ No newline at end of file diff --git a/data/reusables/gpg/ssh-git-version.md b/data/reusables/gpg/ssh-git-version.md new file mode 100644 index 0000000000..00395fab29 --- /dev/null +++ b/data/reusables/gpg/ssh-git-version.md @@ -0,0 +1,6 @@ + +{% note %} + +**Note:** SSH signature verification is available in Git 2.34 or later. To update your version of Git, see the [Git](https://git-scm.com/downloads) website. + +{% endnote %} diff --git a/data/reusables/gpg/x-509-key.md b/data/reusables/gpg/x-509-key.md index 7bb93711ea..6848f78d42 100644 --- a/data/reusables/gpg/x-509-key.md +++ b/data/reusables/gpg/x-509-key.md @@ -1,5 +1,5 @@ -### Telling Git about your X.509 key +## Telling Git about your X.509 key You can use [smimesign](https://github.com/github/smimesign) to sign commits and tags using S/MIME instead of GPG. diff --git a/data/reusables/identity-and-permissions/about-adding-ip-allow-list-entries.md b/data/reusables/identity-and-permissions/about-adding-ip-allow-list-entries.md new file mode 100644 index 0000000000..772581f87a --- /dev/null +++ b/data/reusables/identity-and-permissions/about-adding-ip-allow-list-entries.md @@ -0,0 +1,3 @@ +You can create an IP allow list by adding entries that each contain an IP address or address range.{% ifversion ip-allow-list-address-check %} After you finish adding entries, you can check whether a particular IP address would be allowed by any of the enabled entries in your list.{% endif %} + +Before the list restricts access to {% ifversion ghae %}your enterprise{% else %}private assets owned by organizations in your enterprise{% endif %}, you must also enable allowed IP addresses. \ No newline at end of file diff --git a/data/reusables/identity-and-permissions/about-checking-ip-address.md b/data/reusables/identity-and-permissions/about-checking-ip-address.md new file mode 100644 index 0000000000..dfdc758f91 --- /dev/null +++ b/data/reusables/identity-and-permissions/about-checking-ip-address.md @@ -0,0 +1 @@ +You can check whether a particular IP address would be allowed by any of the enabled entries in your IP allow list, even if the list is not currently enabled. \ No newline at end of file diff --git a/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md b/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md new file mode 100644 index 0000000000..1e189b909d --- /dev/null +++ b/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md @@ -0,0 +1,5 @@ +You can edit an entry in your IP allow list. If you edit an enabled entry, changes are enforced immediately. + +{% ifversion ip-allow-list-address-check %} +After you finish editing entries, you can check whether a particular IP address would be allowed by any of the enabled entries in your list. +{% endif %} \ No newline at end of file diff --git a/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md b/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md new file mode 100644 index 0000000000..dde4e9bc05 --- /dev/null +++ b/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md @@ -0,0 +1,5 @@ +After you create an IP allow list, you can enable allowed IP addresses. When you enable allowed IP addresses, {% data variables.product.company_short %} immediately enforces any enabled entries in your IP allow list. + +{% ifversion ip-allow-list-address-check %} +Before you enable allowed IP addresses, you can check whether a particular IP address would be allowed by any of the enabled entries in your list. For more information, see "[Checking if an IP address is permitted](#checking-if-an-ip-address-is-permitted)." +{% endif %} \ No newline at end of file diff --git a/data/reusables/identity-and-permissions/check-ip-address-step.md b/data/reusables/identity-and-permissions/check-ip-address-step.md new file mode 100644 index 0000000000..cb4ba79b1b --- /dev/null +++ b/data/reusables/identity-and-permissions/check-ip-address-step.md @@ -0,0 +1,2 @@ +1. Under "Check your IP address", enter an IP address. + ![Screenshot of the "Check IP address" text field](/assets/images/help/security/check-ip-address.png) \ No newline at end of file diff --git a/data/reusables/identity-and-permissions/check-ip-address.md b/data/reusables/identity-and-permissions/check-ip-address.md new file mode 100644 index 0000000000..9a187752d6 --- /dev/null +++ b/data/reusables/identity-and-permissions/check-ip-address.md @@ -0,0 +1,3 @@ +{%- ifversion ip-allow-list-address-check %} +1. Optionally, check if a particular IP address would be allowed by any of the enabled entries in your list. For more information, see "[Checking if an IP address is permitted](#checking-if-an-ip-address-is-permitted)." +{%- endif %} \ No newline at end of file diff --git a/data/reusables/identity-and-permissions/ip-allow-lists-enable.md b/data/reusables/identity-and-permissions/ip-allow-lists-enable.md index ada28fa49e..9b382356fa 100644 --- a/data/reusables/identity-and-permissions/ip-allow-lists-enable.md +++ b/data/reusables/identity-and-permissions/ip-allow-lists-enable.md @@ -1 +1,3 @@ -To enforce the IP allow list, you must first add IP addresses to the list, then enable the IP allow list. You must add your current IP address, or a matching range, before you enable the IP allow list. +To enforce the IP allow list, you must first add IP addresses to the list, then enable the IP allow list.{% ifversion ip-allow-list-address-check %} After you complete your list, you can check whether a particular IP address would be allowed by any of the enabled entries in the list.{% endif %} + +You must add your current IP address, or a matching range, before you enable the IP allow list. diff --git a/data/reusables/identity-and-permissions/ipv6-allow-lists.md b/data/reusables/identity-and-permissions/ipv6-allow-lists.md new file mode 100644 index 0000000000..3c26491fe2 --- /dev/null +++ b/data/reusables/identity-and-permissions/ipv6-allow-lists.md @@ -0,0 +1,7 @@ +{% ifversion fpt or ghec %} +{% note %} + +**Note:** {% data variables.product.company_short %} is gradually rolling out support for IPv6. As {% data variables.product.prodname_dotcom %} services continue to add IPv6 support, we will start recognizing IPv6 addresses of {% data variables.product.prodname_dotcom %} users. To prevent possible access interruptions, please ensure you have added any necessary IPv6 addresses to your IP allow list. + +{% endnote %} +{% endif %} \ No newline at end of file diff --git a/data/reusables/organizations/about-following-organizations.md b/data/reusables/organizations/about-following-organizations.md new file mode 100644 index 0000000000..52e52467fb --- /dev/null +++ b/data/reusables/organizations/about-following-organizations.md @@ -0,0 +1 @@ +When you follow organizations on {% data variables.product.product_name %}, you'll see their {% ifversion fpt or ghec %}public{% endif %} activity on your personal dashboard. This activity includes new discussions, sponsorships, and repositories. \ No newline at end of file diff --git a/data/reusables/organizations/follow-organizations-beta.md b/data/reusables/organizations/follow-organizations-beta.md new file mode 100644 index 0000000000..1730f73ccd --- /dev/null +++ b/data/reusables/organizations/follow-organizations-beta.md @@ -0,0 +1,5 @@ +{% note %} + +**Note:** The ability to follow organizations is currently in public beta and subject to change. + +{% endnote %} \ No newline at end of file diff --git a/data/reusables/package_registry/authenticate-packages.md b/data/reusables/package_registry/authenticate-packages.md index a766f6e96d..5ca4e91584 100644 --- a/data/reusables/package_registry/authenticate-packages.md +++ b/data/reusables/package_registry/authenticate-packages.md @@ -4,4 +4,4 @@ You can use a personal access token (PAT) to authenticate to {% data variables.p To authenticate to a {% data variables.product.prodname_registry %} registry within a {% data variables.product.prodname_actions %} workflow, you can use: - `GITHUB_TOKEN` to publish packages associated with the workflow repository. -- a PAT to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). +- a PAT with at least `packages:read` scope to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). diff --git a/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md b/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md deleted file mode 100644 index a54f9a0844..0000000000 --- a/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md +++ /dev/null @@ -1,11 +0,0 @@ -{% ifversion fpt or ghec or ghes > 3.4 %} - -To authenticate to the {% data variables.product.prodname_container_registry %} within a {% data variables.product.prodname_actions %} workflow, use the `GITHUB_TOKEN` for the best security and experience. If your workflow is using a personal access token (PAT) to authenticate to `{% data reusables.package_registry.container-registry-hostname %}`, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. - -{% ifversion fpt or ghec %}For guidance on updating your workflows that authenticate to `{% data reusables.package_registry.container-registry-hostname %}` with a personal access token, see "[Upgrading a workflow that accesses `ghcr.io`](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#upgrading-a-workflow-that-accesses-ghcrio)."{% endif %} - -For more information about the `GITHUB_TOKEN`, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)." - -If you're using the {% data variables.product.prodname_container_registry %} in actions, follow our security best practices at "[Security hardening for GitHub Actions](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)." - -{% endif %} diff --git a/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md b/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md new file mode 100644 index 0000000000..023e44c78c --- /dev/null +++ b/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md @@ -0,0 +1,7 @@ +If your workflow is using a personal access token (PAT) to authenticate to a registry, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. + +{% ifversion fpt or ghec %}For guidance on updating your workflows that authenticate to a registry with a personal access token, see "[Upgrading a workflow that accesses a registry using a PAT](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#upgrading-a-workflow-that-accesses-a-registry-using-a-pat)."{% endif %} + +For more information about the `GITHUB_TOKEN`, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)." + +For more information about the best practises when using a registry in actions, see "[Security hardening for GitHub Actions](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)." diff --git a/data/reusables/package_registry/no-graphql-to-delete-packages.md b/data/reusables/package_registry/no-graphql-to-delete-packages.md new file mode 100644 index 0000000000..cbab609f2b --- /dev/null +++ b/data/reusables/package_registry/no-graphql-to-delete-packages.md @@ -0,0 +1 @@ +{% ifversion fpt or ghec %} The {% data variables.product.prodname_registry %} GraphQL API does not support containers or Docker images that use the package namespace `https://ghcr.io/OWNER/PACKAGE-NAME`, or npm images that use the package namespace `https://npm.pkg.github.com/OWNER/PACKAGE-NAME`.{% endif %} \ No newline at end of file diff --git a/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md b/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md index 67593664e7..14f4157528 100644 --- a/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md +++ b/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md @@ -1,16 +1,16 @@ -{% ifversion ghes > 3.1 or ghes < 3.5 %} +{% ifversion ghes < 3.5 %} -In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server 3.5 or later may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 when you upgrade from an earlier release to 3.5 or later. A fix for 3.5 and later will be available in an upcoming patch release. +In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server 3.5 or later may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 when you upgrade from an earlier release to 3.5 or later. A fix will be available in upcoming patch releases. -To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). [Updated: 2022-08-16] +To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). [Updated: 2022-08-26] -{% elsif ghes > 3.4 or ghes < 3.7 %} +{% elsif ghes = 3.5 or ghes = 3.6 %} -In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server {{ currentVersion }} may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 as you upgrade to the latest release. To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). +In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server {{ allVersions[currentVersion].currentRelease }} may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 as you upgrade to the latest release. To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). - To display the missing alerts for all repositories owned by an organization, organization owners can navigate to the organization's **Code security and analysis** settings, then click **Enable all** for secret scanning. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories)." - To display the missing alerts for an individual repository, people with admin access to the repository can disable then enable secret scanning for the repository. For more information, see "[Managing security and analysis settings for your repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)." -A fix will be available in an upcoming patch release. [Updated: 2022-08-16] +A fix will be available in an upcoming patch release. [Updated: 2022-08-26] {% endif %} diff --git a/data/reusables/secret-scanning/push-protection-web-ui-choice.md b/data/reusables/secret-scanning/push-protection-web-ui-choice.md index 31e85566d4..682eee5ec7 100644 --- a/data/reusables/secret-scanning/push-protection-web-ui-choice.md +++ b/data/reusables/secret-scanning/push-protection-web-ui-choice.md @@ -2,5 +2,12 @@ When you use the web UI to attempt to commit a supported secret to a repository You will see a banner at the top of the page with information about the secret's location, and the secret will also be underlined in the file so you can easily find it. +{% ifversion push-protection-custom-link-orgs %} + + ![Screenshot showing commit in web ui blocked because of secret scanning push protection](/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-blocked-banner-with-link.png) + +{% else %} + ![Screenshot showing commit in web ui blocked because of secret scanning push protection](/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-blocked-banner.png) - \ No newline at end of file + +{% endif %} \ No newline at end of file diff --git a/data/variables/product.yml b/data/variables/product.yml index b7beb0e583..90baf84430 100644 --- a/data/variables/product.yml +++ b/data/variables/product.yml @@ -139,6 +139,10 @@ prodname_registry: 'GitHub Packages' prodname_container_registry: 'Container registry' prodname_docker_registry_namespace: '{% ifversion fpt or ghec %}`docker.pkg.github.com`{% elsif ghes or ghae %}docker.HOSTNAME{% endif %}' prodname_container_registry_namespace: '{% ifversion fpt or ghec %}`ghcr.io`{% elsif ghes or ghae %}containers.HOSTNAME{% endif %}' +prodname_npm_registry: 'npm registry' +prodname_ghcr_and_npm_registry: '{% data variables.product.prodname_container_registry %}{% ifversion packages-npm-v2 %} and {% data variables.product.prodname_npm_registry %}{% endif %}' +prodname_ghcr_or_npm_registry: '{% data variables.product.prodname_container_registry %}{% ifversion packages-npm-v2 %} or {% data variables.product.prodname_npm_registry %}{% endif %}' +prodname_ghcr_and_npm_registry_full: '{% data variables.product.prodname_container_registry %} (`ghcr.io`){% ifversion packages-npm-v2 %} and {% data variables.product.prodname_npm_registry %} (`npm.pkg.github.com`){% endif %}' # GitHub Insights prodname_insights: 'GitHub Insights' diff --git a/jest.config.js b/jest.config.js index 7539481b98..404781c322 100644 --- a/jest.config.js +++ b/jest.config.js @@ -8,6 +8,7 @@ let reporters = ['default'] if (testTranslation) { // only use custom reporter if we are linting translations + // Remove this when removing translations directory B504EDD0 reporters = ['/tests/helpers/lint-translation-reporter.js'] } else if (isActions) { reporters.push('jest-github-actions-reporter') diff --git a/lib/failbot.js b/lib/failbot.js index 0189ff27a9..46ed67babd 100644 --- a/lib/failbot.js +++ b/lib/failbot.js @@ -33,9 +33,11 @@ async function retryingGot(url, args) { ) } -export async function report(error, metadata) { +export function report(error, metadata) { // If there's no HAYSTACK_URL set, bail early - if (!process.env.HAYSTACK_URL) return + if (!process.env.HAYSTACK_URL) { + return + } const backends = [ new HTTPBackend({ @@ -47,6 +49,7 @@ export async function report(error, metadata) { app: HAYSTACK_APP, backends, }) + return failbot.report(error, metadata) } diff --git a/lib/frontmatter.js b/lib/frontmatter.js index 8dd1df3ccd..86d6ce1e50 100644 --- a/lib/frontmatter.js +++ b/lib/frontmatter.js @@ -62,6 +62,11 @@ export const schema = { noEarlyAccessBanner: { type: 'boolean', }, + // specify whether an Early Acccess product should have a table of contents + // (EA categories and map topics have them by default, but products don't) + earlyAccessToc: { + type: 'boolean', + }, layout: { type: ['string', 'boolean'], enum: layoutNames, diff --git a/lib/graphql/static/changelog.json b/lib/graphql/static/changelog.json index d7ad97e746..99353a9e00 100644 --- a/lib/graphql/static/changelog.json +++ b/lib/graphql/static/changelog.json @@ -1,4 +1,49 @@ [ + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "

    Enum value GITHUB was removed from enum MigrationSourceType

    ", + "

    Enum value GITLAB was removed from enum MigrationSourceType

    " + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2022-08-26" + }, + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "

    Input field createLabelsIfMissing was added to input object type TransferIssueInput

    " + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2022-08-24" + }, + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [] + } + ], + "previewChanges": [], + "upcomingChanges": [ + { + "title": "The following changes will be made to the schema:", + "changes": [ + "

    On member ProjectView.groupedItems:groupedItems will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement. Effective 2022-10-01.

    " + ] + } + ], + "date": "2022-08-22" + }, { "schemaChanges": [ { diff --git a/lib/graphql/static/schema-dotcom.json b/lib/graphql/static/schema-dotcom.json index 2a3796ad61..81b5fe1859 100644 --- a/lib/graphql/static/schema-dotcom.json +++ b/lib/graphql/static/schema-dotcom.json @@ -12432,7 +12432,7 @@ }, { "name": "minimizedReason", - "description": "

    Returns why the comment was minimized.

    ", + "description": "

    Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

    ", "type": "String", "id": "string", "kind": "scalars", @@ -17758,7 +17758,7 @@ }, { "name": "minimizedReason", - "description": "

    Returns why the comment was minimized.

    ", + "description": "

    Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

    ", "type": "String", "id": "string", "kind": "scalars", @@ -23722,7 +23722,7 @@ }, { "name": "minimizedReason", - "description": "

    Returns why the comment was minimized.

    ", + "description": "

    Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

    ", "type": "String", "id": "string", "kind": "scalars", @@ -26154,7 +26154,7 @@ }, { "name": "minimizedReason", - "description": "

    Returns why the comment was minimized.

    ", + "description": "

    Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

    ", "type": "String", "id": "string", "kind": "scalars", @@ -47356,7 +47356,7 @@ }, { "name": "minimizedReason", - "description": "

    Returns why the comment was minimized.

    ", + "description": "

    Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

    ", "type": "String", "id": "string", "kind": "scalars", @@ -70787,7 +70787,7 @@ }, { "name": "minimizedReason", - "description": "

    Returns why the comment was minimized.

    ", + "description": "

    Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

    ", "type": "String", "id": "string", "kind": "scalars", @@ -74864,17 +74864,9 @@ "name": "BITBUCKET_SERVER", "description": "

    A Bitbucket Server migration source.

    " }, - { - "name": "GITHUB", - "description": "

    A GitHub migration source.

    " - }, { "name": "GITHUB_ARCHIVE", "description": "

    A GitHub Migration API source.

    " - }, - { - "name": "GITLAB", - "description": "

    A GitLab migration source.

    " } ] }, @@ -87260,6 +87252,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "createLabelsIfMissing", + "description": "

    Whether to create labels if they don't exist in the target repository (matched by name).

    ", + "type": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "issueId", "description": "

    The Node ID of the issue to be transferred.

    ", diff --git a/lib/graphql/static/schema-ghae.json b/lib/graphql/static/schema-ghae.json index 8d37681935..69e6a7c5de 100644 --- a/lib/graphql/static/schema-ghae.json +++ b/lib/graphql/static/schema-ghae.json @@ -10759,7 +10759,7 @@ }, { "name": "minimizedReason", - "description": "

    Returns why the comment was minimized.

    ", + "description": "

    Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

    ", "type": "String", "id": "string", "kind": "scalars", @@ -15646,7 +15646,7 @@ }, { "name": "minimizedReason", - "description": "

    Returns why the comment was minimized.

    ", + "description": "

    Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

    ", "type": "String", "id": "string", "kind": "scalars", @@ -20824,7 +20824,7 @@ }, { "name": "minimizedReason", - "description": "

    Returns why the comment was minimized.

    ", + "description": "

    Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

    ", "type": "String", "id": "string", "kind": "scalars", @@ -22787,7 +22787,7 @@ }, { "name": "minimizedReason", - "description": "

    Returns why the comment was minimized.

    ", + "description": "

    Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

    ", "type": "String", "id": "string", "kind": "scalars", @@ -37716,7 +37716,7 @@ }, { "name": "minimizedReason", - "description": "

    Returns why the comment was minimized.

    ", + "description": "

    Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

    ", "type": "String", "id": "string", "kind": "scalars", @@ -58483,7 +58483,7 @@ }, { "name": "minimizedReason", - "description": "

    Returns why the comment was minimized.

    ", + "description": "

    Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

    ", "type": "String", "id": "string", "kind": "scalars", @@ -61371,17 +61371,9 @@ "name": "BITBUCKET_SERVER", "description": "

    A Bitbucket Server migration source.

    " }, - { - "name": "GITHUB", - "description": "

    A GitHub migration source.

    " - }, { "name": "GITHUB_ARCHIVE", "description": "

    A GitHub Migration API source.

    " - }, - { - "name": "GITLAB", - "description": "

    A GitLab migration source.

    " } ] }, @@ -71048,6 +71040,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "createLabelsIfMissing", + "description": "

    Whether to create labels if they don't exist in the target repository (matched by name).

    ", + "type": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "issueId", "description": "

    The Node ID of the issue to be transferred.

    ", diff --git a/lib/graphql/static/schema-ghec.json b/lib/graphql/static/schema-ghec.json index 2a3796ad61..81b5fe1859 100644 --- a/lib/graphql/static/schema-ghec.json +++ b/lib/graphql/static/schema-ghec.json @@ -12432,7 +12432,7 @@ }, { "name": "minimizedReason", - "description": "

    Returns why the comment was minimized.

    ", + "description": "

    Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

    ", "type": "String", "id": "string", "kind": "scalars", @@ -17758,7 +17758,7 @@ }, { "name": "minimizedReason", - "description": "

    Returns why the comment was minimized.

    ", + "description": "

    Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

    ", "type": "String", "id": "string", "kind": "scalars", @@ -23722,7 +23722,7 @@ }, { "name": "minimizedReason", - "description": "

    Returns why the comment was minimized.

    ", + "description": "

    Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

    ", "type": "String", "id": "string", "kind": "scalars", @@ -26154,7 +26154,7 @@ }, { "name": "minimizedReason", - "description": "

    Returns why the comment was minimized.

    ", + "description": "

    Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

    ", "type": "String", "id": "string", "kind": "scalars", @@ -47356,7 +47356,7 @@ }, { "name": "minimizedReason", - "description": "

    Returns why the comment was minimized.

    ", + "description": "

    Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

    ", "type": "String", "id": "string", "kind": "scalars", @@ -70787,7 +70787,7 @@ }, { "name": "minimizedReason", - "description": "

    Returns why the comment was minimized.

    ", + "description": "

    Returns why the comment was minimized. One of abuse, off-topic,\noutdated, resolved, duplicate and spam. Note that the case and\nformatting of these values differs from the inputs to the MinimizeComment mutation.

    ", "type": "String", "id": "string", "kind": "scalars", @@ -74864,17 +74864,9 @@ "name": "BITBUCKET_SERVER", "description": "

    A Bitbucket Server migration source.

    " }, - { - "name": "GITHUB", - "description": "

    A GitHub migration source.

    " - }, { "name": "GITHUB_ARCHIVE", "description": "

    A GitHub Migration API source.

    " - }, - { - "name": "GITLAB", - "description": "

    A GitLab migration source.

    " } ] }, @@ -87260,6 +87252,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "createLabelsIfMissing", + "description": "

    Whether to create labels if they don't exist in the target repository (matched by name).

    ", + "type": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "issueId", "description": "

    The Node ID of the issue to be transferred.

    ", diff --git a/lib/graphql/static/upcoming-changes.json b/lib/graphql/static/upcoming-changes.json index adb90ab1d9..f39dbb9963 100644 --- a/lib/graphql/static/upcoming-changes.json +++ b/lib/graphql/static/upcoming-changes.json @@ -273,6 +273,14 @@ "criticality": "breaking", "owner": "lukewar" }, + { + "location": "ProjectView.groupedItems", + "description": "

    groupedItems will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.

    ", + "reason": "

    The ProjectNext API is deprecated in favour of the more capable ProjectV2 API.

    ", + "date": "2022-10-01", + "criticality": "breaking", + "owner": "lukewar" + }, { "location": "ProjectView.groupBy", "description": "

    groupBy will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.

    ", @@ -1703,6 +1711,14 @@ "criticality": "breaking", "owner": "lukewar" }, + { + "location": "ProjectView.groupedItems", + "description": "

    groupedItems will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.

    ", + "reason": "

    The ProjectNext API is deprecated in favour of the more capable ProjectV2 API.

    ", + "date": "2022-10-01", + "criticality": "breaking", + "owner": "lukewar" + }, { "location": "ProjectView.groupBy", "description": "

    groupBy will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.

    ", diff --git a/lib/handle-exceptions.js b/lib/handle-exceptions.js index a6ce0adc57..dda3894c9a 100644 --- a/lib/handle-exceptions.js +++ b/lib/handle-exceptions.js @@ -10,7 +10,7 @@ process.on('uncaughtException', async (err) => { console.error(err) try { - await FailBot.report(err) + FailBot.report(err) } catch (failBotError) { console.warn('Even sending the uncaughtException error to FailBot failed!') console.error(failBotError) @@ -20,7 +20,7 @@ process.on('uncaughtException', async (err) => { process.on('unhandledRejection', async (err) => { console.error(err) try { - await FailBot.report(err) + FailBot.report(err) } catch (failBotError) { console.warn('Even sending the unhandledRejection error to FailBot failed!') console.error(failBotError) diff --git a/lib/redis/create-client.js b/lib/redis/create-client.js deleted file mode 100644 index 5783661262..0000000000 --- a/lib/redis/create-client.js +++ /dev/null @@ -1,171 +0,0 @@ -import Redis from 'redis' - -const { REDIS_MIN_DB, REDIS_MAX_DB } = process.env - -// By default, every Redis instance supports database numbers 0 - 15 -const redisMinDb = REDIS_MIN_DB || 0 -const redisMaxDb = REDIS_MAX_DB || 15 - -// Maximum delay between reconnection attempts after backoff -const maxReconnectDelay = 5000 - -function formatRedisError(error) { - const errorCode = error ? error.code : null - const errorName = error ? error.constructor.name : 'Server disconnection' - const errorMsg = error ? error.toString() : 'unknown (commonly a server idle timeout)' - const preamble = errorName + (errorCode ? ` with code "${errorCode}"` : '') - return preamble + ': ' + errorMsg -} - -export default function createClient(options = {}) { - const { db, name, url } = options - - // If no Redis URL is provided, bail out - // NOTE: Could support other options like `host`, `port`, and `path` but - // choosing not to for the time being! - if (!url) return null - - // Verify database number is within range - if (db != null) { - if (!Number.isInteger(db) || db < redisMinDb || db > redisMaxDb) { - throw new TypeError( - `Redis database number must be an integer between ${redisMinDb} and ${redisMaxDb} but was: ${JSON.stringify( - db - )}` - ) - } - } - - let pingInterval = null - function stopPinging() { - if (pingInterval) { - clearInterval(pingInterval) - pingInterval = null - } - } - - // Create the client - const client = Redis.createClient(url, { - // Only add this configuration for TLS-enabled Redis URL values. - // Otherwise, it breaks for local Redis instances without TLS enabled. - ...(url.startsWith('rediss://') && { - tls: { - // Required for production Heroku Redis - rejectUnauthorized: false, - }, - }), - - // Any running command that is unfulfilled when a connection is lost should - // NOT be retried after the connection has been reestablished. - retry_unfulfilled_commands: false, - - // If we failed to send a new command during a disconnection, do NOT - // enqueue it to send later after the connection has been [re-]established. - // This is also critical to preventing a backend pile-up! - enable_offline_queue: false, - - // This timeout value will be applied to both the initial connection - // and any auto-reconnect attempts (if the `retry_strategy` option is - // provided). If not using the `retry_strategy` option, this value can be - // set to a very low number. If using the `retry_strategy` option to allow - // more than one reconnection attempt, this value must be set to a higher - // number. Defaults to 1 hour if not configured! - connect_timeout: 60 * 60 * 1000, // 60 minutes - - // Be aware that this retry (NOT just reconnection) strategy appears to - // be a major point of confusion (and possibly legitimate issues) between - // reconnecting and retrying failed commands. - retry_strategy: function ({ - attempt, - error, - total_retry_time: totalRetryTime, - times_connected: timesConnected, - }) { - let delayPerAttempt = 100 - - // If the server appears to be unavailable, slow down faster - if (error && error.code === 'ECONNREFUSED') { - delayPerAttempt *= 5 - } - - // Reconnect after delay - return Math.min(attempt * delayPerAttempt, maxReconnectDelay) - }, - - // Expand whatever other options and overrides were provided - ...options, - }) - - // Handle connection errors to prevent killing the Node.js process - client.on('error', (connectError) => { - try { - // Forcibly close the connection to the Redis server. - // Allow all still running commands to silently fail immediately. - client.end(false) - } catch (disconnectError) { - // Swallow any failure - } - - // Also, stop pinging the Redis server - stopPinging() - }) - - client.on('connect', () => { - // Stop pinging the Redis server, if any such timer already exists - stopPinging() - - // Start pinging the server once per minute to prevent Redis connection - // from closing when its idle `timeout` configuration value expires - pingInterval = setInterval(() => { - client.ping(() => {}) - }, 60 * 1000) - }) - - client.on('end', () => { - // Stop pinging the Redis server - stopPinging() - }) - - // If a `name` was provided, use it in the prefix for logging event messages - const logPrefix = '[redis' + (name ? ` (${name})` : '') + ']' - - // Add event listeners for basic logging - client.on('connect', () => { - console.log(logPrefix, 'Connection opened') - }) - client.on('ready', () => { - console.log(logPrefix, 'Ready to receive commands') - }) - client.on('end', () => { - console.log(logPrefix, 'Connection closed') - }) - client.on( - 'reconnecting', - ({ - attempt, - delay, - // The rest are unofficial properties but currently supported - error, - total_retry_time: totalRetryTime, - times_connected: timesConnected, - }) => { - console.log( - logPrefix, - 'Reconnecting,', - `attempt ${attempt}`, - `with ${delay} delay`, - `due to ${formatRedisError(error)}.`, - `Elapsed time: ${totalRetryTime}.`, - `Successful connections: ${timesConnected}.` - ) - } - ) - client.on('warning', (msg) => { - console.warn(logPrefix, 'Warning:', msg) - }) - client.on('error', (error) => { - console.error(logPrefix, formatRedisError(error)) - }) - - return client -} diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 340e737ff6..7aa23aaaf3 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -1675,14 +1675,10 @@ ], "bodyParameters": [ { - "description": "

    Whether the enterprise customer requested a custom issuer URL.

    ", "type": "boolean", - "examples": [ - true - ], "name": "include_enterprise_slug", "in": "body", - "isRequired": false + "description": "

    Whether the enterprise customer requested a custom issuer URL.

    " } ], "enabledForGitHubApps": true, @@ -2127,27 +2123,26 @@ "bodyParameters": [ { "type": "string", + "name": "enabled_organizations", + "in": "body", "description": "

    The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.

    ", + "isRequired": true, "enum": [ "all", "none", "selected" - ], - "name": "enabled_organizations", - "in": "body", - "isRequired": true + ] }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions and reusable workflows that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": false, @@ -2398,10 +2393,10 @@ ], "bodyParameters": [ { - "description": "

    List of organization IDs to enable for GitHub Actions.

    ", "type": "array of integers", "name": "selected_organization_ids", "in": "body", + "description": "

    List of organization IDs to enable for GitHub Actions.

    ", "isRequired": true } ], @@ -2643,24 +2638,21 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", - "isRequired": false + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    " }, { "type": "boolean", - "description": "

    Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

    ", "name": "verified_allowed", "in": "body", - "isRequired": false + "description": "

    Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

    " }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", - "isRequired": false + "description": "

    Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    " } ], "enabledForGitHubApps": false, @@ -2790,21 +2782,19 @@ "bodyParameters": [ { "type": "string", + "name": "default_workflow_permissions", + "in": "body", "description": "

    The default workflow permissions granted to the GITHUB_TOKEN when running workflows.

    ", "enum": [ "read", "write" - ], - "name": "default_workflow_permissions", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

    ", "name": "can_approve_pull_request_reviews", "in": "body", - "isRequired": false + "description": "

    Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

    " } ], "enabledForGitHubApps": true, @@ -2944,27 +2934,26 @@ "bodyParameters": [ { "type": "string", + "name": "enabled_repositories", + "in": "body", "description": "

    The policy that controls the repositories in the organization that are allowed to run GitHub Actions.

    ", + "isRequired": true, "enum": [ "all", "none", "selected" - ], - "name": "enabled_repositories", - "in": "body", - "isRequired": true + ] }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions and reusable workflows that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -4680,10 +4669,10 @@ ], "bodyParameters": [ { - "description": "

    List of repository IDs to enable for GitHub Actions.

    ", "type": "array of integers", "name": "selected_repository_ids", "in": "body", + "description": "

    List of repository IDs to enable for GitHub Actions.

    ", "isRequired": true } ], @@ -4925,24 +4914,21 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", - "isRequired": false + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    " }, { "type": "boolean", - "description": "

    Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

    ", "name": "verified_allowed", "in": "body", - "isRequired": false + "description": "

    Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

    " }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", - "isRequired": false + "description": "

    Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    " } ], "enabledForGitHubApps": true, @@ -5072,21 +5058,19 @@ "bodyParameters": [ { "type": "string", + "name": "default_workflow_permissions", + "in": "body", "description": "

    The default workflow permissions granted to the GITHUB_TOKEN when running workflows.

    ", "enum": [ "read", "write" - ], - "name": "default_workflow_permissions", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

    ", "name": "can_approve_pull_request_reviews", "in": "body", - "isRequired": false + "description": "

    Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

    " } ], "enabledForGitHubApps": true, @@ -5240,22 +5224,21 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub Actions is enabled on the repository.

    ", "name": "enabled", "in": "body", + "description": "

    Whether GitHub Actions is enabled on the repository.

    ", "isRequired": true }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions and reusable workflows that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -5396,15 +5379,15 @@ "bodyParameters": [ { "type": "string", + "name": "access_level", + "in": "body", "description": "

    Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository. none means access is only possible from workflows in this repository.

    ", + "isRequired": true, "enum": [ "none", "organization", "enterprise" - ], - "name": "access_level", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -5552,24 +5535,21 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", - "isRequired": false + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    " }, { "type": "boolean", - "description": "

    Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

    ", "name": "verified_allowed", "in": "body", - "isRequired": false + "description": "

    Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

    " }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", - "isRequired": false + "description": "

    Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    " } ], "enabledForGitHubApps": true, @@ -5719,21 +5699,19 @@ "bodyParameters": [ { "type": "string", + "name": "default_workflow_permissions", + "in": "body", "description": "

    The default workflow permissions granted to the GITHUB_TOKEN when running workflows.

    ", "enum": [ "read", "write" - ], - "name": "default_workflow_permissions", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

    ", "name": "can_approve_pull_request_reviews", "in": "body", - "isRequired": false + "description": "

    Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

    " } ], "enabledForGitHubApps": true, @@ -6157,37 +6135,33 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret.

    ", + "isRequired": true, "enum": [ "all", "private", "selected" - ], - "name": "visibility", - "in": "body", - "isRequired": true + ] }, { "type": "array of integers", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", - "isRequired": false + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    " } ], "enabledForGitHubApps": true, @@ -8717,9 +8691,9 @@ "bodyParameters": [ { "type": "array of integers", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "isRequired": true } ], @@ -9271,18 +9245,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " } ], "enabledForGitHubApps": true, @@ -9794,17 +9765,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

    ", "isRequired": true }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", + "description": "

    ID of the key you used to encrypt the secret.

    ", "isRequired": true } ], @@ -10148,59 +10118,51 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all organizations or select individual organization.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all organizations or select individual organization.

    ", "enum": [ "selected", "all" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { - "description": "

    List of organization IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_organization_ids", "in": "body", - "isRequired": false + "description": "

    List of organization IDs that can access the runner group.

    " }, { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", - "isRequired": false + "description": "

    List of runner IDs to add to the runner group.

    " }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " }, { - "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    ", "type": "boolean", - "default": false, "name": "restricted_to_workflows", "in": "body", - "isRequired": false + "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    " }, { - "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    ", "type": "array of strings", "name": "selected_workflows", "in": "body", - "isRequired": false + "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    " } ], "enabledForGitHubApps": false, @@ -10466,46 +10428,39 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", - "isRequired": false + "description": "

    Name of the runner group.

    " }, { - "description": "

    Visibility of a runner group. You can select all organizations or select individual organizations.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all organizations or select individual organizations.

    ", "enum": [ "selected", "all" ], - "default": "all", - "name": "visibility", - "in": "body", - "isRequired": false + "default": "all" }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " }, { - "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    ", "type": "boolean", - "default": false, "name": "restricted_to_workflows", "in": "body", - "isRequired": false + "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    " }, { - "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    ", "type": "array of strings", "name": "selected_workflows", "in": "body", - "isRequired": false + "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    " } ], "enabledForGitHubApps": false, @@ -10901,10 +10856,10 @@ ], "bodyParameters": [ { - "description": "

    List of organization IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_organization_ids", "in": "body", + "description": "

    List of organization IDs that can access the runner group.

    ", "isRequired": true } ], @@ -11323,10 +11278,10 @@ ], "bodyParameters": [ { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", + "description": "

    List of runner IDs to add to the runner group.

    ", "isRequired": true } ], @@ -11711,61 +11666,53 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

    ", "enum": [ "selected", "all", "private" ], - "default": "all", - "name": "visibility", - "in": "body", - "isRequired": false + "default": "all" }, { - "description": "

    List of repository IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_repository_ids", "in": "body", - "isRequired": false + "description": "

    List of repository IDs that can access the runner group.

    " }, { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", - "isRequired": false + "description": "

    List of runner IDs to add to the runner group.

    " }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " }, { - "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    ", "type": "boolean", - "default": false, "name": "restricted_to_workflows", "in": "body", - "isRequired": false + "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    " }, { - "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    ", "type": "array of strings", "name": "selected_workflows", "in": "body", - "isRequired": false + "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    " } ], "enabledForGitHubApps": true, @@ -12049,46 +11996,40 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

    ", "enum": [ "selected", "all", "private" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " }, { - "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    ", "type": "boolean", - "default": false, "name": "restricted_to_workflows", "in": "body", - "isRequired": false + "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    " }, { - "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    ", "type": "array of strings", "name": "selected_workflows", "in": "body", - "isRequired": false + "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    " } ], "enabledForGitHubApps": true, @@ -14825,10 +14766,10 @@ ], "bodyParameters": [ { - "description": "

    List of repository IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_repository_ids", "in": "body", + "description": "

    List of repository IDs that can access the runner group.

    ", "isRequired": true } ], @@ -15247,10 +15188,10 @@ ], "bodyParameters": [ { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", + "description": "

    List of runner IDs to add to the runner group.

    ", "isRequired": true } ], @@ -19234,11 +19175,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "maxItems": 100, - "description": "

    The names of the custom labels to add to the runner.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to add to the runner.

    ", "isRequired": true } ], @@ -19381,11 +19320,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 0, - "maxItems": 100, - "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "isRequired": true } ], @@ -23581,11 +23518,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "maxItems": 100, - "description": "

    The names of the custom labels to add to the runner.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to add to the runner.

    ", "isRequired": true } ], @@ -23728,11 +23663,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 0, - "maxItems": 100, - "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "isRequired": true } ], @@ -28003,11 +27936,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "maxItems": 100, - "description": "

    The names of the custom labels to add to the runner.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to add to the runner.

    ", "isRequired": true } ], @@ -28160,11 +28091,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 0, - "maxItems": 100, - "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "isRequired": true } ], @@ -30067,11 +29996,9 @@ "bodyParameters": [ { "type": "boolean", - "default": false, - "description": "

    Whether to enable debug logging for the re-run.

    ", "name": "enable_debug_logging", "in": "body", - "isRequired": false + "description": "

    Whether to enable debug logging for the re-run.

    " } ], "enabledForGitHubApps": true, @@ -48025,37 +47952,27 @@ "bodyParameters": [ { "type": "array of integers", - "description": "

    The list of environment ids to approve or reject

    ", - "examples": [ - 161171787, - 161171795 - ], "name": "environment_ids", "in": "body", + "description": "

    The list of environment ids to approve or reject

    ", "isRequired": true }, { "type": "string", + "name": "state", + "in": "body", "description": "

    Whether to approve or reject deployment to the specified environments.

    ", + "isRequired": true, "enum": [ "approved", "rejected" - ], - "examples": [ - "approved" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    A comment to accompany the deployment review

    ", - "examples": [ - "Ship it!" - ], "name": "comment", "in": "body", + "description": "

    A comment to accompany the deployment review

    ", "isRequired": true } ], @@ -48816,11 +48733,9 @@ "bodyParameters": [ { "type": "boolean", - "default": false, - "description": "

    Whether to enable debug logging for the re-run.

    ", "name": "enable_debug_logging", "in": "body", - "isRequired": false + "description": "

    Whether to enable debug logging for the re-run.

    " } ], "enabledForGitHubApps": false, @@ -48901,11 +48816,9 @@ "bodyParameters": [ { "type": "boolean", - "default": false, - "description": "

    Whether to enable debug logging for the re-run.

    ", "name": "enable_debug_logging", "in": "body", - "isRequired": false + "description": "

    Whether to enable debug logging for the re-run.

    " } ], "enabledForGitHubApps": true, @@ -55257,21 +55170,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The git reference for the workflow. The reference can be a branch or tag name.

    ", "name": "ref", "in": "body", + "description": "

    The git reference for the workflow. The reference can be a branch or tag name.

    ", "isRequired": true }, { "type": "object", - "description": "

    Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.

    ", - "additionalProperties": { - "type": "string" - }, - "maxProperties": 10, "name": "inputs", "in": "body", - "isRequired": false + "description": "

    Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.

    " } ], "enabledForGitHubApps": true, @@ -94474,19 +94382,16 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    ", "type": "string", - "format": "date-time", "name": "last_read_at", "in": "body", - "isRequired": false + "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    " }, { - "description": "

    Whether the notification has been read.

    ", "type": "boolean", "name": "read", "in": "body", - "isRequired": false + "description": "

    Whether the notification has been read.

    " } ], "enabledForGitHubApps": false, @@ -97158,12 +97063,10 @@ ], "bodyParameters": [ { - "description": "

    Whether to block all notifications from a thread.

    ", - "default": false, "type": "boolean", "name": "ignored", "in": "body", - "isRequired": false + "description": "

    Whether to block all notifications from a thread.

    " } ], "enabledForGitHubApps": false, @@ -99839,11 +99742,9 @@ "bodyParameters": [ { "type": "string", - "format": "date-time", - "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    ", "name": "last_read_at", "in": "body", - "isRequired": false + "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    " } ], "enabledForGitHubApps": false, @@ -107815,17 +107716,15 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Determines if notifications should be received from this repository.

    ", "name": "subscribed", "in": "body", - "isRequired": false + "description": "

    Determines if notifications should be received from this repository.

    " }, { "type": "boolean", - "description": "

    Determines if all notifications should be blocked from this repository.

    ", "name": "ignored", "in": "body", - "isRequired": false + "description": "

    Determines if all notifications should be blocked from this repository.

    " } ], "enabledForGitHubApps": false, @@ -114050,14 +113949,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -114202,6 +114093,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -114979,14 +114878,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -115131,6 +115022,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -115548,756 +115447,300 @@ ], "bodyParameters": [ { - "description": "

    List of repository names that the token should have access to

    ", "type": "array of strings", "name": "repositories", "in": "body", - "isRequired": false + "description": "

    List of repository names that the token should have access to

    " }, { - "description": "

    List of repository IDs that the token should have access to

    ", "type": "array of integers", - "examples": [ - 1 - ], "name": "repository_ids", "in": "body", - "isRequired": false + "description": "

    List of repository IDs that the token should have access to

    " }, { - "title": "App Permissions", "type": "object", + "name": "permissions", + "in": "body", "description": "

    The permissions granted to the user-to-server access token.

    ", - "properties": { - "actions": { + "childParamsGroups": [ + { "type": "string", + "name": "actions", "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", "enum": [ "read", "write" - ], - "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + ] }, - "administration": { + { "type": "string", + "name": "administration", "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", "enum": [ "read", "write" - ], - "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + ] }, - "checks": { + { "type": "string", + "name": "checks", "description": "

    The level of permission to grant the access token for checks on code.

    ", "enum": [ "read", "write" - ], - "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + ] }, - "contents": { + { "type": "string", + "name": "contents", "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", "enum": [ "read", "write" - ], - "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + ] }, - "organization_custom_roles": { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for custom roles management.", - "childParamsGroups": [] - }, - "deployments": { + { "type": "string", + "name": "deployments", "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", "enum": [ "read", "write" - ], - "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + ] }, - "environments": { + { "type": "string", + "name": "environments", "description": "

    The level of permission to grant the access token for managing repository environments.

    ", "enum": [ "read", "write" - ], - "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + ] }, - "issues": { + { "type": "string", + "name": "issues", "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", "enum": [ "read", "write" - ], - "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + ] }, - "metadata": { + { "type": "string", + "name": "metadata", "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", "enum": [ "read", "write" - ], - "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + ] }, - "packages": { + { "type": "string", + "name": "packages", "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "pages": { + { "type": "string", + "name": "pages", "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", "enum": [ "read", "write" - ], - "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + ] }, - "pull_requests": { + { "type": "string", + "name": "pull_requests", "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", "enum": [ "read", "write" - ], - "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + ] }, - "repository_hooks": { + { "type": "string", + "name": "repository_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", "enum": [ "read", "write" - ], - "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + ] }, - "repository_projects": { + { "type": "string", + "name": "repository_projects", "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", "enum": [ "read", "write", "admin" - ], - "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + ] }, - "secret_scanning_alerts": { + { "type": "string", + "name": "secret_scanning_alerts", "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + ] }, - "secrets": { + { "type": "string", + "name": "secrets", "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", "enum": [ "read", "write" - ], - "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + ] }, - "security_events": { + { "type": "string", + "name": "security_events", "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + ] }, - "single_file": { + { "type": "string", + "name": "single_file", "description": "

    The level of permission to grant the access token to manage just a single file.

    ", "enum": [ "read", "write" - ], - "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + ] }, - "statuses": { + { "type": "string", + "name": "statuses", "description": "

    The level of permission to grant the access token for commit statuses.

    ", "enum": [ "read", "write" - ], - "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + ] }, - "vulnerability_alerts": { + { "type": "string", + "name": "vulnerability_alerts", "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", "enum": [ "read", "write" - ], - "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + ] }, - "workflows": { + { "type": "string", + "name": "workflows", "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", "enum": [ "write" - ], - "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + ] }, - "members": { + { "type": "string", + "name": "members", "description": "

    The level of permission to grant the access token for organization teams and members.

    ", "enum": [ "read", "write" - ], - "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + ] }, - "organization_administration": { + { "type": "string", + "name": "organization_administration", "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + ] }, - "organization_hooks": { + { "type": "string", + "name": "organization_custom_roles", + "description": "

    The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.

    ", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + ] }, - "organization_plan": { + { "type": "string", + "name": "organization_plan", "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", "enum": [ "read" - ], - "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + ] }, - "organization_projects": { + { "type": "string", + "name": "organization_projects", "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", "enum": [ "read", "write", "admin" - ], - "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + ] }, - "organization_packages": { + { "type": "string", + "name": "organization_packages", "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "organization_secrets": { + { "type": "string", + "name": "organization_secrets", "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", "enum": [ "read", "write" - ], - "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + ] }, - "organization_self_hosted_runners": { + { "type": "string", + "name": "organization_self_hosted_runners", "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + ] }, - "organization_user_blocking": { + { "type": "string", + "name": "organization_user_blocking", "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + ] }, - "team_discussions": { + { "type": "string", + "name": "team_discussions", "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", "enum": [ "read", "write" - ], - "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - }, - "name": "permissions", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "permissions", - "parentType": "object", - "id": "permissions-object", - "params": [ - { - "type": "string", - "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", - "enum": [ - "read", - "write" - ], - "name": "actions", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", - "enum": [ - "read", - "write" - ], - "name": "administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for checks on code.

    ", - "enum": [ - "read", - "write" - ], - "name": "checks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "contents", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "deployments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for managing repository environments.

    ", - "enum": [ - "read", - "write" - ], - "name": "environments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", - "enum": [ - "read", - "write" - ], - "name": "issues", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", - "enum": [ - "read", - "write" - ], - "name": "metadata", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", - "enum": [ - "read", - "write" - ], - "name": "pages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "pull_requests", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", - "enum": [ - "read", - "write" - ], - "name": "repository_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "repository_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "secret_scanning_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "security_events", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage just a single file.

    ", - "enum": [ - "read", - "write" - ], - "name": "single_file", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for commit statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "statuses", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "vulnerability_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", - "enum": [ - "write" - ], - "name": "workflows", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization teams and members.

    ", - "enum": [ - "read", - "write" - ], - "name": "members", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", - "enum": [ - "read" - ], - "name": "organization_plan", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "organization_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_self_hosted_runners", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_user_blocking", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", - "enum": [ - "read", - "write" - ], - "name": "team_discussions", - "in": "body" - } ] } ] @@ -116508,14 +115951,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -116660,6 +116095,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -119218,14 +118661,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -119370,6 +118805,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -120151,14 +119594,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -120303,6 +119738,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -121082,14 +120525,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -121234,6 +120669,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -123776,14 +123219,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -123928,6 +123363,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -128899,9 +128342,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", + "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "isRequired": true } ], @@ -128964,10 +128407,10 @@ ], "bodyParameters": [ { - "description": "

    The access_token of the OAuth application.

    ", "type": "string", "name": "access_token", "in": "body", + "description": "

    The access_token of the OAuth application.

    ", "isRequired": true } ], @@ -129330,14 +128773,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -129482,6 +128917,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -129835,10 +129278,10 @@ ], "bodyParameters": [ { - "description": "

    The access_token of the OAuth application.

    ", "type": "string", "name": "access_token", "in": "body", + "description": "

    The access_token of the OAuth application.

    ", "isRequired": true } ], @@ -130201,14 +129644,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -130353,6 +129788,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -130703,9 +130146,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", + "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "isRequired": true } ], @@ -130769,785 +130212,318 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", - "examples": [ - "e72e16c7e42f292c6912e7710c838347ae178b4a" - ], "name": "access_token", "in": "body", + "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "isRequired": true }, { - "description": "

    The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

    ", "type": "string", - "examples": [ - "octocat" - ], "name": "target", "in": "body", - "isRequired": false + "description": "

    The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

    " }, { - "description": "

    The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

    ", "type": "integer", - "examples": [ - 1 - ], "name": "target_id", "in": "body", - "isRequired": false + "description": "

    The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

    " }, { - "description": "

    The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

    ", "type": "array of strings", "name": "repositories", "in": "body", - "isRequired": false + "description": "

    The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

    " }, { - "description": "

    The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

    ", "type": "array of integers", - "examples": [ - 1 - ], "name": "repository_ids", "in": "body", - "isRequired": false + "description": "

    The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

    " }, { - "title": "App Permissions", "type": "object", + "name": "permissions", + "in": "body", "description": "

    The permissions granted to the user-to-server access token.

    ", - "properties": { - "actions": { + "childParamsGroups": [ + { "type": "string", + "name": "actions", "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", "enum": [ "read", "write" - ], - "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + ] }, - "administration": { + { "type": "string", + "name": "administration", "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", "enum": [ "read", "write" - ], - "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + ] }, - "checks": { + { "type": "string", + "name": "checks", "description": "

    The level of permission to grant the access token for checks on code.

    ", "enum": [ "read", "write" - ], - "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + ] }, - "contents": { + { "type": "string", + "name": "contents", "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", "enum": [ "read", "write" - ], - "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + ] }, - "organization_custom_roles": { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for custom roles management.", - "childParamsGroups": [] - }, - "deployments": { + { "type": "string", + "name": "deployments", "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", "enum": [ "read", "write" - ], - "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + ] }, - "environments": { + { "type": "string", + "name": "environments", "description": "

    The level of permission to grant the access token for managing repository environments.

    ", "enum": [ "read", "write" - ], - "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + ] }, - "issues": { + { "type": "string", + "name": "issues", "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", "enum": [ "read", "write" - ], - "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + ] }, - "metadata": { + { "type": "string", + "name": "metadata", "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", "enum": [ "read", "write" - ], - "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + ] }, - "packages": { + { "type": "string", + "name": "packages", "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "pages": { + { "type": "string", + "name": "pages", "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", "enum": [ "read", "write" - ], - "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + ] }, - "pull_requests": { + { "type": "string", + "name": "pull_requests", "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", "enum": [ "read", "write" - ], - "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + ] }, - "repository_hooks": { + { "type": "string", + "name": "repository_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", "enum": [ "read", "write" - ], - "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + ] }, - "repository_projects": { + { "type": "string", + "name": "repository_projects", "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", "enum": [ "read", "write", "admin" - ], - "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + ] }, - "secret_scanning_alerts": { + { "type": "string", + "name": "secret_scanning_alerts", "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + ] }, - "secrets": { + { "type": "string", + "name": "secrets", "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", "enum": [ "read", "write" - ], - "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + ] }, - "security_events": { + { "type": "string", + "name": "security_events", "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + ] }, - "single_file": { + { "type": "string", + "name": "single_file", "description": "

    The level of permission to grant the access token to manage just a single file.

    ", "enum": [ "read", "write" - ], - "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + ] }, - "statuses": { + { "type": "string", + "name": "statuses", "description": "

    The level of permission to grant the access token for commit statuses.

    ", "enum": [ "read", "write" - ], - "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + ] }, - "vulnerability_alerts": { + { "type": "string", + "name": "vulnerability_alerts", "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", "enum": [ "read", "write" - ], - "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + ] }, - "workflows": { + { "type": "string", + "name": "workflows", "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", "enum": [ "write" - ], - "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + ] }, - "members": { + { "type": "string", + "name": "members", "description": "

    The level of permission to grant the access token for organization teams and members.

    ", "enum": [ "read", "write" - ], - "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + ] }, - "organization_administration": { + { "type": "string", + "name": "organization_administration", "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + ] }, - "organization_hooks": { + { "type": "string", + "name": "organization_custom_roles", + "description": "

    The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.

    ", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "organization_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + ] }, - "organization_plan": { + { "type": "string", + "name": "organization_plan", "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", "enum": [ "read" - ], - "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + ] }, - "organization_projects": { + { "type": "string", + "name": "organization_projects", "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", "enum": [ "read", "write", "admin" - ], - "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + ] }, - "organization_packages": { + { "type": "string", + "name": "organization_packages", "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "organization_secrets": { + { "type": "string", + "name": "organization_secrets", "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", "enum": [ "read", "write" - ], - "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + ] }, - "organization_self_hosted_runners": { + { "type": "string", + "name": "organization_self_hosted_runners", "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + ] }, - "organization_user_blocking": { + { "type": "string", + "name": "organization_user_blocking", "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + ] }, - "team_discussions": { + { "type": "string", + "name": "team_discussions", "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", "enum": [ "read", "write" - ], - "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - }, - "name": "permissions", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "permissions", - "parentType": "object", - "id": "permissions-object", - "params": [ - { - "type": "string", - "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", - "enum": [ - "read", - "write" - ], - "name": "actions", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", - "enum": [ - "read", - "write" - ], - "name": "administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for checks on code.

    ", - "enum": [ - "read", - "write" - ], - "name": "checks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "contents", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "deployments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for managing repository environments.

    ", - "enum": [ - "read", - "write" - ], - "name": "environments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", - "enum": [ - "read", - "write" - ], - "name": "issues", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", - "enum": [ - "read", - "write" - ], - "name": "metadata", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", - "enum": [ - "read", - "write" - ], - "name": "pages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "pull_requests", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", - "enum": [ - "read", - "write" - ], - "name": "repository_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "repository_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "secret_scanning_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "security_events", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage just a single file.

    ", - "enum": [ - "read", - "write" - ], - "name": "single_file", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for commit statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "statuses", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "vulnerability_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", - "enum": [ - "write" - ], - "name": "workflows", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization teams and members.

    ", - "enum": [ - "read", - "write" - ], - "name": "members", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", - "enum": [ - "read" - ], - "name": "organization_plan", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "organization_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_self_hosted_runners", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_user_blocking", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", - "enum": [ - "read", - "write" - ], - "name": "team_discussions", - "in": "body" - } ] } ] @@ -131947,14 +130923,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -132099,6 +131067,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -132530,53 +131506,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": false, @@ -136051,7 +135001,2775 @@ }, "response": { "statusCode": "200", - "description": "

    Response

    " + "contentType": "application/json", + "description": "

    Response

    ", + "example": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [], + "checks": [] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + }, + "schema": { + "title": "Branch With Protection", + "description": "Branch With Protection", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "commit": { + "title": "Commit", + "description": "Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } + }, + "required": [ + "sha", + "url" + ] + } + }, + "stats": { + "type": "object", + "properties": { + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + }, + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "string" + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "html", + "self" + ] + }, + "protected": { + "type": "boolean" + }, + "protection": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enforcement_level": { + "type": "string" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string" + }, + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts", + "checks" + ] + }, + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" + ] + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } + }, + "bypass_pull_request_allowances": { + "type": "object", + "description": "Allow specific users, teams, or apps to bypass pull request requirements.", + "properties": { + "users": { + "description": "The list of users allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "require_code_owner_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "required_approving_review_count": { + "type": "integer", + "minimum": 0, + "maximum": 6, + "examples": [ + 2 + ] + } + }, + "required": [ + "dismiss_stale_reviews", + "require_code_owner_reviews" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + } + } + }, + "protection_url": { + "type": "string", + "format": "uri" + }, + "pattern": { + "type": "string", + "examples": [ + "\"mas*\"" + ] + }, + "required_approving_review_count": { + "type": "integer", + "examples": [ + 1 + ] + } + }, + "required": [ + "name", + "commit", + "_links", + "protection", + "protected", + "protection_url" + ] + } } } ], @@ -136112,9 +137830,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new name of the branch.

    ", "name": "new_name", "in": "body", + "description": "

    The new name of the branch.

    ", "isRequired": true } ], @@ -138959,9 +140677,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the branch which should be updated to match upstream.

    ", "name": "branch", "in": "body", + "description": "

    The name of the branch which should be updated to match upstream.

    ", "isRequired": true } ], @@ -139061,24 +140779,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the base branch that the head will be merged into.

    ", "name": "base", "in": "body", + "description": "

    The name of the base branch that the head will be merged into.

    ", "isRequired": true }, { "type": "string", - "description": "

    The head to merge. This can be a branch name or a commit SHA1.

    ", "name": "head", "in": "body", + "description": "

    The head to merge. This can be a branch name or a commit SHA1.

    ", "isRequired": true }, { "type": "string", - "description": "

    Commit message to use for the merge commit. If omitted, a default message will be used.

    ", "name": "commit_message", "in": "body", - "isRequired": false + "description": "

    Commit message to use for the merge commit. If omitted, a default message will be used.

    " } ], "enabledForGitHubApps": true, @@ -142150,171 +143867,38 @@ "bodyParameters": [ { "type": "object or null", - "description": "

    Require status checks to pass before merging. Set to null to disable.

    ", - "properties": { - "strict": { - "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", - "name": "strict", - "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": true, - "childParamsGroups": [] - }, - "contexts": { - "type": "array of strings", - "deprecated": true, - "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "isRequired": true, - "childParamsGroups": [] - }, - "checks": { - "type": "array of objects", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", - "items": { - "type": "object", - "required": [ - "context" - ], - "properties": { - "context": { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] - }, - "app_id": { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] - } - } - }, - "name": "checks", - "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ - { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "strict", - "contexts" - ], "name": "required_status_checks", "in": "body", + "description": "

    Require status checks to pass before merging. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "required_status_checks", - "parentType": "object", - "id": "required_status_checks-object", - "params": [ - { - "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", - "name": "strict", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "deprecated": true, - "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", - "name": "contexts", - "in": "body", - "isRequired": true - }, - { - "type": "array of objects", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", - "name": "checks", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ - { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "boolean", + "name": "strict", + "description": "

    Require branches to be up to date before merging.

    ", + "isRequired": true }, { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ + "type": "array of strings", + "name": "contexts", + "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", + "isRequired": true + }, + { + "type": "array of objects", + "name": "checks", + "description": "

    The list of status checks to require in order to merge into this branch.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The name of the required check

    ", "name": "context", - "in": "body", + "description": "

    The name of the required check

    ", "isRequired": true }, { "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", "name": "app_id", - "in": "body", - "isRequired": false + "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    " } ] } @@ -142322,407 +143906,74 @@ }, { "type": "boolean or null", - "description": "

    Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "name": "enforce_admins", "in": "body", + "description": "

    Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "isRequired": true }, { "type": "object or null", - "description": "

    Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", - "properties": { - "dismissal_restrictions": { - "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, - "name": "dismissal_restrictions", - "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", - "childParamsGroups": [ - { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] - } - ] - }, - "dismiss_stale_reviews": { - "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", - "name": "dismiss_stale_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "childParamsGroups": [] - }, - "require_code_owner_reviews": { - "type": "boolean", - "description": "

    Blocks merging pull requests until code owners review them.

    ", - "name": "require_code_owner_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", - "childParamsGroups": [] - }, - "required_approving_review_count": { - "type": "integer", - "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    ", - "name": "required_approving_review_count", - "in": "body", - "rawType": "integer", - "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", - "childParamsGroups": [] - }, - "bypass_pull_request_allowances": { - "type": "object", - "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - } - }, - "name": "bypass_pull_request_allowances", - "in": "body", - "rawType": "object", - "rawDescription": "Allow specific users, teams, or apps to bypass pull request requirements.", - "childParamsGroups": [ - { - "parentName": "bypass_pull_request_allowances", - "parentType": "object", - "id": "bypass_pull_request_allowances-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "name": "apps", - "in": "body" - } - ] - } - ] - } - }, "name": "required_pull_request_reviews", "in": "body", + "description": "

    Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "required_pull_request_reviews", - "parentType": "object", - "id": "required_pull_request_reviews-object", - "params": [ + "type": "object", + "name": "dismissal_restrictions", + "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", + "childParamsGroups": [ { - "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, - "name": "dismissal_restrictions", - "in": "body", - "childParamsGroups": [ - { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with dismissal access

    " }, { - "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", - "name": "dismiss_stale_reviews", - "in": "body" + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with dismissal access

    " }, { - "type": "boolean", - "description": "

    Blocks merging pull requests until code owners review them.

    ", - "name": "require_code_owner_reviews", - "in": "body" - }, - { - "type": "integer", - "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    ", - "name": "required_approving_review_count", - "in": "body" - }, - { - "type": "object", - "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - } - }, - "name": "bypass_pull_request_allowances", - "in": "body", - "childParamsGroups": [ - { - "parentName": "bypass_pull_request_allowances", - "parentType": "object", - "id": "bypass_pull_request_allowances-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "name": "apps", - "in": "body" - } - ] - } - ] + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with dismissal access

    " } ] }, { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] + "type": "boolean", + "name": "dismiss_stale_reviews", + "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    " }, { - "parentName": "bypass_pull_request_allowances", - "parentType": "object", - "id": "bypass_pull_request_allowances-object", - "params": [ + "type": "boolean", + "name": "require_code_owner_reviews", + "description": "

    Blocks merging pull requests until code owners review them.

    " + }, + { + "type": "integer", + "name": "required_approving_review_count", + "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    " + }, + { + "type": "object", + "name": "bypass_pull_request_allowances", + "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", + "childParamsGroups": [ { "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", "name": "users", - "in": "body" + "description": "

    The list of user logins allowed to bypass pull request requirements.

    " }, { "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", "name": "teams", - "in": "body" + "description": "

    The list of team slugs allowed to bypass pull request requirements.

    " }, { "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", "name": "apps", - "in": "body" + "description": "

    The list of app slugs allowed to bypass pull request requirements.

    " } ] } @@ -142730,120 +143981,59 @@ }, { "type": "object or null", - "description": "

    Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with push access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with push access", - "isRequired": true, - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with push access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with push access", - "isRequired": true, - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with push access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with push access", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "users", - "teams" - ], "name": "restrictions", "in": "body", + "description": "

    Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "restrictions", - "parentType": "object", - "id": "restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with push access

    ", - "name": "users", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with push access

    ", - "name": "teams", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with push access

    ", - "name": "apps", - "in": "body", - "isRequired": false - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with push access

    ", + "isRequired": true + }, + { + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with push access

    ", + "isRequired": true + }, + { + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with push access

    " } ] }, { "type": "boolean", - "description": "

    Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

    ", "name": "required_linear_history", "in": "body", - "isRequired": false + "description": "

    Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

    " }, { "type": "boolean or null", - "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "name": "allow_force_pushes", "in": "body", - "isRequired": false + "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    " }, { "type": "boolean", - "description": "

    Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

    ", "name": "allow_deletions", "in": "body", - "isRequired": false + "description": "

    Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

    ", "name": "block_creations", "in": "body", - "isRequired": false + "description": "

    If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

    " }, { "type": "boolean", - "description": "

    Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

    ", "name": "required_conversation_resolution", "in": "body", - "isRequired": false + "description": "

    Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

    " } ], "enabledForGitHubApps": true, @@ -142908,7 +144098,2001 @@ }, "response": { "statusCode": "200", - "description": "

    Response

    " + "contentType": "application/json", + "description": "

    Response

    ", + "example": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [], + "teams": [], + "apps": [] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [], + "teams": [], + "apps": [] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + }, + "schema": { + "title": "Protected Branch", + "description": "Branch protections protect branches", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "required_status_checks": { + "title": "Status Check Policy", + "description": "Status Check Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] + }, + "strict": { + "type": "boolean", + "examples": [ + true + ] + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + ] + } + }, + "required": [ + "url", + "contexts_url", + "strict", + "contexts", + "checks" + ] + }, + "required_pull_request_reviews": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "dismiss_stale_reviews": { + "type": "boolean" + }, + "require_code_owner_reviews": { + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "users", + "teams" + ] + }, + "bypass_pull_request_allowances": { + "type": "object", + "properties": { + "users": { + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + }, + "required": [ + "users", + "teams" + ] + } + }, + "required": [ + "url" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "enforce_admins": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "url", + "enabled" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + } + }, + "required": [ + "url" + ] + } } } ], @@ -144919,166 +148103,65 @@ "bodyParameters": [ { "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, "name": "dismissal_restrictions", "in": "body", - "isRequired": false, + "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", "childParamsGroups": [ { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with dismissal access

    " + }, + { + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with dismissal access

    " + }, + { + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with dismissal access

    " } ] }, { "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", "name": "dismiss_stale_reviews", "in": "body", - "isRequired": false + "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    " }, { "type": "boolean", - "description": "

    Blocks merging pull requests until code owners have reviewed.

    ", "name": "require_code_owner_reviews", "in": "body", - "isRequired": false + "description": "

    Blocks merging pull requests until code owners have reviewed.

    " }, { "type": "integer", - "description": "

    Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    ", "name": "required_approving_review_count", "in": "body", - "isRequired": false + "description": "

    Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    " }, { "type": "object", - "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - } - }, "name": "bypass_pull_request_allowances", "in": "body", - "isRequired": false, + "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", "childParamsGroups": [ { - "parentName": "bypass_pull_request_allowances", - "parentType": "object", - "id": "bypass_pull_request_allowances-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "name": "apps", - "in": "body" - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins allowed to bypass pull request requirements.

    " + }, + { + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs allowed to bypass pull request requirements.

    " + }, + { + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs allowed to bypass pull request requirements.

    " } ] } @@ -147217,46 +150300,32 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", "name": "strict", "in": "body", - "isRequired": false + "description": "

    Require branches to be up to date before merging.

    " }, { "type": "array of strings", - "deprecated": true, - "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", "name": "contexts", "in": "body", - "isRequired": false + "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    " }, { "type": "array of objects", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", "name": "checks", "in": "body", - "isRequired": false, + "description": "

    The list of status checks to require in order to merge into this branch.

    ", "childParamsGroups": [ { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ - { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "context", + "description": "

    The name of the required check

    ", + "isRequired": true + }, + { + "type": "integer", + "name": "app_id", + "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    " } ] } @@ -147566,9 +150635,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -147578,8 +150647,14 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding status checks to a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -147664,9 +150739,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -147676,8 +150751,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example updating status checks for a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -147757,9 +150837,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -147769,8 +150849,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing status checks from a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -148819,9 +151904,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -149270,9 +152355,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -149721,9 +152806,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -150462,9 +153547,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -150474,8 +153559,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -150761,9 +153851,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -150773,8 +153863,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -151060,9 +154155,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -151072,8 +154167,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -151616,9 +154716,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -151628,8 +154728,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -151882,9 +154987,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -151894,8 +154999,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -152148,9 +155258,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -152160,8 +155270,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -152408,55 +155523,52 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the check. For example, \"code-coverage\".

    ", "name": "name", "in": "body", + "description": "

    The name of the check. For example, \"code-coverage\".

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the commit.

    ", "name": "head_sha", "in": "body", + "description": "

    The SHA of the commit.

    ", "isRequired": true }, { "type": "string", - "description": "

    The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

    ", "name": "details_url", "in": "body", - "isRequired": false + "description": "

    The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

    " }, { "type": "string", - "description": "

    A reference for the run on the integrator's system.

    ", "name": "external_id", "in": "body", - "isRequired": false + "description": "

    A reference for the run on the integrator's system.

    " }, { "type": "string", + "name": "status", + "in": "body", "description": "

    The current status.

    ", "enum": [ "queued", "in_progress", "completed" ], - "default": "queued", - "name": "status", - "in": "body", - "isRequired": false + "default": "queued" }, { "type": "string", - "format": "date-time", - "description": "

    The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "string", + "name": "conclusion", + "in": "body", "description": "

    Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.

    ", "enum": [ "action_required", @@ -152467,588 +155579,120 @@ "skipped", "stale", "timed_out" - ], - "name": "conclusion", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "format": "date-time", - "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "completed_at", "in": "body", - "isRequired": false + "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "object", - "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", - "properties": { - "title": { - "type": "string", - "description": "

    The title of the check run.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the check run.", - "isRequired": true, - "childParamsGroups": [] - }, - "summary": { - "type": "string", - "maxLength": 65535, - "description": "

    The summary of the check run. This parameter supports Markdown.

    ", - "name": "summary", - "in": "body", - "rawType": "string", - "rawDescription": "The summary of the check run. This parameter supports Markdown.", - "isRequired": true, - "childParamsGroups": [] - }, - "text": { - "type": "string", - "maxLength": 65535, - "description": "

    The details of the check run. This parameter supports Markdown.

    ", - "name": "text", - "in": "body", - "rawType": "string", - "rawDescription": "The details of the check run. This parameter supports Markdown.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotations": { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", - "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, - "name": "annotations", - "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object) description for details about how to use this parameter.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - "images": { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, - "name": "images", - "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#images-object) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "title", - "summary" - ], "name": "output", "in": "body", - "isRequired": false, + "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", "childParamsGroups": [ { - "parentName": "output", - "parentType": "object", - "id": "output-object", - "params": [ - { - "type": "string", - "description": "

    The title of the check run.

    ", - "name": "title", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 65535, - "description": "

    The summary of the check run. This parameter supports Markdown.

    ", - "name": "summary", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 65535, - "description": "

    The details of the check run. This parameter supports Markdown.

    ", - "name": "text", - "in": "body", - "isRequired": false - }, - { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", - "maxItems": 50, - "name": "annotations", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "name": "images", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "string", + "name": "title", + "description": "

    The title of the check run.

    ", + "isRequired": true }, { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ + "type": "string", + "name": "summary", + "description": "

    The summary of the check run. This parameter supports Markdown.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "text", + "description": "

    The details of the check run. This parameter supports Markdown.

    " + }, + { + "type": "array of objects", + "name": "annotations", + "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "name": "path", - "in": "body", + "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start line of the annotation.

    ", "name": "start_line", - "in": "body", + "description": "

    The start line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The end line of the annotation.

    ", "name": "end_line", - "in": "body", + "description": "

    The end line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "start_column", - "in": "body", - "isRequired": false + "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "end_column", - "in": "body", - "isRequired": false + "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "string", + "name": "annotation_level", "description": "

    The level of the annotation.

    ", + "isRequired": true, "enum": [ "notice", "warning", "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "name": "message", - "in": "body", + "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "isRequired": true }, { "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", "name": "title", - "in": "body", - "isRequired": false + "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    " }, { "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", "name": "raw_details", - "in": "body", - "isRequired": false + "description": "

    Details about this annotation. The maximum size is 64 KB.

    " } ] }, { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ + "type": "array of objects", + "name": "images", + "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The alternative text for the image.

    ", "name": "alt", - "in": "body", + "description": "

    The alternative text for the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full URL of the image.

    ", "name": "image_url", - "in": "body", + "description": "

    The full URL of the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short image description.

    ", "name": "caption", - "in": "body", - "isRequired": false + "description": "

    A short image description.

    " } ] } @@ -153056,42 +155700,27 @@ }, { "type": "array of objects", - "description": "

    Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", - "maxItems": 3, "name": "actions", "in": "body", - "isRequired": false, + "description": "

    Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", "childParamsGroups": [ { - "parentName": "actions", - "parentType": "items", - "id": "actions-items", - "params": [ - { - "type": "string", - "maxLength": 20, - "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", - "name": "label", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 40, - "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", - "name": "description", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 20, - "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", - "name": "identifier", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "label", + "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "identifier", + "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", + "isRequired": true } ] } @@ -156743,47 +159372,43 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the check. For example, \"code-coverage\".

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the check. For example, \"code-coverage\".

    " }, { "type": "string", - "description": "

    The URL of the integrator's site that has the full details of the check.

    ", "name": "details_url", "in": "body", - "isRequired": false + "description": "

    The URL of the integrator's site that has the full details of the check.

    " }, { "type": "string", - "description": "

    A reference for the run on the integrator's system.

    ", "name": "external_id", "in": "body", - "isRequired": false + "description": "

    A reference for the run on the integrator's system.

    " }, { "type": "string", - "format": "date-time", - "description": "

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "string", + "name": "status", + "in": "body", "description": "

    The current status.

    ", "enum": [ "queued", "in_progress", "completed" - ], - "name": "status", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "conclusion", + "in": "body", "description": "

    Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.

    ", "enum": [ "action_required", @@ -156794,587 +159419,119 @@ "skipped", "stale", "timed_out" - ], - "name": "conclusion", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "format": "date-time", - "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "completed_at", "in": "body", - "isRequired": false + "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "object", - "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", - "properties": { - "title": { - "type": "string", - "description": "

    Required.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "**Required**.", - "isRequired": false, - "childParamsGroups": [] - }, - "summary": { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "summary", - "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": true, - "childParamsGroups": [] - }, - "text": { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "text", - "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotations": { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", - "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, - "name": "annotations", - "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - "images": { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, - "name": "images", - "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "summary" - ], "name": "output", "in": "body", - "isRequired": false, + "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", "childParamsGroups": [ { - "parentName": "output", - "parentType": "object", - "id": "output-object", - "params": [ - { - "type": "string", - "description": "

    Required.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "summary", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "text", - "in": "body", - "isRequired": false - }, - { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", - "maxItems": 50, - "name": "annotations", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "name": "images", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "string", + "name": "title", + "description": "

    Required.

    " }, { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ + "type": "string", + "name": "summary", + "description": "

    Can contain Markdown.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "text", + "description": "

    Can contain Markdown.

    " + }, + { + "type": "array of objects", + "name": "annotations", + "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "name": "path", - "in": "body", + "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start line of the annotation.

    ", "name": "start_line", - "in": "body", + "description": "

    The start line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The end line of the annotation.

    ", "name": "end_line", - "in": "body", + "description": "

    The end line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "start_column", - "in": "body", - "isRequired": false + "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "end_column", - "in": "body", - "isRequired": false + "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "string", + "name": "annotation_level", "description": "

    The level of the annotation.

    ", + "isRequired": true, "enum": [ "notice", "warning", "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "name": "message", - "in": "body", + "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "isRequired": true }, { "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", "name": "title", - "in": "body", - "isRequired": false + "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    " }, { "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", "name": "raw_details", - "in": "body", - "isRequired": false + "description": "

    Details about this annotation. The maximum size is 64 KB.

    " } ] }, { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ + "type": "array of objects", + "name": "images", + "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The alternative text for the image.

    ", "name": "alt", - "in": "body", + "description": "

    The alternative text for the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full URL of the image.

    ", "name": "image_url", - "in": "body", + "description": "

    The full URL of the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short image description.

    ", "name": "caption", - "in": "body", - "isRequired": false + "description": "

    A short image description.

    " } ] } @@ -157382,42 +159539,27 @@ }, { "type": "array of objects", - "description": "

    Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", - "maxItems": 3, "name": "actions", "in": "body", - "isRequired": false, + "description": "

    Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", "childParamsGroups": [ { - "parentName": "actions", - "parentType": "items", - "id": "actions-items", - "params": [ - { - "type": "string", - "maxLength": 20, - "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", - "name": "label", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 40, - "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", - "name": "description", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 20, - "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", - "name": "identifier", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "label", + "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "identifier", + "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", + "isRequired": true } ] } @@ -161524,9 +163666,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The sha of the head commit.

    ", "name": "head_sha", "in": "body", + "description": "

    The sha of the head commit.

    ", "isRequired": true } ], @@ -167894,32 +170036,22 @@ "bodyParameters": [ { "type": "array of objects", - "description": "

    Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

    ", "name": "auto_trigger_checks", "in": "body", - "isRequired": false, + "description": "

    Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

    ", "childParamsGroups": [ { - "parentName": "auto_trigger_checks", - "parentType": "items", - "id": "auto_trigger_checks-items", - "params": [ - { - "type": "integer", - "description": "

    The id of the GitHub App.

    ", - "name": "app_id", - "in": "body", - "isRequired": true - }, - { - "type": "boolean", - "description": "

    Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

    ", - "default": true, - "name": "setting", - "in": "body", - "isRequired": true - } - ] + "type": "integer", + "name": "app_id", + "description": "

    The id of the GitHub App.

    ", + "isRequired": true + }, + { + "type": "boolean", + "name": "setting", + "description": "

    Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

    ", + "isRequired": true, + "default": true } ] } @@ -181004,36 +183136,33 @@ ], "bodyParameters": [ { - "description": "

    Sets the state of the code scanning alert. You must provide dismissed_reason when you set the state to dismissed.

    ", "type": "string", + "name": "state", + "in": "body", + "description": "

    Sets the state of the code scanning alert. You must provide dismissed_reason when you set the state to dismissed.

    ", + "isRequired": true, "enum": [ "open", "dismissed" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", + "name": "dismissed_reason", + "in": "body", "description": "

    Required when the state is dismissed. The reason for dismissing or closing the alert.

    ", "enum": [ null, "false positive", "won't fix", "used in tests" - ], - "name": "dismissed_reason", - "in": "body", - "isRequired": false + ] }, { "type": "string or null", - "description": "

    The dismissal comment associated with the dismissal of the alert.

    ", - "maxLength": 280, "name": "dismissed_comment", "in": "body", - "isRequired": false + "description": "

    The dismissal comment associated with the dismissal of the alert.

    " } ], "enabledForGitHubApps": true, @@ -181689,6 +183818,7 @@ "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "state": "open", "fixed_at": null, "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", @@ -181929,6 +184059,33 @@ "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53" ] } + }, + { + "name": "direction", + "description": "

    The direction to sort the results by.

    ", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "

    The property by which to sort the results.

    ", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created" + ], + "default": "created" + } } ], "bodyParameters": [], @@ -182540,7 +184697,7 @@ "description": "

    Service unavailable

    " } ], - "descriptionHTML": "

    Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the repo scope. For public repositories,\nyou must use an access token with public_repo scope.\nGitHub Apps must have the security_events write permission to use this endpoint.

    \n

    You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.

    \n

    When you list the analyses for a repository,\none or more will be identified as deletable in the response:

    \n
    \"deletable\": true\n
    \n

    An analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:

    \n
      \n
    • ref
      • \n
    • tool
      • \n
    • analysis_key
      • \n
    • environment
      • \n
    \n

    If you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:

    \n
    Analysis specified is not deletable.\n
    \n

    The response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\nnext_analysis_url and confirm_delete_url.\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.

    \n

    As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:

    \n

    Outer loop:

    \n
      \n
    • \n

      List the analyses for the repository, filtered by tool.

      \n
      • \n
    • \n

      Parse this list to find a deletable analysis. If found:

      \n

      Inner loop:

      \n
        \n
      • Delete the identified analysis.
        • \n
      • Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.
        • \n
      \n
      • \n
    \n

    The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

    ", + "descriptionHTML": "

    Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the repo scope. For public repositories,\nyou must use an access token with public_repo scope.\nGitHub Apps must have the security_events write permission to use this endpoint.

    \n

    You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.

    \n

    When you list the analyses for a repository,\none or more will be identified as deletable in the response:

    \n
    \"deletable\": true\n
    \n

    An analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:

    \n
      \n
    • ref
      • \n
    • tool
      • \n
    • category
      • \n
    \n

    If you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:

    \n
    Analysis specified is not deletable.\n
    \n

    The response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\nnext_analysis_url and confirm_delete_url.\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.

    \n

    As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:

    \n

    Outer loop:

    \n
      \n
    • \n

      List the analyses for the repository, filtered by tool.

      \n
      • \n
    • \n

      Parse this list to find a deletable analysis. If found:

      \n

      Inner loop:

      \n
        \n
      • Delete the identified analysis.
        • \n
      • Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.
        • \n
      \n
      • \n
    \n

    The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

    ", "subcategory": "code-scanning" }, { @@ -182571,54 +184728,43 @@ ], "bodyParameters": [ { - "description": "

    The SHA of the commit to which the analysis you are uploading relates.

    ", "type": "string", - "minLength": 40, - "maxLength": 40, - "pattern": "^[0-9a-fA-F]+$", "name": "commit_sha", "in": "body", + "description": "

    The SHA of the commit to which the analysis you are uploading relates.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", "name": "ref", "in": "body", + "description": "

    The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", "isRequired": true }, { - "description": "

    A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

    ", "type": "string", "name": "sarif", "in": "body", + "description": "

    A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

    ", "isRequired": true }, { - "description": "

    The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

    ", "type": "string", - "format": "uri", - "examples": [ - "file:///github/workspace/" - ], "name": "checkout_uri", "in": "body", - "isRequired": false + "description": "

    The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

    " }, { - "description": "

    The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "format": "date-time", "type": "string", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { - "description": "

    The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

    ", "type": "string", "name": "tool_name", "in": "body", - "isRequired": false + "description": "

    The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

    " } ], "enabledForGitHubApps": true, @@ -186257,6 +188403,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -186344,74 +188500,64 @@ ], "bodyParameters": [ { - "description": "

    Git ref (typically a branch name) for this codespace

    ", "type": "string", "name": "ref", "in": "body", - "isRequired": false + "description": "

    Git ref (typically a branch name) for this codespace

    " }, { - "description": "

    Location for this codespace. Assigned by IP if not provided

    ", "type": "string", "name": "location", "in": "body", - "isRequired": false + "description": "

    Location for this codespace. Assigned by IP if not provided

    " }, { - "description": "

    IP for location auto-detection when proxying a request

    ", "type": "string", "name": "client_ip", "in": "body", - "isRequired": false + "description": "

    IP for location auto-detection when proxying a request

    " }, { - "description": "

    Machine type to use for this codespace

    ", "type": "string", "name": "machine", "in": "body", - "isRequired": false + "description": "

    Machine type to use for this codespace

    " }, { - "description": "

    Path to devcontainer.json config to use for this codespace

    ", "type": "string", "name": "devcontainer_path", "in": "body", - "isRequired": false + "description": "

    Path to devcontainer.json config to use for this codespace

    " }, { - "description": "

    Whether to authorize requested permissions from devcontainer.json

    ", "type": "boolean", "name": "multi_repo_permissions_opt_out", "in": "body", - "isRequired": false + "description": "

    Whether to authorize requested permissions from devcontainer.json

    " }, { - "description": "

    Working directory for this codespace

    ", "type": "string", "name": "working_directory", "in": "body", - "isRequired": false + "description": "

    Working directory for this codespace

    " }, { - "description": "

    Time in minutes before codespace stops from inactivity

    ", "type": "integer", "name": "idle_timeout_minutes", "in": "body", - "isRequired": false + "description": "

    Time in minutes before codespace stops from inactivity

    " }, { - "description": "

    Display name for this codespace

    ", "type": "string", "name": "display_name", "in": "body", - "isRequired": false + "description": "

    Display name for this codespace

    " }, { - "description": "

    Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).

    ", "type": "integer", "name": "retention_period_minutes", "in": "body", - "isRequired": false + "description": "

    Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).

    " } ], "enabledForGitHubApps": false, @@ -189447,6 +191593,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -192507,6 +194663,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -193033,67 +195199,58 @@ ], "bodyParameters": [ { - "description": "

    Location for this codespace. Assigned by IP if not provided

    ", "type": "string", "name": "location", "in": "body", - "isRequired": false + "description": "

    Location for this codespace. Assigned by IP if not provided

    " }, { - "description": "

    IP for location auto-detection when proxying a request

    ", "type": "string", "name": "client_ip", "in": "body", - "isRequired": false + "description": "

    IP for location auto-detection when proxying a request

    " }, { - "description": "

    Machine type to use for this codespace

    ", "type": "string", "name": "machine", "in": "body", - "isRequired": false + "description": "

    Machine type to use for this codespace

    " }, { - "description": "

    Path to devcontainer.json config to use for this codespace

    ", "type": "string", "name": "devcontainer_path", "in": "body", - "isRequired": false + "description": "

    Path to devcontainer.json config to use for this codespace

    " }, { - "description": "

    Whether to authorize requested permissions from devcontainer.json

    ", "type": "boolean", "name": "multi_repo_permissions_opt_out", "in": "body", - "isRequired": false + "description": "

    Whether to authorize requested permissions from devcontainer.json

    " }, { - "description": "

    Working directory for this codespace

    ", "type": "string", "name": "working_directory", "in": "body", - "isRequired": false + "description": "

    Working directory for this codespace

    " }, { - "description": "

    Time in minutes before codespace stops from inactivity

    ", "type": "integer", "name": "idle_timeout_minutes", "in": "body", - "isRequired": false + "description": "

    Time in minutes before codespace stops from inactivity

    " }, { - "description": "

    Display name for this codespace

    ", "type": "string", "name": "display_name", "in": "body", - "isRequired": false + "description": "

    Display name for this codespace

    " }, { - "description": "

    Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).

    ", "type": "integer", "name": "retention_period_minutes", "in": "body", - "isRequired": false + "description": "

    Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).

    " } ], "enabledForGitHubApps": false, @@ -196130,6 +198287,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -199191,6 +201358,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -202606,6 +204783,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -202678,135 +204865,90 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Repository id for this codespace

    ", "type": "integer", "name": "repository_id", "in": "body", + "description": "

    Repository id for this codespace

    ", "isRequired": true }, { - "description": "

    Git ref (typically a branch name) for this codespace

    ", "type": "string", "name": "ref", "in": "body", - "isRequired": false + "description": "

    Git ref (typically a branch name) for this codespace

    " }, { - "description": "

    Location for this codespace. Assigned by IP if not provided

    ", "type": "string", "name": "location", "in": "body", - "isRequired": false + "description": "

    Location for this codespace. Assigned by IP if not provided

    " }, { - "description": "

    IP for location auto-detection when proxying a request

    ", "type": "string", "name": "client_ip", "in": "body", - "isRequired": false + "description": "

    IP for location auto-detection when proxying a request

    " }, { - "description": "

    Machine type to use for this codespace

    ", "type": "string", "name": "machine", "in": "body", - "isRequired": false + "description": "

    Machine type to use for this codespace

    " }, { - "description": "

    Path to devcontainer.json config to use for this codespace

    ", "type": "string", "name": "devcontainer_path", "in": "body", - "isRequired": false + "description": "

    Path to devcontainer.json config to use for this codespace

    " }, { - "description": "

    Whether to authorize requested permissions from devcontainer.json

    ", "type": "boolean", "name": "multi_repo_permissions_opt_out", "in": "body", - "isRequired": false + "description": "

    Whether to authorize requested permissions from devcontainer.json

    " }, { - "description": "

    Working directory for this codespace

    ", "type": "string", "name": "working_directory", "in": "body", - "isRequired": false + "description": "

    Working directory for this codespace

    " }, { - "description": "

    Time in minutes before codespace stops from inactivity

    ", "type": "integer", "name": "idle_timeout_minutes", "in": "body", - "isRequired": false + "description": "

    Time in minutes before codespace stops from inactivity

    " }, { - "description": "

    Display name for this codespace

    ", "type": "string", "name": "display_name", "in": "body", - "isRequired": false + "description": "

    Display name for this codespace

    " }, { - "description": "

    Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).

    ", "type": "integer", "name": "retention_period_minutes", "in": "body", - "isRequired": false + "description": "

    Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).

    " }, { - "required": [ - "pull_request_number", - "repository_id" - ], - "description": "

    Pull request number for this codespace

    ", "type": "object", - "properties": { - "pull_request_number": { - "description": "

    Pull request number

    ", - "type": "integer", - "name": "pull_request_number", - "in": "body", - "rawType": "integer", - "rawDescription": "Pull request number", - "isRequired": true, - "childParamsGroups": [] - }, - "repository_id": { - "description": "

    Repository id for this codespace

    ", - "type": "integer", - "name": "repository_id", - "in": "body", - "rawType": "integer", - "rawDescription": "Repository id for this codespace", - "isRequired": true, - "childParamsGroups": [] - } - }, "name": "pull_request", "in": "body", + "description": "

    Pull request number for this codespace

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "pull_request", - "parentType": "object", - "id": "pull_request-object", - "params": [ - { - "description": "

    Pull request number

    ", - "type": "integer", - "name": "pull_request_number", - "in": "body", - "isRequired": true - }, - { - "description": "

    Repository id for this codespace

    ", - "type": "integer", - "name": "repository_id", - "in": "body", - "isRequired": true - } - ] + "type": "integer", + "name": "pull_request_number", + "description": "

    Pull request number

    ", + "isRequired": true + }, + { + "type": "integer", + "name": "repository_id", + "description": "

    Repository id for this codespace

    ", + "isRequired": true } ] } @@ -205841,6 +207983,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -208898,6 +211050,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -211999,6 +214161,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -212078,25 +214250,22 @@ ], "bodyParameters": [ { - "description": "

    A valid machine to transition this codespace to.

    ", "type": "string", "name": "machine", "in": "body", - "isRequired": false + "description": "

    A valid machine to transition this codespace to.

    " }, { - "description": "

    Display name for this codespace

    ", "type": "string", "name": "display_name", "in": "body", - "isRequired": false + "description": "

    Display name for this codespace

    " }, { - "description": "

    Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in.

    ", "type": "array of strings", "name": "recent_folders", "in": "body", - "isRequired": false + "description": "

    Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in.

    " } ], "enabledForGitHubApps": false, @@ -215130,6 +217299,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -218578,6 +220757,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -221695,6 +223884,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -225500,6 +227699,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -228713,6 +230922,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -229154,18 +231373,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " } ], "enabledForGitHubApps": true, @@ -229609,25 +231825,22 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get the public key for the authenticated user endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get the public key for the authenticated user endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", + "description": "

    ID of the key you used to encrypt the secret.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    An array of repository ids that can access the user secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Set selected repositories for a user secret, and Remove a selected repository from a user secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", - "isRequired": false + "description": "

    An array of repository ids that can access the user secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Set selected repositories for a user secret, and Remove a selected repository from a user secret endpoints.

    " } ], "enabledForGitHubApps": false, @@ -232293,9 +234506,9 @@ "bodyParameters": [ { "type": "array of integers", - "description": "

    An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Add a selected repository to a user secret, and Remove a selected repository from a user secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", + "description": "

    An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Add a selected repository to a user secret, and Remove a selected repository from a user secret endpoints.

    ", "isRequired": true } ], @@ -232915,11 +235128,10 @@ "bodyParameters": [ { "type": "string", - "description": "

    The permission to grant the collaborator. Only valid on organization-owned repositories. We accept the following permissions to be set: pull, triage, push, maintain, admin and you can also specify a custom repository role name, if the owning organization has defined any.

    ", - "default": "push", "name": "permission", "in": "body", - "isRequired": false + "description": "

    The permission to grant the collaborator. Only valid on organization-owned repositories. We accept the following permissions to be set: pull, triage, push, maintain, admin and you can also specify a custom repository role name, if the owning organization has defined any.

    ", + "default": "push" } ], "enabledForGitHubApps": true, @@ -238907,6 +241119,8 @@ "bodyParameters": [ { "type": "string", + "name": "permissions", + "in": "body", "description": "

    The permissions that the associated user will have on the repository. Valid values are read, write, maintain, triage, and admin.

    ", "enum": [ "read", @@ -238914,10 +241128,7 @@ "maintain", "triage", "admin" - ], - "name": "permissions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -238926,8 +241137,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example request body", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permissions": "write" + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -255664,9 +257878,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment

    ", "isRequired": true } ], @@ -256580,31 +258794,28 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true }, { "type": "string", - "description": "

    Relative path of the file to comment on.

    ", "name": "path", "in": "body", - "isRequired": false + "description": "

    Relative path of the file to comment on.

    " }, { "type": "integer", - "description": "

    Line index in the diff to comment on.

    ", "name": "position", "in": "body", - "isRequired": false + "description": "

    Line index in the diff to comment on.

    " }, { "type": "integer", - "description": "

    Deprecated. Use position parameter instead. Line number in the file to comment on.

    ", "name": "line", "in": "body", - "isRequired": false + "description": "

    Deprecated. Use position parameter instead. Line number in the file to comment on.

    " } ], "enabledForGitHubApps": true, @@ -259882,38 +262093,35 @@ "bodyParameters": [ { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the status.

    ", + "isRequired": true, "enum": [ "error", "failure", "pending", "success" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", - "description": "

    The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
    \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
    \nhttp://ci.example.com/user/repo/build/sha

    ", "name": "target_url", "in": "body", - "isRequired": false + "description": "

    The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
    \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
    \nhttp://ci.example.com/user/repo/build/sha

    " }, { "type": "string or null", - "description": "

    A short description of the status.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the status.

    " }, { "type": "string", - "description": "

    A string label to differentiate this status from the status of other systems. This field is case-insensitive.

    ", - "default": "default", "name": "context", "in": "body", - "isRequired": false + "description": "

    A string label to differentiate this status from the status of other systems. This field is case-insensitive.

    ", + "default": "default" } ], "enabledForGitHubApps": true, @@ -260574,37 +262782,33 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret.

    ", + "isRequired": true, "enum": [ "all", "private", "selected" - ], - "name": "visibility", - "in": "body", - "isRequired": true + ] }, { "type": "array of strings", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", - "isRequired": false + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    " } ], "enabledForGitHubApps": true, @@ -263134,9 +265338,9 @@ "bodyParameters": [ { "type": "array of integers", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "isRequired": true } ], @@ -263664,18 +265868,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " } ], "enabledForGitHubApps": true, @@ -264086,975 +266287,175 @@ ], "bodyParameters": [ { - "description": "

    The version of the repository snapshot submission.

    ", "type": "integer", "name": "version", "in": "body", + "description": "

    The version of the repository snapshot submission.

    ", "isRequired": true }, { "type": "object", - "properties": { - "id": { - "type": "string", - "description": "

    The external ID of the job.

    ", - "examples": [ - "5622a2b0-63f6-4732-8c34-a1ab27e102a11" - ], - "name": "id", - "in": "body", - "rawType": "string", - "rawDescription": "The external ID of the job.", - "isRequired": true, - "childParamsGroups": [] - }, - "correlator": { - "type": "string", - "description": "

    Correlator provides a key that is used to group snapshots submitted over time. Only the \"latest\" submitted snapshot for a given combination of job.correlator and detector.name will be considered when calculating a repository's current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given \"wave\" of CI workflow you run. If you're using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you're using a build matrix, then you'll also need to add additional key(s) to distinguish between each submission inside a matrix variation.

    ", - "examples": [ - "yourworkflowname_yourjobname" - ], - "name": "correlator", - "in": "body", - "rawType": "string", - "rawDescription": "Correlator provides a key that is used to group snapshots submitted over time. Only the \"latest\" submitted snapshot for a given combination of `job.correlator` and `detector.name` will be considered when calculating a repository's current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given \"wave\" of CI workflow you run. If you're using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you're using a build matrix, then you'll also need to add additional key(s) to distinguish between each submission inside a matrix variation.", - "isRequired": true, - "childParamsGroups": [] - }, - "html_url": { - "type": "string", - "description": "

    The url for the job.

    ", - "examples": [ - "http://example.com/build" - ], - "name": "html_url", - "in": "body", - "rawType": "string", - "rawDescription": "The url for the job.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "id", - "correlator" - ], - "additionalProperties": false, "name": "job", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { - "parentName": "job", - "parentType": "object", - "id": "job-object", - "params": [ - { - "type": "string", - "description": "

    The external ID of the job.

    ", - "examples": [ - "5622a2b0-63f6-4732-8c34-a1ab27e102a11" - ], - "name": "id", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    Correlator provides a key that is used to group snapshots submitted over time. Only the \"latest\" submitted snapshot for a given combination of job.correlator and detector.name will be considered when calculating a repository's current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given \"wave\" of CI workflow you run. If you're using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you're using a build matrix, then you'll also need to add additional key(s) to distinguish between each submission inside a matrix variation.

    ", - "examples": [ - "yourworkflowname_yourjobname" - ], - "name": "correlator", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The url for the job.

    ", - "examples": [ - "http://example.com/build" - ], - "name": "html_url", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "id", + "description": "

    The external ID of the job.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "correlator", + "description": "

    Correlator provides a key that is used to group snapshots submitted over time. Only the \"latest\" submitted snapshot for a given combination of job.correlator and detector.name will be considered when calculating a repository's current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given \"wave\" of CI workflow you run. If you're using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you're using a build matrix, then you'll also need to add additional key(s) to distinguish between each submission inside a matrix variation.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "

    The url for the job.

    " } ] }, { - "description": "

    The commit SHA associated with this dependency snapshot.

    ", "type": "string", - "minLength": 40, - "examples": [ - "ddc951f4b1293222421f2c8df679786153acf689" - ], "name": "sha", "in": "body", + "description": "

    The commit SHA associated with this dependency snapshot.

    ", "isRequired": true }, { - "description": "

    The repository branch that triggered this snapshot.

    ", "type": "string", - "pattern": "^refs/", - "examples": [ - "refs/heads/main" - ], "name": "ref", "in": "body", + "description": "

    The repository branch that triggered this snapshot.

    ", "isRequired": true }, { "type": "object", - "description": "

    A description of the detector used.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the detector used.

    ", - "examples": [ - "docker buildtime detector" - ], - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the detector used.", - "isRequired": true, - "childParamsGroups": [] - }, - "version": { - "type": "string", - "description": "

    The version of the detector used.

    ", - "examples": [ - "1.0.0" - ], - "name": "version", - "in": "body", - "rawType": "string", - "rawDescription": "The version of the detector used.", - "isRequired": true, - "childParamsGroups": [] - }, - "url": { - "type": "string", - "description": "

    The url of the detector used.

    ", - "examples": [ - "http://example.com/docker-buildtimer-detector" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The url of the detector used.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "version", - "url" - ], - "additionalProperties": false, "name": "detector", "in": "body", + "description": "

    A description of the detector used.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "detector", - "parentType": "object", - "id": "detector-object", - "params": [ - { - "type": "string", - "description": "

    The name of the detector used.

    ", - "examples": [ - "docker buildtime detector" - ], - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The version of the detector used.

    ", - "examples": [ - "1.0.0" - ], - "name": "version", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The url of the detector used.

    ", - "examples": [ - "http://example.com/docker-buildtimer-detector" - ], - "name": "url", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the detector used.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "version", + "description": "

    The version of the detector used.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "

    The url of the detector used.

    ", + "isRequired": true } ] }, { - "title": "metadata", - "description": "

    User-defined metadata to store domain-specific information limited to 8 keys with scalar values.

    ", "type": "object", - "maxProperties": 8, - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - } - ], - "type": [ - "null", - "string", - "number", - "boolean" - ] - }, "name": "metadata", "in": "body", - "isRequired": false + "description": "

    User-defined metadata to store domain-specific information limited to 8 keys with scalar values.

    " }, { "type": "object", - "description": "

    A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies.

    ", - "additionalProperties": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the manifest.

    ", - "examples": [ - "package-lock.json" - ], - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the manifest.", - "isRequired": true, - "childParamsGroups": [] - }, - "file": { - "type": "object", - "properties": { - "source_location": { - "type": "string", - "description": "

    The path of the manifest file relative to the root of the Git repository.

    ", - "examples": [ - "/src/build/package-lock.json" - ], - "name": "source_location", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the manifest file relative to the root of the Git repository.", - "childParamsGroups": [] - } - }, - "additionalProperties": false, - "name": "file", - "in": "body", - "rawType": "object", - "description": "", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "file", - "parentType": "object", - "id": "file-object", - "params": [ - { - "type": "string", - "description": "

    The path of the manifest file relative to the root of the Git repository.

    ", - "examples": [ - "/src/build/package-lock.json" - ], - "name": "source_location", - "in": "body" - } - ] - } - ] - }, - "metadata": { - "title": "metadata", - "description": "

    User-defined metadata to store domain-specific information limited to 8 keys with scalar values.

    ", - "type": "object", - "maxProperties": 8, - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - } - ], - "type": [ - "null", - "string", - "number", - "boolean" - ] - }, - "name": "metadata", - "in": "body", - "rawType": "object", - "rawDescription": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "isRequired": false, - "childParamsGroups": [] - }, - "resolved": { - "type": "object", - "description": "

    A collection of resolved package dependencies.

    ", - "additionalProperties": { - "type": "object", - "properties": { - "package_url": { - "type": "string", - "description": "

    Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.

    ", - "pattern": "^pkg", - "examples": [ - "pkg:/npm/%40actions/http-client@1.0.11" - ], - "name": "package_url", - "in": "body", - "rawType": "string", - "rawDescription": "Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.", - "childParamsGroups": [] - }, - "metadata": { - "title": "metadata", - "description": "

    User-defined metadata to store domain-specific information limited to 8 keys with scalar values.

    ", - "type": "object", - "maxProperties": 8, - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - } - ], - "type": [ - "null", - "string", - "number", - "boolean" - ] - }, - "name": "metadata", - "in": "body", - "rawType": "object", - "rawDescription": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "childParamsGroups": [] - }, - "relationship": { - "type": "string", - "description": "

    A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.

    ", - "enum": [ - "direct", - "indirect" - ], - "examples": [ - "direct" - ], - "name": "relationship", - "in": "body", - "rawType": "string", - "rawDescription": "A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.", - "childParamsGroups": [] - }, - "scope": { - "type": "string", - "description": "

    A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.

    ", - "enum": [ - "runtime", - "development" - ], - "examples": [ - "runtime" - ], - "name": "scope", - "in": "body", - "rawType": "string", - "rawDescription": "A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.", - "childParamsGroups": [] - }, - "dependencies": { - "type": "array of strings", - "description": "

    Array of package-url (PURLs) of direct child dependencies.

    ", - "items": { - "type": "string" - }, - "examples": [ - "@actions/http-client" - ], - "name": "dependencies", - "in": "body", - "rawType": "array", - "rawDescription": "Array of package-url (PURLs) of direct child dependencies.", - "childParamsGroups": [] - } - }, - "additionalProperties": false, - "rawType": "object", - "name": "key" - }, - "name": "resolved", - "in": "body", - "rawType": "object", - "rawDescription": "A collection of resolved package dependencies.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "resolved", - "parentType": "object", - "id": "resolved-object", - "params": [ - { - "description": "

    A user-defined key to represent an item in resolved.

    ", - "type": "string", - "name": "key", - "in": "body", - "rawType": "string", - "rawDescription": "A key to represent an item in resolved." - } - ] - }, - { - "parentName": "key", - "parentType": "object", - "id": "key-object", - "params": [ - { - "type": "string", - "description": "

    Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.

    ", - "pattern": "^pkg", - "examples": [ - "pkg:/npm/%40actions/http-client@1.0.11" - ], - "name": "package_url", - "in": "body" - }, - { - "title": "metadata", - "description": "

    User-defined metadata to store domain-specific information limited to 8 keys with scalar values.

    ", - "type": "object", - "maxProperties": 8, - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - } - ], - "type": [ - "null", - "string", - "number", - "boolean" - ] - }, - "name": "metadata", - "in": "body" - }, - { - "type": "string", - "description": "

    A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.

    ", - "enum": [ - "direct", - "indirect" - ], - "examples": [ - "direct" - ], - "name": "relationship", - "in": "body" - }, - { - "type": "string", - "description": "

    A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.

    ", - "enum": [ - "runtime", - "development" - ], - "examples": [ - "runtime" - ], - "name": "scope", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    Array of package-url (PURLs) of direct child dependencies.

    ", - "examples": [ - "@actions/http-client" - ], - "name": "dependencies", - "in": "body" - } - ] - } - ] - } - }, - "required": [ - "name" - ], - "additionalProperties": false, - "rawType": "object", - "name": "key" - }, "name": "manifests", "in": "body", - "isRequired": false, + "description": "

    A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies.

    ", "childParamsGroups": [ { - "parentName": "manifests", - "parentType": "object", - "id": "manifests-object", - "params": [ - { - "description": "

    A user-defined key to represent an item in manifests.

    ", - "type": "string", - "name": "key", - "in": "body", - "rawType": "string", - "rawDescription": "A key to represent an item in manifests." - } - ] - }, - { - "parentName": "key", - "parentType": "object", - "id": "key-object", - "params": [ + "type": "object", + "name": "key", + "description": "

    A user-defined key to represent an item in manifests.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The name of the manifest.

    ", - "examples": [ - "package-lock.json" - ], "name": "name", - "in": "body", + "description": "

    The name of the manifest.

    ", "isRequired": true }, { "type": "object", - "properties": { - "source_location": { - "type": "string", - "description": "

    The path of the manifest file relative to the root of the Git repository.

    ", - "examples": [ - "/src/build/package-lock.json" - ], - "name": "source_location", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the manifest file relative to the root of the Git repository.", - "childParamsGroups": [] - } - }, - "additionalProperties": false, "name": "file", - "in": "body", "description": "", - "isRequired": false, "childParamsGroups": [ { - "parentName": "file", - "parentType": "object", - "id": "file-object", - "params": [ - { - "type": "string", - "description": "

    The path of the manifest file relative to the root of the Git repository.

    ", - "examples": [ - "/src/build/package-lock.json" - ], - "name": "source_location", - "in": "body" - } - ] + "type": "string", + "name": "source_location", + "description": "

    The path of the manifest file relative to the root of the Git repository.

    " } ] }, { - "title": "metadata", - "description": "

    User-defined metadata to store domain-specific information limited to 8 keys with scalar values.

    ", "type": "object", - "maxProperties": 8, - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - } - ], - "type": [ - "null", - "string", - "number", - "boolean" - ] - }, "name": "metadata", - "in": "body", - "isRequired": false + "description": "

    User-defined metadata to store domain-specific information limited to 8 keys with scalar values.

    " }, { "type": "object", - "description": "

    A collection of resolved package dependencies.

    ", - "additionalProperties": { - "type": "object", - "properties": { - "package_url": { - "type": "string", - "description": "

    Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.

    ", - "pattern": "^pkg", - "examples": [ - "pkg:/npm/%40actions/http-client@1.0.11" - ], - "name": "package_url", - "in": "body", - "rawType": "string", - "rawDescription": "Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.", - "childParamsGroups": [] - }, - "metadata": { - "title": "metadata", - "description": "

    User-defined metadata to store domain-specific information limited to 8 keys with scalar values.

    ", - "type": "object", - "maxProperties": 8, - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - } - ], - "type": [ - "null", - "string", - "number", - "boolean" - ] - }, - "name": "metadata", - "in": "body", - "rawType": "object", - "rawDescription": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", - "childParamsGroups": [] - }, - "relationship": { - "type": "string", - "description": "

    A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.

    ", - "enum": [ - "direct", - "indirect" - ], - "examples": [ - "direct" - ], - "name": "relationship", - "in": "body", - "rawType": "string", - "rawDescription": "A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.", - "childParamsGroups": [] - }, - "scope": { - "type": "string", - "description": "

    A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.

    ", - "enum": [ - "runtime", - "development" - ], - "examples": [ - "runtime" - ], - "name": "scope", - "in": "body", - "rawType": "string", - "rawDescription": "A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.", - "childParamsGroups": [] - }, - "dependencies": { - "type": "array of strings", - "description": "

    Array of package-url (PURLs) of direct child dependencies.

    ", - "items": { - "type": "string" - }, - "examples": [ - "@actions/http-client" - ], - "name": "dependencies", - "in": "body", - "rawType": "array", - "rawDescription": "Array of package-url (PURLs) of direct child dependencies.", - "childParamsGroups": [] - } - }, - "additionalProperties": false, - "rawType": "object", - "name": "key" - }, "name": "resolved", - "in": "body", - "isRequired": false, + "description": "

    A collection of resolved package dependencies.

    ", "childParamsGroups": [ { - "parentName": "resolved", - "parentType": "object", - "id": "resolved-object", - "params": [ - { - "description": "

    A user-defined key to represent an item in resolved.

    ", - "type": "string", - "name": "key", - "in": "body", - "rawType": "string", - "rawDescription": "A key to represent an item in resolved." - } - ] - }, - { - "parentName": "key", - "parentType": "object", - "id": "key-object", - "params": [ + "type": "object", + "name": "key", + "description": "

    A user-defined key to represent an item in resolved.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.

    ", - "pattern": "^pkg", - "examples": [ - "pkg:/npm/%40actions/http-client@1.0.11" - ], "name": "package_url", - "in": "body" + "description": "

    Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.

    " }, { - "title": "metadata", - "description": "

    User-defined metadata to store domain-specific information limited to 8 keys with scalar values.

    ", "type": "object", - "maxProperties": 8, - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - } - ], - "type": [ - "null", - "string", - "number", - "boolean" - ] - }, "name": "metadata", - "in": "body" + "description": "

    User-defined metadata to store domain-specific information limited to 8 keys with scalar values.

    " }, { "type": "string", + "name": "relationship", "description": "

    A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.

    ", "enum": [ "direct", "indirect" - ], - "examples": [ - "direct" - ], - "name": "relationship", - "in": "body" + ] }, { "type": "string", + "name": "scope", "description": "

    A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.

    ", "enum": [ "runtime", "development" - ], - "examples": [ - "runtime" - ], - "name": "scope", - "in": "body" + ] }, { "type": "array of strings", - "description": "

    Array of package-url (PURLs) of direct child dependencies.

    ", - "examples": [ - "@actions/http-client" - ], "name": "dependencies", - "in": "body" + "description": "

    Array of package-url (PURLs) of direct child dependencies.

    " } ] } ] } ] - }, - { - "parentName": "file", - "parentType": "object", - "id": "file-object", - "params": [ - { - "type": "string", - "description": "

    The path of the manifest file relative to the root of the Git repository.

    ", - "examples": [ - "/src/build/package-lock.json" - ], - "name": "source_location", - "in": "body" - } - ] - }, - { - "parentName": "resolved", - "parentType": "object", - "id": "resolved-object", - "params": [ - { - "description": "

    A user-defined key to represent an item in resolved.

    ", - "type": "string", - "name": "key", - "in": "body", - "rawType": "string", - "rawDescription": "A key to represent an item in resolved." - } - ] - }, - { - "parentName": "key", - "parentType": "object", - "id": "key-object", - "params": [ - { - "type": "string", - "description": "

    Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.

    ", - "pattern": "^pkg", - "examples": [ - "pkg:/npm/%40actions/http-client@1.0.11" - ], - "name": "package_url", - "in": "body" - }, - { - "title": "metadata", - "description": "

    User-defined metadata to store domain-specific information limited to 8 keys with scalar values.

    ", - "type": "object", - "maxProperties": 8, - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - } - ], - "type": [ - "null", - "string", - "number", - "boolean" - ] - }, - "name": "metadata", - "in": "body" - }, - { - "type": "string", - "description": "

    A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.

    ", - "enum": [ - "direct", - "indirect" - ], - "examples": [ - "direct" - ], - "name": "relationship", - "in": "body" - }, - { - "type": "string", - "description": "

    A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.

    ", - "enum": [ - "runtime", - "development" - ], - "examples": [ - "runtime" - ], - "name": "scope", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    Array of package-url (PURLs) of direct child dependencies.

    ", - "examples": [ - "@actions/http-client" - ], - "name": "dependencies", - "in": "body" - } - ] } ] }, { "type": "string", - "format": "date-time", - "description": "

    The time at which the snapshot was scanned.

    ", - "examples": [ - "2020-06-13T14:52:50-05:00" - ], "name": "scanned", "in": "body", + "description": "

    The time at which the snapshot was scanned.

    ", "isRequired": true } ], @@ -265332,24 +266733,22 @@ "bodyParameters": [ { "type": "string", - "description": "

    A name for the key.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    A name for the key.

    " }, { "type": "string", - "description": "

    The contents of the key.

    ", "name": "key", "in": "body", + "description": "

    The contents of the key.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

    \n

    Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

    ", "name": "read_only", "in": "body", - "isRequired": false + "description": "

    If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

    \n

    Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

    " } ], "enabledForGitHubApps": true, @@ -266478,82 +267877,61 @@ "bodyParameters": [ { "type": "string", - "description": "

    The ref to deploy. This can be a branch, tag, or SHA.

    ", "name": "ref", "in": "body", + "description": "

    The ref to deploy. This can be a branch, tag, or SHA.

    ", "isRequired": true }, { "type": "string", - "description": "

    Specifies a task to execute (e.g., deploy or deploy:migrations).

    ", - "default": "deploy", "name": "task", "in": "body", - "isRequired": false + "description": "

    Specifies a task to execute (e.g., deploy or deploy:migrations).

    ", + "default": "deploy" }, { "type": "boolean", - "description": "

    Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

    ", - "default": true, "name": "auto_merge", "in": "body", - "isRequired": false + "description": "

    Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

    ", + "default": true }, { "type": "array of strings", - "description": "

    The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

    ", "name": "required_contexts", "in": "body", - "isRequired": false + "description": "

    The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

    " }, { - "oneOf": [ - { - "type": "object", - "additionalProperties": true - }, - { - "type": "string", - "description": "JSON payload with extra information about the deployment.", - "default": "" - } - ], + "type": "object or string", "name": "payload", "in": "body", - "type": "object or string", - "description": "

    JSON payload with extra information about the deployment.

    ", - "isRequired": false + "description": "

    JSON payload with extra information about the deployment.

    " }, { "type": "string", - "description": "

    Name for the target deployment environment (e.g., production, staging, qa).

    ", - "default": "production", "name": "environment", "in": "body", - "isRequired": false + "description": "

    Name for the target deployment environment (e.g., production, staging, qa).

    ", + "default": "production" }, { "type": "string or null", - "description": "

    Short description of the deployment.

    ", - "default": "", "name": "description", "in": "body", - "isRequired": false + "description": "

    Short description of the deployment.

    " }, { "type": "boolean", - "description": "

    Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false

    ", - "default": false, "name": "transient_environment", "in": "body", - "isRequired": false + "description": "

    Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false

    " }, { "type": "boolean", - "description": "

    Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

    ", "name": "production_environment", "in": "body", - "isRequired": false + "description": "

    Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

    " } ], "enabledForGitHubApps": true, @@ -268282,13 +269660,10 @@ ], "bodyParameters": [ { - "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "type": "string", - "examples": [ - "release/*" - ], "name": "name", "in": "body", + "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "isRequired": true } ], @@ -268573,13 +269948,10 @@ ], "bodyParameters": [ { - "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "type": "string", - "examples": [ - "release/*" - ], "name": "name", "in": "body", + "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "isRequired": true } ], @@ -270207,105 +271579,49 @@ "bodyParameters": [ { "type": "integer", - "description": "

    The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).

    ", - "examples": [ - 30 - ], "name": "wait_timer", "in": "body", - "isRequired": false + "description": "

    The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).

    " }, { "type": "array of objects or null", - "description": "

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", "name": "reviewers", "in": "body", - "isRequired": false, + "description": "

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", "childParamsGroups": [ { - "parentName": "reviewers", - "parentType": "items", - "id": "reviewers-items", - "params": [ - { - "type": "string", - "description": "

    The type of reviewer.

    ", - "enum": [ - "User", - "Team" - ], - "examples": [ - "User" - ], - "name": "type", - "in": "body" - }, - { - "type": "integer", - "description": "

    The id of the user or team who can review the deployment

    ", - "examples": [ - 4532992 - ], - "name": "id", - "in": "body" - } + "type": "string", + "name": "type", + "description": "

    The type of reviewer.

    ", + "enum": [ + "User", + "Team" ] + }, + { + "type": "integer", + "name": "id", + "description": "

    The id of the user or team who can review the deployment

    " } ] }, { "type": "object or null", - "description": "

    The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

    ", - "properties": { - "protected_branches": { - "type": "boolean", - "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", - "name": "protected_branches", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", - "isRequired": true, - "childParamsGroups": [] - }, - "custom_branch_policies": { - "type": "boolean", - "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", - "name": "custom_branch_policies", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "protected_branches", - "custom_branch_policies" - ], "name": "deployment_branch_policy", "in": "body", - "isRequired": false, + "description": "

    The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

    ", "childParamsGroups": [ { - "parentName": "deployment_branch_policy", - "parentType": "object", - "id": "deployment_branch_policy-object", - "params": [ - { - "type": "boolean", - "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", - "name": "protected_branches", - "in": "body", - "isRequired": true - }, - { - "type": "boolean", - "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", - "name": "custom_branch_policies", - "in": "body", - "isRequired": true - } - ] + "type": "boolean", + "name": "protected_branches", + "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", + "isRequired": true + }, + { + "type": "boolean", + "name": "custom_branch_policies", + "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", + "isRequired": true } ] } @@ -271863,7 +273179,10 @@ "bodyParameters": [ { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the status. When you set a transient deployment to inactive, the deployment will be shown as destroyed in GitHub.

    ", + "isRequired": true, "enum": [ "error", "failure", @@ -271872,61 +273191,48 @@ "queued", "pending", "success" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.

    ", - "default": "", "name": "target_url", "in": "body", - "isRequired": false + "description": "

    The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.

    " }, { "type": "string", - "description": "

    The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: \"\"

    ", - "default": "", "name": "log_url", "in": "body", - "isRequired": false + "description": "

    The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: \"\"

    " }, { "type": "string", - "description": "

    A short description of the status. The maximum description length is 140 characters.

    ", - "default": "", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the status. The maximum description length is 140 characters.

    " }, { "type": "string", + "name": "environment", + "in": "body", "description": "

    Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa.

    ", "enum": [ "production", "staging", "qa" - ], - "name": "environment", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "description": "

    Sets the URL for accessing your environment. Default: \"\"

    ", - "default": "", "name": "environment_url", "in": "body", - "isRequired": false + "description": "

    Sets the URL for accessing your environment. Default: \"\"

    " }, { "type": "boolean", - "description": "

    Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true

    ", "name": "auto_inactive", "in": "body", - "isRequired": false + "description": "

    Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true

    " } ], "enabledForGitHubApps": true, @@ -276982,16 +278288,16 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    The SCIM schema URIs.

    ", "name": "schemas", "in": "body", + "description": "

    The SCIM schema URIs.

    ", "isRequired": true }, { "type": "string", - "description": "

    The name of the SCIM group. This must match the GitHub organization that the group maps to.

    ", "name": "displayName", "in": "body", + "description": "

    The name of the SCIM group. This must match the GitHub organization that the group maps to.

    ", "isRequired": true }, { @@ -276999,21 +278305,12 @@ "name": "members", "in": "body", "description": "", - "isRequired": false, "childParamsGroups": [ { - "parentName": "members", - "parentType": "items", - "id": "members-items", - "params": [ - { - "type": "string", - "description": "

    The SCIM user ID for a user.

    ", - "name": "value", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "value", + "description": "

    The SCIM user ID for a user.

    ", + "isRequired": true } ] } @@ -277329,16 +278626,16 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    The SCIM schema URIs.

    ", "name": "schemas", "in": "body", + "description": "

    The SCIM schema URIs.

    ", "isRequired": true }, { "type": "string", - "description": "

    The name of the SCIM group. This must match the GitHub organization that the group maps to.

    ", "name": "displayName", "in": "body", + "description": "

    The name of the SCIM group. This must match the GitHub organization that the group maps to.

    ", "isRequired": true }, { @@ -277346,21 +278643,12 @@ "name": "members", "in": "body", "description": "", - "isRequired": false, "childParamsGroups": [ { - "parentName": "members", - "parentType": "items", - "id": "members-items", - "params": [ - { - "type": "string", - "description": "

    The SCIM user ID for a user.

    ", - "name": "value", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "value", + "description": "

    The SCIM user ID for a user.

    ", + "isRequired": true } ] } @@ -277525,54 +278813,41 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    The SCIM schema URIs.

    ", "name": "schemas", "in": "body", + "description": "

    The SCIM schema URIs.

    ", "isRequired": true }, { "type": "array of objects", - "description": "

    Array of SCIM operations.

    ", - "minItems": 1, "name": "Operations", "in": "body", + "description": "

    Array of SCIM operations.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "Operations", - "parentType": "items", - "id": "operations-items", - "params": [ - { - "type": "string", - "enum": [ - "add", - "Add", - "remove", - "Remove", - "replace", - "Replace" - ], - "name": "op", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "in": "body", - "description": "", - "isRequired": false - }, - { - "description": "

    Can be any value - string, number, array or object.

    ", - "name": "value", - "in": "body", - "type": "", - "isRequired": false - } + "type": "string", + "name": "op", + "description": "", + "isRequired": true, + "enum": [ + "add", + "Add", + "remove", + "Remove", + "replace", + "Replace" ] + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "", + "name": "value", + "description": "

    Can be any value - string, number, array or object.

    " } ] } @@ -278034,130 +279309,76 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    The SCIM schema URIs.

    ", "name": "schemas", "in": "body", + "description": "

    The SCIM schema URIs.

    ", "isRequired": true }, { "type": "string", - "description": "

    The username for the user.

    ", "name": "userName", "in": "body", + "description": "

    The username for the user.

    ", "isRequired": true }, { "type": "object", - "properties": { - "givenName": { - "type": "string", - "description": "

    The first name of the user.

    ", - "name": "givenName", - "in": "body", - "rawType": "string", - "rawDescription": "The first name of the user.", - "isRequired": true, - "childParamsGroups": [] - }, - "familyName": { - "type": "string", - "description": "

    The last name of the user.

    ", - "name": "familyName", - "in": "body", - "rawType": "string", - "rawDescription": "The last name of the user.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "givenName", - "familyName" - ], "name": "name", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { - "parentName": "name", - "parentType": "object", - "id": "name-object", - "params": [ - { - "type": "string", - "description": "

    The first name of the user.

    ", - "name": "givenName", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The last name of the user.

    ", - "name": "familyName", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "givenName", + "description": "

    The first name of the user.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "familyName", + "description": "

    The last name of the user.

    ", + "isRequired": true } ] }, { "type": "array of objects", - "description": "

    List of user emails.

    ", "name": "emails", "in": "body", + "description": "

    List of user emails.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "emails", - "parentType": "items", - "id": "emails-items", - "params": [ - { - "type": "string", - "description": "

    The email address.

    ", - "name": "value", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The type of email address.

    ", - "name": "type", - "in": "body", - "isRequired": true - }, - { - "type": "boolean", - "description": "

    Whether this email address is the primary address.

    ", - "name": "primary", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "value", + "description": "

    The email address.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "

    The type of email address.

    ", + "isRequired": true + }, + { + "type": "boolean", + "name": "primary", + "description": "

    Whether this email address is the primary address.

    ", + "isRequired": true } ] }, { "type": "array of objects", - "description": "

    List of SCIM group IDs the user is a member of.

    ", "name": "groups", "in": "body", - "isRequired": false, + "description": "

    List of SCIM group IDs the user is a member of.

    ", "childParamsGroups": [ { - "parentName": "groups", - "parentType": "items", - "id": "groups-items", - "params": [ - { - "type": "string", - "name": "value", - "in": "body", - "description": "" - } - ] + "type": "string", + "name": "value", + "description": "" } ] } @@ -278526,130 +279747,76 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    The SCIM schema URIs.

    ", "name": "schemas", "in": "body", + "description": "

    The SCIM schema URIs.

    ", "isRequired": true }, { "type": "string", - "description": "

    The username for the user.

    ", "name": "userName", "in": "body", + "description": "

    The username for the user.

    ", "isRequired": true }, { "type": "object", - "properties": { - "givenName": { - "type": "string", - "description": "

    The first name of the user.

    ", - "name": "givenName", - "in": "body", - "rawType": "string", - "rawDescription": "The first name of the user.", - "isRequired": true, - "childParamsGroups": [] - }, - "familyName": { - "type": "string", - "description": "

    The last name of the user.

    ", - "name": "familyName", - "in": "body", - "rawType": "string", - "rawDescription": "The last name of the user.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "givenName", - "familyName" - ], "name": "name", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { - "parentName": "name", - "parentType": "object", - "id": "name-object", - "params": [ - { - "type": "string", - "description": "

    The first name of the user.

    ", - "name": "givenName", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The last name of the user.

    ", - "name": "familyName", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "givenName", + "description": "

    The first name of the user.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "familyName", + "description": "

    The last name of the user.

    ", + "isRequired": true } ] }, { "type": "array of objects", - "description": "

    List of user emails.

    ", "name": "emails", "in": "body", + "description": "

    List of user emails.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "emails", - "parentType": "items", - "id": "emails-items", - "params": [ - { - "type": "string", - "description": "

    The email address.

    ", - "name": "value", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The type of email address.

    ", - "name": "type", - "in": "body", - "isRequired": true - }, - { - "type": "boolean", - "description": "

    Whether this email address is the primary address.

    ", - "name": "primary", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "value", + "description": "

    The email address.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "

    The type of email address.

    ", + "isRequired": true + }, + { + "type": "boolean", + "name": "primary", + "description": "

    Whether this email address is the primary address.

    ", + "isRequired": true } ] }, { "type": "array of objects", - "description": "

    List of SCIM group IDs the user is a member of.

    ", "name": "groups", "in": "body", - "isRequired": false, + "description": "

    List of SCIM group IDs the user is a member of.

    ", "childParamsGroups": [ { - "parentName": "groups", - "parentType": "items", - "id": "groups-items", - "params": [ - { - "type": "string", - "name": "value", - "in": "body", - "description": "" - } - ] + "type": "string", + "name": "value", + "description": "" } ] } @@ -278849,16 +280016,16 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    The SCIM schema URIs.

    ", "name": "schemas", "in": "body", + "description": "

    The SCIM schema URIs.

    ", "isRequired": true }, { "type": "array of objects", - "description": "

    Array of SCIM operations.

    ", "name": "Operations", "in": "body", + "description": "

    Array of SCIM operations.

    ", "isRequired": true } ], @@ -279663,76 +280830,27 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Description of the gist

    ", "type": "string", - "examples": [ - "Example Ruby script" - ], "name": "description", "in": "body", - "isRequired": false + "description": "

    Description of the gist

    " }, { - "description": "

    Names and content for the files that make up the gist

    ", "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "content": { - "description": "

    Content of the file

    ", - "readOnly": false, - "type": "string", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "Content of the file", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "content" - ], - "rawType": "object", - "name": "key" - }, - "examples": [ - { - "hello.rb": { - "content": "puts \"Hello, World!\"" - } - } - ], "name": "files", "in": "body", + "description": "

    Names and content for the files that make up the gist

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "files", - "parentType": "object", - "id": "files-object", - "params": [ + "type": "object", + "name": "key", + "description": "

    A user-defined key to represent an item in files.

    ", + "childParamsGroups": [ { - "description": "

    A user-defined key to represent an item in files.

    ", - "type": "string", - "name": "key", - "in": "body", - "rawType": "string", - "rawDescription": "A key to represent an item in files." - } - ] - }, - { - "parentName": "key", - "parentType": "object", - "id": "key-object", - "params": [ - { - "description": "

    Content of the file

    ", - "readOnly": false, "type": "string", "name": "content", - "in": "body", + "description": "

    Content of the file

    ", "isRequired": true } ] @@ -279740,32 +280858,10 @@ ] }, { - "oneOf": [ - { - "description": "Flag indicating whether the gist is public", - "type": "boolean", - "default": false, - "examples": [ - true - ] - }, - { - "type": "string", - "default": "false", - "enum": [ - "true", - "false" - ], - "examples": [ - "true" - ] - } - ], + "type": "boolean or string", "name": "public", "in": "body", - "type": "boolean or string", - "description": "

    Flag indicating whether the gist is public

    ", - "isRequired": false + "description": "

    Flag indicating whether the gist is public

    " } ], "enabledForGitHubApps": false, @@ -283412,108 +284508,31 @@ ], "bodyParameters": [ { - "description": "

    Description of the gist

    ", "type": "string", - "examples": [ - "Example Ruby script" - ], "name": "description", "in": "body", - "isRequired": false + "description": "

    Description of the gist

    " }, { - "description": "

    Names of files to be updated

    ", "type": "object", - "additionalProperties": { - "type": [ - "object", - "null" - ], - "properties": { - "content": { - "description": "

    The new content of the file

    ", - "type": "string", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The new content of the file", - "childParamsGroups": [] - }, - "filename": { - "description": "

    The new filename for the file

    ", - "type": "string or null", - "name": "filename", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new filename for the file", - "childParamsGroups": [] - } - }, - "anyOf": [ - { - "required": [ - "content" - ] - }, - { - "required": [ - "filename" - ] - }, - { - "type": "object", - "maxProperties": 0 - } - ], - "rawType": "object", - "name": "key" - }, - "examples": [ - { - "hello.rb": { - "content": "blah", - "filename": "goodbye.rb" - } - } - ], "name": "files", "in": "body", - "isRequired": false, + "description": "

    Names of files to be updated

    ", "childParamsGroups": [ { - "parentName": "files", - "parentType": "object", - "id": "files-object", - "params": [ + "type": "object", + "name": "key", + "description": "

    A user-defined key to represent an item in files.

    ", + "childParamsGroups": [ { - "description": "

    A user-defined key to represent an item in files.

    ", - "type": "string", - "name": "key", - "in": "body", - "rawType": "string", - "rawDescription": "A key to represent an item in files." - } - ] - }, - { - "parentName": "key", - "parentType": "object", - "id": "key-object", - "params": [ - { - "description": "

    The new content of the file

    ", "type": "string", "name": "content", - "in": "body" + "description": "

    The new content of the file

    " }, { - "description": "

    The new filename for the file

    ", "type": "string or null", "name": "filename", - "in": "body" + "description": "

    The new filename for the file

    " } ] } @@ -289369,14 +290388,10 @@ ], "bodyParameters": [ { - "description": "

    The comment text.

    ", "type": "string", - "maxLength": 65535, - "examples": [ - "Body of the attachment" - ], "name": "body", "in": "body", + "description": "

    The comment text.

    ", "isRequired": true } ], @@ -290066,14 +291081,10 @@ ], "bodyParameters": [ { - "description": "

    The comment text.

    ", "type": "string", - "maxLength": 65535, - "examples": [ - "Body of the attachment" - ], "name": "body", "in": "body", + "description": "

    The comment text.

    ", "isRequired": true } ], @@ -290487,18 +291498,17 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new blob's content.

    ", "name": "content", "in": "body", + "description": "

    The new blob's content.

    ", "isRequired": true }, { "type": "string", - "description": "

    The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.

    ", - "default": "utf-8", "name": "encoding", "in": "body", - "isRequired": false + "description": "

    The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.

    ", + "default": "utf-8" } ], "enabledForGitHubApps": true, @@ -290729,171 +291739,77 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message

    ", "name": "message", "in": "body", + "description": "

    The commit message

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the tree object this commit points to

    ", "name": "tree", "in": "body", + "description": "

    The SHA of the tree object this commit points to

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

    ", "name": "parents", "in": "body", - "isRequired": false + "description": "

    The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

    " }, { "type": "object", - "description": "

    Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "author", "in": "body", - "isRequired": false, + "description": "

    Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] }, { "type": "object", - "description": "

    Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "childParamsGroups": [] - } - }, "name": "committer", "in": "body", - "isRequired": false, + "description": "

    Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - }, - { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "date", + "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] }, { "type": "string", - "description": "

    The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

    ", "name": "signature", "in": "body", - "isRequired": false + "description": "

    The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

    " } ], "enabledForGitHubApps": true, @@ -291762,27 +292678,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

    ", "name": "ref", "in": "body", + "description": "

    The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA1 value for this reference.

    ", "name": "sha", "in": "body", + "description": "

    The SHA1 value for this reference.

    ", "isRequired": true }, { "type": "string", - "examples": [ - "\"refs/heads/newbranch\"" - ], "name": "key", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -291922,18 +292834,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The SHA1 value to set this reference to

    ", "name": "sha", "in": "body", + "description": "

    The SHA1 value to set this reference to

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

    ", - "default": false, "name": "force", "in": "body", - "isRequired": false + "description": "

    Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

    " } ], "enabledForGitHubApps": true, @@ -292135,109 +293045,59 @@ "bodyParameters": [ { "type": "string", - "description": "

    The tag's name. This is typically a version (e.g., \"v0.0.1\").

    ", "name": "tag", "in": "body", + "description": "

    The tag's name. This is typically a version (e.g., \"v0.0.1\").

    ", "isRequired": true }, { "type": "string", - "description": "

    The tag message.

    ", "name": "message", "in": "body", + "description": "

    The tag message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the git object this is tagging.

    ", "name": "object", "in": "body", + "description": "

    The SHA of the git object this is tagging.

    ", "isRequired": true }, { "type": "string", + "name": "type", + "in": "body", "description": "

    The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.

    ", + "isRequired": true, "enum": [ "commit", "tree", "blob" - ], - "name": "type", - "in": "body", - "isRequired": true + ] }, { "type": "object", - "description": "

    An object with information about the individual creating the tag.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author of the tag

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author of the tag", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author of the tag

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author of the tag", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "tagger", "in": "body", - "isRequired": false, + "description": "

    An object with information about the individual creating the tag.

    ", "childParamsGroups": [ { - "parentName": "tagger", - "parentType": "object", - "id": "tagger-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author of the tag

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author of the tag

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "format": "date-time", - "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author of the tag

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author of the tag

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] } @@ -292672,68 +293532,55 @@ "bodyParameters": [ { "type": "array of objects", - "description": "

    Objects (of path, mode, type, and sha) specifying a tree structure.

    ", "name": "tree", "in": "body", + "description": "

    Objects (of path, mode, type, and sha) specifying a tree structure.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "tree", - "parentType": "items", - "id": "tree-items", - "params": [ - { - "type": "string", - "description": "

    The file referenced in the tree.

    ", - "name": "path", - "in": "body" - }, - { - "type": "string", - "description": "

    The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

    ", - "enum": [ - "100644", - "100755", - "040000", - "160000", - "120000" - ], - "name": "mode", - "in": "body" - }, - { - "type": "string", - "description": "

    Either blob, tree, or commit.

    ", - "enum": [ - "blob", - "tree", - "commit" - ], - "name": "type", - "in": "body" - }, - { - "type": "string or null", - "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", - "name": "sha", - "in": "body" - }, - { - "type": "string", - "description": "

    The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", - "name": "content", - "in": "body" - } + "type": "string", + "name": "path", + "description": "

    The file referenced in the tree.

    " + }, + { + "type": "string", + "name": "mode", + "description": "

    The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

    ", + "enum": [ + "100644", + "100755", + "040000", + "160000", + "120000" ] + }, + { + "type": "string", + "name": "type", + "description": "

    Either blob, tree, or commit.

    ", + "enum": [ + "blob", + "tree", + "commit" + ] + }, + { + "type": "string or null", + "name": "sha", + "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    " + }, + { + "type": "string", + "name": "content", + "description": "

    The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    " } ] }, { "type": "string", - "description": "

    The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

    ", "name": "base_tree", "in": "body", - "isRequired": false + "description": "

    The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

    " } ], "enabledForGitHubApps": true, @@ -293522,21 +294369,20 @@ "bodyParameters": [ { "type": "string", + "name": "limit", + "in": "body", "description": "

    The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.

    ", + "isRequired": true, "enum": [ "existing_users", "contributors_only", "collaborators_only" - ], - "examples": [ - "collaborators_only" - ], - "name": "limit", - "in": "body", - "isRequired": true + ] }, { "type": "string", + "name": "expiry", + "in": "body", "description": "

    The duration of the interaction restriction. Default: one_day.

    ", "enum": [ "one_day", @@ -293544,13 +294390,7 @@ "one_week", "one_month", "six_months" - ], - "examples": [ - "one_month" - ], - "name": "expiry", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -293811,21 +294651,20 @@ "bodyParameters": [ { "type": "string", + "name": "limit", + "in": "body", "description": "

    The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.

    ", + "isRequired": true, "enum": [ "existing_users", "contributors_only", "collaborators_only" - ], - "examples": [ - "collaborators_only" - ], - "name": "limit", - "in": "body", - "isRequired": true + ] }, { "type": "string", + "name": "expiry", + "in": "body", "description": "

    The duration of the interaction restriction. Default: one_day.

    ", "enum": [ "one_day", @@ -293833,13 +294672,7 @@ "one_week", "one_month", "six_months" - ], - "examples": [ - "one_month" - ], - "name": "expiry", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -293848,8 +294681,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example request body", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "limit": "collaborators_only", + "expiry": "one_day" + }, "parameters": { "owner": "OWNER", "repo": "REPO" @@ -294077,21 +294914,20 @@ "bodyParameters": [ { "type": "string", + "name": "limit", + "in": "body", "description": "

    The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.

    ", + "isRequired": true, "enum": [ "existing_users", "contributors_only", "collaborators_only" - ], - "examples": [ - "collaborators_only" - ], - "name": "limit", - "in": "body", - "isRequired": true + ] }, { "type": "string", + "name": "expiry", + "in": "body", "description": "

    The duration of the interaction restriction. Default: one_day.

    ", "enum": [ "one_day", @@ -294099,13 +294935,7 @@ "one_week", "one_month", "six_months" - ], - "examples": [ - "one_month" - ], - "name": "expiry", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": false, @@ -301547,7 +302377,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ], "schema": { @@ -304684,63 +305515,41 @@ ], "bodyParameters": [ { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "

    The title of the issue.

    ", + "type": "string or integer", "name": "title", "in": "body", - "type": "string or integer", + "description": "

    The title of the issue.

    ", "isRequired": true }, { "type": "string", - "description": "

    The contents of the issue.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the issue.

    " }, { "type": "string or null", - "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "name": "assignee", "in": "body", - "isRequired": false + "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    " }, { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._" - } - ], - "type": "string or integer or null", + "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "isRequired": false + "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    " }, { - "type": "array of strings or array of objects", - "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", + "type": "array", "name": "labels", "in": "body", - "isRequired": false + "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    " }, { "type": "array of strings", - "description": "

    Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    " } ], "enabledForGitHubApps": true, @@ -304926,7 +305735,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -308247,7 +309057,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -311393,74 +312204,56 @@ ], "bodyParameters": [ { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "

    The title of the issue.

    ", - "type": "string or integer or null", + "type": "null or string or integer or string or integer", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the issue.

    " }, { "type": "string or null", - "description": "

    The contents of the issue.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the issue.

    " }, { "type": "string or null", - "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", "in": "body", - "isRequired": false + "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    State of the issue. Either open or closed.

    ", "enum": [ "open", "closed" - ], - "name": "state", - "in": "body", - "isRequired": false + ] }, { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._" - } - ], - "type": "string or integer or null", + "type": "string or null", + "name": "state_reason", + "in": "body", + "description": "

    The reason for the current state

    " + }, + { + "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "isRequired": false + "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    " }, { - "type": "array of strings or array of objects", - "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", + "type": "array", "name": "labels", "in": "body", - "isRequired": false + "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    " }, { "type": "array of strings", - "description": "

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    " } ], "enabledForGitHubApps": true, @@ -311648,7 +312441,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -314803,16 +315597,15 @@ "bodyParameters": [ { "type": "string", + "name": "lock_reason", + "in": "body", "description": "

    The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
    \n* off-topic
    \n* too heated
    \n* resolved
    \n* spam

    ", "enum": [ "off-topic", "too heated", "resolved", "spam" - ], - "name": "lock_reason", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -318795,10 +319588,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

    " } ], "enabledForGitHubApps": true, @@ -318980,7 +319772,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -322111,10 +322904,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

    " } ], "enabledForGitHubApps": true, @@ -322296,7 +323088,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -326961,9 +327754,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true } ], @@ -328553,9 +329346,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true } ], @@ -329505,7 +330298,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ], @@ -334449,7 +335243,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } }, "schema": { @@ -349477,10 +350272,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

    ", "name": "labels", - "in": "body" + "in": "body", + "description": "

    The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

    " } ], "enabledForGitHubApps": true, @@ -349655,10 +350449,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

    ", "name": "labels", - "in": "body" + "in": "body", + "description": "

    The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

    " } ], "enabledForGitHubApps": true, @@ -350224,24 +351017,22 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "name": "name", "in": "body", + "description": "

    The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "isRequired": true }, { "type": "string", - "description": "

    The hexadecimal color code for the label, without the leading #.

    ", "name": "color", "in": "body", - "isRequired": false + "description": "

    The hexadecimal color code for the label, without the leading #.

    " }, { "type": "string", - "description": "

    A short description of the label. Must be 100 characters or fewer.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the label. Must be 100 characters or fewer.

    " } ], "enabledForGitHubApps": true, @@ -350545,24 +351336,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "name": "new_name", "in": "body", - "isRequired": false + "description": "

    The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    " }, { "type": "string", - "description": "

    The hexadecimal color code for the label, without the leading #.

    ", "name": "color", "in": "body", - "isRequired": false + "description": "

    The hexadecimal color code for the label, without the leading #.

    " }, { "type": "string", - "description": "

    A short description of the label. Must be 100 characters or fewer.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the label. Must be 100 characters or fewer.

    " } ], "enabledForGitHubApps": true, @@ -351415,37 +352203,33 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the milestone.

    ", "name": "title", "in": "body", + "description": "

    The title of the milestone.

    ", "isRequired": true }, { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the milestone. Either open or closed.

    ", "enum": [ "open", "closed" ], - "default": "open", - "name": "state", - "in": "body", - "isRequired": false + "default": "open" }, { "type": "string", - "description": "

    A description of the milestone.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A description of the milestone.

    " }, { "type": "string", - "format": "date-time", - "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "due_on", "in": "body", - "isRequired": false + "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ], "enabledForGitHubApps": true, @@ -352288,37 +353072,32 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the milestone.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the milestone.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the milestone. Either open or closed.

    ", "enum": [ "open", "closed" ], - "default": "open", - "name": "state", - "in": "body", - "isRequired": false + "default": "open" }, { "type": "string", - "description": "

    A description of the milestone.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A description of the milestone.

    " }, { "type": "string", - "format": "date-time", - "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "due_on", "in": "body", - "isRequired": false + "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ], "enabledForGitHubApps": true, @@ -369271,33 +370050,28 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The Markdown text to render in HTML.

    ", "type": "string", "name": "text", "in": "body", + "description": "

    The Markdown text to render in HTML.

    ", "isRequired": true }, { + "type": "string", + "name": "mode", + "in": "body", "description": "

    The rendering mode. Can be either markdown or gfm.

    ", "enum": [ "markdown", "gfm" ], - "default": "markdown", - "type": "string", - "examples": [ - "markdown" - ], - "name": "mode", - "in": "body", - "isRequired": false + "default": "markdown" }, { - "description": "

    The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

    ", "type": "string", "name": "context", "in": "body", - "isRequired": false + "description": "

    The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

    " } ], "enabledForGitHubApps": true, @@ -373780,88 +374554,58 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    A list of arrays indicating which repositories should be migrated.

    ", "name": "repositories", "in": "body", + "description": "

    A list of arrays indicating which repositories should be migrated.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Indicates whether repositories should be locked (to prevent manipulation) while migrating data.

    ", - "default": false, - "examples": [ - true - ], "name": "lock_repositories", "in": "body", - "isRequired": false + "description": "

    Indicates whether repositories should be locked (to prevent manipulation) while migrating data.

    " }, { "type": "boolean", - "description": "

    Indicates whether metadata should be excluded and only git source should be included for the migration.

    ", - "default": false, "name": "exclude_metadata", "in": "body", - "isRequired": false + "description": "

    Indicates whether metadata should be excluded and only git source should be included for the migration.

    " }, { "type": "boolean", - "description": "

    Indicates whether the repository git data should be excluded from the migration.

    ", - "default": false, "name": "exclude_git_data", "in": "body", - "isRequired": false + "description": "

    Indicates whether the repository git data should be excluded from the migration.

    " }, { "type": "boolean", - "description": "

    Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).

    ", - "default": false, - "examples": [ - true - ], "name": "exclude_attachments", "in": "body", - "isRequired": false + "description": "

    Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).

    " }, { "type": "boolean", - "description": "

    Indicates whether releases should be excluded from the migration (to reduce migration archive file size).

    ", - "default": false, - "examples": [ - true - ], "name": "exclude_releases", "in": "body", - "isRequired": false + "description": "

    Indicates whether releases should be excluded from the migration (to reduce migration archive file size).

    " }, { "type": "boolean", - "description": "

    Indicates whether projects owned by the organization or users should be excluded. from the migration.

    ", - "default": false, - "examples": [ - true - ], "name": "exclude_owner_projects", "in": "body", - "isRequired": false + "description": "

    Indicates whether projects owned by the organization or users should be excluded. from the migration.

    " }, { "type": "boolean", - "description": "

    Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

    ", - "default": false, - "examples": [ - true - ], "name": "org_metadata_only", "in": "body", - "isRequired": false + "description": "

    Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

    " }, { "type": "array of strings", - "description": "

    Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: \"repositories\".

    ", "name": "exclude", "in": "body", - "isRequired": false + "description": "

    Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: \"repositories\".

    " } ], "enabledForGitHubApps": false, @@ -380581,44 +381325,40 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL of the originating repository.

    ", "name": "vcs_url", "in": "body", + "description": "

    The URL of the originating repository.

    ", "isRequired": true }, { "type": "string", + "name": "vcs", + "in": "body", "description": "

    The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.

    ", "enum": [ "subversion", "git", "mercurial", "tfvc" - ], - "name": "vcs", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "description": "

    If authentication is required, the username to provide to vcs_url.

    ", "name": "vcs_username", "in": "body", - "isRequired": false + "description": "

    If authentication is required, the username to provide to vcs_url.

    " }, { "type": "string", - "description": "

    If authentication is required, the password to provide to vcs_url.

    ", "name": "vcs_password", "in": "body", - "isRequired": false + "description": "

    If authentication is required, the password to provide to vcs_url.

    " }, { "type": "string", - "description": "

    For a tfvc import, the name of the project that is being imported.

    ", "name": "tfvc_project", "in": "body", - "isRequired": false + "description": "

    For a tfvc import, the name of the project that is being imported.

    " } ], "enabledForGitHubApps": true, @@ -380856,43 +381596,33 @@ "bodyParameters": [ { "type": "string", - "description": "

    The username to provide to the originating repository.

    ", "name": "vcs_username", "in": "body", - "isRequired": false + "description": "

    The username to provide to the originating repository.

    " }, { "type": "string", - "description": "

    The password to provide to the originating repository.

    ", "name": "vcs_password", "in": "body", - "isRequired": false + "description": "

    The password to provide to the originating repository.

    " }, { "type": "string", + "name": "vcs", + "in": "body", "description": "

    The type of version control system you are migrating from.

    ", "enum": [ "subversion", "tfvc", "git", "mercurial" - ], - "examples": [ - "\"git\"" - ], - "name": "vcs", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "description": "

    For a tfvc import, the name of the project that is being imported.

    ", - "examples": [ - "\"project1\"" - ], "name": "tfvc_project", "in": "body", - "isRequired": false + "description": "

    For a tfvc import, the name of the project that is being imported.

    " } ], "enabledForGitHubApps": true, @@ -381682,17 +382412,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new Git author email.

    ", "name": "email", "in": "body", - "isRequired": false + "description": "

    The new Git author email.

    " }, { "type": "string", - "description": "

    The new Git author name.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The new Git author name.

    " } ], "enabledForGitHubApps": true, @@ -381919,14 +382647,14 @@ "bodyParameters": [ { "type": "string", + "name": "use_lfs", + "in": "body", "description": "

    Whether to store large files during the import. opt_in means large files will be stored using Git LFS. opt_out means large files will be removed during the import.

    ", + "isRequired": true, "enum": [ "opt_in", "opt_out" - ], - "name": "use_lfs", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -384090,92 +384818,52 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Lock the repositories being migrated at the start of the migration

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "lock_repositories", "in": "body", - "isRequired": false + "description": "

    Lock the repositories being migrated at the start of the migration

    " }, { - "description": "

    Indicates whether metadata should be excluded and only git source should be included for the migration.

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_metadata", "in": "body", - "isRequired": false + "description": "

    Indicates whether metadata should be excluded and only git source should be included for the migration.

    " }, { - "description": "

    Indicates whether the repository git data should be excluded from the migration.

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_git_data", "in": "body", - "isRequired": false + "description": "

    Indicates whether the repository git data should be excluded from the migration.

    " }, { - "description": "

    Do not include attachments in the migration

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_attachments", "in": "body", - "isRequired": false + "description": "

    Do not include attachments in the migration

    " }, { - "description": "

    Do not include releases in the migration

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_releases", "in": "body", - "isRequired": false + "description": "

    Do not include releases in the migration

    " }, { - "description": "

    Indicates whether projects owned by the organization or users should be excluded.

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_owner_projects", "in": "body", - "isRequired": false + "description": "

    Indicates whether projects owned by the organization or users should be excluded.

    " }, { "type": "boolean", - "description": "

    Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

    ", - "default": false, - "examples": [ - true - ], "name": "org_metadata_only", "in": "body", - "isRequired": false + "description": "

    Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

    " }, { - "description": "

    Exclude attributes from the API response to improve performance

    ", - "readOnly": false, "type": "array of strings", - "examples": [ - "repositories" - ], "name": "exclude", "in": "body", - "isRequired": false + "description": "

    Exclude attributes from the API response to improve performance

    " }, { "type": "array of strings", @@ -391300,69 +391988,62 @@ "bodyParameters": [ { "type": "string", - "description": "

    Billing email address. This address is not publicized.

    ", "name": "billing_email", "in": "body", - "isRequired": false + "description": "

    Billing email address. This address is not publicized.

    " }, { "type": "string", - "description": "

    The company name.

    ", "name": "company", "in": "body", - "isRequired": false + "description": "

    The company name.

    " }, { "type": "string", - "description": "

    The publicly visible email address.

    ", "name": "email", "in": "body", - "isRequired": false + "description": "

    The publicly visible email address.

    " }, { "type": "string", - "description": "

    The Twitter username of the company.

    ", "name": "twitter_username", "in": "body", - "isRequired": false + "description": "

    The Twitter username of the company.

    " }, { "type": "string", - "description": "

    The location.

    ", "name": "location", "in": "body", - "isRequired": false + "description": "

    The location.

    " }, { "type": "string", - "description": "

    The shorthand name of the company.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The shorthand name of the company.

    " }, { "type": "string", - "description": "

    The description of the company.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the company.

    " }, { "type": "boolean", - "description": "

    Whether an organization can use organization projects.

    ", "name": "has_organization_projects", "in": "body", - "isRequired": false + "description": "

    Whether an organization can use organization projects.

    " }, { "type": "boolean", - "description": "

    Whether repositories that belong to the organization can use repository projects.

    ", "name": "has_repository_projects", "in": "body", - "isRequired": false + "description": "

    Whether repositories that belong to the organization can use repository projects.

    " }, { "type": "string", + "name": "default_repository_permission", + "in": "body", "description": "

    Default permission level members have for organization repositories.

    ", "enum": [ "read", @@ -391370,101 +392051,82 @@ "admin", "none" ], - "default": "read", - "name": "default_repository_permission", - "in": "body", - "isRequired": false + "default": "read" }, { "type": "boolean", - "description": "

    Whether of non-admin organization members can create repositories. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

    ", - "default": true, "name": "members_can_create_repositories", "in": "body", - "isRequired": false + "description": "

    Whether of non-admin organization members can create repositories. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

    ", + "default": true }, { "type": "boolean", - "description": "

    Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_internal_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_private_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "string", + "name": "members_allowed_repository_creation_type", + "in": "body", "description": "

    Specifies which types of repositories non-admin organization members can create. private is only available to repositories that are part of an organization on GitHub Enterprise Cloud.\nNote: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See the parameter deprecation notice in the operation description for details.

    ", "enum": [ "all", "private", "none" - ], - "name": "members_allowed_repository_creation_type", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.

    ", - "default": true, "name": "members_can_create_pages", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.

    ", + "default": true }, { "type": "boolean", - "description": "

    Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.

    ", - "default": true, "name": "members_can_create_public_pages", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.

    ", + "default": true }, { "type": "boolean", - "description": "

    Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.

    ", - "default": true, "name": "members_can_create_private_pages", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.

    ", + "default": true }, { "type": "boolean", - "description": "

    Whether organization members can fork private organization repositories.

    ", - "default": false, "name": "members_can_fork_private_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can fork private organization repositories.

    " }, { "type": "boolean", - "description": "

    Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.

    ", - "default": false, "name": "web_commit_signoff_required", "in": "body", - "isRequired": false + "description": "

    Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.

    " }, { "type": "string", - "examples": [ - "\"http://github.blog\"" - ], "name": "blog", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -392986,14 +393648,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -393138,6 +393792,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -394334,7 +394996,7 @@ } ], "previews": [], - "descriptionHTML": "

    List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.

    \n

    For more information on custom repository roles, see \"Managing custom repository roles for an organization\".

    ", + "descriptionHTML": "

    List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.

    \n

    To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with admin:org repo scope.\nGitHub Apps must have the organization_custom_roles:read organization permission to use this endpoint.

    \n

    For more information on custom repository roles, see \"Managing custom repository roles for an organization\".

    ", "statusCodes": [ { "httpStatusCode": "200", @@ -395029,37 +395691,33 @@ "bodyParameters": [ { "type": "integer", - "description": "

    Required unless you provide email. GitHub user ID for the person you are inviting.

    ", "name": "invitee_id", "in": "body", - "isRequired": false + "description": "

    Required unless you provide email. GitHub user ID for the person you are inviting.

    " }, { "type": "string", - "description": "

    Required unless you provide invitee_id. Email address of the person you are inviting, which can be an existing GitHub user.

    ", "name": "email", "in": "body", - "isRequired": false + "description": "

    Required unless you provide invitee_id. Email address of the person you are inviting, which can be an existing GitHub user.

    " }, { "type": "string", + "name": "role", + "in": "body", "description": "

    The role for the new member.\n* admin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams.
    \n* direct_member - Non-owner organization members with ability to see other members and join teams by invitation.
    \n* billing_manager - Non-owner organization members with ability to manage the billing settings of your organization.

    ", "enum": [ "admin", "direct_member", "billing_manager" ], - "default": "direct_member", - "name": "role", - "in": "body", - "isRequired": false + "default": "direct_member" }, { "type": "array of integers", - "description": "

    Specify IDs for the teams you want to invite new members to.

    ", "name": "team_ids", "in": "body", - "isRequired": false + "description": "

    Specify IDs for the teams you want to invite new members to.

    " } ], "enabledForGitHubApps": true, @@ -396596,15 +397254,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role to give the user in the organization. Can be one of:
    \n* admin - The user will become an owner of the organization.
    \n* member - The user will become a non-owner member of the organization.

    ", "enum": [ "admin", "member" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -398444,13 +399101,13 @@ "bodyParameters": [ { "type": "string", - "description": "

    The state that the membership should be in. Only \"active\" will be accepted.

    ", - "enum": [ - "active" - ], "name": "state", "in": "body", - "isRequired": true + "description": "

    The state that the membership should be in. Only \"active\" will be accepted.

    ", + "isRequired": true, + "enum": [ + "active" + ] } ], "enabledForGitHubApps": false, @@ -399162,11 +399819,9 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

    ", - "default": false, "name": "async", "in": "body", - "isRequired": false + "description": "

    When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

    " } ], "enabledForGitHubApps": true, @@ -399809,203 +400464,66 @@ "bodyParameters": [ { "type": "string", - "description": "

    Must be passed as \"web\".

    ", "name": "name", "in": "body", + "description": "

    Must be passed as \"web\".

    ", "isRequired": true }, { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - }, - "username": { - "type": "string", - "examples": [ - "\"kdaigle\"" - ], - "name": "username", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "password": { - "type": "string", - "examples": [ - "\"password\"" - ], - "name": "password", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"kdaigle\"" - ], - "name": "username", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"password\"" - ], - "name": "password", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "username", + "description": "" + }, + { + "type": "string", + "name": "password", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, @@ -400412,162 +400930,54 @@ "bodyParameters": [ { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true }, { "type": "string", - "examples": [ - "\"web\"" - ], "name": "name", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -400939,53 +401349,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": true, @@ -420218,77 +420602,35 @@ "bodyParameters": [ { "type": "string", + "name": "build_type", + "in": "body", "description": "

    The process in which the Page will be built. Possible values are \"legacy\" and \"workflow\".

    ", "enum": [ "legacy", "workflow" - ], - "name": "build_type", - "in": "body", - "isRequired": false + ] }, { "type": "object", + "name": "source", + "in": "body", "description": "

    The source branch and directory used to publish your Pages site.

    ", - "properties": { - "branch": { + "childParamsGroups": [ + { "type": "string", - "description": "

    The repository branch used to publish your site's source files.

    ", "name": "branch", - "in": "body", - "rawType": "string", - "rawDescription": "The repository branch used to publish your site's source files.", - "isRequired": true, - "childParamsGroups": [] + "description": "

    The repository branch used to publish your site's source files.

    ", + "isRequired": true }, - "path": { + { "type": "string", + "name": "path", "description": "

    The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: /

    ", "enum": [ "/", "/docs" ], - "default": "/", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "branch" - ], - "name": "source", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "source", - "parentType": "object", - "id": "source-object", - "params": [ - { - "type": "string", - "description": "

    The repository branch used to publish your site's source files.

    ", - "name": "branch", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: /

    ", - "enum": [ - "/", - "/docs" - ], - "default": "/", - "name": "path", - "in": "body", - "isRequired": false - } - ] + "default": "/" } ] } @@ -420572,75 +420914,37 @@ "bodyParameters": [ { "type": "string or null", - "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    ", "name": "cname", "in": "body", - "isRequired": false + "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    " }, { "type": "boolean", - "description": "

    Specify whether HTTPS should be enforced for the repository.

    ", "name": "https_enforced", "in": "body", - "isRequired": false + "description": "

    Specify whether HTTPS should be enforced for the repository.

    " }, { "type": "boolean", - "description": "

    Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

    ", "name": "public", "in": "body", - "isRequired": false + "description": "

    Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

    " }, { "type": "string", + "name": "build_type", + "in": "body", "description": "

    The process by which the GitHub Pages site will be built. workflow means that the site is built by a custom GitHub Actions workflow. legacy means that the site is built by GitHub when changes are pushed to a specific branch.

    ", "enum": [ "legacy", "workflow" - ], - "name": "build_type", - "in": "body", - "isRequired": false + ] }, { - "anyOf": [ - { - "type": "string", - "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", - "enum": [ - "gh-pages", - "master", - "master /docs" - ] - }, - { - "type": "object", - "description": "Update the source for the repository. Must include the branch name and path.", - "properties": { - "branch": { - "type": "string", - "description": "The repository branch used to publish your site's source files." - }, - "path": { - "type": "string", - "description": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.", - "enum": [ - "/", - "/docs" - ] - } - }, - "required": [ - "branch", - "path" - ] - } - ], + "type": "", "name": "source", "in": "body", - "type": "", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -421817,32 +422121,31 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository.

    ", "name": "artifact_url", "in": "body", + "description": "

    The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    The target environment for this GitHub Pages deployment.

    ", - "default": "github-pages", "name": "environment", "in": "body", - "isRequired": false + "description": "

    The target environment for this GitHub Pages deployment.

    ", + "default": "github-pages" }, { "type": "string", - "description": "

    A unique string that represents the version of the build for this deployment.

    ", - "default": "GITHUB_SHA", "name": "pages_build_version", "in": "body", - "isRequired": true + "description": "

    A unique string that represents the version of the build for this deployment.

    ", + "isRequired": true, + "default": "GITHUB_SHA" }, { "type": "string", - "description": "

    The OIDC token issued by GitHub Actions certifying the origin of the deployment.

    ", "name": "oidc_token", "in": "body", + "description": "

    The OIDC token issued by GitHub Actions certifying the origin of the deployment.

    ", "isRequired": true } ], @@ -422798,17 +423101,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the project.

    ", "name": "name", "in": "body", + "description": "

    The name of the project.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the project.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The description of the project.

    " } ], "enabledForGitHubApps": true, @@ -423585,54 +423887,40 @@ ], "bodyParameters": [ { - "description": "

    Name of the project

    ", "type": "string", - "examples": [ - "Week One Sprint" - ], "name": "name", "in": "body", - "isRequired": false + "description": "

    Name of the project

    " }, { - "description": "

    Body of the project

    ", "type": "string or null", - "examples": [ - "This project represents the sprint of the first week in January" - ], "name": "body", "in": "body", - "isRequired": false + "description": "

    Body of the project

    " }, { - "description": "

    State of the project; either 'open' or 'closed'

    ", "type": "string", - "examples": [ - "open" - ], "name": "state", "in": "body", - "isRequired": false + "description": "

    State of the project; either 'open' or 'closed'

    " }, { - "description": "

    The baseline permission that all organization members have on this project

    ", "type": "string", + "name": "organization_permission", + "in": "body", + "description": "

    The baseline permission that all organization members have on this project

    ", "enum": [ "read", "write", "admin", "none" - ], - "name": "organization_permission", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether or not this project can be seen by everyone.

    ", "type": "boolean", "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether or not this project can be seen by everyone.

    " } ], "enabledForGitHubApps": true, @@ -424545,17 +424833,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the project.

    ", "name": "name", "in": "body", + "description": "

    The name of the project.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the project.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The description of the project.

    " } ], "enabledForGitHubApps": true, @@ -424943,24 +425230,17 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Name of the project

    ", "type": "string", - "examples": [ - "Week One Sprint" - ], "name": "name", "in": "body", + "description": "

    Name of the project

    ", "isRequired": true }, { - "description": "

    Body of the project

    ", "type": "string or null", - "examples": [ - "This project represents the sprint of the first week in January" - ], "name": "body", "in": "body", - "isRequired": false + "description": "

    Body of the project

    " } ], "enabledForGitHubApps": true, @@ -426120,24 +426400,16 @@ ], "bodyParameters": [ { - "description": "

    The project card's note

    ", "type": "string or null", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    The project card's note

    " }, { - "description": "

    Whether or not the card is archived

    ", "type": "boolean", - "examples": [ - false - ], "name": "archived", "in": "body", - "isRequired": false + "description": "

    Whether or not the card is archived

    " } ], "enabledForGitHubApps": true, @@ -426567,25 +426839,17 @@ ], "bodyParameters": [ { - "description": "

    The position of the card in a column. Can be one of: top, bottom, or after:<card_id> to place after the specified card.

    ", "type": "string", - "pattern": "^(?:top|bottom|after:\\d+)$", - "examples": [ - "bottom" - ], "name": "position", "in": "body", + "description": "

    The position of the card in a column. Can be one of: top, bottom, or after:<card_id> to place after the specified card.

    ", "isRequired": true }, { - "description": "

    The unique identifier of the column the card should be moved to

    ", "type": "integer", - "examples": [ - 42 - ], "name": "column_id", "in": "body", - "isRequired": false + "description": "

    The unique identifier of the column the card should be moved to

    " } ], "enabledForGitHubApps": true, @@ -427057,33 +427321,24 @@ ], "bodyParameters": [ { - "description": "

    The project card's note

    ", "type": "string or null", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", + "description": "

    The project card's note

    ", "isRequired": true }, { - "description": "

    The unique identifier of the content associated with the card

    ", "type": "integer", - "examples": [ - 42 - ], "name": "content_id", "in": "body", + "description": "

    The unique identifier of the content associated with the card

    ", "isRequired": true }, { - "description": "

    The piece of content associated with the card

    ", "type": "string", - "examples": [ - "PullRequest" - ], "name": "content_type", "in": "body", + "description": "

    The piece of content associated with the card

    ", "isRequired": true } ], @@ -427749,20 +428004,16 @@ ], "bodyParameters": [ { + "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant the collaborator.

    ", "enum": [ "read", "write", "admin" ], - "default": "write", - "type": "string", - "examples": [ - "write" - ], - "name": "permission", - "in": "body", - "isRequired": false + "default": "write" } ], "enabledForGitHubApps": true, @@ -428338,13 +428589,10 @@ ], "bodyParameters": [ { - "description": "

    Name of the project column

    ", "type": "string", - "examples": [ - "Remaining tasks" - ], "name": "name", "in": "body", + "description": "

    Name of the project column

    ", "isRequired": true } ], @@ -428550,14 +428798,10 @@ ], "bodyParameters": [ { - "description": "

    The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

    ", "type": "string", - "pattern": "^(?:first|last|after:\\d+)$", - "examples": [ - "last" - ], "name": "position", "in": "body", + "description": "

    The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

    ", "isRequired": true } ], @@ -428797,13 +429041,10 @@ ], "bodyParameters": [ { - "description": "

    Name of the project column

    ", "type": "string", - "examples": [ - "Remaining tasks" - ], "name": "name", "in": "body", + "description": "

    Name of the project column

    ", "isRequired": true } ], @@ -434697,55 +434938,47 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the new pull request. Required unless issue is specified.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the new pull request. Required unless issue is specified.

    " }, { "type": "string", - "description": "

    The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

    ", "name": "head", "in": "body", + "description": "

    The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

    ", "isRequired": true }, { "type": "string", - "description": "

    The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

    ", "name": "base", "in": "body", + "description": "

    The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    The contents of the pull request.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the pull request.

    " }, { "type": "boolean", - "description": "

    Indicates whether maintainers can modify the pull request.

    ", "name": "maintainer_can_modify", "in": "body", - "isRequired": false + "description": "

    Indicates whether maintainers can modify the pull request.

    " }, { "type": "boolean", - "description": "

    Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

    ", "name": "draft", "in": "body", - "isRequired": false + "description": "

    Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

    " }, { "type": "integer", - "description": "

    An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified.

    ", - "examples": [ - 1 - ], "name": "issue", "in": "body", - "isRequired": false + "description": "

    An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified.

    " } ], "enabledForGitHubApps": true, @@ -442394,42 +442627,37 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the pull request.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the pull request.

    " }, { "type": "string", - "description": "

    The contents of the pull request.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the pull request.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    State of this Pull Request. Either open or closed.

    ", "enum": [ "open", "closed" - ], - "name": "state", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "description": "

    The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

    ", "name": "base", "in": "body", - "isRequired": false + "description": "

    The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

    " }, { "type": "boolean", - "description": "

    Indicates whether maintainers can modify the pull request.

    ", "name": "maintainer_can_modify", "in": "body", - "isRequired": false + "description": "

    Indicates whether maintainers can modify the pull request.

    " } ], "enabledForGitHubApps": true, @@ -447379,36 +447607,32 @@ "bodyParameters": [ { "type": "string", - "description": "

    Title for the automatic commit message.

    ", "name": "commit_title", "in": "body", - "isRequired": false + "description": "

    Title for the automatic commit message.

    " }, { "type": "string", - "description": "

    Extra detail to append to automatic commit message.

    ", "name": "commit_message", "in": "body", - "isRequired": false + "description": "

    Extra detail to append to automatic commit message.

    " }, { "type": "string", - "description": "

    SHA that pull request head must match to allow merge.

    ", "name": "sha", "in": "body", - "isRequired": false + "description": "

    SHA that pull request head must match to allow merge.

    " }, { "type": "string", + "name": "merge_method", + "in": "body", "description": "

    Merge method to use. Possible values are merge, squash or rebase. Default is merge.

    ", "enum": [ "merge", "squash", "rebase" - ], - "name": "merge_method", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -447526,10 +447750,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

    ", "name": "expected_head_sha", "in": "body", - "isRequired": false + "description": "

    The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

    " } ], "enabledForGitHubApps": false, @@ -448918,9 +449141,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the reply to the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the reply to the review comment.

    ", "isRequired": true } ], @@ -450293,82 +450516,70 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the review comment.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

    ", "name": "commit_id", "in": "body", + "description": "

    The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

    ", "isRequired": true }, { "type": "string", - "description": "

    The relative path to the file that necessitates a comment.

    ", "name": "path", "in": "body", + "description": "

    The relative path to the file that necessitates a comment.

    ", "isRequired": true }, { "type": "integer", - "description": "

    This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    ", - "deprecated": true, - "x-github": { - "deprecationDate": "2022-11-01" - }, "name": "position", "in": "body", - "isRequired": false + "description": "

    This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    " }, { "type": "string", + "name": "side", + "in": "body", "description": "

    In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

    ", "enum": [ "LEFT", "RIGHT" - ], - "name": "side", - "in": "body", - "isRequired": false + ] }, { "type": "integer", - "description": "

    The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

    ", "name": "line", "in": "body", + "description": "

    The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

    ", "isRequired": true }, { "type": "integer", - "description": "

    Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

    ", "name": "start_line", "in": "body", - "isRequired": false + "description": "

    Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

    " }, { "type": "string", + "name": "start_side", + "in": "body", "description": "

    Required when using multi-line comments unless using in_reply_to. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

    ", "enum": [ "LEFT", "RIGHT", "side" - ], - "name": "start_side", - "in": "body", - "isRequired": false + ] }, { "type": "integer", - "description": "

    The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

    ", - "examples": [ - 2 - ], "name": "in_reply_to", "in": "body", - "isRequired": false + "description": "

    The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

    " } ], "enabledForGitHubApps": true, @@ -451017,9 +451228,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the review comment.

    ", "isRequired": true } ], @@ -452137,17 +452348,15 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of user logins that will be requested.

    ", "name": "reviewers", "in": "body", - "isRequired": false + "description": "

    An array of user logins that will be requested.

    " }, { "type": "array of strings", - "description": "

    An array of team slugs that will be requested.

    ", "name": "team_reviewers", "in": "body", - "isRequired": false + "description": "

    An array of team slugs that will be requested.

    " } ], "enabledForGitHubApps": true, @@ -457856,17 +458065,16 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of user logins that will be removed.

    ", "name": "reviewers", "in": "body", + "description": "

    An array of user logins that will be removed.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    An array of team slugs that will be removed.

    ", "name": "team_reviewers", "in": "body", - "isRequired": false + "description": "

    An array of team slugs that will be removed.

    " } ], "enabledForGitHubApps": true, @@ -463954,104 +464162,69 @@ "bodyParameters": [ { "type": "string", - "description": "

    The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

    ", "name": "commit_id", "in": "body", - "isRequired": false + "description": "

    The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

    " }, { "type": "string", - "description": "

    Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

    " }, { "type": "string", + "name": "event", + "in": "body", "description": "

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

    ", "enum": [ "APPROVE", "REQUEST_CHANGES", "COMMENT" - ], - "name": "event", - "in": "body", - "isRequired": false + ] }, { "type": "array of objects", - "description": "

    Use the following table to specify the location, destination, and contents of the draft review comment.

    ", "name": "comments", "in": "body", - "isRequired": false, + "description": "

    Use the following table to specify the location, destination, and contents of the draft review comment.

    ", "childParamsGroups": [ { - "parentName": "comments", - "parentType": "items", - "id": "comments-items", - "params": [ - { - "type": "string", - "description": "

    The relative path to the file that necessitates a review comment.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

    ", - "name": "position", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Text of the review comment.

    ", - "name": "body", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "examples": [ - 28 - ], - "name": "line", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "RIGHT" - ], - "name": "side", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "integer", - "examples": [ - 26 - ], - "name": "start_line", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "LEFT" - ], - "name": "start_side", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "path", + "description": "

    The relative path to the file that necessitates a review comment.

    ", + "isRequired": true + }, + { + "type": "integer", + "name": "position", + "description": "

    The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

    " + }, + { + "type": "string", + "name": "body", + "description": "

    Text of the review comment.

    ", + "isRequired": true + }, + { + "type": "integer", + "name": "line", + "description": "" + }, + { + "type": "string", + "name": "side", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + }, + { + "type": "string", + "name": "start_side", + "description": "" } ] } @@ -464898,9 +465071,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The body text of the pull request review.

    ", "name": "body", "in": "body", + "description": "

    The body text of the pull request review.

    ", "isRequired": true } ], @@ -466371,23 +466544,19 @@ "bodyParameters": [ { "type": "string", - "description": "

    The message for the pull request review dismissal

    ", "name": "message", "in": "body", + "description": "

    The message for the pull request review dismissal

    ", "isRequired": true }, { "type": "string", - "enum": [ - "DISMISS" - ], - "examples": [ - "\"DISMISS\"" - ], "name": "event", "in": "body", "description": "", - "isRequired": false + "enum": [ + "DISMISS" + ] } ], "enabledForGitHubApps": true, @@ -466813,22 +466982,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The body text of the pull request review

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The body text of the pull request review

    " }, { "type": "string", + "name": "event", + "in": "body", "description": "

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.

    ", + "isRequired": true, "enum": [ "APPROVE", "REQUEST_CHANGES", "COMMENT" - ], - "name": "event", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -467968,7 +468136,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -467978,10 +468149,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -469008,7 +469176,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -469018,10 +469189,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -470040,7 +470208,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the commit comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -470050,10 +470221,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -471076,7 +471244,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the issue comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -471086,10 +471257,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -472116,7 +472284,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the issue.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -472126,10 +472297,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -473152,7 +473320,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the pull request review comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -473162,10 +473333,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -474186,7 +474354,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the release.

    ", + "isRequired": true, "enum": [ "+1", "laugh", @@ -474194,10 +474365,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -475216,7 +475384,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -475226,10 +475397,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -475881,7 +476049,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -475891,10 +476062,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -476946,62 +477114,52 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the tag.

    ", "name": "tag_name", "in": "body", + "description": "

    The name of the tag.

    ", "isRequired": true }, { "type": "string", - "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    ", "name": "target_commitish", "in": "body", - "isRequired": false + "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    " }, { "type": "string", - "description": "

    The name of the release.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the release.

    " }, { "type": "string", - "description": "

    Text describing the contents of the tag.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Text describing the contents of the tag.

    " }, { "type": "boolean", - "description": "

    true to create a draft (unpublished) release, false to create a published one.

    ", - "default": false, "name": "draft", "in": "body", - "isRequired": false + "description": "

    true to create a draft (unpublished) release, false to create a published one.

    " }, { "type": "boolean", - "description": "

    true to identify the release as a prerelease. false to identify the release as a full release.

    ", - "default": false, "name": "prerelease", "in": "body", - "isRequired": false + "description": "

    true to identify the release as a prerelease. false to identify the release as a full release.

    " }, { "type": "string", - "description": "

    If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"Managing categories for discussions in your repository.\"

    ", "name": "discussion_category_name", "in": "body", - "isRequired": false + "description": "

    If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"Managing categories for discussions in your repository.\"

    " }, { "type": "boolean", - "description": "

    Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes.

    ", - "default": false, "name": "generate_release_notes", "in": "body", - "isRequired": false + "description": "

    Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes.

    " } ], "enabledForGitHubApps": true, @@ -477736,31 +477894,28 @@ "bodyParameters": [ { "type": "string", - "description": "

    The tag name for the release. This can be an existing tag or a new one.

    ", "name": "tag_name", "in": "body", + "description": "

    The tag name for the release. This can be an existing tag or a new one.

    ", "isRequired": true }, { "type": "string", - "description": "

    Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.

    ", "name": "target_commitish", "in": "body", - "isRequired": false + "description": "

    Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.

    " }, { "type": "string", - "description": "

    The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.

    ", "name": "previous_tag_name", "in": "body", - "isRequired": false + "description": "

    The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.

    " }, { "type": "string", - "description": "

    Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.

    ", "name": "configuration_file_path", "in": "body", - "isRequired": false + "description": "

    Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.

    " } ], "enabledForGitHubApps": true, @@ -480032,52 +480187,45 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the tag.

    ", "name": "tag_name", "in": "body", - "isRequired": false + "description": "

    The name of the tag.

    " }, { "type": "string", - "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    ", "name": "target_commitish", "in": "body", - "isRequired": false + "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    " }, { "type": "string", - "description": "

    The name of the release.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the release.

    " }, { "type": "string", - "description": "

    Text describing the contents of the tag.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Text describing the contents of the tag.

    " }, { "type": "boolean", - "description": "

    true makes the release a draft, and false publishes the release.

    ", "name": "draft", "in": "body", - "isRequired": false + "description": "

    true makes the release a draft, and false publishes the release.

    " }, { "type": "boolean", - "description": "

    true to identify the release as a prerelease, false to identify the release as a full release.

    ", "name": "prerelease", "in": "body", - "isRequired": false + "description": "

    true to identify the release as a prerelease, false to identify the release as a full release.

    " }, { "type": "string", - "description": "

    If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see \"Managing categories for discussions in your repository.\"

    ", "name": "discussion_category_name", "in": "body", - "isRequired": false + "description": "

    If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see \"Managing categories for discussions in your repository.\"

    " } ], "enabledForGitHubApps": true, @@ -481234,27 +481382,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The file name of the asset.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The file name of the asset.

    " }, { "type": "string", - "description": "

    An alternate short description of the asset. Used in place of the filename.

    ", "name": "label", "in": "body", - "isRequired": false + "description": "

    An alternate short description of the asset. Used in place of the filename.

    " }, { "type": "string", - "examples": [ - "\"uploaded\"" - ], "name": "state", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -484809,199 +484951,171 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the repository.

    ", "name": "name", "in": "body", + "description": "

    The name of the repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short description of the repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { "type": "string", - "description": "

    A URL with more information about the repository.

    ", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { "type": "boolean", - "description": "

    Whether the repository is private.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether the repository is private.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.

    ", "enum": [ "public", "private", "internal" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Either true to enable issues for this repository or false to disable them.

    ", - "default": true, "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Either true to enable issues for this repository or false to disable them.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", - "default": true, "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", - "default": true, "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    ", - "default": false, "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    " }, { "type": "integer", - "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    ", "name": "team_id", "in": "body", - "isRequired": false + "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    " }, { "type": "boolean", - "description": "

    Pass true to create an initial commit with empty README.

    ", - "default": false, "name": "auto_init", "in": "body", - "isRequired": false + "description": "

    Pass true to create an initial commit with empty README.

    " }, { "type": "string", - "description": "

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

    ", "name": "gitignore_template", "in": "body", - "isRequired": false + "description": "

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

    " }, { "type": "string", - "description": "

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

    ", "name": "license_template", "in": "body", - "isRequired": false + "description": "

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", - "default": true, "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", - "default": true, "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", - "default": true, "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    ", - "default": false, "name": "allow_auto_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    " }, { "type": "boolean", - "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    ", - "default": false, "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    ", - "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -492775,295 +492889,78 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the repository.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the repository.

    " }, { "type": "string", - "description": "

    A short description of the repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { "type": "string", - "description": "

    A URL with more information about the repository.

    ", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { "type": "boolean", - "description": "

    Either true to make the repository private or false to make it public. Default: false.
    \nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Either true to make the repository private or false to make it public. Default: false.
    \nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal.\"

    ", "enum": [ "public", "private", "internal" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { "type": "object or null", - "description": "

    Specify which security and analysis features to enable or disable for the repository.

    \n

    To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

    \n

    For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.

    \n

    You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

    ", - "properties": { - "advanced_security": { - "type": "object", - "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "advanced_security", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", - "childParamsGroups": [ - { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - "secret_scanning": { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", - "childParamsGroups": [ - { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - "secret_scanning_push_protection": { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning_push_protection", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", - "childParamsGroups": [ - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - } - }, "name": "security_and_analysis", "in": "body", - "isRequired": false, + "description": "

    Specify which security and analysis features to enable or disable for the repository.

    \n

    To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

    \n

    For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.

    \n

    You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

    ", "childParamsGroups": [ { - "parentName": "security_and_analysis", - "parentType": "object", - "id": "security_and_analysis-object", - "params": [ + "type": "object", + "name": "advanced_security", + "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", + "childParamsGroups": [ { - "type": "object", - "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "advanced_security", - "in": "body", - "childParamsGroups": [ - { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning", - "in": "body", - "childParamsGroups": [ - { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning_push_protection", - "in": "body", - "childParamsGroups": [ - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] + "type": "string", + "name": "status", + "description": "

    Can be enabled or disabled.

    " } ] }, { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ + "type": "object", + "name": "secret_scanning", + "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    Can be enabled or disabled.

    ", "name": "status", - "in": "body" + "description": "

    Can be enabled or disabled.

    " } ] }, { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ + "type": "object", + "name": "secret_scanning_push_protection", + "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    Can be enabled or disabled.

    ", "name": "status", - "in": "body" - } - ] - }, - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" + "description": "

    Can be enabled or disabled.

    " } ] } @@ -493071,168 +492968,141 @@ }, { "type": "boolean", - "description": "

    Either true to enable issues for this repository or false to disable them.

    ", - "default": true, "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Either true to enable issues for this repository or false to disable them.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", - "default": true, "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", - "default": true, "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    ", - "default": false, "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    " }, { "type": "string", - "description": "

    Updates the default branch for this repository.

    ", "name": "default_branch", "in": "body", - "isRequired": false + "description": "

    Updates the default branch for this repository.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", - "default": true, "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", - "default": true, "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", - "default": true, "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    ", - "default": false, "name": "allow_auto_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    " }, { "type": "boolean", - "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    ", - "default": false, "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    " }, { "type": "boolean", - "description": "

    Either true to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.

    ", - "default": false, "name": "allow_update_branch", "in": "body", - "isRequired": false + "description": "

    Either true to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    ", - "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    true to archive this repository. Note: You cannot unarchive repositories through the API.

    ", - "default": false, "name": "archived", "in": "body", - "isRequired": false + "description": "

    true to archive this repository. Note: You cannot unarchive repositories through the API.

    " }, { "type": "boolean", - "description": "

    Either true to allow private forks, or false to prevent private forks.

    ", - "default": false, "name": "allow_forking", "in": "body", - "isRequired": false + "description": "

    Either true to allow private forks, or false to prevent private forks.

    " }, { "type": "boolean", - "description": "

    Either true to require contributors to sign off on web-based commits, or false to not require contributors to sign off on web-based commits.

    ", - "default": false, "name": "web_commit_signoff_required", "in": "body", - "isRequired": false + "description": "

    Either true to require contributors to sign off on web-based commits, or false to not require contributors to sign off on web-based commits.

    " } ], "enabledForGitHubApps": true, @@ -499922,21 +499792,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    A custom webhook event name. Must be 100 characters or fewer.

    ", - "minLength": 1, - "maxLength": 100, "name": "event_type", "in": "body", + "description": "

    A custom webhook event name. Must be 100 characters or fewer.

    ", "isRequired": true }, { "type": "object", - "description": "

    JSON payload with extra information about the webhook event that your action or workflow may use.

    ", - "additionalProperties": true, - "maxProperties": 10, "name": "client_payload", "in": "body", - "isRequired": false + "description": "

    JSON payload with extra information about the webhook event that your action or workflow may use.

    " } ], "enabledForGitHubApps": true, @@ -500613,9 +500478,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

    ", "name": "names", "in": "body", + "description": "

    An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

    ", "isRequired": true } ], @@ -500718,17 +500583,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The username or organization name the repository will be transferred to.

    ", "name": "new_owner", "in": "body", + "description": "

    The username or organization name the repository will be transferred to.

    ", "isRequired": true }, { "type": "array of integers", - "description": "

    ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

    ", "name": "team_ids", "in": "body", - "isRequired": false + "description": "

    ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

    " } ], "enabledForGitHubApps": true, @@ -503396,40 +503260,34 @@ "bodyParameters": [ { "type": "string", - "description": "

    The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

    ", "name": "owner", "in": "body", - "isRequired": false + "description": "

    The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

    " }, { "type": "string", - "description": "

    The name of the new repository.

    ", "name": "name", "in": "body", + "description": "

    The name of the new repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short description of the new repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the new repository.

    " }, { "type": "boolean", - "description": "

    Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.

    ", - "default": false, "name": "include_all_branches", "in": "body", - "isRequired": false + "description": "

    Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.

    " }, { "type": "boolean", - "description": "

    Either true to create a new private repository or false to create a new public one.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Either true to create a new private repository or false to create a new public one.

    " } ], "enabledForGitHubApps": false, @@ -509120,227 +508978,162 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The name of the repository.

    ", "type": "string", - "examples": [ - "Team Environment" - ], "name": "name", "in": "body", + "description": "

    The name of the repository.

    ", "isRequired": true }, { - "description": "

    A short description of the repository.

    ", "type": "string", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { - "description": "

    A URL with more information about the repository.

    ", "type": "string", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { - "description": "

    Whether the repository is private.

    ", - "default": false, "type": "boolean", "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether the repository is private.

    " }, { - "description": "

    Whether issues are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Whether issues are enabled.

    ", + "default": true }, { - "description": "

    Whether projects are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Whether projects are enabled.

    ", + "default": true }, { - "description": "

    Whether the wiki is enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Whether the wiki is enabled.

    ", + "default": true }, { - "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    ", "type": "integer", "name": "team_id", "in": "body", - "isRequired": false + "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    " }, { - "description": "

    Whether the repository is initialized with a minimal README.

    ", - "default": false, "type": "boolean", "name": "auto_init", "in": "body", - "isRequired": false + "description": "

    Whether the repository is initialized with a minimal README.

    " }, { - "description": "

    The desired language or platform to apply to the .gitignore.

    ", "type": "string", - "examples": [ - "Haskell" - ], "name": "gitignore_template", "in": "body", - "isRequired": false + "description": "

    The desired language or platform to apply to the .gitignore.

    " }, { - "description": "

    The license keyword of the open source license for this repository.

    ", "type": "string", - "examples": [ - "mit" - ], "name": "license_template", "in": "body", - "isRequired": false + "description": "

    The license keyword of the open source license for this repository.

    " }, { - "description": "

    Whether to allow squash merges for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Whether to allow squash merges for pull requests.

    ", + "default": true }, { - "description": "

    Whether to allow merge commits for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Whether to allow merge commits for pull requests.

    ", + "default": true }, { - "description": "

    Whether to allow rebase merges for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Whether to allow rebase merges for pull requests.

    ", + "default": true }, { - "description": "

    Whether to allow Auto-merge to be used on pull requests.

    ", - "default": false, "type": "boolean", - "examples": [ - false - ], "name": "allow_auto_merge", "in": "body", - "isRequired": false + "description": "

    Whether to allow Auto-merge to be used on pull requests.

    " }, { - "description": "

    Whether to delete head branches when pull requests are merged

    ", - "default": false, "type": "boolean", - "examples": [ - false - ], "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Whether to delete head branches when pull requests are merged

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether downloads are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_downloads", "in": "body", - "isRequired": false + "description": "

    Whether downloads are enabled.

    ", + "default": true }, { - "description": "

    Whether this repository acts as a template that can be used to generate new repositories.

    ", - "default": false, "type": "boolean", - "examples": [ - true - ], "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Whether this repository acts as a template that can be used to generate new repositories.

    " } ], "enabledForGitHubApps": false, @@ -513537,16 +513330,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The prefix appended by alphanumeric characters will generate a link any time it is found in an issue, pull request, or commit.

    ", "name": "key_prefix", "in": "body", + "description": "

    The prefix appended by alphanumeric characters will generate a link any time it is found in an issue, pull request, or commit.

    ", "isRequired": true }, { "type": "string", - "description": "

    The URL must contain <num> for the reference number. <num> matches alphanumeric characters A-Z (case insensitive), 0-9, and -.

    ", "name": "url_template", "in": "body", + "description": "

    The URL must contain <num> for the reference number. <num> matches alphanumeric characters A-Z (case insensitive), 0-9, and -.

    ", "isRequired": true } ], @@ -515625,7 +515418,7 @@ } ], "previews": [], - "descriptionHTML": "

    Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

    \n

    Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

    \n

    Note:

    \n
      \n
    • To get a repository's contents recursively, you can recursively get the tree.
      • \n
    • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
      • \n
    \n

    Size limits

    \n

    If the requested file's size is:

    \n
      \n
    • 1 MB or smaller: All features of this endpoint are supported.
      • \n
    • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
      • \n
    • Greater than 100 MB: This endpoint is not supported.
      • \n
    \n

    If the content is a directory

    \n

    The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

    \n

    If the content is a symlink

    \n

    If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

    \n

    If the content is a submodule

    \n

    The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

    \n

    If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

    ", + "descriptionHTML": "

    Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

    \n

    Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

    \n

    Notes:

    \n
      \n
    • To get a repository's contents recursively, you can recursively get the tree.
      • \n
    • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
      • \n
    • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
      • \n
    \n

    Size limits

    \n

    If the requested file's size is:

    \n
      \n
    • 1 MB or smaller: All features of this endpoint are supported.
      • \n
    • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
      • \n
    • Greater than 100 MB: This endpoint is not supported.
      • \n
    \n

    If the content is a directory

    \n

    The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

    \n

    If the content is a symlink

    \n

    If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

    \n

    If the content is a submodule

    \n

    The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

    \n

    If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

    ", "statusCodes": [ { "httpStatusCode": "200", @@ -515685,185 +515478,77 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message.

    ", "name": "message", "in": "body", + "description": "

    The commit message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The new file content, using Base64 encoding.

    ", "name": "content", "in": "body", + "description": "

    The new file content, using Base64 encoding.

    ", "isRequired": true }, { "type": "string", - "description": "

    Required if you are updating a file. The blob SHA of the file being replaced.

    ", "name": "sha", "in": "body", - "isRequired": false + "description": "

    Required if you are updating a file. The blob SHA of the file being replaced.

    " }, { "type": "string", - "description": "

    The branch name. Default: the repository’s default branch (usually master)

    ", "name": "branch", "in": "body", - "isRequired": false + "description": "

    The branch name. Default: the repository’s default branch (usually master)

    " }, { "type": "object", - "description": "

    The person that committed the file. Default: the authenticated user.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "examples": [ - "\"2013-01-05T13:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "committer", "in": "body", - "isRequired": false, + "description": "

    The person that committed the file. Default: the authenticated user.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "examples": [ - "\"2013-01-05T13:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "" } ] }, { "type": "object", - "description": "

    The author of the file. Default: The committer or the authenticated user if you omit committer.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "examples": [ - "\"2013-01-15T17:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "author", "in": "body", - "isRequired": false, + "description": "

    The author of the file. Default: The committer or the authenticated user if you omit committer.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "examples": [ - "\"2013-01-15T17:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "" } ] } @@ -516411,118 +516096,57 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message.

    ", "name": "message", "in": "body", + "description": "

    The commit message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The blob SHA of the file being replaced.

    ", "name": "sha", "in": "body", + "description": "

    The blob SHA of the file being replaced.

    ", "isRequired": true }, { "type": "string", - "description": "

    The branch name. Default: the repository’s default branch (usually master)

    ", "name": "branch", "in": "body", - "isRequired": false + "description": "

    The branch name. Default: the repository’s default branch (usually master)

    " }, { "type": "object", - "description": "

    object containing information about the committer.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - } - }, "name": "committer", "in": "body", - "isRequired": false, + "description": "

    object containing information about the committer.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " } ] }, { "type": "object", - "description": "

    object containing information about the author.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - } - }, "name": "author", "in": "body", - "isRequired": false, + "description": "

    object containing information about the author.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " } ] } @@ -519769,17 +519393,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    Optional parameter to specify the organization name if forking into an organization.

    ", "name": "organization", "in": "body", - "isRequired": false + "description": "

    Optional parameter to specify the organization name if forking into an organization.

    " }, { "type": "string", - "description": "

    When forking from an existing repository, a new name for the fork.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    When forking from an existing repository, a new name for the fork.

    " + }, + { + "type": "boolean", + "name": "default_branch_only", + "in": "body", + "description": "

    When forking from an existing repository, fork with only the default branch.

    " } ], "enabledForGitHubApps": true, @@ -526140,9 +525768,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    An optional glob pattern to match against when enforcing tag protection.

    ", "name": "pattern", "in": "body", + "description": "

    An optional glob pattern to match against when enforcing tag protection.

    ", "isRequired": true } ], @@ -527082,144 +526710,66 @@ ], "bodyParameters": [ { - "description": "

    Configured by the admin. Could be an email, login, or username

    ", "type": "string", - "examples": [ - "someone@example.com" - ], "name": "userName", "in": "body", + "description": "

    Configured by the admin. Could be an email, login, or username

    ", "isRequired": true }, { - "description": "

    The name of the user, suitable for display to end-users

    ", "type": "string", - "examples": [ - "Jon Doe" - ], "name": "displayName", "in": "body", - "isRequired": false + "description": "

    The name of the user, suitable for display to end-users

    " }, { "type": "object", - "properties": { - "givenName": { - "type": "string", - "name": "givenName", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": true, - "childParamsGroups": [] - }, - "familyName": { - "type": "string", - "name": "familyName", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": true, - "childParamsGroups": [] - }, - "formatted": { - "type": "string", - "name": "formatted", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "givenName", - "familyName" - ], - "example": { - "givenName": "Jane", - "familyName": "User" - }, "name": "name", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { - "parentName": "name", - "parentType": "object", - "id": "name-object", - "params": [ - { - "type": "string", - "name": "givenName", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "familyName", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "formatted", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "givenName", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "familyName", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "formatted", + "description": "" } ] }, { - "description": "

    user emails

    ", "type": "array of objects", - "minItems": 1, - "examples": [ - { - "value": "someone@example.com", - "primary": true - }, - { - "value": "another@example.com", - "primary": false - } - ], "name": "emails", "in": "body", + "description": "

    user emails

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "emails", - "parentType": "items", - "id": "emails-items", - "params": [ - { - "type": "string", - "name": "value", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "primary", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "name": "type", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "value", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "primary", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "" } ] }, @@ -527227,29 +526777,25 @@ "type": "array of strings", "name": "schemas", "in": "body", - "description": "", - "isRequired": false + "description": "" }, { "type": "string", "name": "externalId", "in": "body", - "description": "", - "isRequired": false + "description": "" }, { "type": "array of strings", "name": "groups", "in": "body", - "description": "", - "isRequired": false + "description": "" }, { "type": "boolean", "name": "active", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -527920,169 +527466,87 @@ "type": "array of strings", "name": "schemas", "in": "body", - "description": "", - "isRequired": false + "description": "" }, { - "description": "

    The name of the user, suitable for display to end-users

    ", "type": "string", - "examples": [ - "Jon Doe" - ], "name": "displayName", "in": "body", - "isRequired": false + "description": "

    The name of the user, suitable for display to end-users

    " }, { "type": "string", "name": "externalId", "in": "body", - "description": "", - "isRequired": false + "description": "" }, { "type": "array of strings", "name": "groups", "in": "body", - "description": "", - "isRequired": false + "description": "" }, { "type": "boolean", "name": "active", "in": "body", - "description": "", - "isRequired": false + "description": "" }, { - "description": "

    Configured by the admin. Could be an email, login, or username

    ", "type": "string", - "examples": [ - "someone@example.com" - ], "name": "userName", "in": "body", + "description": "

    Configured by the admin. Could be an email, login, or username

    ", "isRequired": true }, { "type": "object", - "properties": { - "givenName": { - "type": "string", - "name": "givenName", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": true, - "childParamsGroups": [] - }, - "familyName": { - "type": "string", - "name": "familyName", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": true, - "childParamsGroups": [] - }, - "formatted": { - "type": "string", - "name": "formatted", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "givenName", - "familyName" - ], - "example": { - "givenName": "Jane", - "familyName": "User" - }, "name": "name", "in": "body", "description": "", "isRequired": true, "childParamsGroups": [ { - "parentName": "name", - "parentType": "object", - "id": "name-object", - "params": [ - { - "type": "string", - "name": "givenName", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "familyName", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "formatted", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "givenName", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "familyName", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "formatted", + "description": "" } ] }, { - "description": "

    user emails

    ", "type": "array of objects", - "minItems": 1, - "examples": [ - { - "value": "someone@example.com", - "primary": true - }, - { - "value": "another@example.com", - "primary": false - } - ], "name": "emails", "in": "body", + "description": "

    user emails

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "emails", - "parentType": "items", - "id": "emails-items", - "params": [ - { - "type": "string", - "name": "type", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "name": "value", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "primary", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "type", + "description": "" + }, + { + "type": "string", + "name": "value", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "primary", + "description": "" } ] } @@ -528418,111 +527882,35 @@ "type": "array of strings", "name": "schemas", "in": "body", - "description": "", - "isRequired": false + "description": "" }, { - "description": "

    Set of operations to be performed

    ", "type": "array of objects", - "minItems": 1, - "examples": [ - { - "op": "replace", - "value": { - "active": false - } - } - ], "name": "Operations", "in": "body", + "description": "

    Set of operations to be performed

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "Operations", - "parentType": "items", - "id": "operations-items", - "params": [ - { - "type": "string", - "enum": [ - "add", - "remove", - "replace" - ], - "name": "op", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "in": "body", - "description": "", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "object", - "properties": { - "active": { - "type": [ - "boolean", - "null" - ] - }, - "userName": { - "type": [ - "string", - "null" - ] - }, - "externalId": { - "type": [ - "string", - "null" - ] - }, - "givenName": { - "type": [ - "string", - "null" - ] - }, - "familyName": { - "type": [ - "string", - "null" - ] - } - } - }, - { - "type": "array", - "items": { - "type": "object", - "properties": { - "value": { - "type": "string" - }, - "primary": { - "type": "boolean" - } - } - } - }, - { - "type": "string" - } - ], - "name": "value", - "in": "body", - "type": "object or array or string", - "description": "", - "isRequired": false - } + "type": "string", + "name": "op", + "description": "", + "isRequired": true, + "enum": [ + "add", + "remove", + "replace" ] + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "object or array or string", + "name": "value", + "description": "" } ] } @@ -534462,7 +533850,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] }, @@ -543190,18 +542579,20 @@ ], "bodyParameters": [ { - "description": "

    Sets the state of the secret scanning alert. Can be either open or resolved. You must provide resolution when you set the state to resolved.

    ", "type": "string", + "name": "state", + "in": "body", + "description": "

    Sets the state of the secret scanning alert. Can be either open or resolved. You must provide resolution when you set the state to resolved.

    ", + "isRequired": true, "enum": [ "open", "resolved" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", + "name": "resolution", + "in": "body", "description": "

    Required when the state is resolved. The reason for resolving the alert.

    ", "enum": [ null, @@ -543209,10 +542600,7 @@ "wont_fix", "revoked", "used_in_tests" - ], - "name": "resolution", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -544268,61 +543656,55 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", + "description": "

    The name of the team.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "array of strings", - "description": "

    List GitHub IDs for organization members who will become team maintainers.

    ", "name": "maintainers", "in": "body", - "isRequired": false + "description": "

    List GitHub IDs for organization members who will become team maintainers.

    " }, { "type": "array of strings", - "description": "

    The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

    ", "name": "repo_names", "in": "body", - "isRequired": false + "description": "

    The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nDefault: secret
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.
    \nDefault for child team: closed

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " } ], "enabledForGitHubApps": true, @@ -544619,8 +544001,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -545351,8 +544733,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -545793,48 +545175,43 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the team.

    " }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push", "admin" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer or null", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " } ], "enabledForGitHubApps": true, @@ -546131,8 +545508,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -547364,15 +546741,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"

    ", "enum": [ "read", "write", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -552593,11 +551969,10 @@ "bodyParameters": [ { "type": "string", - "description": "

    The permission to grant the team on this repository. We accept the following permissions to be set: pull, triage, push, maintain, admin and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", - "default": "push", "name": "permission", "in": "body", - "isRequired": false + "description": "

    The permission to grant the team on this repository. We accept the following permissions to be set: pull, triage, push, maintain, admin and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", + "default": "push" } ], "enabledForGitHubApps": true, @@ -553319,8 +552694,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -553752,48 +553127,44 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", + "description": "

    The name of the team.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push", "admin" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer or null", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " } ], "enabledForGitHubApps": true, @@ -554089,8 +553460,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -554778,8 +554149,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -556000,15 +555371,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"

    ", "enum": [ "read", "write", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -561206,15 +560576,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant the team on this repository. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", "enum": [ "pull", "push", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -561942,8 +561311,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -562866,9 +562235,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -563745,9 +563114,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -564699,9 +564068,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -565558,9 +564927,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -566556,25 +565925,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", + "description": "

    The discussion post's title.

    ", "isRequired": true }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion post's body text.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    " } ], "enabledForGitHubApps": true, @@ -567519,17 +566886,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The discussion post's title.

    " }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The discussion post's body text.

    " } ], "enabledForGitHubApps": true, @@ -568538,25 +567903,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", + "description": "

    The discussion post's title.

    ", "isRequired": true }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion post's body text.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    " } ], "enabledForGitHubApps": true, @@ -569481,17 +568844,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The discussion post's title.

    " }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The discussion post's body text.

    " } ], "enabledForGitHubApps": true, @@ -570491,12 +569852,9 @@ "bodyParameters": [ { "type": "integer", - "description": "

    External Group Id

    ", - "examples": [ - 1 - ], "name": "group_id", "in": "body", + "description": "

    External Group Id

    ", "isRequired": true } ], @@ -571509,15 +570867,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role that this user should have in the team.

    ", "enum": [ "member", "maintainer" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -572584,15 +571941,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role that this user should have in the team.

    ", "enum": [ "member", "maintainer" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -573060,38 +572416,27 @@ "bodyParameters": [ { "type": "array of objects", - "description": "

    The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.

    ", "name": "groups", "in": "body", - "isRequired": false, + "description": "

    The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.

    ", "childParamsGroups": [ { - "parentName": "groups", - "parentType": "items", - "id": "groups-items", - "params": [ - { - "type": "string", - "description": "

    ID of the IdP group.

    ", - "name": "group_id", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    Name of the IdP group.

    ", - "name": "group_name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    Description of the IdP group.

    ", - "name": "group_description", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "group_id", + "description": "

    ID of the IdP group.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "group_name", + "description": "

    Name of the IdP group.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "group_description", + "description": "

    Description of the IdP group.

    ", + "isRequired": true } ] } @@ -573379,80 +572724,51 @@ "bodyParameters": [ { "type": "array of objects", - "description": "

    The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.

    ", "name": "groups", "in": "body", + "description": "

    The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "groups", - "parentType": "items", - "id": "groups-items", - "params": [ - { - "type": "string", - "description": "

    ID of the IdP group.

    ", - "name": "group_id", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    Name of the IdP group.

    ", - "name": "group_name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    Description of the IdP group.

    ", - "name": "group_description", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "examples": [ - "\"caceab43fc9ffa20081c\"" - ], - "name": "id", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"external-team-6c13e7288ef7\"" - ], - "name": "name", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"moar cheese pleese\"" - ], - "name": "description", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "group_id", + "description": "

    ID of the IdP group.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "group_name", + "description": "

    Name of the IdP group.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "group_description", + "description": "

    Description of the IdP group.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "id", + "description": "" + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "description", + "description": "" } ] }, { "type": "string", - "examples": [ - "\"I am not a timestamp\"" - ], "name": "synced_at", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": false, @@ -574893,78 +574209,52 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The new name of the user.

    ", "type": "string", - "examples": [ - "Omar Jahandar" - ], "name": "name", "in": "body", - "isRequired": false + "description": "

    The new name of the user.

    " }, { - "description": "

    The publicly visible email address of the user.

    ", "type": "string", - "examples": [ - "omar@example.com" - ], "name": "email", "in": "body", - "isRequired": false + "description": "

    The publicly visible email address of the user.

    " }, { - "description": "

    The new blog URL of the user.

    ", "type": "string", - "examples": [ - "blog.example.com" - ], "name": "blog", "in": "body", - "isRequired": false + "description": "

    The new blog URL of the user.

    " }, { - "description": "

    The new Twitter username of the user.

    ", "type": "string or null", - "examples": [ - "therealomarj" - ], "name": "twitter_username", "in": "body", - "isRequired": false + "description": "

    The new Twitter username of the user.

    " }, { - "description": "

    The new company of the user.

    ", "type": "string", - "examples": [ - "Acme corporation" - ], "name": "company", "in": "body", - "isRequired": false + "description": "

    The new company of the user.

    " }, { - "description": "

    The new location of the user.

    ", "type": "string", - "examples": [ - "Berlin, Germany" - ], "name": "location", "in": "body", - "isRequired": false + "description": "

    The new location of the user.

    " }, { - "description": "

    The new hiring availability of the user.

    ", "type": "boolean", "name": "hireable", "in": "body", - "isRequired": false + "description": "

    The new hiring availability of the user.

    " }, { - "description": "

    The new short biography of the user.

    ", "type": "string", "name": "bio", "in": "body", - "isRequired": false + "description": "

    The new short biography of the user.

    " } ], "enabledForGitHubApps": false, @@ -577494,15 +576784,15 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Denotes whether an email is publicly visible.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Denotes whether an email is publicly visible.

    ", + "isRequired": true, "enum": [ "public", "private" - ], - "name": "visibility", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -577735,11 +577025,10 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", "type": "array of strings", - "examples": [], "name": "emails", "in": "body", + "description": "

    Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", "isRequired": true } ], @@ -577869,10 +577158,10 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Email addresses associated with the GitHub user account.

    ", "type": "array of strings", "name": "emails", "in": "body", + "description": "

    Email addresses associated with the GitHub user account.

    ", "isRequired": true } ], @@ -579608,17 +578897,16 @@ "parameters": [], "bodyParameters": [ { - "description": "

    A descriptive name for the new key.

    ", "type": "string", "name": "name", "in": "body", - "isRequired": false + "description": "

    A descriptive name for the new key.

    " }, { - "description": "

    A GPG key in ASCII-armored format.

    ", "type": "string", "name": "armored_public_key", "in": "body", + "description": "

    A GPG key in ASCII-armored format.

    ", "isRequired": true } ], @@ -580703,21 +579991,16 @@ "parameters": [], "bodyParameters": [ { - "description": "

    A descriptive name for the new key.

    ", "type": "string", - "examples": [ - "Personal MacBook Air" - ], "name": "title", "in": "body", - "isRequired": false + "description": "

    A descriptive name for the new key.

    " }, { - "description": "

    The public SSH key to add to your GitHub account.

    ", "type": "string", - "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ", "name": "key", "in": "body", + "description": "

    The public SSH key to add to your GitHub account.

    ", "isRequired": true } ], @@ -581231,53 +580514,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": true, @@ -582312,188 +581569,63 @@ "bodyParameters": [ { "type": "string", - "description": "

    Use web to create a webhook. Default: web. This parameter only accepts the value web.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    Use web to create a webhook. Default: web. This parameter only accepts the value web.

    " }, { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "childParamsGroups": [] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ], - "name": "token", - "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ], - "name": "digest", - "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] - } - }, "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body" - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body" - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body" - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " - }, - { - "type": "string", - "examples": [ - "\"abc\"" - ], - "name": "token", - "in": "body", - "description": "" - }, - { - "type": "string", - "examples": [ - "\"sha256\"" - ], - "name": "digest", - "in": "body", - "description": "" - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    " + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "token", + "description": "" + }, + { + "type": "string", + "name": "digest", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, @@ -583119,210 +582251,70 @@ "bodyParameters": [ { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - }, - "address": { - "type": "string", - "examples": [ - "\"bar@example.com\"" - ], - "name": "address", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "room": { - "type": "string", - "examples": [ - "\"The Serious Room\"" - ], - "name": "room", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"bar@example.com\"" - ], - "name": "address", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"The Serious Room\"" - ], - "name": "room", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "address", + "description": "" + }, + { + "type": "string", + "name": "room", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for. This replaces the entire array of events.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "array of strings", - "description": "

    Determines a list of events to be added to the list of events that the Hook triggers for.

    ", "name": "add_events", "in": "body", - "isRequired": false + "description": "

    Determines a list of events to be added to the list of events that the Hook triggers for.

    " }, { "type": "array of strings", - "description": "

    Determines a list of events to be removed from the list of events that the Hook triggers for.

    ", "name": "remove_events", "in": "body", - "isRequired": false + "description": "

    Determines a list of events to be removed from the list of events that the Hook triggers for.

    " }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index 05e8629400..bb8e01cd51 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -937,27 +937,26 @@ "bodyParameters": [ { "type": "string", + "name": "enabled_organizations", + "in": "body", "description": "

    The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.

    ", + "isRequired": true, "enum": [ "all", "none", "selected" - ], - "name": "enabled_organizations", - "in": "body", - "isRequired": true + ] }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": false, @@ -1208,10 +1207,10 @@ ], "bodyParameters": [ { - "description": "

    List of organization IDs to enable for GitHub Actions.

    ", "type": "array of integers", "name": "selected_organization_ids", "in": "body", + "description": "

    List of organization IDs to enable for GitHub Actions.

    ", "isRequired": true } ], @@ -1453,16 +1452,16 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", + "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "isRequired": true } ], @@ -1607,27 +1606,26 @@ "bodyParameters": [ { "type": "string", + "name": "enabled_repositories", + "in": "body", "description": "

    The policy that controls the repositories in the organization that are allowed to run GitHub Actions.

    ", + "isRequired": true, "enum": [ "all", "none", "selected" - ], - "name": "enabled_repositories", - "in": "body", - "isRequired": true + ] }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -3251,10 +3249,10 @@ ], "bodyParameters": [ { - "description": "

    List of repository IDs to enable for GitHub Actions.

    ", "type": "array of integers", "name": "selected_repository_ids", "in": "body", + "description": "

    List of repository IDs to enable for GitHub Actions.

    ", "isRequired": true } ], @@ -3496,16 +3494,16 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", + "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "isRequired": true } ], @@ -3660,22 +3658,21 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub Actions is enabled on the repository.

    ", "name": "enabled", "in": "body", + "description": "

    Whether GitHub Actions is enabled on the repository.

    ", "isRequired": true }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -3824,16 +3821,16 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", + "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "isRequired": true } ], @@ -4258,37 +4255,33 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret.

    ", + "isRequired": true, "enum": [ "all", "private", "selected" - ], - "name": "visibility", - "in": "body", - "isRequired": true + ] }, { "type": "array of integers", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", - "isRequired": false + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    " } ], "enabledForGitHubApps": true, @@ -6714,9 +6707,9 @@ "bodyParameters": [ { "type": "array of integers", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "isRequired": true } ], @@ -7268,18 +7261,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " } ], "enabledForGitHubApps": true, @@ -7791,17 +7781,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

    ", "isRequired": true }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", + "description": "

    ID of the key you used to encrypt the secret.

    ", "isRequired": true } ], @@ -8102,44 +8091,39 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all organizations or select individual organization.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all organizations or select individual organization.

    ", "enum": [ "selected", "all" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { - "description": "

    List of organization IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_organization_ids", "in": "body", - "isRequired": false + "description": "

    List of organization IDs that can access the runner group.

    " }, { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", - "isRequired": false + "description": "

    List of runner IDs to add to the runner group.

    " }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " } ], "enabledForGitHubApps": false, @@ -8353,31 +8337,27 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", - "isRequired": false + "description": "

    Name of the runner group.

    " }, { - "description": "

    Visibility of a runner group. You can select all organizations or select individual organizations.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all organizations or select individual organizations.

    ", "enum": [ "selected", "all" ], - "default": "all", - "name": "visibility", - "in": "body", - "isRequired": false + "default": "all" }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " } ], "enabledForGitHubApps": false, @@ -8747,10 +8727,10 @@ ], "bodyParameters": [ { - "description": "

    List of organization IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_organization_ids", "in": "body", + "description": "

    List of organization IDs that can access the runner group.

    ", "isRequired": true } ], @@ -9169,10 +9149,10 @@ ], "bodyParameters": [ { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", + "description": "

    List of runner IDs to add to the runner group.

    ", "isRequired": true } ], @@ -9514,46 +9494,41 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

    ", "enum": [ "selected", "all", "private" ], - "default": "all", - "name": "visibility", - "in": "body", - "isRequired": false + "default": "all" }, { - "description": "

    List of repository IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_repository_ids", "in": "body", - "isRequired": false + "description": "

    List of repository IDs that can access the runner group.

    " }, { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", - "isRequired": false + "description": "

    List of runner IDs to add to the runner group.

    " }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " } ], "enabledForGitHubApps": true, @@ -9785,31 +9760,28 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

    ", "enum": [ "selected", "all", "private" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " } ], "enabledForGitHubApps": true, @@ -12416,10 +12388,10 @@ ], "bodyParameters": [ { - "description": "

    List of repository IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_repository_ids", "in": "body", + "description": "

    List of repository IDs that can access the runner group.

    ", "isRequired": true } ], @@ -12838,10 +12810,10 @@ ], "bodyParameters": [ { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", + "description": "

    List of runner IDs to add to the runner group.

    ", "isRequired": true } ], @@ -35373,37 +35345,27 @@ "bodyParameters": [ { "type": "array of integers", - "description": "

    The list of environment ids to approve or reject

    ", - "examples": [ - 161171787, - 161171795 - ], "name": "environment_ids", "in": "body", + "description": "

    The list of environment ids to approve or reject

    ", "isRequired": true }, { "type": "string", + "name": "state", + "in": "body", "description": "

    Whether to approve or reject deployment to the specified environments.

    ", + "isRequired": true, "enum": [ "approved", "rejected" - ], - "examples": [ - "approved" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    A comment to accompany the deployment review

    ", - "examples": [ - "Ship it!" - ], "name": "comment", "in": "body", + "description": "

    A comment to accompany the deployment review

    ", "isRequired": true } ], @@ -41642,21 +41604,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The git reference for the workflow. The reference can be a branch or tag name.

    ", "name": "ref", "in": "body", + "description": "

    The git reference for the workflow. The reference can be a branch or tag name.

    ", "isRequired": true }, { "type": "object", - "description": "

    Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.

    ", - "additionalProperties": { - "type": "string" - }, - "maxProperties": 10, "name": "inputs", "in": "body", - "isRequired": false + "description": "

    Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.

    " } ], "enabledForGitHubApps": true, @@ -79798,19 +79755,16 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    ", "type": "string", - "format": "date-time", "name": "last_read_at", "in": "body", - "isRequired": false + "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    " }, { - "description": "

    Whether the notification has been read.

    ", "type": "boolean", "name": "read", "in": "body", - "isRequired": false + "description": "

    Whether the notification has been read.

    " } ], "enabledForGitHubApps": false, @@ -82378,12 +82332,10 @@ ], "bodyParameters": [ { - "description": "

    Whether to block all notifications from a thread.

    ", - "default": false, "type": "boolean", "name": "ignored", "in": "body", - "isRequired": false + "description": "

    Whether to block all notifications from a thread.

    " } ], "enabledForGitHubApps": false, @@ -84955,11 +84907,9 @@ "bodyParameters": [ { "type": "string", - "format": "date-time", - "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    ", "name": "last_read_at", "in": "body", - "isRequired": false + "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    " } ], "enabledForGitHubApps": false, @@ -92561,17 +92511,15 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Determines if notifications should be received from this repository.

    ", "name": "subscribed", "in": "body", - "isRequired": false + "description": "

    Determines if notifications should be received from this repository.

    " }, { "type": "boolean", - "description": "

    Determines if all notifications should be blocked from this repository.

    ", "name": "ignored", "in": "body", - "isRequired": false + "description": "

    Determines if all notifications should be blocked from this repository.

    " } ], "enabledForGitHubApps": false, @@ -98588,14 +98536,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -99525,14 +99465,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -100102,779 +100034,300 @@ ], "bodyParameters": [ { - "description": "

    List of repository names that the token should have access to

    ", "type": "array of strings", "name": "repositories", "in": "body", - "isRequired": false + "description": "

    List of repository names that the token should have access to

    " }, { - "description": "

    List of repository IDs that the token should have access to

    ", "type": "array of integers", - "examples": [ - 1 - ], "name": "repository_ids", "in": "body", - "isRequired": false + "description": "

    List of repository IDs that the token should have access to

    " }, { - "title": "App Permissions", "type": "object", + "name": "permissions", + "in": "body", "description": "

    The permissions granted to the user-to-server access token.

    ", - "properties": { - "actions": { + "childParamsGroups": [ + { "type": "string", + "name": "actions", "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", "enum": [ "read", "write" - ], - "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + ] }, - "administration": { + { "type": "string", + "name": "administration", "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", "enum": [ "read", "write" - ], - "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + ] }, - "checks": { + { "type": "string", + "name": "checks", "description": "

    The level of permission to grant the access token for checks on code.

    ", "enum": [ "read", "write" - ], - "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + ] }, - "contents": { + { "type": "string", + "name": "contents", "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", "enum": [ "read", "write" - ], - "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + ] }, - "organization_custom_roles": { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for custom roles management.", - "childParamsGroups": [] - }, - "deployments": { + { "type": "string", + "name": "deployments", "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", "enum": [ "read", "write" - ], - "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + ] }, - "environments": { + { "type": "string", + "name": "environments", "description": "

    The level of permission to grant the access token for managing repository environments.

    ", "enum": [ "read", "write" - ], - "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + ] }, - "issues": { + { "type": "string", + "name": "issues", "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", "enum": [ "read", "write" - ], - "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + ] }, - "metadata": { + { "type": "string", + "name": "metadata", "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", "enum": [ "read", "write" - ], - "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + ] }, - "packages": { + { "type": "string", + "name": "packages", "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "pages": { + { "type": "string", + "name": "pages", "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", "enum": [ "read", "write" - ], - "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + ] }, - "pull_requests": { + { "type": "string", + "name": "pull_requests", "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", "enum": [ "read", "write" - ], - "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + ] }, - "repository_hooks": { + { "type": "string", + "name": "repository_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", "enum": [ "read", "write" - ], - "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + ] }, - "repository_projects": { + { "type": "string", + "name": "repository_projects", "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", "enum": [ "read", "write", "admin" - ], - "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + ] }, - "secret_scanning_alerts": { + { "type": "string", + "name": "secret_scanning_alerts", "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + ] }, - "secrets": { + { "type": "string", + "name": "secrets", "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", "enum": [ "read", "write" - ], - "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + ] }, - "security_events": { + { "type": "string", + "name": "security_events", "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + ] }, - "single_file": { + { "type": "string", + "name": "single_file", "description": "

    The level of permission to grant the access token to manage just a single file.

    ", "enum": [ "read", "write" - ], - "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + ] }, - "statuses": { + { "type": "string", + "name": "statuses", "description": "

    The level of permission to grant the access token for commit statuses.

    ", "enum": [ "read", "write" - ], - "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + ] }, - "vulnerability_alerts": { + { "type": "string", + "name": "vulnerability_alerts", "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", "enum": [ "read", "write" - ], - "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + ] }, - "workflows": { + { "type": "string", + "name": "workflows", "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", "enum": [ "write" - ], - "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + ] }, - "members": { + { "type": "string", + "name": "members", "description": "

    The level of permission to grant the access token for organization teams and members.

    ", "enum": [ "read", "write" - ], - "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + ] }, - "organization_administration": { + { "type": "string", + "name": "organization_administration", "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + ] }, - "organization_hooks": { + { "type": "string", + "name": "organization_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + ] }, - "organization_plan": { + { "type": "string", + "name": "organization_plan", "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", "enum": [ "read" - ], - "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + ] }, - "organization_projects": { + { "type": "string", + "name": "organization_projects", "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", "enum": [ "read", "write", "admin" - ], - "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + ] }, - "organization_packages": { + { "type": "string", + "name": "organization_packages", "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "organization_secrets": { + { "type": "string", + "name": "organization_secrets", "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", "enum": [ "read", "write" - ], - "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + ] }, - "organization_self_hosted_runners": { + { "type": "string", + "name": "organization_self_hosted_runners", "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + ] }, - "organization_user_blocking": { + { "type": "string", + "name": "organization_user_blocking", "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + ] }, - "team_discussions": { + { "type": "string", + "name": "team_discussions", "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", "enum": [ "read", "write" - ], - "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] + ] }, - "content_references": { + { "type": "string", + "name": "content_references", "description": "

    The level of permission to grant the access token for notification of content references and creation content attachments.

    ", "enum": [ "read", "write" - ], - "name": "content_references", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "childParamsGroups": [] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - }, - "name": "permissions", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "permissions", - "parentType": "object", - "id": "permissions-object", - "params": [ - { - "type": "string", - "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", - "enum": [ - "read", - "write" - ], - "name": "actions", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", - "enum": [ - "read", - "write" - ], - "name": "administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for checks on code.

    ", - "enum": [ - "read", - "write" - ], - "name": "checks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "contents", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "deployments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for managing repository environments.

    ", - "enum": [ - "read", - "write" - ], - "name": "environments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", - "enum": [ - "read", - "write" - ], - "name": "issues", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", - "enum": [ - "read", - "write" - ], - "name": "metadata", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", - "enum": [ - "read", - "write" - ], - "name": "pages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "pull_requests", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", - "enum": [ - "read", - "write" - ], - "name": "repository_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "repository_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "secret_scanning_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "security_events", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage just a single file.

    ", - "enum": [ - "read", - "write" - ], - "name": "single_file", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for commit statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "statuses", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "vulnerability_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", - "enum": [ - "write" - ], - "name": "workflows", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization teams and members.

    ", - "enum": [ - "read", - "write" - ], - "name": "members", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", - "enum": [ - "read" - ], - "name": "organization_plan", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "organization_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_self_hosted_runners", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_user_blocking", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", - "enum": [ - "read", - "write" - ], - "name": "team_discussions", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for notification of content references and creation content attachments.

    ", - "enum": [ - "read", - "write" - ], - "name": "content_references", - "in": "body" - } ] } ] @@ -101085,14 +100538,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -103711,14 +103156,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -104652,14 +104089,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -105591,14 +105020,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -107731,25 +107152,17 @@ ], "bodyParameters": [ { - "description": "

    The title of the attachment

    ", "type": "string", - "maxLength": 1024, - "examples": [ - "Title of the attachment" - ], "name": "title", "in": "body", + "description": "

    The title of the attachment

    ", "isRequired": true }, { - "description": "

    The body of the attachment

    ", "type": "string", - "maxLength": 262144, - "examples": [ - "Body of the attachment" - ], "name": "body", "in": "body", + "description": "

    The body of the attachment

    ", "isRequired": true } ], @@ -108366,14 +107779,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -110639,9 +110044,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", + "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "isRequired": true } ], @@ -110764,10 +110169,10 @@ ], "bodyParameters": [ { - "description": "

    The access_token of the OAuth application.

    ", "type": "string", "name": "access_token", "in": "body", + "description": "

    The access_token of the OAuth application.

    ", "isRequired": true } ], @@ -111130,14 +110535,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -111643,10 +111040,10 @@ ], "bodyParameters": [ { - "description": "

    The access_token of the OAuth application.

    ", "type": "string", "name": "access_token", "in": "body", + "description": "

    The access_token of the OAuth application.

    ", "isRequired": true } ], @@ -112009,14 +111406,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -112519,9 +111908,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", + "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "isRequired": true } ], @@ -112585,808 +111974,318 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", - "examples": [ - "e72e16c7e42f292c6912e7710c838347ae178b4a" - ], "name": "access_token", "in": "body", + "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "isRequired": true }, { - "description": "

    The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

    ", "type": "string", - "examples": [ - "octocat" - ], "name": "target", "in": "body", - "isRequired": false + "description": "

    The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

    " }, { - "description": "

    The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

    ", "type": "integer", - "examples": [ - 1 - ], "name": "target_id", "in": "body", - "isRequired": false + "description": "

    The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

    " }, { - "description": "

    The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

    ", "type": "array of strings", "name": "repositories", "in": "body", - "isRequired": false + "description": "

    The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

    " }, { - "description": "

    The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

    ", "type": "array of integers", - "examples": [ - 1 - ], "name": "repository_ids", "in": "body", - "isRequired": false + "description": "

    The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

    " }, { - "title": "App Permissions", "type": "object", + "name": "permissions", + "in": "body", "description": "

    The permissions granted to the user-to-server access token.

    ", - "properties": { - "actions": { + "childParamsGroups": [ + { "type": "string", + "name": "actions", "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", "enum": [ "read", "write" - ], - "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + ] }, - "administration": { + { "type": "string", + "name": "administration", "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", "enum": [ "read", "write" - ], - "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + ] }, - "checks": { + { "type": "string", + "name": "checks", "description": "

    The level of permission to grant the access token for checks on code.

    ", "enum": [ "read", "write" - ], - "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + ] }, - "contents": { + { "type": "string", + "name": "contents", "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", "enum": [ "read", "write" - ], - "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + ] }, - "organization_custom_roles": { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for custom roles management.", - "childParamsGroups": [] - }, - "deployments": { + { "type": "string", + "name": "deployments", "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", "enum": [ "read", "write" - ], - "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + ] }, - "environments": { + { "type": "string", + "name": "environments", "description": "

    The level of permission to grant the access token for managing repository environments.

    ", "enum": [ "read", "write" - ], - "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + ] }, - "issues": { + { "type": "string", + "name": "issues", "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", "enum": [ "read", "write" - ], - "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + ] }, - "metadata": { + { "type": "string", + "name": "metadata", "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", "enum": [ "read", "write" - ], - "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + ] }, - "packages": { + { "type": "string", + "name": "packages", "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "pages": { + { "type": "string", + "name": "pages", "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", "enum": [ "read", "write" - ], - "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + ] }, - "pull_requests": { + { "type": "string", + "name": "pull_requests", "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", "enum": [ "read", "write" - ], - "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + ] }, - "repository_hooks": { + { "type": "string", + "name": "repository_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", "enum": [ "read", "write" - ], - "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + ] }, - "repository_projects": { + { "type": "string", + "name": "repository_projects", "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", "enum": [ "read", "write", "admin" - ], - "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + ] }, - "secret_scanning_alerts": { + { "type": "string", + "name": "secret_scanning_alerts", "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + ] }, - "secrets": { + { "type": "string", + "name": "secrets", "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", "enum": [ "read", "write" - ], - "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + ] }, - "security_events": { + { "type": "string", + "name": "security_events", "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + ] }, - "single_file": { + { "type": "string", + "name": "single_file", "description": "

    The level of permission to grant the access token to manage just a single file.

    ", "enum": [ "read", "write" - ], - "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + ] }, - "statuses": { + { "type": "string", + "name": "statuses", "description": "

    The level of permission to grant the access token for commit statuses.

    ", "enum": [ "read", "write" - ], - "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + ] }, - "vulnerability_alerts": { + { "type": "string", + "name": "vulnerability_alerts", "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", "enum": [ "read", "write" - ], - "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + ] }, - "workflows": { + { "type": "string", + "name": "workflows", "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", "enum": [ "write" - ], - "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + ] }, - "members": { + { "type": "string", + "name": "members", "description": "

    The level of permission to grant the access token for organization teams and members.

    ", "enum": [ "read", "write" - ], - "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + ] }, - "organization_administration": { + { "type": "string", + "name": "organization_administration", "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + ] }, - "organization_hooks": { + { "type": "string", + "name": "organization_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + ] }, - "organization_plan": { + { "type": "string", + "name": "organization_plan", "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", "enum": [ "read" - ], - "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + ] }, - "organization_projects": { + { "type": "string", + "name": "organization_projects", "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", "enum": [ "read", "write", "admin" - ], - "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + ] }, - "organization_packages": { + { "type": "string", + "name": "organization_packages", "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "organization_secrets": { + { "type": "string", + "name": "organization_secrets", "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", "enum": [ "read", "write" - ], - "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + ] }, - "organization_self_hosted_runners": { + { "type": "string", + "name": "organization_self_hosted_runners", "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + ] }, - "organization_user_blocking": { + { "type": "string", + "name": "organization_user_blocking", "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + ] }, - "team_discussions": { + { "type": "string", + "name": "team_discussions", "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", "enum": [ "read", "write" - ], - "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] + ] }, - "content_references": { + { "type": "string", + "name": "content_references", "description": "

    The level of permission to grant the access token for notification of content references and creation content attachments.

    ", "enum": [ "read", "write" - ], - "name": "content_references", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "childParamsGroups": [] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - }, - "name": "permissions", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "permissions", - "parentType": "object", - "id": "permissions-object", - "params": [ - { - "type": "string", - "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", - "enum": [ - "read", - "write" - ], - "name": "actions", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", - "enum": [ - "read", - "write" - ], - "name": "administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for checks on code.

    ", - "enum": [ - "read", - "write" - ], - "name": "checks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "contents", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "deployments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for managing repository environments.

    ", - "enum": [ - "read", - "write" - ], - "name": "environments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", - "enum": [ - "read", - "write" - ], - "name": "issues", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", - "enum": [ - "read", - "write" - ], - "name": "metadata", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", - "enum": [ - "read", - "write" - ], - "name": "pages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "pull_requests", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", - "enum": [ - "read", - "write" - ], - "name": "repository_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "repository_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "secret_scanning_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "security_events", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage just a single file.

    ", - "enum": [ - "read", - "write" - ], - "name": "single_file", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for commit statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "statuses", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "vulnerability_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", - "enum": [ - "write" - ], - "name": "workflows", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization teams and members.

    ", - "enum": [ - "read", - "write" - ], - "name": "members", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", - "enum": [ - "read" - ], - "name": "organization_plan", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "organization_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_self_hosted_runners", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_user_blocking", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", - "enum": [ - "read", - "write" - ], - "name": "team_discussions", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for notification of content references and creation content attachments.

    ", - "enum": [ - "read", - "write" - ], - "name": "content_references", - "in": "body" - } ] } ] @@ -113786,14 +112685,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -114676,14 +113567,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -115551,14 +114434,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -116186,53 +115061,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": false, @@ -118241,7 +117090,2049 @@ }, "response": { "statusCode": "200", - "description": "

    Response

    " + "contentType": "application/json", + "description": "

    Response

    ", + "example": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [], + "checks": [] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + }, + "schema": { + "title": "Branch With Protection", + "description": "Branch With Protection", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "commit": { + "title": "Commit", + "description": "Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } + }, + "required": [ + "sha", + "url" + ] + } + }, + "stats": { + "type": "object", + "properties": { + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + }, + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "string" + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "html", + "self" + ] + }, + "protected": { + "type": "boolean" + }, + "protection": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enforcement_level": { + "type": "string" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + }, + "contexts_url": { + "type": "string" + }, + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts" + ] + }, + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" + ] + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "require_code_owner_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "required_approving_review_count": { + "type": "integer", + "minimum": 1, + "maximum": 6, + "examples": [ + 2 + ] + } + }, + "required": [ + "dismiss_stale_reviews", + "require_code_owner_reviews" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + } + } + }, + "protection_url": { + "type": "string", + "format": "uri" + }, + "pattern": { + "type": "string", + "examples": [ + "\"mas*\"" + ] + }, + "required_approving_review_count": { + "type": "integer", + "examples": [ + 1 + ] + } + }, + "required": [ + "name", + "commit", + "_links", + "protection", + "protected", + "protection_url" + ] + } } } ], @@ -118302,9 +119193,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new name of the branch.

    ", "name": "new_name", "in": "body", + "description": "

    The new name of the branch.

    ", "isRequired": true } ], @@ -120423,24 +121314,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the base branch that the head will be merged into.

    ", "name": "base", "in": "body", + "description": "

    The name of the base branch that the head will be merged into.

    ", "isRequired": true }, { "type": "string", - "description": "

    The head to merge. This can be a branch name or a commit SHA1.

    ", "name": "head", "in": "body", + "description": "

    The head to merge. This can be a branch name or a commit SHA1.

    ", "isRequired": true }, { "type": "string", - "description": "

    Commit message to use for the merge commit. If omitted, a default message will be used.

    ", "name": "commit_message", "in": "body", - "isRequired": false + "description": "

    Commit message to use for the merge commit. If omitted, a default message will be used.

    " } ], "enabledForGitHubApps": true, @@ -122788,171 +123678,38 @@ "bodyParameters": [ { "type": "object or null", - "description": "

    Require status checks to pass before merging. Set to null to disable.

    ", - "properties": { - "strict": { - "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", - "name": "strict", - "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": true, - "childParamsGroups": [] - }, - "contexts": { - "type": "array of strings", - "deprecated": true, - "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "isRequired": true, - "childParamsGroups": [] - }, - "checks": { - "type": "array of objects", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", - "items": { - "type": "object", - "required": [ - "context" - ], - "properties": { - "context": { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] - }, - "app_id": { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] - } - } - }, - "name": "checks", - "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ - { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "strict", - "contexts" - ], "name": "required_status_checks", "in": "body", + "description": "

    Require status checks to pass before merging. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "required_status_checks", - "parentType": "object", - "id": "required_status_checks-object", - "params": [ - { - "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", - "name": "strict", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "deprecated": true, - "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", - "name": "contexts", - "in": "body", - "isRequired": true - }, - { - "type": "array of objects", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", - "name": "checks", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ - { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "boolean", + "name": "strict", + "description": "

    Require branches to be up to date before merging.

    ", + "isRequired": true }, { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ + "type": "array of strings", + "name": "contexts", + "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", + "isRequired": true + }, + { + "type": "array of objects", + "name": "checks", + "description": "

    The list of status checks to require in order to merge into this branch.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The name of the required check

    ", "name": "context", - "in": "body", + "description": "

    The name of the required check

    ", "isRequired": true }, { "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", "name": "app_id", - "in": "body", - "isRequired": false + "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    " } ] } @@ -122960,366 +123717,118 @@ }, { "type": "boolean or null", - "description": "

    Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "name": "enforce_admins", "in": "body", + "description": "

    Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "isRequired": true }, { "type": "object or null", - "description": "

    Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", - "properties": { - "dismissal_restrictions": { - "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, - "name": "dismissal_restrictions", - "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", - "childParamsGroups": [ - { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] - } - ] - }, - "dismiss_stale_reviews": { - "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", - "name": "dismiss_stale_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "childParamsGroups": [] - }, - "require_code_owner_reviews": { - "type": "boolean", - "description": "

    Blocks merging pull requests until code owners review them.

    ", - "name": "require_code_owner_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", - "childParamsGroups": [] - }, - "required_approving_review_count": { - "type": "integer", - "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.

    ", - "name": "required_approving_review_count", - "in": "body", - "rawType": "integer", - "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "childParamsGroups": [] - } - }, "name": "required_pull_request_reviews", "in": "body", + "description": "

    Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "required_pull_request_reviews", - "parentType": "object", - "id": "required_pull_request_reviews-object", - "params": [ + "type": "object", + "name": "dismissal_restrictions", + "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", + "childParamsGroups": [ { - "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, - "name": "dismissal_restrictions", - "in": "body", - "childParamsGroups": [ - { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with dismissal access

    " }, { - "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", - "name": "dismiss_stale_reviews", - "in": "body" + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with dismissal access

    " }, { - "type": "boolean", - "description": "

    Blocks merging pull requests until code owners review them.

    ", - "name": "require_code_owner_reviews", - "in": "body" - }, - { - "type": "integer", - "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.

    ", - "name": "required_approving_review_count", - "in": "body" + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with dismissal access

    " } ] }, { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] + "type": "boolean", + "name": "dismiss_stale_reviews", + "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    " + }, + { + "type": "boolean", + "name": "require_code_owner_reviews", + "description": "

    Blocks merging pull requests until code owners review them.

    " + }, + { + "type": "integer", + "name": "required_approving_review_count", + "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.

    " } ] }, { "type": "object or null", - "description": "

    Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with push access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with push access", - "isRequired": true, - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with push access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with push access", - "isRequired": true, - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with push access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with push access", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "users", - "teams" - ], "name": "restrictions", "in": "body", + "description": "

    Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "restrictions", - "parentType": "object", - "id": "restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with push access

    ", - "name": "users", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with push access

    ", - "name": "teams", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with push access

    ", - "name": "apps", - "in": "body", - "isRequired": false - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with push access

    ", + "isRequired": true + }, + { + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with push access

    ", + "isRequired": true + }, + { + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with push access

    " } ] }, { "type": "boolean", - "description": "

    Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

    ", "name": "required_linear_history", "in": "body", - "isRequired": false + "description": "

    Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

    " }, { "type": "boolean or null", - "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "name": "allow_force_pushes", "in": "body", - "isRequired": false + "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    " }, { "type": "boolean", - "description": "

    Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

    ", "name": "allow_deletions", "in": "body", - "isRequired": false + "description": "

    Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

    ", "name": "block_creations", "in": "body", - "isRequired": false + "description": "

    If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

    " }, { "type": "boolean", - "description": "

    Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

    ", "name": "required_conversation_resolution", "in": "body", - "isRequired": false + "description": "

    Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

    " }, { "type": "array of strings", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", "name": "contexts", "in": "body", - "isRequired": false + "description": "

    The list of status checks to require in order to merge into this branch.

    " } ], "enabledForGitHubApps": true, @@ -123384,7 +123893,1272 @@ }, "response": { "statusCode": "200", - "description": "

    Response

    " + "contentType": "application/json", + "description": "

    Response

    ", + "example": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [], + "teams": [], + "apps": [] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [], + "teams": [], + "apps": [] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + }, + "schema": { + "title": "Protected Branch", + "description": "Branch protections protect branches", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "required_status_checks": { + "title": "Status Check Policy", + "description": "Status Check Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] + }, + "strict": { + "type": "boolean", + "examples": [ + true + ] + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "contexts_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + ] + } + }, + "required": [ + "url", + "contexts_url", + "strict", + "contexts" + ] + }, + "required_pull_request_reviews": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "dismiss_stale_reviews": { + "type": "boolean" + }, + "require_code_owner_reviews": { + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "users", + "teams" + ] + } + }, + "required": [ + "url" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "enforce_admins": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "url", + "enabled" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + } + }, + "required": [ + "url" + ] + } } } ], @@ -124695,96 +126469,44 @@ "bodyParameters": [ { "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, "name": "dismissal_restrictions", "in": "body", - "isRequired": false, + "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", "childParamsGroups": [ { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with dismissal access

    " + }, + { + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with dismissal access

    " + }, + { + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with dismissal access

    " } ] }, { "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", "name": "dismiss_stale_reviews", "in": "body", - "isRequired": false + "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    " }, { "type": "boolean", - "description": "

    Blocks merging pull requests until code owners have reviewed.

    ", "name": "require_code_owner_reviews", "in": "body", - "isRequired": false + "description": "

    Blocks merging pull requests until code owners have reviewed.

    " }, { "type": "integer", - "description": "

    Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.

    ", "name": "required_approving_review_count", "in": "body", - "isRequired": false + "description": "

    Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.

    " } ], "enabledForGitHubApps": true, @@ -126200,18 +127922,15 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", "name": "strict", "in": "body", - "isRequired": false + "description": "

    Require branches to be up to date before merging.

    " }, { "type": "array of strings", - "deprecated": true, - "description": "

    The list of status checks to require in order to merge into this branch

    ", "name": "contexts", "in": "body", - "isRequired": false + "description": "

    The list of status checks to require in order to merge into this branch

    " } ], "enabledForGitHubApps": true, @@ -126494,9 +128213,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -126506,8 +128225,14 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding status checks to a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -126592,9 +128317,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -126604,8 +128329,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example updating status checks for a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -126685,9 +128415,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -126697,8 +128427,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing status checks from a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -127747,9 +129482,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -128198,9 +129933,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -128649,9 +130384,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -129390,9 +131125,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -129402,8 +131137,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -129689,9 +131429,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -129701,8 +131441,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -129988,9 +131733,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -130000,8 +131745,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -130544,9 +132294,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -130556,8 +132306,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -130810,9 +132565,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -130822,8 +132577,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -131076,9 +132836,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -131088,8 +132848,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -131336,55 +133101,52 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the check. For example, \"code-coverage\".

    ", "name": "name", "in": "body", + "description": "

    The name of the check. For example, \"code-coverage\".

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the commit.

    ", "name": "head_sha", "in": "body", + "description": "

    The SHA of the commit.

    ", "isRequired": true }, { "type": "string", - "description": "

    The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

    ", "name": "details_url", "in": "body", - "isRequired": false + "description": "

    The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

    " }, { "type": "string", - "description": "

    A reference for the run on the integrator's system.

    ", "name": "external_id", "in": "body", - "isRequired": false + "description": "

    A reference for the run on the integrator's system.

    " }, { "type": "string", + "name": "status", + "in": "body", "description": "

    The current status.

    ", "enum": [ "queued", "in_progress", "completed" ], - "default": "queued", - "name": "status", - "in": "body", - "isRequired": false + "default": "queued" }, { "type": "string", - "format": "date-time", - "description": "

    The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "string", + "name": "conclusion", + "in": "body", "description": "

    Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.

    ", "enum": [ "action_required", @@ -131395,588 +133157,120 @@ "skipped", "stale", "timed_out" - ], - "name": "conclusion", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "format": "date-time", - "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "completed_at", "in": "body", - "isRequired": false + "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "object", - "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", - "properties": { - "title": { - "type": "string", - "description": "

    The title of the check run.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the check run.", - "isRequired": true, - "childParamsGroups": [] - }, - "summary": { - "type": "string", - "maxLength": 65535, - "description": "

    The summary of the check run. This parameter supports Markdown.

    ", - "name": "summary", - "in": "body", - "rawType": "string", - "rawDescription": "The summary of the check run. This parameter supports Markdown.", - "isRequired": true, - "childParamsGroups": [] - }, - "text": { - "type": "string", - "maxLength": 65535, - "description": "

    The details of the check run. This parameter supports Markdown.

    ", - "name": "text", - "in": "body", - "rawType": "string", - "rawDescription": "The details of the check run. This parameter supports Markdown.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotations": { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", - "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, - "name": "annotations", - "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#annotations-object) description for details about how to use this parameter.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - "images": { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, - "name": "images", - "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#images-object) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "title", - "summary" - ], "name": "output", "in": "body", - "isRequired": false, + "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", "childParamsGroups": [ { - "parentName": "output", - "parentType": "object", - "id": "output-object", - "params": [ - { - "type": "string", - "description": "

    The title of the check run.

    ", - "name": "title", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 65535, - "description": "

    The summary of the check run. This parameter supports Markdown.

    ", - "name": "summary", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 65535, - "description": "

    The details of the check run. This parameter supports Markdown.

    ", - "name": "text", - "in": "body", - "isRequired": false - }, - { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", - "maxItems": 50, - "name": "annotations", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "name": "images", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "string", + "name": "title", + "description": "

    The title of the check run.

    ", + "isRequired": true }, { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ + "type": "string", + "name": "summary", + "description": "

    The summary of the check run. This parameter supports Markdown.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "text", + "description": "

    The details of the check run. This parameter supports Markdown.

    " + }, + { + "type": "array of objects", + "name": "annotations", + "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "name": "path", - "in": "body", + "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start line of the annotation.

    ", "name": "start_line", - "in": "body", + "description": "

    The start line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The end line of the annotation.

    ", "name": "end_line", - "in": "body", + "description": "

    The end line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "start_column", - "in": "body", - "isRequired": false + "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "end_column", - "in": "body", - "isRequired": false + "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "string", + "name": "annotation_level", "description": "

    The level of the annotation.

    ", + "isRequired": true, "enum": [ "notice", "warning", "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "name": "message", - "in": "body", + "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "isRequired": true }, { "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", "name": "title", - "in": "body", - "isRequired": false + "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    " }, { "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", "name": "raw_details", - "in": "body", - "isRequired": false + "description": "

    Details about this annotation. The maximum size is 64 KB.

    " } ] }, { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ + "type": "array of objects", + "name": "images", + "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The alternative text for the image.

    ", "name": "alt", - "in": "body", + "description": "

    The alternative text for the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full URL of the image.

    ", "name": "image_url", - "in": "body", + "description": "

    The full URL of the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short image description.

    ", "name": "caption", - "in": "body", - "isRequired": false + "description": "

    A short image description.

    " } ] } @@ -131984,42 +133278,27 @@ }, { "type": "array of objects", - "description": "

    Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", - "maxItems": 3, "name": "actions", "in": "body", - "isRequired": false, + "description": "

    Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", "childParamsGroups": [ { - "parentName": "actions", - "parentType": "items", - "id": "actions-items", - "params": [ - { - "type": "string", - "maxLength": 20, - "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", - "name": "label", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 40, - "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", - "name": "description", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 20, - "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", - "name": "identifier", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "label", + "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "identifier", + "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", + "isRequired": true } ] } @@ -135671,47 +136950,43 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the check. For example, \"code-coverage\".

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the check. For example, \"code-coverage\".

    " }, { "type": "string", - "description": "

    The URL of the integrator's site that has the full details of the check.

    ", "name": "details_url", "in": "body", - "isRequired": false + "description": "

    The URL of the integrator's site that has the full details of the check.

    " }, { "type": "string", - "description": "

    A reference for the run on the integrator's system.

    ", "name": "external_id", "in": "body", - "isRequired": false + "description": "

    A reference for the run on the integrator's system.

    " }, { "type": "string", - "format": "date-time", - "description": "

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "string", + "name": "status", + "in": "body", "description": "

    The current status.

    ", "enum": [ "queued", "in_progress", "completed" - ], - "name": "status", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "conclusion", + "in": "body", "description": "

    Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.

    ", "enum": [ "action_required", @@ -135722,587 +136997,119 @@ "skipped", "stale", "timed_out" - ], - "name": "conclusion", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "format": "date-time", - "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "completed_at", "in": "body", - "isRequired": false + "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "object", - "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", - "properties": { - "title": { - "type": "string", - "description": "

    Required.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "**Required**.", - "isRequired": false, - "childParamsGroups": [] - }, - "summary": { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "summary", - "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": true, - "childParamsGroups": [] - }, - "text": { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "text", - "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotations": { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", - "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, - "name": "annotations", - "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#annotations-object-1) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - "images": { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, - "name": "images", - "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#annotations-object-1) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "summary" - ], "name": "output", "in": "body", - "isRequired": false, + "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", "childParamsGroups": [ { - "parentName": "output", - "parentType": "object", - "id": "output-object", - "params": [ - { - "type": "string", - "description": "

    Required.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "summary", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "text", - "in": "body", - "isRequired": false - }, - { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", - "maxItems": 50, - "name": "annotations", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "name": "images", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "string", + "name": "title", + "description": "

    Required.

    " }, { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ + "type": "string", + "name": "summary", + "description": "

    Can contain Markdown.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "text", + "description": "

    Can contain Markdown.

    " + }, + { + "type": "array of objects", + "name": "annotations", + "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "name": "path", - "in": "body", + "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start line of the annotation.

    ", "name": "start_line", - "in": "body", + "description": "

    The start line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The end line of the annotation.

    ", "name": "end_line", - "in": "body", + "description": "

    The end line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "start_column", - "in": "body", - "isRequired": false + "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "end_column", - "in": "body", - "isRequired": false + "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "string", + "name": "annotation_level", "description": "

    The level of the annotation.

    ", + "isRequired": true, "enum": [ "notice", "warning", "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "name": "message", - "in": "body", + "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "isRequired": true }, { "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", "name": "title", - "in": "body", - "isRequired": false + "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    " }, { "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", "name": "raw_details", - "in": "body", - "isRequired": false + "description": "

    Details about this annotation. The maximum size is 64 KB.

    " } ] }, { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ + "type": "array of objects", + "name": "images", + "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The alternative text for the image.

    ", "name": "alt", - "in": "body", + "description": "

    The alternative text for the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full URL of the image.

    ", "name": "image_url", - "in": "body", + "description": "

    The full URL of the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short image description.

    ", "name": "caption", - "in": "body", - "isRequired": false + "description": "

    A short image description.

    " } ] } @@ -136310,42 +137117,27 @@ }, { "type": "array of objects", - "description": "

    Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", - "maxItems": 3, "name": "actions", "in": "body", - "isRequired": false, + "description": "

    Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", "childParamsGroups": [ { - "parentName": "actions", - "parentType": "items", - "id": "actions-items", - "params": [ - { - "type": "string", - "maxLength": 20, - "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", - "name": "label", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 40, - "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", - "name": "description", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 20, - "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", - "name": "identifier", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "label", + "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "identifier", + "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", + "isRequired": true } ] } @@ -140375,9 +141167,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The sha of the head commit.

    ", "name": "head_sha", "in": "body", + "description": "

    The sha of the head commit.

    ", "isRequired": true } ], @@ -146537,32 +147329,22 @@ "bodyParameters": [ { "type": "array of objects", - "description": "

    Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

    ", "name": "auto_trigger_checks", "in": "body", - "isRequired": false, + "description": "

    Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

    ", "childParamsGroups": [ { - "parentName": "auto_trigger_checks", - "parentType": "items", - "id": "auto_trigger_checks-items", - "params": [ - { - "type": "integer", - "description": "

    The id of the GitHub App.

    ", - "name": "app_id", - "in": "body", - "isRequired": true - }, - { - "type": "boolean", - "description": "

    Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

    ", - "default": true, - "name": "setting", - "in": "body", - "isRequired": true - } - ] + "type": "integer", + "name": "app_id", + "description": "

    The id of the GitHub App.

    ", + "isRequired": true + }, + { + "type": "boolean", + "name": "setting", + "description": "

    Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

    ", + "isRequired": true, + "default": true } ] } @@ -156427,28 +157209,27 @@ ], "bodyParameters": [ { - "description": "

    Sets the state of the code scanning alert. You must provide dismissed_reason when you set the state to dismissed.

    ", "type": "string", + "name": "state", + "in": "body", + "description": "

    Sets the state of the code scanning alert. You must provide dismissed_reason when you set the state to dismissed.

    ", + "isRequired": true, "enum": [ "open", "dismissed" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", + "name": "dismissed_reason", + "in": "body", "description": "

    Required when the state is dismissed. The reason for dismissing or closing the alert.

    ", "enum": [ null, "false positive", "won't fix", "used in tests" - ], - "name": "dismissed_reason", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -157967,54 +158748,43 @@ ], "bodyParameters": [ { - "description": "

    The SHA of the commit to which the analysis you are uploading relates.

    ", "type": "string", - "minLength": 40, - "maxLength": 40, - "pattern": "^[0-9a-fA-F]+$", "name": "commit_sha", "in": "body", + "description": "

    The SHA of the commit to which the analysis you are uploading relates.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", "name": "ref", "in": "body", + "description": "

    The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", "isRequired": true }, { - "description": "

    A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

    ", "type": "string", "name": "sarif", "in": "body", + "description": "

    A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

    ", "isRequired": true }, { - "description": "

    The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

    ", "type": "string", - "format": "uri", - "examples": [ - "file:///github/workspace/" - ], "name": "checkout_uri", "in": "body", - "isRequired": false + "description": "

    The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

    " }, { - "description": "

    The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "format": "date-time", "type": "string", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { - "description": "

    The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

    ", "type": "string", "name": "tool_name", "in": "body", - "isRequired": false + "description": "

    The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

    " } ], "enabledForGitHubApps": true, @@ -158822,11 +159592,10 @@ "bodyParameters": [ { "type": "string", - "description": "

    The permission to grant the collaborator. Only valid on organization-owned repositories.

    ", - "default": "push", "name": "permission", "in": "body", - "isRequired": false + "description": "

    The permission to grant the collaborator. Only valid on organization-owned repositories.

    ", + "default": "push" } ], "enabledForGitHubApps": true, @@ -164591,6 +165360,8 @@ "bodyParameters": [ { "type": "string", + "name": "permissions", + "in": "body", "description": "

    The permissions that the associated user will have on the repository. Valid values are read, write, maintain, triage, and admin.

    ", "enum": [ "read", @@ -164598,10 +165369,7 @@ "maintain", "triage", "admin" - ], - "name": "permissions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -164610,8 +165378,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example request body", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permissions": "write" + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -180964,9 +181735,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment

    ", "isRequired": true } ], @@ -181882,31 +182653,28 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true }, { "type": "string", - "description": "

    Relative path of the file to comment on.

    ", "name": "path", "in": "body", - "isRequired": false + "description": "

    Relative path of the file to comment on.

    " }, { "type": "integer", - "description": "

    Line index in the diff to comment on.

    ", "name": "position", "in": "body", - "isRequired": false + "description": "

    Line index in the diff to comment on.

    " }, { "type": "integer", - "description": "

    Deprecated. Use position parameter instead. Line number in the file to comment on.

    ", "name": "line", "in": "body", - "isRequired": false + "description": "

    Deprecated. Use position parameter instead. Line number in the file to comment on.

    " } ], "enabledForGitHubApps": true, @@ -185080,38 +185848,35 @@ "bodyParameters": [ { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the status.

    ", + "isRequired": true, "enum": [ "error", "failure", "pending", "success" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", - "description": "

    The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
    \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
    \nhttp://ci.example.com/user/repo/build/sha

    ", "name": "target_url", "in": "body", - "isRequired": false + "description": "

    The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
    \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
    \nhttp://ci.example.com/user/repo/build/sha

    " }, { "type": "string or null", - "description": "

    A short description of the status.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the status.

    " }, { "type": "string", - "description": "

    A string label to differentiate this status from the status of other systems. This field is case-insensitive.

    ", - "default": "default", "name": "context", "in": "body", - "isRequired": false + "description": "

    A string label to differentiate this status from the status of other systems. This field is case-insensitive.

    ", + "default": "default" } ], "enabledForGitHubApps": true, @@ -185557,24 +186322,22 @@ "bodyParameters": [ { "type": "string", - "description": "

    A name for the key.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    A name for the key.

    " }, { "type": "string", - "description": "

    The contents of the key.

    ", "name": "key", "in": "body", + "description": "

    The contents of the key.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

    \n

    Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

    ", "name": "read_only", "in": "body", - "isRequired": false + "description": "

    If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

    \n

    Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

    " } ], "enabledForGitHubApps": true, @@ -186677,82 +187440,61 @@ "bodyParameters": [ { "type": "string", - "description": "

    The ref to deploy. This can be a branch, tag, or SHA.

    ", "name": "ref", "in": "body", + "description": "

    The ref to deploy. This can be a branch, tag, or SHA.

    ", "isRequired": true }, { "type": "string", - "description": "

    Specifies a task to execute (e.g., deploy or deploy:migrations).

    ", - "default": "deploy", "name": "task", "in": "body", - "isRequired": false + "description": "

    Specifies a task to execute (e.g., deploy or deploy:migrations).

    ", + "default": "deploy" }, { "type": "boolean", - "description": "

    Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

    ", - "default": true, "name": "auto_merge", "in": "body", - "isRequired": false + "description": "

    Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

    ", + "default": true }, { "type": "array of strings", - "description": "

    The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

    ", "name": "required_contexts", "in": "body", - "isRequired": false + "description": "

    The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

    " }, { - "oneOf": [ - { - "type": "object", - "additionalProperties": true - }, - { - "type": "string", - "description": "JSON payload with extra information about the deployment.", - "default": "" - } - ], + "type": "object or string", "name": "payload", "in": "body", - "type": "object or string", - "description": "

    JSON payload with extra information about the deployment.

    ", - "isRequired": false + "description": "

    JSON payload with extra information about the deployment.

    " }, { "type": "string", - "description": "

    Name for the target deployment environment (e.g., production, staging, qa).

    ", - "default": "production", "name": "environment", "in": "body", - "isRequired": false + "description": "

    Name for the target deployment environment (e.g., production, staging, qa).

    ", + "default": "production" }, { "type": "string or null", - "description": "

    Short description of the deployment.

    ", - "default": "", "name": "description", "in": "body", - "isRequired": false + "description": "

    Short description of the deployment.

    " }, { "type": "boolean", - "description": "

    Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false
    \nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

    ", - "default": false, "name": "transient_environment", "in": "body", - "isRequired": false + "description": "

    Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false
    \nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

    " }, { "type": "boolean", - "description": "

    Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.
    \nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

    ", "name": "production_environment", "in": "body", - "isRequired": false + "description": "

    Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.
    \nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

    " } ], "enabledForGitHubApps": true, @@ -188486,13 +189228,10 @@ ], "bodyParameters": [ { - "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "type": "string", - "examples": [ - "release/*" - ], "name": "name", "in": "body", + "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "isRequired": true } ], @@ -188777,13 +189516,10 @@ ], "bodyParameters": [ { - "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "type": "string", - "examples": [ - "release/*" - ], "name": "name", "in": "body", + "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "isRequired": true } ], @@ -190411,105 +191147,49 @@ "bodyParameters": [ { "type": "integer", - "description": "

    The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).

    ", - "examples": [ - 30 - ], "name": "wait_timer", "in": "body", - "isRequired": false + "description": "

    The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).

    " }, { "type": "array of objects or null", - "description": "

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", "name": "reviewers", "in": "body", - "isRequired": false, + "description": "

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", "childParamsGroups": [ { - "parentName": "reviewers", - "parentType": "items", - "id": "reviewers-items", - "params": [ - { - "type": "string", - "description": "

    The type of reviewer.

    ", - "enum": [ - "User", - "Team" - ], - "examples": [ - "User" - ], - "name": "type", - "in": "body" - }, - { - "type": "integer", - "description": "

    The id of the user or team who can review the deployment

    ", - "examples": [ - 4532992 - ], - "name": "id", - "in": "body" - } + "type": "string", + "name": "type", + "description": "

    The type of reviewer.

    ", + "enum": [ + "User", + "Team" ] + }, + { + "type": "integer", + "name": "id", + "description": "

    The id of the user or team who can review the deployment

    " } ] }, { "type": "object or null", - "description": "

    The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

    ", - "properties": { - "protected_branches": { - "type": "boolean", - "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", - "name": "protected_branches", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", - "isRequired": true, - "childParamsGroups": [] - }, - "custom_branch_policies": { - "type": "boolean", - "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", - "name": "custom_branch_policies", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "protected_branches", - "custom_branch_policies" - ], "name": "deployment_branch_policy", "in": "body", - "isRequired": false, + "description": "

    The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

    ", "childParamsGroups": [ { - "parentName": "deployment_branch_policy", - "parentType": "object", - "id": "deployment_branch_policy-object", - "params": [ - { - "type": "boolean", - "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", - "name": "protected_branches", - "in": "body", - "isRequired": true - }, - { - "type": "boolean", - "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", - "name": "custom_branch_policies", - "in": "body", - "isRequired": true - } - ] + "type": "boolean", + "name": "protected_branches", + "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", + "isRequired": true + }, + { + "type": "boolean", + "name": "custom_branch_policies", + "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", + "isRequired": true } ] } @@ -192070,7 +192750,10 @@ "bodyParameters": [ { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the status. Note: To use the inactive state, you must provide the application/vnd.github.ant-man-preview+json custom media type. When you set a transient deployment to inactive, the deployment will be shown as destroyed in GitHub.

    ", + "isRequired": true, "enum": [ "error", "failure", @@ -192079,61 +192762,48 @@ "queued", "pending", "success" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.

    ", - "default": "", "name": "target_url", "in": "body", - "isRequired": false + "description": "

    The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.

    " }, { "type": "string", - "description": "

    The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: \"\"
    \nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

    ", - "default": "", "name": "log_url", "in": "body", - "isRequired": false + "description": "

    The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: \"\"
    \nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

    " }, { "type": "string", - "description": "

    A short description of the status. The maximum description length is 140 characters.

    ", - "default": "", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the status. The maximum description length is 140 characters.

    " }, { "type": "string", + "name": "environment", + "in": "body", "description": "

    Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa.

    ", "enum": [ "production", "staging", "qa" - ], - "name": "environment", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "description": "

    Sets the URL for accessing your environment. Default: \"\"
    \nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

    ", - "default": "", "name": "environment_url", "in": "body", - "isRequired": false + "description": "

    Sets the URL for accessing your environment. Default: \"\"
    \nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

    " }, { "type": "boolean", - "description": "

    Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

    ", "name": "auto_inactive", "in": "body", - "isRequired": false + "description": "

    Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true\nNote: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

    " } ], "enabledForGitHubApps": true, @@ -196219,24 +196889,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

    ", - "examples": [ - "Very **important** announcement about _nothing_." - ], "name": "announcement", "in": "body", + "description": "

    The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

    ", "isRequired": true }, { "type": "string or null", - "format": "date-time", - "description": "

    The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

    ", - "examples": [ - "\"2021-01-01T00:00:00.000-07:00\"" - ], "name": "expires_at", "in": "body", - "isRequired": false + "description": "

    The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

    " } ], "enabledForGitHubApps": false, @@ -196483,114 +197145,53 @@ "bodyParameters": [ { "type": "string", - "description": "

    Must be passed as \"web\".

    ", "name": "name", "in": "body", + "description": "

    Must be passed as \"web\".

    ", "isRequired": true }, { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", + "description": "

    Key/value pairs to provide settings for this webhook.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    " + }, + { + "type": "string", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ] }, { "type": "array of strings", - "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    ", "name": "events", "in": "body", - "isRequired": false + "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    " }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": false, @@ -196865,107 +197466,45 @@ "bodyParameters": [ { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    " + }, + { + "type": "string", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ] }, { "type": "array of strings", - "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    ", "name": "events", "in": "body", - "isRequired": false + "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    " }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": false, @@ -197190,9 +197729,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The distinguished name (DN) of the LDAP entry to map to a team.

    ", "name": "ldap_dn", "in": "body", + "description": "

    The distinguished name (DN) of the LDAP entry to map to a team.

    ", "isRequired": true } ], @@ -197371,9 +197910,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The distinguished name (DN) of the LDAP entry to map to a team.

    ", "name": "ldap_dn", "in": "body", + "description": "

    The distinguished name (DN) of the LDAP entry to map to a team.

    ", "isRequired": true } ], @@ -198144,9 +198683,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    A JSON string with the attributes enabled and when.

    \n

    The possible values for enabled are true and false. When it's false, the attribute when is ignored and the maintenance mode is turned off. when defines the time period when the maintenance was enabled.

    \n

    The possible values for when are now or any date parseable by mojombo/chronic.

    ", "name": "maintenance", "in": "body", + "description": "

    A JSON string with the attributes enabled and when.

    \n

    The possible values for enabled are true and false. When it's false, the attribute when is ignored and the maintenance mode is turned off. when defines the time period when the maintenance was enabled.

    \n

    The possible values for when are now or any date parseable by mojombo/chronic.

    ", "isRequired": true } ], @@ -198900,9 +199439,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.

    ", "name": "settings", "in": "body", + "description": "

    A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.

    ", "isRequired": true } ], @@ -199005,9 +199544,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The public SSH key.

    ", "name": "authorized_key", "in": "body", + "description": "

    The public SSH key.

    ", "isRequired": true } ], @@ -199078,9 +199617,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The public SSH key.

    ", "name": "authorized_key", "in": "body", + "description": "

    The public SSH key.

    ", "isRequired": true } ], @@ -199151,24 +199690,22 @@ "bodyParameters": [ { "type": "string", - "description": "

    The content of your .ghl license file.

    ", "name": "license", "in": "body", + "description": "

    The content of your .ghl license file.

    ", "isRequired": true }, { "type": "string", - "description": "

    You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.

    ", "name": "password", "in": "body", - "isRequired": false + "description": "

    You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.

    " }, { "type": "string", - "description": "

    An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.

    ", "name": "settings", "in": "body", - "isRequired": false + "description": "

    An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.

    " } ], "enabledForGitHubApps": false, @@ -199206,10 +199743,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The content of your new .ghl license file.

    ", "name": "license", "in": "body", - "isRequired": false + "description": "

    The content of your new .ghl license file.

    " } ], "enabledForGitHubApps": false, @@ -199479,18 +200015,16 @@ ], "bodyParameters": [ { - "description": "

    The state of enforcement for the hook on this repository.

    ", "type": "string", "name": "enforcement", "in": "body", - "isRequired": false + "description": "

    The state of enforcement for the hook on this repository.

    " }, { - "description": "

    Whether repositories can override enforcement.

    ", "type": "boolean", "name": "allow_downstream_configuration", "in": "body", - "isRequired": false + "description": "

    Whether repositories can override enforcement.

    " } ], "enabledForGitHubApps": true, @@ -199653,24 +200187,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The organization's username.

    ", "name": "login", "in": "body", + "description": "

    The organization's username.

    ", "isRequired": true }, { "type": "string", - "description": "

    The login of the user who will manage this organization.

    ", "name": "admin", "in": "body", + "description": "

    The login of the user who will manage this organization.

    ", "isRequired": true }, { "type": "string", - "description": "

    The organization's display name.

    ", "name": "profile_name", "in": "body", - "isRequired": false + "description": "

    The organization's display name.

    " } ], "enabledForGitHubApps": false, @@ -199837,9 +200370,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The organization's new name.

    ", "name": "login", "in": "body", + "description": "

    The organization's new name.

    ", "isRequired": true } ], @@ -200074,16 +200607,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new pre-receive environment's name.

    ", "name": "name", "in": "body", + "description": "

    The new pre-receive environment's name.

    ", "isRequired": true }, { "type": "string", - "description": "

    URL from which to download a tarball of this environment.

    ", "name": "image_url", "in": "body", + "description": "

    URL from which to download a tarball of this environment.

    ", "isRequired": true } ], @@ -200323,17 +200856,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    This pre-receive environment's new name.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    This pre-receive environment's new name.

    " }, { "type": "string", - "description": "

    URL from which to download a tarball of this environment.

    ", "name": "image_url", "in": "body", - "isRequired": false + "description": "

    URL from which to download a tarball of this environment.

    " } ], "enabledForGitHubApps": false, @@ -200866,49 +201397,43 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the hook.

    ", "name": "name", "in": "body", + "description": "

    The name of the hook.

    ", "isRequired": true }, { "type": "string", - "description": "

    The script that the hook runs.

    ", "name": "script", "in": "body", + "description": "

    The script that the hook runs.

    ", "isRequired": true }, { "type": "object", - "description": "

    The GitHub repository where the script is kept.

    ", - "properties": {}, - "additionalProperties": true, "name": "script_repository", "in": "body", + "description": "

    The GitHub repository where the script is kept.

    ", "isRequired": true }, { "type": "object", - "description": "

    The pre-receive environment where the script is executed.

    ", - "properties": {}, - "additionalProperties": true, "name": "environment", "in": "body", + "description": "

    The pre-receive environment where the script is executed.

    ", "isRequired": true }, { "type": "string", - "description": "

    The state of enforcement for this hook. default: disabled

    ", "name": "enforcement", "in": "body", - "isRequired": false + "description": "

    The state of enforcement for this hook. default: disabled

    " }, { "type": "boolean", - "description": "

    Whether enforcement can be overridden at the org or repo level. default: false

    ", "name": "allow_downstream_configuration", "in": "body", - "isRequired": false + "description": "

    Whether enforcement can be overridden at the org or repo level. default: false

    " } ], "enabledForGitHubApps": false, @@ -201255,49 +201780,39 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the hook.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the hook.

    " }, { "type": "string", - "description": "

    The script that the hook runs.

    ", "name": "script", "in": "body", - "isRequired": false + "description": "

    The script that the hook runs.

    " }, { "type": "object", - "description": "

    The GitHub repository where the script is kept.

    ", - "properties": {}, - "additionalProperties": true, "name": "script_repository", "in": "body", - "isRequired": false + "description": "

    The GitHub repository where the script is kept.

    " }, { "type": "object", - "description": "

    The pre-receive environment where the script is executed.

    ", - "properties": {}, - "additionalProperties": true, "name": "environment", "in": "body", - "isRequired": false + "description": "

    The pre-receive environment where the script is executed.

    " }, { "type": "string", - "description": "

    The state of enforcement for this hook.

    ", "name": "enforcement", "in": "body", - "isRequired": false + "description": "

    The state of enforcement for this hook.

    " }, { "type": "boolean", - "description": "

    Whether enforcement can be overridden at the org or repo level.

    ", "name": "allow_downstream_configuration", "in": "body", - "isRequired": false + "description": "

    Whether enforcement can be overridden at the org or repo level.

    " } ], "enabledForGitHubApps": false, @@ -201766,16 +202281,15 @@ ], "bodyParameters": [ { - "description": "

    The state of enforcement for the hook on this repository.

    ", "type": "string", + "name": "enforcement", + "in": "body", + "description": "

    The state of enforcement for the hook on this repository.

    ", "enum": [ "enabled", "disabled", "testing" - ], - "name": "enforcement", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -202518,14 +203032,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -203055,17 +203561,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The user's username.

    ", "name": "login", "in": "body", + "description": "

    The user's username.

    ", "isRequired": true }, { "type": "string", - "description": "

    Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

    ", "name": "email", "in": "body", - "isRequired": false + "description": "

    Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

    " } ], "enabledForGitHubApps": false, @@ -203299,9 +203804,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The user's new username.

    ", "name": "login", "in": "body", + "description": "

    The user's new username.

    ", "isRequired": true } ], @@ -203417,10 +203922,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    A list of scopes.

    ", "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes.

    " } ], "enabledForGitHubApps": false, @@ -203758,14 +204262,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -204561,14 +205057,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -205201,10 +205689,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    ", "name": "reason", "in": "body", - "isRequired": false + "description": "

    The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    " } ], "enabledForGitHubApps": false, @@ -205255,10 +205742,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    ", "name": "reason", "in": "body", - "isRequired": false + "description": "

    The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    " } ], "enabledForGitHubApps": false, @@ -205865,76 +206351,27 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Description of the gist

    ", "type": "string", - "examples": [ - "Example Ruby script" - ], "name": "description", "in": "body", - "isRequired": false + "description": "

    Description of the gist

    " }, { - "description": "

    Names and content for the files that make up the gist

    ", "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "content": { - "description": "

    Content of the file

    ", - "readOnly": false, - "type": "string", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "Content of the file", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "content" - ], - "rawType": "object", - "name": "key" - }, - "examples": [ - { - "hello.rb": { - "content": "puts \"Hello, World!\"" - } - } - ], "name": "files", "in": "body", + "description": "

    Names and content for the files that make up the gist

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "files", - "parentType": "object", - "id": "files-object", - "params": [ + "type": "object", + "name": "key", + "description": "

    A user-defined key to represent an item in files.

    ", + "childParamsGroups": [ { - "description": "

    A user-defined key to represent an item in files.

    ", - "type": "string", - "name": "key", - "in": "body", - "rawType": "string", - "rawDescription": "A key to represent an item in files." - } - ] - }, - { - "parentName": "key", - "parentType": "object", - "id": "key-object", - "params": [ - { - "description": "

    Content of the file

    ", - "readOnly": false, "type": "string", "name": "content", - "in": "body", + "description": "

    Content of the file

    ", "isRequired": true } ] @@ -205942,32 +206379,10 @@ ] }, { - "oneOf": [ - { - "description": "Flag indicating whether the gist is public", - "type": "boolean", - "default": false, - "examples": [ - true - ] - }, - { - "type": "string", - "default": "false", - "enum": [ - "true", - "false" - ], - "examples": [ - "true" - ] - } - ], + "type": "boolean or string", "name": "public", "in": "body", - "type": "boolean or string", - "description": "

    Flag indicating whether the gist is public

    ", - "isRequired": false + "description": "

    Flag indicating whether the gist is public

    " } ], "enabledForGitHubApps": false, @@ -209614,108 +210029,31 @@ ], "bodyParameters": [ { - "description": "

    Description of the gist

    ", "type": "string", - "examples": [ - "Example Ruby script" - ], "name": "description", "in": "body", - "isRequired": false + "description": "

    Description of the gist

    " }, { - "description": "

    Names of files to be updated

    ", "type": "object", - "additionalProperties": { - "type": [ - "object", - "null" - ], - "properties": { - "content": { - "description": "

    The new content of the file

    ", - "type": "string", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The new content of the file", - "childParamsGroups": [] - }, - "filename": { - "description": "

    The new filename for the file

    ", - "type": "string or null", - "name": "filename", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new filename for the file", - "childParamsGroups": [] - } - }, - "anyOf": [ - { - "required": [ - "content" - ] - }, - { - "required": [ - "filename" - ] - }, - { - "type": "object", - "maxProperties": 0 - } - ], - "rawType": "object", - "name": "key" - }, - "examples": [ - { - "hello.rb": { - "content": "blah", - "filename": "goodbye.rb" - } - } - ], "name": "files", "in": "body", - "isRequired": false, + "description": "

    Names of files to be updated

    ", "childParamsGroups": [ { - "parentName": "files", - "parentType": "object", - "id": "files-object", - "params": [ + "type": "object", + "name": "key", + "description": "

    A user-defined key to represent an item in files.

    ", + "childParamsGroups": [ { - "description": "

    A user-defined key to represent an item in files.

    ", - "type": "string", - "name": "key", - "in": "body", - "rawType": "string", - "rawDescription": "A key to represent an item in files." - } - ] - }, - { - "parentName": "key", - "parentType": "object", - "id": "key-object", - "params": [ - { - "description": "

    The new content of the file

    ", "type": "string", "name": "content", - "in": "body" + "description": "

    The new content of the file

    " }, { - "description": "

    The new filename for the file

    ", "type": "string or null", "name": "filename", - "in": "body" + "description": "

    The new filename for the file

    " } ] } @@ -215571,14 +215909,10 @@ ], "bodyParameters": [ { - "description": "

    The comment text.

    ", "type": "string", - "maxLength": 65535, - "examples": [ - "Body of the attachment" - ], "name": "body", "in": "body", + "description": "

    The comment text.

    ", "isRequired": true } ], @@ -216268,14 +216602,10 @@ ], "bodyParameters": [ { - "description": "

    The comment text.

    ", "type": "string", - "maxLength": 65535, - "examples": [ - "Body of the attachment" - ], "name": "body", "in": "body", + "description": "

    The comment text.

    ", "isRequired": true } ], @@ -216689,18 +217019,17 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new blob's content.

    ", "name": "content", "in": "body", + "description": "

    The new blob's content.

    ", "isRequired": true }, { "type": "string", - "description": "

    The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.

    ", - "default": "utf-8", "name": "encoding", "in": "body", - "isRequired": false + "description": "

    The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.

    ", + "default": "utf-8" } ], "enabledForGitHubApps": true, @@ -216931,171 +217260,77 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message

    ", "name": "message", "in": "body", + "description": "

    The commit message

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the tree object this commit points to

    ", "name": "tree", "in": "body", + "description": "

    The SHA of the tree object this commit points to

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

    ", "name": "parents", "in": "body", - "isRequired": false + "description": "

    The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

    " }, { "type": "object", - "description": "

    Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "author", "in": "body", - "isRequired": false, + "description": "

    Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] }, { "type": "object", - "description": "

    Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "childParamsGroups": [] - } - }, "name": "committer", "in": "body", - "isRequired": false, + "description": "

    Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - }, - { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "date", + "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] }, { "type": "string", - "description": "

    The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

    ", "name": "signature", "in": "body", - "isRequired": false + "description": "

    The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

    " } ], "enabledForGitHubApps": true, @@ -217964,27 +218199,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

    ", "name": "ref", "in": "body", + "description": "

    The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA1 value for this reference.

    ", "name": "sha", "in": "body", + "description": "

    The SHA1 value for this reference.

    ", "isRequired": true }, { "type": "string", - "examples": [ - "\"refs/heads/newbranch\"" - ], "name": "key", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -218124,18 +218355,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The SHA1 value to set this reference to

    ", "name": "sha", "in": "body", + "description": "

    The SHA1 value to set this reference to

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

    ", - "default": false, "name": "force", "in": "body", - "isRequired": false + "description": "

    Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

    " } ], "enabledForGitHubApps": true, @@ -218337,109 +218566,59 @@ "bodyParameters": [ { "type": "string", - "description": "

    The tag's name. This is typically a version (e.g., \"v0.0.1\").

    ", "name": "tag", "in": "body", + "description": "

    The tag's name. This is typically a version (e.g., \"v0.0.1\").

    ", "isRequired": true }, { "type": "string", - "description": "

    The tag message.

    ", "name": "message", "in": "body", + "description": "

    The tag message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the git object this is tagging.

    ", "name": "object", "in": "body", + "description": "

    The SHA of the git object this is tagging.

    ", "isRequired": true }, { "type": "string", + "name": "type", + "in": "body", "description": "

    The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.

    ", + "isRequired": true, "enum": [ "commit", "tree", "blob" - ], - "name": "type", - "in": "body", - "isRequired": true + ] }, { "type": "object", - "description": "

    An object with information about the individual creating the tag.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author of the tag

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author of the tag", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author of the tag

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author of the tag", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "tagger", "in": "body", - "isRequired": false, + "description": "

    An object with information about the individual creating the tag.

    ", "childParamsGroups": [ { - "parentName": "tagger", - "parentType": "object", - "id": "tagger-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author of the tag

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author of the tag

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "format": "date-time", - "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author of the tag

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author of the tag

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] } @@ -218874,68 +219053,55 @@ "bodyParameters": [ { "type": "array of objects", - "description": "

    Objects (of path, mode, type, and sha) specifying a tree structure.

    ", "name": "tree", "in": "body", + "description": "

    Objects (of path, mode, type, and sha) specifying a tree structure.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "tree", - "parentType": "items", - "id": "tree-items", - "params": [ - { - "type": "string", - "description": "

    The file referenced in the tree.

    ", - "name": "path", - "in": "body" - }, - { - "type": "string", - "description": "

    The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

    ", - "enum": [ - "100644", - "100755", - "040000", - "160000", - "120000" - ], - "name": "mode", - "in": "body" - }, - { - "type": "string", - "description": "

    Either blob, tree, or commit.

    ", - "enum": [ - "blob", - "tree", - "commit" - ], - "name": "type", - "in": "body" - }, - { - "type": "string or null", - "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", - "name": "sha", - "in": "body" - }, - { - "type": "string", - "description": "

    The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", - "name": "content", - "in": "body" - } + "type": "string", + "name": "path", + "description": "

    The file referenced in the tree.

    " + }, + { + "type": "string", + "name": "mode", + "description": "

    The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

    ", + "enum": [ + "100644", + "100755", + "040000", + "160000", + "120000" ] + }, + { + "type": "string", + "name": "type", + "description": "

    Either blob, tree, or commit.

    ", + "enum": [ + "blob", + "tree", + "commit" + ] + }, + { + "type": "string or null", + "name": "sha", + "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    " + }, + { + "type": "string", + "name": "content", + "description": "

    The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    " } ] }, { "type": "string", - "description": "

    The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

    ", "name": "base_tree", "in": "body", - "isRequired": false + "description": "

    The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

    " } ], "enabledForGitHubApps": true, @@ -226760,7 +226926,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ], "schema": { @@ -229808,63 +229975,41 @@ ], "bodyParameters": [ { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "

    The title of the issue.

    ", + "type": "string or integer", "name": "title", "in": "body", - "type": "string or integer", + "description": "

    The title of the issue.

    ", "isRequired": true }, { "type": "string", - "description": "

    The contents of the issue.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the issue.

    " }, { "type": "string or null", - "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "name": "assignee", "in": "body", - "isRequired": false + "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    " }, { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._" - } - ], - "type": "string or integer or null", + "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "isRequired": false + "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    " }, { - "type": "array of strings or array of objects", - "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", + "type": "array", "name": "labels", "in": "body", - "isRequired": false + "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    " }, { "type": "array of strings", - "description": "

    Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    " } ], "enabledForGitHubApps": true, @@ -230050,7 +230195,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -233279,7 +233425,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -236335,74 +236482,56 @@ ], "bodyParameters": [ { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "

    The title of the issue.

    ", - "type": "string or integer or null", + "type": "null or string or integer or string or integer", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the issue.

    " }, { "type": "string or null", - "description": "

    The contents of the issue.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the issue.

    " }, { "type": "string or null", - "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", "in": "body", - "isRequired": false + "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    State of the issue. Either open or closed.

    ", "enum": [ "open", "closed" - ], - "name": "state", - "in": "body", - "isRequired": false + ] }, { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._" - } - ], - "type": "string or integer or null", + "type": "string or null", + "name": "state_reason", + "in": "body", + "description": "

    The reason for the current state

    " + }, + { + "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "isRequired": false + "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    " }, { - "type": "array of strings or array of objects", - "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", + "type": "array", "name": "labels", "in": "body", - "isRequired": false + "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    " }, { "type": "array of strings", - "description": "

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    " } ], "enabledForGitHubApps": true, @@ -236590,7 +236719,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -239653,16 +239783,15 @@ "bodyParameters": [ { "type": "string", + "name": "lock_reason", + "in": "body", "description": "

    The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
    \n* off-topic
    \n* too heated
    \n* resolved
    \n* spam

    ", "enum": [ "off-topic", "too heated", "resolved", "spam" - ], - "name": "lock_reason", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -243556,10 +243685,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

    " } ], "enabledForGitHubApps": true, @@ -243741,7 +243869,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -246780,10 +246909,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

    " } ], "enabledForGitHubApps": true, @@ -246965,7 +247093,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -251543,9 +251672,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true } ], @@ -253137,9 +253266,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true } ], @@ -254089,7 +254218,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ], @@ -258943,7 +259073,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } }, "schema": { @@ -273883,10 +274014,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

    ", "name": "labels", - "in": "body" + "in": "body", + "description": "

    The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

    " } ], "enabledForGitHubApps": true, @@ -274061,10 +274191,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

    ", "name": "labels", - "in": "body" + "in": "body", + "description": "

    The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

    " } ], "enabledForGitHubApps": true, @@ -274630,24 +274759,22 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "name": "name", "in": "body", + "description": "

    The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "isRequired": true }, { "type": "string", - "description": "

    The hexadecimal color code for the label, without the leading #.

    ", "name": "color", "in": "body", - "isRequired": false + "description": "

    The hexadecimal color code for the label, without the leading #.

    " }, { "type": "string", - "description": "

    A short description of the label. Must be 100 characters or fewer.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the label. Must be 100 characters or fewer.

    " } ], "enabledForGitHubApps": true, @@ -274951,24 +275078,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "name": "new_name", "in": "body", - "isRequired": false + "description": "

    The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    " }, { "type": "string", - "description": "

    The hexadecimal color code for the label, without the leading #.

    ", "name": "color", "in": "body", - "isRequired": false + "description": "

    The hexadecimal color code for the label, without the leading #.

    " }, { "type": "string", - "description": "

    A short description of the label. Must be 100 characters or fewer.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the label. Must be 100 characters or fewer.

    " } ], "enabledForGitHubApps": true, @@ -275821,37 +275945,33 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the milestone.

    ", "name": "title", "in": "body", + "description": "

    The title of the milestone.

    ", "isRequired": true }, { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the milestone. Either open or closed.

    ", "enum": [ "open", "closed" ], - "default": "open", - "name": "state", - "in": "body", - "isRequired": false + "default": "open" }, { "type": "string", - "description": "

    A description of the milestone.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A description of the milestone.

    " }, { "type": "string", - "format": "date-time", - "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "due_on", "in": "body", - "isRequired": false + "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ], "enabledForGitHubApps": true, @@ -276694,37 +276814,32 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the milestone.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the milestone.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the milestone. Either open or closed.

    ", "enum": [ "open", "closed" ], - "default": "open", - "name": "state", - "in": "body", - "isRequired": false + "default": "open" }, { "type": "string", - "description": "

    A description of the milestone.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A description of the milestone.

    " }, { "type": "string", - "format": "date-time", - "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "due_on", "in": "body", - "isRequired": false + "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ], "enabledForGitHubApps": true, @@ -293588,33 +293703,28 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The Markdown text to render in HTML.

    ", "type": "string", "name": "text", "in": "body", + "description": "

    The Markdown text to render in HTML.

    ", "isRequired": true }, { + "type": "string", + "name": "mode", + "in": "body", "description": "

    The rendering mode. Can be either markdown or gfm.

    ", "enum": [ "markdown", "gfm" ], - "default": "markdown", - "type": "string", - "examples": [ - "markdown" - ], - "name": "mode", - "in": "body", - "isRequired": false + "default": "markdown" }, { - "description": "

    The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

    ", "type": "string", "name": "context", "in": "body", - "isRequired": false + "description": "

    The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

    " } ], "enabledForGitHubApps": true, @@ -295977,14 +296087,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -296484,55 +296586,40 @@ "parameters": [], "bodyParameters": [ { - "description": "

    A list of scopes that this authorization is in.

    ", "type": "array of strings or null", - "examples": [ - "public_repo", - "user" - ], "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes that this authorization is in.

    " }, { - "description": "

    A note to remind you what the OAuth token is for.

    ", "type": "string", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    A note to remind you what the OAuth token is for.

    " }, { - "description": "

    A URL to remind you what app the OAuth token is for.

    ", "type": "string", "name": "note_url", "in": "body", - "isRequired": false + "description": "

    A URL to remind you what app the OAuth token is for.

    " }, { - "description": "

    The OAuth app client key for which to create the token.

    ", - "maxLength": 20, "type": "string", "name": "client_id", "in": "body", - "isRequired": false + "description": "

    The OAuth app client key for which to create the token.

    " }, { - "description": "

    The OAuth app client secret for which to create the token.

    ", - "maxLength": 40, "type": "string", "name": "client_secret", "in": "body", - "isRequired": false + "description": "

    The OAuth app client secret for which to create the token.

    " }, { - "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    ", "type": "string", "name": "fingerprint", "in": "body", - "isRequired": false + "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    " } ], "enabledForGitHubApps": false, @@ -296876,14 +296963,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -297401,47 +297480,35 @@ ], "bodyParameters": [ { - "description": "

    The OAuth app client secret for which to create the token.

    ", - "maxLength": 40, "type": "string", "name": "client_secret", "in": "body", + "description": "

    The OAuth app client secret for which to create the token.

    ", "isRequired": true }, { - "description": "

    A list of scopes that this authorization is in.

    ", "type": "array of strings or null", - "examples": [ - "public_repo", - "user" - ], "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes that this authorization is in.

    " }, { - "description": "

    A note to remind you what the OAuth token is for.

    ", "type": "string", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    A note to remind you what the OAuth token is for.

    " }, { - "description": "

    A URL to remind you what app the OAuth token is for.

    ", "type": "string", "name": "note_url", "in": "body", - "isRequired": false + "description": "

    A URL to remind you what app the OAuth token is for.

    " }, { - "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    ", "type": "string", "name": "fingerprint", "in": "body", - "isRequired": false + "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    " } ], "enabledForGitHubApps": false, @@ -297787,14 +297854,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -298598,14 +298657,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -299132,40 +299183,29 @@ ], "bodyParameters": [ { - "description": "

    The OAuth app client secret for which to create the token.

    ", - "maxLength": 40, "type": "string", "name": "client_secret", "in": "body", + "description": "

    The OAuth app client secret for which to create the token.

    ", "isRequired": true }, { - "description": "

    A list of scopes that this authorization is in.

    ", "type": "array of strings or null", - "examples": [ - "public_repo", - "user" - ], "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes that this authorization is in.

    " }, { - "description": "

    A note to remind you what the OAuth token is for.

    ", "type": "string", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    A note to remind you what the OAuth token is for.

    " }, { - "description": "

    A URL to remind you what app the OAuth token is for.

    ", "type": "string", "name": "note_url", "in": "body", - "isRequired": false + "description": "

    A URL to remind you what app the OAuth token is for.

    " } ], "enabledForGitHubApps": false, @@ -299512,14 +299552,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -300324,14 +300356,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -301165,14 +301189,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -301677,53 +301693,40 @@ ], "bodyParameters": [ { - "description": "

    A list of scopes that this authorization is in.

    ", "type": "array of strings or null", - "examples": [ - "public_repo", - "user" - ], "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes that this authorization is in.

    " }, { - "description": "

    A list of scopes to add to this authorization.

    ", "type": "array of strings", "name": "add_scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes to add to this authorization.

    " }, { - "description": "

    A list of scopes to remove from this authorization.

    ", "type": "array of strings", "name": "remove_scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes to remove from this authorization.

    " }, { - "description": "

    A note to remind you what the OAuth token is for.

    ", "type": "string", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    A note to remind you what the OAuth token is for.

    " }, { - "description": "

    A URL to remind you what app the OAuth token is for.

    ", "type": "string", "name": "note_url", "in": "body", - "isRequired": false + "description": "

    A URL to remind you what app the OAuth token is for.

    " }, { - "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    ", "type": "string", "name": "fingerprint", "in": "body", - "isRequired": false + "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    " } ], "enabledForGitHubApps": false, @@ -302061,14 +302064,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -303261,69 +303256,62 @@ "bodyParameters": [ { "type": "string", - "description": "

    Billing email address. This address is not publicized.

    ", "name": "billing_email", "in": "body", - "isRequired": false + "description": "

    Billing email address. This address is not publicized.

    " }, { "type": "string", - "description": "

    The company name.

    ", "name": "company", "in": "body", - "isRequired": false + "description": "

    The company name.

    " }, { "type": "string", - "description": "

    The publicly visible email address.

    ", "name": "email", "in": "body", - "isRequired": false + "description": "

    The publicly visible email address.

    " }, { "type": "string", - "description": "

    The Twitter username of the company.

    ", "name": "twitter_username", "in": "body", - "isRequired": false + "description": "

    The Twitter username of the company.

    " }, { "type": "string", - "description": "

    The location.

    ", "name": "location", "in": "body", - "isRequired": false + "description": "

    The location.

    " }, { "type": "string", - "description": "

    The shorthand name of the company.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The shorthand name of the company.

    " }, { "type": "string", - "description": "

    The description of the company.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the company.

    " }, { "type": "boolean", - "description": "

    Whether an organization can use organization projects.

    ", "name": "has_organization_projects", "in": "body", - "isRequired": false + "description": "

    Whether an organization can use organization projects.

    " }, { "type": "boolean", - "description": "

    Whether repositories that belong to the organization can use repository projects.

    ", "name": "has_repository_projects", "in": "body", - "isRequired": false + "description": "

    Whether repositories that belong to the organization can use repository projects.

    " }, { "type": "string", + "name": "default_repository_permission", + "in": "body", "description": "

    Default permission level members have for organization repositories.

    ", "enum": [ "read", @@ -303331,69 +303319,56 @@ "admin", "none" ], - "default": "read", - "name": "default_repository_permission", - "in": "body", - "isRequired": false + "default": "read" }, { "type": "boolean", - "description": "

    Whether of non-admin organization members can create repositories. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

    ", - "default": true, "name": "members_can_create_repositories", "in": "body", - "isRequired": false + "description": "

    Whether of non-admin organization members can create repositories. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

    ", + "default": true }, { "type": "boolean", - "description": "

    Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_internal_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_private_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "string", + "name": "members_allowed_repository_creation_type", + "in": "body", "description": "

    Specifies which types of repositories non-admin organization members can create.\nNote: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See the parameter deprecation notice in the operation description for details.

    ", "enum": [ "all", "private", "none" - ], - "name": "members_allowed_repository_creation_type", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.

    ", - "default": true, "name": "members_can_create_pages", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.

    ", + "default": true }, { "type": "string", - "examples": [ - "\"http://github.blog\"" - ], "name": "blog", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -304327,14 +304302,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -306064,15 +306031,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role to give the user in the organization. Can be one of:
    \n* admin - The user will become an owner of the organization.
    \n* member - The user will become a non-owner member of the organization.

    ", "enum": [ "admin", "member" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -307912,13 +307878,13 @@ "bodyParameters": [ { "type": "string", - "description": "

    The state that the membership should be in. Only \"active\" will be accepted.

    ", - "enum": [ - "active" - ], "name": "state", "in": "body", - "isRequired": true + "description": "

    The state that the membership should be in. Only \"active\" will be accepted.

    ", + "isRequired": true, + "enum": [ + "active" + ] } ], "enabledForGitHubApps": false, @@ -308630,11 +308596,9 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

    ", - "default": false, "name": "async", "in": "body", - "isRequired": false + "description": "

    When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

    " } ], "enabledForGitHubApps": true, @@ -308992,203 +308956,66 @@ "bodyParameters": [ { "type": "string", - "description": "

    Must be passed as \"web\".

    ", "name": "name", "in": "body", + "description": "

    Must be passed as \"web\".

    ", "isRequired": true }, { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - }, - "username": { - "type": "string", - "examples": [ - "\"kdaigle\"" - ], - "name": "username", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "password": { - "type": "string", - "examples": [ - "\"password\"" - ], - "name": "password", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"kdaigle\"" - ], - "name": "username", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"password\"" - ], - "name": "password", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "username", + "description": "" + }, + { + "type": "string", + "name": "password", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, @@ -309595,162 +309422,54 @@ "bodyParameters": [ { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true }, { "type": "string", - "examples": [ - "\"web\"" - ], "name": "name", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -310122,53 +309841,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": true, @@ -311189,77 +310882,35 @@ "bodyParameters": [ { "type": "string", + "name": "build_type", + "in": "body", "description": "

    The process in which the Page will be built. Possible values are \"legacy\" and \"workflow\".

    ", "enum": [ "legacy", "workflow" - ], - "name": "build_type", - "in": "body", - "isRequired": false + ] }, { "type": "object", + "name": "source", + "in": "body", "description": "

    The source branch and directory used to publish your Pages site.

    ", - "properties": { - "branch": { + "childParamsGroups": [ + { "type": "string", - "description": "

    The repository branch used to publish your site's source files.

    ", "name": "branch", - "in": "body", - "rawType": "string", - "rawDescription": "The repository branch used to publish your site's source files.", - "isRequired": true, - "childParamsGroups": [] + "description": "

    The repository branch used to publish your site's source files.

    ", + "isRequired": true }, - "path": { + { "type": "string", + "name": "path", "description": "

    The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: /

    ", "enum": [ "/", "/docs" ], - "default": "/", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "branch" - ], - "name": "source", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "source", - "parentType": "object", - "id": "source-object", - "params": [ - { - "type": "string", - "description": "

    The repository branch used to publish your site's source files.

    ", - "name": "branch", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: /

    ", - "enum": [ - "/", - "/docs" - ], - "default": "/", - "name": "path", - "in": "body", - "isRequired": false - } - ] + "default": "/" } ] } @@ -311545,75 +311196,37 @@ "bodyParameters": [ { "type": "string or null", - "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    ", "name": "cname", "in": "body", - "isRequired": false + "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    " }, { "type": "boolean", - "description": "

    Specify whether HTTPS should be enforced for the repository.

    ", "name": "https_enforced", "in": "body", - "isRequired": false + "description": "

    Specify whether HTTPS should be enforced for the repository.

    " }, { "type": "boolean", - "description": "

    Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

    ", "name": "public", "in": "body", - "isRequired": false + "description": "

    Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

    " }, { "type": "string", + "name": "build_type", + "in": "body", "description": "

    The process by which the GitHub Pages site will be built. workflow means that the site is built by a custom GitHub Actions workflow. legacy means that the site is built by GitHub when changes are pushed to a specific branch.

    ", "enum": [ "legacy", "workflow" - ], - "name": "build_type", - "in": "body", - "isRequired": false + ] }, { - "anyOf": [ - { - "type": "string", - "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", - "enum": [ - "gh-pages", - "master", - "master /docs" - ] - }, - { - "type": "object", - "description": "Update the source for the repository. Must include the branch name and path.", - "properties": { - "branch": { - "type": "string", - "description": "The repository branch used to publish your site's source files." - }, - "path": { - "type": "string", - "description": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.", - "enum": [ - "/", - "/docs" - ] - } - }, - "required": [ - "branch", - "path" - ] - } - ], + "type": "", "name": "source", "in": "body", - "type": "", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -313199,17 +312812,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the project.

    ", "name": "name", "in": "body", + "description": "

    The name of the project.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the project.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The description of the project.

    " } ], "enabledForGitHubApps": true, @@ -313990,54 +313602,40 @@ ], "bodyParameters": [ { - "description": "

    Name of the project

    ", "type": "string", - "examples": [ - "Week One Sprint" - ], "name": "name", "in": "body", - "isRequired": false + "description": "

    Name of the project

    " }, { - "description": "

    Body of the project

    ", "type": "string or null", - "examples": [ - "This project represents the sprint of the first week in January" - ], "name": "body", "in": "body", - "isRequired": false + "description": "

    Body of the project

    " }, { - "description": "

    State of the project; either 'open' or 'closed'

    ", "type": "string", - "examples": [ - "open" - ], "name": "state", "in": "body", - "isRequired": false + "description": "

    State of the project; either 'open' or 'closed'

    " }, { - "description": "

    The baseline permission that all organization members have on this project

    ", "type": "string", + "name": "organization_permission", + "in": "body", + "description": "

    The baseline permission that all organization members have on this project

    ", "enum": [ "read", "write", "admin", "none" - ], - "name": "organization_permission", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether or not this project can be seen by everyone.

    ", "type": "boolean", "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether or not this project can be seen by everyone.

    " } ], "enabledForGitHubApps": true, @@ -314956,17 +314554,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the project.

    ", "name": "name", "in": "body", + "description": "

    The name of the project.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the project.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The description of the project.

    " } ], "enabledForGitHubApps": true, @@ -315356,24 +314953,17 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Name of the project

    ", "type": "string", - "examples": [ - "Week One Sprint" - ], "name": "name", "in": "body", + "description": "

    Name of the project

    ", "isRequired": true }, { - "description": "

    Body of the project

    ", "type": "string or null", - "examples": [ - "This project represents the sprint of the first week in January" - ], "name": "body", "in": "body", - "isRequired": false + "description": "

    Body of the project

    " } ], "enabledForGitHubApps": true, @@ -316543,24 +316133,16 @@ ], "bodyParameters": [ { - "description": "

    The project card's note

    ", "type": "string or null", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    The project card's note

    " }, { - "description": "

    Whether or not the card is archived

    ", "type": "boolean", - "examples": [ - false - ], "name": "archived", "in": "body", - "isRequired": false + "description": "

    Whether or not the card is archived

    " } ], "enabledForGitHubApps": true, @@ -316994,25 +316576,17 @@ ], "bodyParameters": [ { - "description": "

    The position of the card in a column. Can be one of: top, bottom, or after:<card_id> to place after the specified card.

    ", "type": "string", - "pattern": "^(?:top|bottom|after:\\d+)$", - "examples": [ - "bottom" - ], "name": "position", "in": "body", + "description": "

    The position of the card in a column. Can be one of: top, bottom, or after:<card_id> to place after the specified card.

    ", "isRequired": true }, { - "description": "

    The unique identifier of the column the card should be moved to

    ", "type": "integer", - "examples": [ - 42 - ], "name": "column_id", "in": "body", - "isRequired": false + "description": "

    The unique identifier of the column the card should be moved to

    " } ], "enabledForGitHubApps": true, @@ -317488,33 +317062,24 @@ ], "bodyParameters": [ { - "description": "

    The project card's note

    ", "type": "string or null", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", + "description": "

    The project card's note

    ", "isRequired": true }, { - "description": "

    The unique identifier of the content associated with the card

    ", "type": "integer", - "examples": [ - 42 - ], "name": "content_id", "in": "body", + "description": "

    The unique identifier of the content associated with the card

    ", "isRequired": true }, { - "description": "

    The piece of content associated with the card

    ", "type": "string", - "examples": [ - "PullRequest" - ], "name": "content_type", "in": "body", + "description": "

    The piece of content associated with the card

    ", "isRequired": true } ], @@ -318184,20 +317749,16 @@ ], "bodyParameters": [ { + "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant the collaborator.

    ", "enum": [ "read", "write", "admin" ], - "default": "write", - "type": "string", - "examples": [ - "write" - ], - "name": "permission", - "in": "body", - "isRequired": false + "default": "write" } ], "enabledForGitHubApps": true, @@ -318781,13 +318342,10 @@ ], "bodyParameters": [ { - "description": "

    Name of the project column

    ", "type": "string", - "examples": [ - "Remaining tasks" - ], "name": "name", "in": "body", + "description": "

    Name of the project column

    ", "isRequired": true } ], @@ -318997,14 +318555,10 @@ ], "bodyParameters": [ { - "description": "

    The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

    ", "type": "string", - "pattern": "^(?:first|last|after:\\d+)$", - "examples": [ - "last" - ], "name": "position", "in": "body", + "description": "

    The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

    ", "isRequired": true } ], @@ -319248,13 +318802,10 @@ ], "bodyParameters": [ { - "description": "

    Name of the project column

    ", "type": "string", - "examples": [ - "Remaining tasks" - ], "name": "name", "in": "body", + "description": "

    Name of the project column

    ", "isRequired": true } ], @@ -324966,55 +324517,47 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the new pull request. Required unless issue is specified.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the new pull request. Required unless issue is specified.

    " }, { "type": "string", - "description": "

    The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

    ", "name": "head", "in": "body", + "description": "

    The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

    ", "isRequired": true }, { "type": "string", - "description": "

    The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

    ", "name": "base", "in": "body", + "description": "

    The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    The contents of the pull request.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the pull request.

    " }, { "type": "boolean", - "description": "

    Indicates whether maintainers can modify the pull request.

    ", "name": "maintainer_can_modify", "in": "body", - "isRequired": false + "description": "

    Indicates whether maintainers can modify the pull request.

    " }, { "type": "boolean", - "description": "

    Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

    ", "name": "draft", "in": "body", - "isRequired": false + "description": "

    Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

    " }, { "type": "integer", - "description": "

    An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified.

    ", - "examples": [ - 1 - ], "name": "issue", "in": "body", - "isRequired": false + "description": "

    An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified.

    " } ], "enabledForGitHubApps": true, @@ -332651,42 +332194,37 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the pull request.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the pull request.

    " }, { "type": "string", - "description": "

    The contents of the pull request.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the pull request.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    State of this Pull Request. Either open or closed.

    ", "enum": [ "open", "closed" - ], - "name": "state", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "description": "

    The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

    ", "name": "base", "in": "body", - "isRequired": false + "description": "

    The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

    " }, { "type": "boolean", - "description": "

    Indicates whether maintainers can modify the pull request.

    ", "name": "maintainer_can_modify", "in": "body", - "isRequired": false + "description": "

    Indicates whether maintainers can modify the pull request.

    " } ], "enabledForGitHubApps": true, @@ -337630,36 +337168,32 @@ "bodyParameters": [ { "type": "string", - "description": "

    Title for the automatic commit message.

    ", "name": "commit_title", "in": "body", - "isRequired": false + "description": "

    Title for the automatic commit message.

    " }, { "type": "string", - "description": "

    Extra detail to append to automatic commit message.

    ", "name": "commit_message", "in": "body", - "isRequired": false + "description": "

    Extra detail to append to automatic commit message.

    " }, { "type": "string", - "description": "

    SHA that pull request head must match to allow merge.

    ", "name": "sha", "in": "body", - "isRequired": false + "description": "

    SHA that pull request head must match to allow merge.

    " }, { "type": "string", + "name": "merge_method", + "in": "body", "description": "

    Merge method to use. Possible values are merge, squash or rebase. Default is merge.

    ", "enum": [ "merge", "squash", "rebase" - ], - "name": "merge_method", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -337777,10 +337311,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

    ", "name": "expected_head_sha", "in": "body", - "isRequired": false + "description": "

    The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

    " } ], "enabledForGitHubApps": false, @@ -339177,9 +338710,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the reply to the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the reply to the review comment.

    ", "isRequired": true } ], @@ -340557,82 +340090,70 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the review comment.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

    ", "name": "commit_id", "in": "body", + "description": "

    The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

    ", "isRequired": true }, { "type": "string", - "description": "

    The relative path to the file that necessitates a comment.

    ", "name": "path", "in": "body", + "description": "

    The relative path to the file that necessitates a comment.

    ", "isRequired": true }, { "type": "integer", - "description": "

    Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    ", - "deprecated": true, - "x-github": { - "deprecationDate": "2022-11-01" - }, "name": "position", "in": "body", - "isRequired": false + "description": "

    Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    " }, { "type": "string", + "name": "side", + "in": "body", "description": "

    Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

    ", "enum": [ "LEFT", "RIGHT" - ], - "name": "side", - "in": "body", - "isRequired": false + ] }, { "type": "integer", - "description": "

    Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

    ", "name": "line", "in": "body", + "description": "

    Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

    ", "isRequired": true }, { "type": "integer", - "description": "

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

    ", "name": "start_line", "in": "body", - "isRequired": false + "description": "

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

    " }, { "type": "string", + "name": "start_side", + "in": "body", "description": "

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

    ", "enum": [ "LEFT", "RIGHT", "side" - ], - "name": "start_side", - "in": "body", - "isRequired": false + ] }, { "type": "integer", - "description": "

    The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

    ", - "examples": [ - 2 - ], "name": "in_reply_to", "in": "body", - "isRequired": false + "description": "

    The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

    " } ], "enabledForGitHubApps": true, @@ -341283,9 +340804,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the review comment.

    ", "isRequired": true } ], @@ -342403,17 +341924,15 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of user logins that will be requested.

    ", "name": "reviewers", "in": "body", - "isRequired": false + "description": "

    An array of user logins that will be requested.

    " }, { "type": "array of strings", - "description": "

    An array of team slugs that will be requested.

    ", "name": "team_reviewers", "in": "body", - "isRequired": false + "description": "

    An array of team slugs that will be requested.

    " } ], "enabledForGitHubApps": true, @@ -347938,17 +347457,16 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of user logins that will be removed.

    ", "name": "reviewers", "in": "body", + "description": "

    An array of user logins that will be removed.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    An array of team slugs that will be removed.

    ", "name": "team_reviewers", "in": "body", - "isRequired": false + "description": "

    An array of team slugs that will be removed.

    " } ], "enabledForGitHubApps": true, @@ -353852,104 +353370,69 @@ "bodyParameters": [ { "type": "string", - "description": "

    The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

    ", "name": "commit_id", "in": "body", - "isRequired": false + "description": "

    The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

    " }, { "type": "string", - "description": "

    Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

    " }, { "type": "string", + "name": "event", + "in": "body", "description": "

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

    ", "enum": [ "APPROVE", "REQUEST_CHANGES", "COMMENT" - ], - "name": "event", - "in": "body", - "isRequired": false + ] }, { "type": "array of objects", - "description": "

    Use the following table to specify the location, destination, and contents of the draft review comment.

    ", "name": "comments", "in": "body", - "isRequired": false, + "description": "

    Use the following table to specify the location, destination, and contents of the draft review comment.

    ", "childParamsGroups": [ { - "parentName": "comments", - "parentType": "items", - "id": "comments-items", - "params": [ - { - "type": "string", - "description": "

    The relative path to the file that necessitates a review comment.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

    ", - "name": "position", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Text of the review comment.

    ", - "name": "body", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "examples": [ - 28 - ], - "name": "line", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "RIGHT" - ], - "name": "side", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "integer", - "examples": [ - 26 - ], - "name": "start_line", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "LEFT" - ], - "name": "start_side", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "path", + "description": "

    The relative path to the file that necessitates a review comment.

    ", + "isRequired": true + }, + { + "type": "integer", + "name": "position", + "description": "

    The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

    " + }, + { + "type": "string", + "name": "body", + "description": "

    Text of the review comment.

    ", + "isRequired": true + }, + { + "type": "integer", + "name": "line", + "description": "" + }, + { + "type": "string", + "name": "side", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + }, + { + "type": "string", + "name": "start_side", + "description": "" } ] } @@ -354796,9 +354279,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The body text of the pull request review.

    ", "name": "body", "in": "body", + "description": "

    The body text of the pull request review.

    ", "isRequired": true } ], @@ -356269,23 +355752,19 @@ "bodyParameters": [ { "type": "string", - "description": "

    The message for the pull request review dismissal

    ", "name": "message", "in": "body", + "description": "

    The message for the pull request review dismissal

    ", "isRequired": true }, { "type": "string", - "enum": [ - "DISMISS" - ], - "examples": [ - "\"DISMISS\"" - ], "name": "event", "in": "body", "description": "", - "isRequired": false + "enum": [ + "DISMISS" + ] } ], "enabledForGitHubApps": true, @@ -356711,22 +356190,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The body text of the pull request review

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The body text of the pull request review

    " }, { "type": "string", + "name": "event", + "in": "body", "description": "

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.

    ", + "isRequired": true, "enum": [ "APPROVE", "REQUEST_CHANGES", "COMMENT" - ], - "name": "event", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -357844,7 +357322,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -357854,10 +357335,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -358890,7 +358368,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -358900,10 +358381,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -359991,7 +359469,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the commit comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -360001,10 +359482,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -361037,7 +360515,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the issue comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -361047,10 +360528,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -362083,7 +361561,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the issue.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -362093,10 +361574,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -363125,7 +362603,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the pull request review comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -363135,10 +362616,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -364169,7 +363647,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the release.

    ", + "isRequired": true, "enum": [ "+1", "laugh", @@ -364177,10 +363658,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -365205,7 +364683,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -365215,10 +364696,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -365874,7 +365352,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -365884,10 +365365,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -366936,47 +366414,40 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the tag.

    ", "name": "tag_name", "in": "body", + "description": "

    The name of the tag.

    ", "isRequired": true }, { "type": "string", - "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    ", "name": "target_commitish", "in": "body", - "isRequired": false + "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    " }, { "type": "string", - "description": "

    The name of the release.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the release.

    " }, { "type": "string", - "description": "

    Text describing the contents of the tag.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Text describing the contents of the tag.

    " }, { "type": "boolean", - "description": "

    true to create a draft (unpublished) release, false to create a published one.

    ", - "default": false, "name": "draft", "in": "body", - "isRequired": false + "description": "

    true to create a draft (unpublished) release, false to create a published one.

    " }, { "type": "boolean", - "description": "

    true to identify the release as a prerelease. false to identify the release as a full release.

    ", - "default": false, "name": "prerelease", "in": "body", - "isRequired": false + "description": "

    true to identify the release as a prerelease. false to identify the release as a full release.

    " } ], "enabledForGitHubApps": true, @@ -369860,45 +369331,39 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the tag.

    ", "name": "tag_name", "in": "body", - "isRequired": false + "description": "

    The name of the tag.

    " }, { "type": "string", - "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    ", "name": "target_commitish", "in": "body", - "isRequired": false + "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    " }, { "type": "string", - "description": "

    The name of the release.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the release.

    " }, { "type": "string", - "description": "

    Text describing the contents of the tag.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Text describing the contents of the tag.

    " }, { "type": "boolean", - "description": "

    true makes the release a draft, and false publishes the release.

    ", "name": "draft", "in": "body", - "isRequired": false + "description": "

    true makes the release a draft, and false publishes the release.

    " }, { "type": "boolean", - "description": "

    true to identify the release as a prerelease, false to identify the release as a full release.

    ", "name": "prerelease", "in": "body", - "isRequired": false + "description": "

    true to identify the release as a prerelease, false to identify the release as a full release.

    " } ], "enabledForGitHubApps": true, @@ -371046,27 +370511,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The file name of the asset.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The file name of the asset.

    " }, { "type": "string", - "description": "

    An alternate short description of the asset. Used in place of the filename.

    ", "name": "label", "in": "body", - "isRequired": false + "description": "

    An alternate short description of the asset. Used in place of the filename.

    " }, { "type": "string", - "examples": [ - "\"uploaded\"" - ], "name": "state", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -374520,191 +373979,165 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the repository.

    ", "name": "name", "in": "body", + "description": "

    The name of the repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short description of the repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { "type": "string", - "description": "

    A URL with more information about the repository.

    ", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { "type": "boolean", - "description": "

    Whether the repository is private.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether the repository is private.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.

    ", "enum": [ "public", "private", "internal" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Either true to enable issues for this repository or false to disable them.

    ", - "default": true, "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Either true to enable issues for this repository or false to disable them.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", - "default": true, "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", - "default": true, "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    ", - "default": false, "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    " }, { "type": "integer", - "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    ", "name": "team_id", "in": "body", - "isRequired": false + "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    " }, { "type": "boolean", - "description": "

    Pass true to create an initial commit with empty README.

    ", - "default": false, "name": "auto_init", "in": "body", - "isRequired": false + "description": "

    Pass true to create an initial commit with empty README.

    " }, { "type": "string", - "description": "

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

    ", "name": "gitignore_template", "in": "body", - "isRequired": false + "description": "

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

    " }, { "type": "string", - "description": "

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

    ", "name": "license_template", "in": "body", - "isRequired": false + "description": "

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", - "default": true, "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", - "default": true, "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", - "default": true, "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    ", - "default": false, "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    ", - "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -387763,295 +387196,78 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the repository.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the repository.

    " }, { "type": "string", - "description": "

    A short description of the repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { "type": "string", - "description": "

    A URL with more information about the repository.

    ", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { "type": "boolean", - "description": "

    Either true to make the repository private or false to make it public. Default: false.
    \nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Either true to make the repository private or false to make it public. Default: false.
    \nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal.\"

    ", "enum": [ "public", "private", "internal" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { "type": "object or null", - "description": "

    Specify which security and analysis features to enable or disable for the repository.

    \n

    To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

    \n

    For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.

    \n

    You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

    ", - "properties": { - "advanced_security": { - "type": "object", - "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "advanced_security", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", - "childParamsGroups": [ - { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - "secret_scanning": { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", - "childParamsGroups": [ - { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - "secret_scanning_push_protection": { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning_push_protection", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", - "childParamsGroups": [ - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - } - }, "name": "security_and_analysis", "in": "body", - "isRequired": false, + "description": "

    Specify which security and analysis features to enable or disable for the repository.

    \n

    To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

    \n

    For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.

    \n

    You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

    ", "childParamsGroups": [ { - "parentName": "security_and_analysis", - "parentType": "object", - "id": "security_and_analysis-object", - "params": [ + "type": "object", + "name": "advanced_security", + "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", + "childParamsGroups": [ { - "type": "object", - "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "advanced_security", - "in": "body", - "childParamsGroups": [ - { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning", - "in": "body", - "childParamsGroups": [ - { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning_push_protection", - "in": "body", - "childParamsGroups": [ - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] + "type": "string", + "name": "status", + "description": "

    Can be enabled or disabled.

    " } ] }, { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ + "type": "object", + "name": "secret_scanning", + "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    Can be enabled or disabled.

    ", "name": "status", - "in": "body" + "description": "

    Can be enabled or disabled.

    " } ] }, { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ + "type": "object", + "name": "secret_scanning_push_protection", + "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    Can be enabled or disabled.

    ", "name": "status", - "in": "body" - } - ] - }, - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" + "description": "

    Can be enabled or disabled.

    " } ] } @@ -388059,152 +387275,129 @@ }, { "type": "boolean", - "description": "

    Either true to enable issues for this repository or false to disable them.

    ", - "default": true, "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Either true to enable issues for this repository or false to disable them.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", - "default": true, "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", - "default": true, "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    ", - "default": false, "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    " }, { "type": "string", - "description": "

    Updates the default branch for this repository.

    ", "name": "default_branch", "in": "body", - "isRequired": false + "description": "

    Updates the default branch for this repository.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", - "default": true, "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", - "default": true, "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", - "default": true, "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    ", - "default": false, "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    " }, { "type": "boolean", - "description": "

    Either true to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.

    ", - "default": false, "name": "allow_update_branch", "in": "body", - "isRequired": false + "description": "

    Either true to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    ", - "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    true to archive this repository. Note: You cannot unarchive repositories through the API.

    ", - "default": false, "name": "archived", "in": "body", - "isRequired": false + "description": "

    true to archive this repository. Note: You cannot unarchive repositories through the API.

    " }, { "type": "boolean", - "description": "

    Either true to allow private forks, or false to prevent private forks.

    ", - "default": false, "name": "allow_forking", "in": "body", - "isRequired": false + "description": "

    Either true to allow private forks, or false to prevent private forks.

    " } ], "enabledForGitHubApps": true, @@ -394270,21 +393463,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    A custom webhook event name. Must be 100 characters or fewer.

    ", - "minLength": 1, - "maxLength": 100, "name": "event_type", "in": "body", + "description": "

    A custom webhook event name. Must be 100 characters or fewer.

    ", "isRequired": true }, { "type": "object", - "description": "

    JSON payload with extra information about the webhook event that your action or workflow may use.

    ", - "additionalProperties": true, - "maxProperties": 10, "name": "client_payload", "in": "body", - "isRequired": false + "description": "

    JSON payload with extra information about the webhook event that your action or workflow may use.

    " } ], "enabledForGitHubApps": true, @@ -394967,9 +394155,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

    ", "name": "names", "in": "body", + "description": "

    An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

    ", "isRequired": true } ], @@ -395078,17 +394266,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The username or organization name the repository will be transferred to.

    ", "name": "new_owner", "in": "body", + "description": "

    The username or organization name the repository will be transferred to.

    ", "isRequired": true }, { "type": "array of integers", - "description": "

    ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

    ", "name": "team_ids", "in": "body", - "isRequired": false + "description": "

    ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

    " } ], "enabledForGitHubApps": true, @@ -397480,40 +396667,34 @@ "bodyParameters": [ { "type": "string", - "description": "

    The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

    ", "name": "owner", "in": "body", - "isRequired": false + "description": "

    The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

    " }, { "type": "string", - "description": "

    The name of the new repository.

    ", "name": "name", "in": "body", + "description": "

    The name of the new repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short description of the new repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the new repository.

    " }, { "type": "boolean", - "description": "

    Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.

    ", - "default": false, "name": "include_all_branches", "in": "body", - "isRequired": false + "description": "

    Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.

    " }, { "type": "boolean", - "description": "

    Either true to create a new private repository or false to create a new public one.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Either true to create a new private repository or false to create a new public one.

    " } ], "enabledForGitHubApps": false, @@ -402933,216 +402114,156 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The name of the repository.

    ", "type": "string", - "examples": [ - "Team Environment" - ], "name": "name", "in": "body", + "description": "

    The name of the repository.

    ", "isRequired": true }, { - "description": "

    A short description of the repository.

    ", "type": "string", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { - "description": "

    A URL with more information about the repository.

    ", "type": "string", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { - "description": "

    Whether the repository is private.

    ", - "default": false, "type": "boolean", "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether the repository is private.

    " }, { - "description": "

    Whether issues are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Whether issues are enabled.

    ", + "default": true }, { - "description": "

    Whether projects are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Whether projects are enabled.

    ", + "default": true }, { - "description": "

    Whether the wiki is enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Whether the wiki is enabled.

    ", + "default": true }, { - "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    ", "type": "integer", "name": "team_id", "in": "body", - "isRequired": false + "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    " }, { - "description": "

    Whether the repository is initialized with a minimal README.

    ", - "default": false, "type": "boolean", "name": "auto_init", "in": "body", - "isRequired": false + "description": "

    Whether the repository is initialized with a minimal README.

    " }, { - "description": "

    The desired language or platform to apply to the .gitignore.

    ", "type": "string", - "examples": [ - "Haskell" - ], "name": "gitignore_template", "in": "body", - "isRequired": false + "description": "

    The desired language or platform to apply to the .gitignore.

    " }, { - "description": "

    The license keyword of the open source license for this repository.

    ", "type": "string", - "examples": [ - "mit" - ], "name": "license_template", "in": "body", - "isRequired": false + "description": "

    The license keyword of the open source license for this repository.

    " }, { - "description": "

    Whether to allow squash merges for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Whether to allow squash merges for pull requests.

    ", + "default": true }, { - "description": "

    Whether to allow merge commits for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Whether to allow merge commits for pull requests.

    ", + "default": true }, { - "description": "

    Whether to allow rebase merges for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Whether to allow rebase merges for pull requests.

    ", + "default": true }, { - "description": "

    Whether to delete head branches when pull requests are merged

    ", - "default": false, "type": "boolean", - "examples": [ - false - ], "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Whether to delete head branches when pull requests are merged

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether downloads are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_downloads", "in": "body", - "isRequired": false + "description": "

    Whether downloads are enabled.

    ", + "default": true }, { - "description": "

    Whether this repository acts as a template that can be used to generate new repositories.

    ", - "default": false, "type": "boolean", - "examples": [ - true - ], "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Whether this repository acts as a template that can be used to generate new repositories.

    " } ], "enabledForGitHubApps": false, @@ -408812,7 +407933,7 @@ } ], "previews": [], - "descriptionHTML": "

    Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

    \n

    Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

    \n

    Note:

    \n
      \n
    • To get a repository's contents recursively, you can recursively get the tree.
      • \n
    • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
      • \n
    • This API supports files up to 1 megabyte in size.
      • \n
    \n

    If the content is a directory

    \n

    The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

    \n

    If the content is a symlink

    \n

    If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

    \n

    If the content is a submodule

    \n

    The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

    \n

    If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

    ", + "descriptionHTML": "

    Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

    \n

    Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

    \n

    Notes:

    \n
      \n
    • To get a repository's contents recursively, you can recursively get the tree.
      • \n
    • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
      • \n
    • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
      • \n
    • This API supports files up to 1 megabyte in size.
      • \n
    \n

    If the content is a directory

    \n

    The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

    \n

    If the content is a symlink

    \n

    If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

    \n

    If the content is a submodule

    \n

    The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

    \n

    If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

    ", "statusCodes": [ { "httpStatusCode": "200", @@ -408872,185 +407993,77 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message.

    ", "name": "message", "in": "body", + "description": "

    The commit message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The new file content, using Base64 encoding.

    ", "name": "content", "in": "body", + "description": "

    The new file content, using Base64 encoding.

    ", "isRequired": true }, { "type": "string", - "description": "

    Required if you are updating a file. The blob SHA of the file being replaced.

    ", "name": "sha", "in": "body", - "isRequired": false + "description": "

    Required if you are updating a file. The blob SHA of the file being replaced.

    " }, { "type": "string", - "description": "

    The branch name. Default: the repository’s default branch (usually master)

    ", "name": "branch", "in": "body", - "isRequired": false + "description": "

    The branch name. Default: the repository’s default branch (usually master)

    " }, { "type": "object", - "description": "

    The person that committed the file. Default: the authenticated user.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "examples": [ - "\"2013-01-05T13:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "committer", "in": "body", - "isRequired": false, + "description": "

    The person that committed the file. Default: the authenticated user.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "examples": [ - "\"2013-01-05T13:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "" } ] }, { "type": "object", - "description": "

    The author of the file. Default: The committer or the authenticated user if you omit committer.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "examples": [ - "\"2013-01-15T17:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "author", "in": "body", - "isRequired": false, + "description": "

    The author of the file. Default: The committer or the authenticated user if you omit committer.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "examples": [ - "\"2013-01-15T17:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "" } ] } @@ -409598,118 +408611,57 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message.

    ", "name": "message", "in": "body", + "description": "

    The commit message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The blob SHA of the file being replaced.

    ", "name": "sha", "in": "body", + "description": "

    The blob SHA of the file being replaced.

    ", "isRequired": true }, { "type": "string", - "description": "

    The branch name. Default: the repository’s default branch (usually master)

    ", "name": "branch", "in": "body", - "isRequired": false + "description": "

    The branch name. Default: the repository’s default branch (usually master)

    " }, { "type": "object", - "description": "

    object containing information about the committer.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - } - }, "name": "committer", "in": "body", - "isRequired": false, + "description": "

    object containing information about the committer.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " } ] }, { "type": "object", - "description": "

    object containing information about the author.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - } - }, "name": "author", "in": "body", - "isRequired": false, + "description": "

    object containing information about the author.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " } ] } @@ -412852,10 +411804,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    Optional parameter to specify the organization name if forking into an organization.

    ", "name": "organization", "in": "body", - "isRequired": false + "description": "

    Optional parameter to specify the organization name if forking into an organization.

    " } ], "enabledForGitHubApps": true, @@ -423960,7 +422911,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] }, @@ -429471,18 +428423,20 @@ ], "bodyParameters": [ { - "description": "

    Sets the state of the secret scanning alert. Can be either open or resolved. You must provide resolution when you set the state to resolved.

    ", "type": "string", + "name": "state", + "in": "body", + "description": "

    Sets the state of the secret scanning alert. Can be either open or resolved. You must provide resolution when you set the state to resolved.

    ", + "isRequired": true, "enum": [ "open", "resolved" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", + "name": "resolution", + "in": "body", "description": "

    Required when the state is resolved. The reason for resolving the alert.

    ", "enum": [ null, @@ -429490,10 +428444,7 @@ "wont_fix", "revoked", "used_in_tests" - ], - "name": "resolution", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -430131,68 +429082,61 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", + "description": "

    The name of the team.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "array of strings", - "description": "

    List GitHub IDs for organization members who will become team maintainers.

    ", "name": "maintainers", "in": "body", - "isRequired": false + "description": "

    List GitHub IDs for organization members who will become team maintainers.

    " }, { "type": "array of strings", - "description": "

    The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

    ", "name": "repo_names", "in": "body", - "isRequired": false + "description": "

    The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nDefault: secret
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.
    \nDefault for child team: closed

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " }, { "type": "string", - "description": "

    The distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"Update LDAP mapping for a team\" endpoint to change the LDAP DN. For more information, see \"Using LDAP.\"

    ", "name": "ldap_dn", "in": "body", - "isRequired": false + "description": "

    The distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"Update LDAP mapping for a team\" endpoint to change the LDAP DN. For more information, see \"Using LDAP.\"

    " } ], "enabledForGitHubApps": true, @@ -430488,8 +429432,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -431204,8 +430148,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -431631,48 +430575,43 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the team.

    " }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push", "admin" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer or null", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " } ], "enabledForGitHubApps": true, @@ -431968,8 +430907,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -433190,15 +432129,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"

    ", "enum": [ "read", "write", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -438209,11 +437147,10 @@ "bodyParameters": [ { "type": "string", - "description": "

    The permission to grant the team on this repository. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", - "default": "push", "name": "permission", "in": "body", - "isRequired": false + "description": "

    The permission to grant the team on this repository. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", + "default": "push" } ], "enabledForGitHubApps": true, @@ -438934,8 +437871,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -439352,48 +438289,44 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", + "description": "

    The name of the team.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push", "admin" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer or null", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " } ], "enabledForGitHubApps": true, @@ -439688,8 +438621,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -440361,8 +439294,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -441572,15 +440505,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"

    ", "enum": [ "read", "write", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -446568,15 +445500,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant the team on this repository. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", "enum": [ "pull", "push", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -447303,8 +446234,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -448214,9 +447145,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -449097,9 +448028,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -450055,9 +448986,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -450918,9 +449849,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -451920,25 +450851,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", + "description": "

    The discussion post's title.

    ", "isRequired": true }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion post's body text.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    " } ], "enabledForGitHubApps": true, @@ -452887,17 +451816,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The discussion post's title.

    " }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The discussion post's body text.

    " } ], "enabledForGitHubApps": true, @@ -453910,25 +452837,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", + "description": "

    The discussion post's title.

    ", "isRequired": true }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion post's body text.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    " } ], "enabledForGitHubApps": true, @@ -454857,17 +453782,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The discussion post's title.

    " }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The discussion post's body text.

    " } ], "enabledForGitHubApps": true, @@ -455788,15 +454711,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role that this user should have in the team.

    ", "enum": [ "member", "maintainer" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -456535,15 +455457,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role that this user should have in the team.

    ", "enum": [ "member", "maintainer" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -458000,78 +456921,52 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The new name of the user.

    ", "type": "string", - "examples": [ - "Omar Jahandar" - ], "name": "name", "in": "body", - "isRequired": false + "description": "

    The new name of the user.

    " }, { - "description": "

    The publicly visible email address of the user.

    ", "type": "string", - "examples": [ - "omar@example.com" - ], "name": "email", "in": "body", - "isRequired": false + "description": "

    The publicly visible email address of the user.

    " }, { - "description": "

    The new blog URL of the user.

    ", "type": "string", - "examples": [ - "blog.example.com" - ], "name": "blog", "in": "body", - "isRequired": false + "description": "

    The new blog URL of the user.

    " }, { - "description": "

    The new Twitter username of the user.

    ", "type": "string or null", - "examples": [ - "therealomarj" - ], "name": "twitter_username", "in": "body", - "isRequired": false + "description": "

    The new Twitter username of the user.

    " }, { - "description": "

    The new company of the user.

    ", "type": "string", - "examples": [ - "Acme corporation" - ], "name": "company", "in": "body", - "isRequired": false + "description": "

    The new company of the user.

    " }, { - "description": "

    The new location of the user.

    ", "type": "string", - "examples": [ - "Berlin, Germany" - ], "name": "location", "in": "body", - "isRequired": false + "description": "

    The new location of the user.

    " }, { - "description": "

    The new hiring availability of the user.

    ", "type": "boolean", "name": "hireable", "in": "body", - "isRequired": false + "description": "

    The new hiring availability of the user.

    " }, { - "description": "

    The new short biography of the user.

    ", "type": "string", "name": "bio", "in": "body", - "isRequired": false + "description": "

    The new short biography of the user.

    " } ], "enabledForGitHubApps": false, @@ -460296,11 +459191,10 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", "type": "array of strings", - "examples": [], "name": "emails", "in": "body", + "description": "

    Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", "isRequired": true } ], @@ -460430,10 +459324,10 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Email addresses associated with the GitHub user account.

    ", "type": "array of strings", "name": "emails", "in": "body", + "description": "

    Email addresses associated with the GitHub user account.

    ", "isRequired": true } ], @@ -462146,10 +461040,10 @@ "parameters": [], "bodyParameters": [ { - "description": "

    A GPG key in ASCII-armored format.

    ", "type": "string", "name": "armored_public_key", "in": "body", + "description": "

    A GPG key in ASCII-armored format.

    ", "isRequired": true } ], @@ -463165,21 +462059,16 @@ "parameters": [], "bodyParameters": [ { - "description": "

    A descriptive name for the new key.

    ", "type": "string", - "examples": [ - "Personal MacBook Air" - ], "name": "title", "in": "body", - "isRequired": false + "description": "

    A descriptive name for the new key.

    " }, { - "description": "

    The public SSH key to add to your GitHub account.

    ", "type": "string", - "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ", "name": "key", "in": "body", + "description": "

    The public SSH key to add to your GitHub account.

    ", "isRequired": true } ], @@ -463693,53 +462582,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": true, @@ -464774,188 +463637,63 @@ "bodyParameters": [ { "type": "string", - "description": "

    Use web to create a webhook. Default: web. This parameter only accepts the value web.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    Use web to create a webhook. Default: web. This parameter only accepts the value web.

    " }, { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "childParamsGroups": [] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ], - "name": "token", - "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ], - "name": "digest", - "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] - } - }, "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body" - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body" - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body" - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " - }, - { - "type": "string", - "examples": [ - "\"abc\"" - ], - "name": "token", - "in": "body", - "description": "" - }, - { - "type": "string", - "examples": [ - "\"sha256\"" - ], - "name": "digest", - "in": "body", - "description": "" - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    " + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "token", + "description": "" + }, + { + "type": "string", + "name": "digest", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, @@ -465581,210 +464319,70 @@ "bodyParameters": [ { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - }, - "address": { - "type": "string", - "examples": [ - "\"bar@example.com\"" - ], - "name": "address", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "room": { - "type": "string", - "examples": [ - "\"The Serious Room\"" - ], - "name": "room", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"bar@example.com\"" - ], - "name": "address", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"The Serious Room\"" - ], - "name": "room", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "address", + "description": "" + }, + { + "type": "string", + "name": "room", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for. This replaces the entire array of events.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "array of strings", - "description": "

    Determines a list of events to be added to the list of events that the Hook triggers for.

    ", "name": "add_events", "in": "body", - "isRequired": false + "description": "

    Determines a list of events to be added to the list of events that the Hook triggers for.

    " }, { "type": "array of strings", - "description": "

    Determines a list of events to be removed from the list of events that the Hook triggers for.

    ", "name": "remove_events", "in": "body", - "isRequired": false + "description": "

    Determines a list of events to be removed from the list of events that the Hook triggers for.

    " }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index 5ee849bbaf..68edc3c232 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -937,27 +937,26 @@ "bodyParameters": [ { "type": "string", + "name": "enabled_organizations", + "in": "body", "description": "

    The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.

    ", + "isRequired": true, "enum": [ "all", "none", "selected" - ], - "name": "enabled_organizations", - "in": "body", - "isRequired": true + ] }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": false, @@ -1208,10 +1207,10 @@ ], "bodyParameters": [ { - "description": "

    List of organization IDs to enable for GitHub Actions.

    ", "type": "array of integers", "name": "selected_organization_ids", "in": "body", + "description": "

    List of organization IDs to enable for GitHub Actions.

    ", "isRequired": true } ], @@ -1453,16 +1452,16 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", + "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "isRequired": true } ], @@ -1607,27 +1606,26 @@ "bodyParameters": [ { "type": "string", + "name": "enabled_repositories", + "in": "body", "description": "

    The policy that controls the repositories in the organization that are allowed to run GitHub Actions.

    ", + "isRequired": true, "enum": [ "all", "none", "selected" - ], - "name": "enabled_repositories", - "in": "body", - "isRequired": true + ] }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -3262,10 +3260,10 @@ ], "bodyParameters": [ { - "description": "

    List of repository IDs to enable for GitHub Actions.

    ", "type": "array of integers", "name": "selected_repository_ids", "in": "body", + "description": "

    List of repository IDs to enable for GitHub Actions.

    ", "isRequired": true } ], @@ -3507,16 +3505,16 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", + "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "isRequired": true } ], @@ -3671,22 +3669,21 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub Actions is enabled on the repository.

    ", "name": "enabled", "in": "body", + "description": "

    Whether GitHub Actions is enabled on the repository.

    ", "isRequired": true }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -3835,16 +3832,16 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", + "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "isRequired": true } ], @@ -4269,37 +4266,33 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret.

    ", + "isRequired": true, "enum": [ "all", "private", "selected" - ], - "name": "visibility", - "in": "body", - "isRequired": true + ] }, { "type": "array of integers", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", - "isRequired": false + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    " } ], "enabledForGitHubApps": true, @@ -6736,9 +6729,9 @@ "bodyParameters": [ { "type": "array of integers", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "isRequired": true } ], @@ -7290,18 +7283,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " } ], "enabledForGitHubApps": true, @@ -7813,17 +7803,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

    ", "isRequired": true }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", + "description": "

    ID of the key you used to encrypt the secret.

    ", "isRequired": true } ], @@ -8124,44 +8113,39 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all organizations or select individual organization.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all organizations or select individual organization.

    ", "enum": [ "selected", "all" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { - "description": "

    List of organization IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_organization_ids", "in": "body", - "isRequired": false + "description": "

    List of organization IDs that can access the runner group.

    " }, { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", - "isRequired": false + "description": "

    List of runner IDs to add to the runner group.

    " }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " } ], "enabledForGitHubApps": false, @@ -8375,31 +8359,27 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", - "isRequired": false + "description": "

    Name of the runner group.

    " }, { - "description": "

    Visibility of a runner group. You can select all organizations or select individual organizations.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all organizations or select individual organizations.

    ", "enum": [ "selected", "all" ], - "default": "all", - "name": "visibility", - "in": "body", - "isRequired": false + "default": "all" }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " } ], "enabledForGitHubApps": false, @@ -8769,10 +8749,10 @@ ], "bodyParameters": [ { - "description": "

    List of organization IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_organization_ids", "in": "body", + "description": "

    List of organization IDs that can access the runner group.

    ", "isRequired": true } ], @@ -9191,10 +9171,10 @@ ], "bodyParameters": [ { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", + "description": "

    List of runner IDs to add to the runner group.

    ", "isRequired": true } ], @@ -9536,46 +9516,41 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

    ", "enum": [ "selected", "all", "private" ], - "default": "all", - "name": "visibility", - "in": "body", - "isRequired": false + "default": "all" }, { - "description": "

    List of repository IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_repository_ids", "in": "body", - "isRequired": false + "description": "

    List of repository IDs that can access the runner group.

    " }, { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", - "isRequired": false + "description": "

    List of runner IDs to add to the runner group.

    " }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " } ], "enabledForGitHubApps": true, @@ -9807,31 +9782,28 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

    ", "enum": [ "selected", "all", "private" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " } ], "enabledForGitHubApps": true, @@ -12449,10 +12421,10 @@ ], "bodyParameters": [ { - "description": "

    List of repository IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_repository_ids", "in": "body", + "description": "

    List of repository IDs that can access the runner group.

    ", "isRequired": true } ], @@ -12871,10 +12843,10 @@ ], "bodyParameters": [ { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", + "description": "

    List of runner IDs to add to the runner group.

    ", "isRequired": true } ], @@ -35653,37 +35625,27 @@ "bodyParameters": [ { "type": "array of integers", - "description": "

    The list of environment ids to approve or reject

    ", - "examples": [ - 161171787, - 161171795 - ], "name": "environment_ids", "in": "body", + "description": "

    The list of environment ids to approve or reject

    ", "isRequired": true }, { "type": "string", + "name": "state", + "in": "body", "description": "

    Whether to approve or reject deployment to the specified environments.

    ", + "isRequired": true, "enum": [ "approved", "rejected" - ], - "examples": [ - "approved" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    A comment to accompany the deployment review

    ", - "examples": [ - "Ship it!" - ], "name": "comment", "in": "body", + "description": "

    A comment to accompany the deployment review

    ", "isRequired": true } ], @@ -41944,21 +41906,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The git reference for the workflow. The reference can be a branch or tag name.

    ", "name": "ref", "in": "body", + "description": "

    The git reference for the workflow. The reference can be a branch or tag name.

    ", "isRequired": true }, { "type": "object", - "description": "

    Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.

    ", - "additionalProperties": { - "type": "string" - }, - "maxProperties": 10, "name": "inputs", "in": "body", - "isRequired": false + "description": "

    Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.

    " } ], "enabledForGitHubApps": true, @@ -80210,19 +80167,16 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    ", "type": "string", - "format": "date-time", "name": "last_read_at", "in": "body", - "isRequired": false + "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    " }, { - "description": "

    Whether the notification has been read.

    ", "type": "boolean", "name": "read", "in": "body", - "isRequired": false + "description": "

    Whether the notification has been read.

    " } ], "enabledForGitHubApps": false, @@ -82801,12 +82755,10 @@ ], "bodyParameters": [ { - "description": "

    Whether to block all notifications from a thread.

    ", - "default": false, "type": "boolean", "name": "ignored", "in": "body", - "isRequired": false + "description": "

    Whether to block all notifications from a thread.

    " } ], "enabledForGitHubApps": false, @@ -85389,11 +85341,9 @@ "bodyParameters": [ { "type": "string", - "format": "date-time", - "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    ", "name": "last_read_at", "in": "body", - "isRequired": false + "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    " } ], "enabledForGitHubApps": false, @@ -93041,17 +92991,15 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Determines if notifications should be received from this repository.

    ", "name": "subscribed", "in": "body", - "isRequired": false + "description": "

    Determines if notifications should be received from this repository.

    " }, { "type": "boolean", - "description": "

    Determines if all notifications should be blocked from this repository.

    ", "name": "ignored", "in": "body", - "isRequired": false + "description": "

    Determines if all notifications should be blocked from this repository.

    " } ], "enabledForGitHubApps": false, @@ -99090,14 +99038,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -100027,14 +99967,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -100604,779 +100536,300 @@ ], "bodyParameters": [ { - "description": "

    List of repository names that the token should have access to

    ", "type": "array of strings", "name": "repositories", "in": "body", - "isRequired": false + "description": "

    List of repository names that the token should have access to

    " }, { - "description": "

    List of repository IDs that the token should have access to

    ", "type": "array of integers", - "examples": [ - 1 - ], "name": "repository_ids", "in": "body", - "isRequired": false + "description": "

    List of repository IDs that the token should have access to

    " }, { - "title": "App Permissions", "type": "object", + "name": "permissions", + "in": "body", "description": "

    The permissions granted to the user-to-server access token.

    ", - "properties": { - "actions": { + "childParamsGroups": [ + { "type": "string", + "name": "actions", "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", "enum": [ "read", "write" - ], - "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + ] }, - "administration": { + { "type": "string", + "name": "administration", "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", "enum": [ "read", "write" - ], - "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + ] }, - "checks": { + { "type": "string", + "name": "checks", "description": "

    The level of permission to grant the access token for checks on code.

    ", "enum": [ "read", "write" - ], - "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + ] }, - "contents": { + { "type": "string", + "name": "contents", "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", "enum": [ "read", "write" - ], - "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + ] }, - "organization_custom_roles": { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for custom roles management.", - "childParamsGroups": [] - }, - "deployments": { + { "type": "string", + "name": "deployments", "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", "enum": [ "read", "write" - ], - "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + ] }, - "environments": { + { "type": "string", + "name": "environments", "description": "

    The level of permission to grant the access token for managing repository environments.

    ", "enum": [ "read", "write" - ], - "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + ] }, - "issues": { + { "type": "string", + "name": "issues", "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", "enum": [ "read", "write" - ], - "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + ] }, - "metadata": { + { "type": "string", + "name": "metadata", "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", "enum": [ "read", "write" - ], - "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + ] }, - "packages": { + { "type": "string", + "name": "packages", "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "pages": { + { "type": "string", + "name": "pages", "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", "enum": [ "read", "write" - ], - "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + ] }, - "pull_requests": { + { "type": "string", + "name": "pull_requests", "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", "enum": [ "read", "write" - ], - "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + ] }, - "repository_hooks": { + { "type": "string", + "name": "repository_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", "enum": [ "read", "write" - ], - "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + ] }, - "repository_projects": { + { "type": "string", + "name": "repository_projects", "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", "enum": [ "read", "write", "admin" - ], - "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + ] }, - "secret_scanning_alerts": { + { "type": "string", + "name": "secret_scanning_alerts", "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + ] }, - "secrets": { + { "type": "string", + "name": "secrets", "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", "enum": [ "read", "write" - ], - "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + ] }, - "security_events": { + { "type": "string", + "name": "security_events", "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + ] }, - "single_file": { + { "type": "string", + "name": "single_file", "description": "

    The level of permission to grant the access token to manage just a single file.

    ", "enum": [ "read", "write" - ], - "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + ] }, - "statuses": { + { "type": "string", + "name": "statuses", "description": "

    The level of permission to grant the access token for commit statuses.

    ", "enum": [ "read", "write" - ], - "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + ] }, - "vulnerability_alerts": { + { "type": "string", + "name": "vulnerability_alerts", "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", "enum": [ "read", "write" - ], - "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + ] }, - "workflows": { + { "type": "string", + "name": "workflows", "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", "enum": [ "write" - ], - "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + ] }, - "members": { + { "type": "string", + "name": "members", "description": "

    The level of permission to grant the access token for organization teams and members.

    ", "enum": [ "read", "write" - ], - "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + ] }, - "organization_administration": { + { "type": "string", + "name": "organization_administration", "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + ] }, - "organization_hooks": { + { "type": "string", + "name": "organization_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + ] }, - "organization_plan": { + { "type": "string", + "name": "organization_plan", "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", "enum": [ "read" - ], - "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + ] }, - "organization_projects": { + { "type": "string", + "name": "organization_projects", "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", "enum": [ "read", "write", "admin" - ], - "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + ] }, - "organization_packages": { + { "type": "string", + "name": "organization_packages", "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "organization_secrets": { + { "type": "string", + "name": "organization_secrets", "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", "enum": [ "read", "write" - ], - "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + ] }, - "organization_self_hosted_runners": { + { "type": "string", + "name": "organization_self_hosted_runners", "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + ] }, - "organization_user_blocking": { + { "type": "string", + "name": "organization_user_blocking", "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + ] }, - "team_discussions": { + { "type": "string", + "name": "team_discussions", "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", "enum": [ "read", "write" - ], - "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] + ] }, - "content_references": { + { "type": "string", + "name": "content_references", "description": "

    The level of permission to grant the access token for notification of content references and creation content attachments.

    ", "enum": [ "read", "write" - ], - "name": "content_references", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "childParamsGroups": [] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - }, - "name": "permissions", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "permissions", - "parentType": "object", - "id": "permissions-object", - "params": [ - { - "type": "string", - "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", - "enum": [ - "read", - "write" - ], - "name": "actions", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", - "enum": [ - "read", - "write" - ], - "name": "administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for checks on code.

    ", - "enum": [ - "read", - "write" - ], - "name": "checks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "contents", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "deployments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for managing repository environments.

    ", - "enum": [ - "read", - "write" - ], - "name": "environments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", - "enum": [ - "read", - "write" - ], - "name": "issues", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", - "enum": [ - "read", - "write" - ], - "name": "metadata", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", - "enum": [ - "read", - "write" - ], - "name": "pages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "pull_requests", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", - "enum": [ - "read", - "write" - ], - "name": "repository_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "repository_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "secret_scanning_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "security_events", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage just a single file.

    ", - "enum": [ - "read", - "write" - ], - "name": "single_file", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for commit statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "statuses", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "vulnerability_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", - "enum": [ - "write" - ], - "name": "workflows", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization teams and members.

    ", - "enum": [ - "read", - "write" - ], - "name": "members", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", - "enum": [ - "read" - ], - "name": "organization_plan", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "organization_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_self_hosted_runners", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_user_blocking", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", - "enum": [ - "read", - "write" - ], - "name": "team_discussions", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for notification of content references and creation content attachments.

    ", - "enum": [ - "read", - "write" - ], - "name": "content_references", - "in": "body" - } ] } ] @@ -101587,14 +101040,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -104224,14 +103669,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -105165,14 +104602,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -106104,14 +105533,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -108253,25 +107674,17 @@ ], "bodyParameters": [ { - "description": "

    The title of the attachment

    ", "type": "string", - "maxLength": 1024, - "examples": [ - "Title of the attachment" - ], "name": "title", "in": "body", + "description": "

    The title of the attachment

    ", "isRequired": true }, { - "description": "

    The body of the attachment

    ", "type": "string", - "maxLength": 262144, - "examples": [ - "Body of the attachment" - ], "name": "body", "in": "body", + "description": "

    The body of the attachment

    ", "isRequired": true } ], @@ -108888,14 +108301,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -111170,9 +110575,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", + "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "isRequired": true } ], @@ -111295,10 +110700,10 @@ ], "bodyParameters": [ { - "description": "

    The access_token of the OAuth application.

    ", "type": "string", "name": "access_token", "in": "body", + "description": "

    The access_token of the OAuth application.

    ", "isRequired": true } ], @@ -111661,14 +111066,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -112174,10 +111571,10 @@ ], "bodyParameters": [ { - "description": "

    The access_token of the OAuth application.

    ", "type": "string", "name": "access_token", "in": "body", + "description": "

    The access_token of the OAuth application.

    ", "isRequired": true } ], @@ -112540,14 +111937,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -113050,9 +112439,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", + "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "isRequired": true } ], @@ -113116,808 +112505,318 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", - "examples": [ - "e72e16c7e42f292c6912e7710c838347ae178b4a" - ], "name": "access_token", "in": "body", + "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "isRequired": true }, { - "description": "

    The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

    ", "type": "string", - "examples": [ - "octocat" - ], "name": "target", "in": "body", - "isRequired": false + "description": "

    The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

    " }, { - "description": "

    The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

    ", "type": "integer", - "examples": [ - 1 - ], "name": "target_id", "in": "body", - "isRequired": false + "description": "

    The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

    " }, { - "description": "

    The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

    ", "type": "array of strings", "name": "repositories", "in": "body", - "isRequired": false + "description": "

    The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

    " }, { - "description": "

    The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

    ", "type": "array of integers", - "examples": [ - 1 - ], "name": "repository_ids", "in": "body", - "isRequired": false + "description": "

    The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

    " }, { - "title": "App Permissions", "type": "object", + "name": "permissions", + "in": "body", "description": "

    The permissions granted to the user-to-server access token.

    ", - "properties": { - "actions": { + "childParamsGroups": [ + { "type": "string", + "name": "actions", "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", "enum": [ "read", "write" - ], - "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + ] }, - "administration": { + { "type": "string", + "name": "administration", "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", "enum": [ "read", "write" - ], - "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + ] }, - "checks": { + { "type": "string", + "name": "checks", "description": "

    The level of permission to grant the access token for checks on code.

    ", "enum": [ "read", "write" - ], - "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + ] }, - "contents": { + { "type": "string", + "name": "contents", "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", "enum": [ "read", "write" - ], - "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + ] }, - "organization_custom_roles": { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for custom roles management.", - "childParamsGroups": [] - }, - "deployments": { + { "type": "string", + "name": "deployments", "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", "enum": [ "read", "write" - ], - "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + ] }, - "environments": { + { "type": "string", + "name": "environments", "description": "

    The level of permission to grant the access token for managing repository environments.

    ", "enum": [ "read", "write" - ], - "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + ] }, - "issues": { + { "type": "string", + "name": "issues", "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", "enum": [ "read", "write" - ], - "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + ] }, - "metadata": { + { "type": "string", + "name": "metadata", "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", "enum": [ "read", "write" - ], - "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + ] }, - "packages": { + { "type": "string", + "name": "packages", "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "pages": { + { "type": "string", + "name": "pages", "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", "enum": [ "read", "write" - ], - "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + ] }, - "pull_requests": { + { "type": "string", + "name": "pull_requests", "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", "enum": [ "read", "write" - ], - "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + ] }, - "repository_hooks": { + { "type": "string", + "name": "repository_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", "enum": [ "read", "write" - ], - "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + ] }, - "repository_projects": { + { "type": "string", + "name": "repository_projects", "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", "enum": [ "read", "write", "admin" - ], - "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + ] }, - "secret_scanning_alerts": { + { "type": "string", + "name": "secret_scanning_alerts", "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + ] }, - "secrets": { + { "type": "string", + "name": "secrets", "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", "enum": [ "read", "write" - ], - "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + ] }, - "security_events": { + { "type": "string", + "name": "security_events", "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + ] }, - "single_file": { + { "type": "string", + "name": "single_file", "description": "

    The level of permission to grant the access token to manage just a single file.

    ", "enum": [ "read", "write" - ], - "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + ] }, - "statuses": { + { "type": "string", + "name": "statuses", "description": "

    The level of permission to grant the access token for commit statuses.

    ", "enum": [ "read", "write" - ], - "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + ] }, - "vulnerability_alerts": { + { "type": "string", + "name": "vulnerability_alerts", "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", "enum": [ "read", "write" - ], - "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + ] }, - "workflows": { + { "type": "string", + "name": "workflows", "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", "enum": [ "write" - ], - "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + ] }, - "members": { + { "type": "string", + "name": "members", "description": "

    The level of permission to grant the access token for organization teams and members.

    ", "enum": [ "read", "write" - ], - "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + ] }, - "organization_administration": { + { "type": "string", + "name": "organization_administration", "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + ] }, - "organization_hooks": { + { "type": "string", + "name": "organization_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + ] }, - "organization_plan": { + { "type": "string", + "name": "organization_plan", "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", "enum": [ "read" - ], - "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + ] }, - "organization_projects": { + { "type": "string", + "name": "organization_projects", "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", "enum": [ "read", "write", "admin" - ], - "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + ] }, - "organization_packages": { + { "type": "string", + "name": "organization_packages", "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "organization_secrets": { + { "type": "string", + "name": "organization_secrets", "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", "enum": [ "read", "write" - ], - "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + ] }, - "organization_self_hosted_runners": { + { "type": "string", + "name": "organization_self_hosted_runners", "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + ] }, - "organization_user_blocking": { + { "type": "string", + "name": "organization_user_blocking", "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + ] }, - "team_discussions": { + { "type": "string", + "name": "team_discussions", "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", "enum": [ "read", "write" - ], - "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] + ] }, - "content_references": { + { "type": "string", + "name": "content_references", "description": "

    The level of permission to grant the access token for notification of content references and creation content attachments.

    ", "enum": [ "read", "write" - ], - "name": "content_references", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "childParamsGroups": [] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - }, - "name": "permissions", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "permissions", - "parentType": "object", - "id": "permissions-object", - "params": [ - { - "type": "string", - "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", - "enum": [ - "read", - "write" - ], - "name": "actions", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", - "enum": [ - "read", - "write" - ], - "name": "administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for checks on code.

    ", - "enum": [ - "read", - "write" - ], - "name": "checks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "contents", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "deployments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for managing repository environments.

    ", - "enum": [ - "read", - "write" - ], - "name": "environments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", - "enum": [ - "read", - "write" - ], - "name": "issues", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", - "enum": [ - "read", - "write" - ], - "name": "metadata", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", - "enum": [ - "read", - "write" - ], - "name": "pages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "pull_requests", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", - "enum": [ - "read", - "write" - ], - "name": "repository_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "repository_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "secret_scanning_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "security_events", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage just a single file.

    ", - "enum": [ - "read", - "write" - ], - "name": "single_file", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for commit statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "statuses", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "vulnerability_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", - "enum": [ - "write" - ], - "name": "workflows", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization teams and members.

    ", - "enum": [ - "read", - "write" - ], - "name": "members", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", - "enum": [ - "read" - ], - "name": "organization_plan", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "organization_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_self_hosted_runners", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_user_blocking", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", - "enum": [ - "read", - "write" - ], - "name": "team_discussions", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for notification of content references and creation content attachments.

    ", - "enum": [ - "read", - "write" - ], - "name": "content_references", - "in": "body" - } ] } ] @@ -114317,14 +113216,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -115207,14 +114098,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -116082,14 +114965,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -116717,53 +115592,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": false, @@ -118772,7 +117621,2049 @@ }, "response": { "statusCode": "200", - "description": "

    Response

    " + "contentType": "application/json", + "description": "

    Response

    ", + "example": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [], + "checks": [] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + }, + "schema": { + "title": "Branch With Protection", + "description": "Branch With Protection", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "commit": { + "title": "Commit", + "description": "Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } + }, + "required": [ + "sha", + "url" + ] + } + }, + "stats": { + "type": "object", + "properties": { + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + }, + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "string" + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "html", + "self" + ] + }, + "protected": { + "type": "boolean" + }, + "protection": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enforcement_level": { + "type": "string" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + }, + "contexts_url": { + "type": "string" + }, + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts" + ] + }, + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" + ] + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "require_code_owner_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "required_approving_review_count": { + "type": "integer", + "minimum": 1, + "maximum": 6, + "examples": [ + 2 + ] + } + }, + "required": [ + "dismiss_stale_reviews", + "require_code_owner_reviews" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + } + } + }, + "protection_url": { + "type": "string", + "format": "uri" + }, + "pattern": { + "type": "string", + "examples": [ + "\"mas*\"" + ] + }, + "required_approving_review_count": { + "type": "integer", + "examples": [ + 1 + ] + } + }, + "required": [ + "name", + "commit", + "_links", + "protection", + "protected", + "protection_url" + ] + } } } ], @@ -118833,9 +119724,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new name of the branch.

    ", "name": "new_name", "in": "body", + "description": "

    The new name of the branch.

    ", "isRequired": true } ], @@ -120954,9 +121845,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the branch which should be updated to match upstream.

    ", "name": "branch", "in": "body", + "description": "

    The name of the branch which should be updated to match upstream.

    ", "isRequired": true } ], @@ -121056,24 +121947,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the base branch that the head will be merged into.

    ", "name": "base", "in": "body", + "description": "

    The name of the base branch that the head will be merged into.

    ", "isRequired": true }, { "type": "string", - "description": "

    The head to merge. This can be a branch name or a commit SHA1.

    ", "name": "head", "in": "body", + "description": "

    The head to merge. This can be a branch name or a commit SHA1.

    ", "isRequired": true }, { "type": "string", - "description": "

    Commit message to use for the merge commit. If omitted, a default message will be used.

    ", "name": "commit_message", "in": "body", - "isRequired": false + "description": "

    Commit message to use for the merge commit. If omitted, a default message will be used.

    " } ], "enabledForGitHubApps": true, @@ -123419,171 +124309,38 @@ "bodyParameters": [ { "type": "object or null", - "description": "

    Require status checks to pass before merging. Set to null to disable.

    ", - "properties": { - "strict": { - "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", - "name": "strict", - "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": true, - "childParamsGroups": [] - }, - "contexts": { - "type": "array of strings", - "deprecated": true, - "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "isRequired": true, - "childParamsGroups": [] - }, - "checks": { - "type": "array of objects", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", - "items": { - "type": "object", - "required": [ - "context" - ], - "properties": { - "context": { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] - }, - "app_id": { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] - } - } - }, - "name": "checks", - "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ - { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "strict", - "contexts" - ], "name": "required_status_checks", "in": "body", + "description": "

    Require status checks to pass before merging. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "required_status_checks", - "parentType": "object", - "id": "required_status_checks-object", - "params": [ - { - "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", - "name": "strict", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "deprecated": true, - "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", - "name": "contexts", - "in": "body", - "isRequired": true - }, - { - "type": "array of objects", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", - "name": "checks", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ - { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "boolean", + "name": "strict", + "description": "

    Require branches to be up to date before merging.

    ", + "isRequired": true }, { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ + "type": "array of strings", + "name": "contexts", + "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", + "isRequired": true + }, + { + "type": "array of objects", + "name": "checks", + "description": "

    The list of status checks to require in order to merge into this branch.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The name of the required check

    ", "name": "context", - "in": "body", + "description": "

    The name of the required check

    ", "isRequired": true }, { "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", "name": "app_id", - "in": "body", - "isRequired": false + "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    " } ] } @@ -123591,366 +124348,118 @@ }, { "type": "boolean or null", - "description": "

    Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "name": "enforce_admins", "in": "body", + "description": "

    Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "isRequired": true }, { "type": "object or null", - "description": "

    Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", - "properties": { - "dismissal_restrictions": { - "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, - "name": "dismissal_restrictions", - "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", - "childParamsGroups": [ - { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] - } - ] - }, - "dismiss_stale_reviews": { - "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", - "name": "dismiss_stale_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "childParamsGroups": [] - }, - "require_code_owner_reviews": { - "type": "boolean", - "description": "

    Blocks merging pull requests until code owners review them.

    ", - "name": "require_code_owner_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", - "childParamsGroups": [] - }, - "required_approving_review_count": { - "type": "integer", - "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.

    ", - "name": "required_approving_review_count", - "in": "body", - "rawType": "integer", - "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "childParamsGroups": [] - } - }, "name": "required_pull_request_reviews", "in": "body", + "description": "

    Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "required_pull_request_reviews", - "parentType": "object", - "id": "required_pull_request_reviews-object", - "params": [ + "type": "object", + "name": "dismissal_restrictions", + "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", + "childParamsGroups": [ { - "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, - "name": "dismissal_restrictions", - "in": "body", - "childParamsGroups": [ - { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with dismissal access

    " }, { - "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", - "name": "dismiss_stale_reviews", - "in": "body" + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with dismissal access

    " }, { - "type": "boolean", - "description": "

    Blocks merging pull requests until code owners review them.

    ", - "name": "require_code_owner_reviews", - "in": "body" - }, - { - "type": "integer", - "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.

    ", - "name": "required_approving_review_count", - "in": "body" + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with dismissal access

    " } ] }, { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] + "type": "boolean", + "name": "dismiss_stale_reviews", + "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    " + }, + { + "type": "boolean", + "name": "require_code_owner_reviews", + "description": "

    Blocks merging pull requests until code owners review them.

    " + }, + { + "type": "integer", + "name": "required_approving_review_count", + "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.

    " } ] }, { "type": "object or null", - "description": "

    Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with push access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with push access", - "isRequired": true, - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with push access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with push access", - "isRequired": true, - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with push access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with push access", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "users", - "teams" - ], "name": "restrictions", "in": "body", + "description": "

    Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "restrictions", - "parentType": "object", - "id": "restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with push access

    ", - "name": "users", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with push access

    ", - "name": "teams", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with push access

    ", - "name": "apps", - "in": "body", - "isRequired": false - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with push access

    ", + "isRequired": true + }, + { + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with push access

    ", + "isRequired": true + }, + { + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with push access

    " } ] }, { "type": "boolean", - "description": "

    Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

    ", "name": "required_linear_history", "in": "body", - "isRequired": false + "description": "

    Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

    " }, { "type": "boolean or null", - "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "name": "allow_force_pushes", "in": "body", - "isRequired": false + "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    " }, { "type": "boolean", - "description": "

    Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

    ", "name": "allow_deletions", "in": "body", - "isRequired": false + "description": "

    Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

    ", "name": "block_creations", "in": "body", - "isRequired": false + "description": "

    If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

    " }, { "type": "boolean", - "description": "

    Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

    ", "name": "required_conversation_resolution", "in": "body", - "isRequired": false + "description": "

    Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

    " }, { "type": "array of strings", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", "name": "contexts", "in": "body", - "isRequired": false + "description": "

    The list of status checks to require in order to merge into this branch.

    " } ], "enabledForGitHubApps": true, @@ -124015,7 +124524,1272 @@ }, "response": { "statusCode": "200", - "description": "

    Response

    " + "contentType": "application/json", + "description": "

    Response

    ", + "example": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [], + "teams": [], + "apps": [] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [], + "teams": [], + "apps": [] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + }, + "schema": { + "title": "Protected Branch", + "description": "Branch protections protect branches", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "required_status_checks": { + "title": "Status Check Policy", + "description": "Status Check Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] + }, + "strict": { + "type": "boolean", + "examples": [ + true + ] + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "contexts_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + ] + } + }, + "required": [ + "url", + "contexts_url", + "strict", + "contexts" + ] + }, + "required_pull_request_reviews": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "dismiss_stale_reviews": { + "type": "boolean" + }, + "require_code_owner_reviews": { + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "users", + "teams" + ] + } + }, + "required": [ + "url" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "enforce_admins": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "url", + "enabled" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + } + }, + "required": [ + "url" + ] + } } } ], @@ -125322,96 +127096,44 @@ "bodyParameters": [ { "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, "name": "dismissal_restrictions", "in": "body", - "isRequired": false, + "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", "childParamsGroups": [ { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with dismissal access

    " + }, + { + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with dismissal access

    " + }, + { + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with dismissal access

    " } ] }, { "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", "name": "dismiss_stale_reviews", "in": "body", - "isRequired": false + "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    " }, { "type": "boolean", - "description": "

    Blocks merging pull requests until code owners have reviewed.

    ", "name": "require_code_owner_reviews", "in": "body", - "isRequired": false + "description": "

    Blocks merging pull requests until code owners have reviewed.

    " }, { "type": "integer", - "description": "

    Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.

    ", "name": "required_approving_review_count", "in": "body", - "isRequired": false + "description": "

    Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.

    " } ], "enabledForGitHubApps": true, @@ -126819,18 +128541,15 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", "name": "strict", "in": "body", - "isRequired": false + "description": "

    Require branches to be up to date before merging.

    " }, { "type": "array of strings", - "deprecated": true, - "description": "

    The list of status checks to require in order to merge into this branch

    ", "name": "contexts", "in": "body", - "isRequired": false + "description": "

    The list of status checks to require in order to merge into this branch

    " } ], "enabledForGitHubApps": true, @@ -127113,9 +128832,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -127125,8 +128844,14 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding status checks to a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -127211,9 +128936,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -127223,8 +128948,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example updating status checks for a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -127304,9 +129034,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -127316,8 +129046,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing status checks from a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -128366,9 +130101,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -128817,9 +130552,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -129268,9 +131003,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -130009,9 +131744,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -130021,8 +131756,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -130308,9 +132048,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -130320,8 +132060,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -130607,9 +132352,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -130619,8 +132364,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -131163,9 +132913,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -131175,8 +132925,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -131429,9 +133184,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -131441,8 +133196,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -131695,9 +133455,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -131707,8 +133467,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -131955,55 +133720,52 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the check. For example, \"code-coverage\".

    ", "name": "name", "in": "body", + "description": "

    The name of the check. For example, \"code-coverage\".

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the commit.

    ", "name": "head_sha", "in": "body", + "description": "

    The SHA of the commit.

    ", "isRequired": true }, { "type": "string", - "description": "

    The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

    ", "name": "details_url", "in": "body", - "isRequired": false + "description": "

    The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

    " }, { "type": "string", - "description": "

    A reference for the run on the integrator's system.

    ", "name": "external_id", "in": "body", - "isRequired": false + "description": "

    A reference for the run on the integrator's system.

    " }, { "type": "string", + "name": "status", + "in": "body", "description": "

    The current status.

    ", "enum": [ "queued", "in_progress", "completed" ], - "default": "queued", - "name": "status", - "in": "body", - "isRequired": false + "default": "queued" }, { "type": "string", - "format": "date-time", - "description": "

    The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "string", + "name": "conclusion", + "in": "body", "description": "

    Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.

    ", "enum": [ "action_required", @@ -132014,588 +133776,120 @@ "skipped", "stale", "timed_out" - ], - "name": "conclusion", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "format": "date-time", - "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "completed_at", "in": "body", - "isRequired": false + "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "object", - "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", - "properties": { - "title": { - "type": "string", - "description": "

    The title of the check run.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the check run.", - "isRequired": true, - "childParamsGroups": [] - }, - "summary": { - "type": "string", - "maxLength": 65535, - "description": "

    The summary of the check run. This parameter supports Markdown.

    ", - "name": "summary", - "in": "body", - "rawType": "string", - "rawDescription": "The summary of the check run. This parameter supports Markdown.", - "isRequired": true, - "childParamsGroups": [] - }, - "text": { - "type": "string", - "maxLength": 65535, - "description": "

    The details of the check run. This parameter supports Markdown.

    ", - "name": "text", - "in": "body", - "rawType": "string", - "rawDescription": "The details of the check run. This parameter supports Markdown.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotations": { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", - "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, - "name": "annotations", - "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#annotations-object) description for details about how to use this parameter.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - "images": { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, - "name": "images", - "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#images-object) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "title", - "summary" - ], "name": "output", "in": "body", - "isRequired": false, + "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", "childParamsGroups": [ { - "parentName": "output", - "parentType": "object", - "id": "output-object", - "params": [ - { - "type": "string", - "description": "

    The title of the check run.

    ", - "name": "title", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 65535, - "description": "

    The summary of the check run. This parameter supports Markdown.

    ", - "name": "summary", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 65535, - "description": "

    The details of the check run. This parameter supports Markdown.

    ", - "name": "text", - "in": "body", - "isRequired": false - }, - { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", - "maxItems": 50, - "name": "annotations", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "name": "images", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "string", + "name": "title", + "description": "

    The title of the check run.

    ", + "isRequired": true }, { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ + "type": "string", + "name": "summary", + "description": "

    The summary of the check run. This parameter supports Markdown.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "text", + "description": "

    The details of the check run. This parameter supports Markdown.

    " + }, + { + "type": "array of objects", + "name": "annotations", + "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "name": "path", - "in": "body", + "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start line of the annotation.

    ", "name": "start_line", - "in": "body", + "description": "

    The start line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The end line of the annotation.

    ", "name": "end_line", - "in": "body", + "description": "

    The end line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "start_column", - "in": "body", - "isRequired": false + "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "end_column", - "in": "body", - "isRequired": false + "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "string", + "name": "annotation_level", "description": "

    The level of the annotation.

    ", + "isRequired": true, "enum": [ "notice", "warning", "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "name": "message", - "in": "body", + "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "isRequired": true }, { "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", "name": "title", - "in": "body", - "isRequired": false + "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    " }, { "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", "name": "raw_details", - "in": "body", - "isRequired": false + "description": "

    Details about this annotation. The maximum size is 64 KB.

    " } ] }, { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ + "type": "array of objects", + "name": "images", + "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The alternative text for the image.

    ", "name": "alt", - "in": "body", + "description": "

    The alternative text for the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full URL of the image.

    ", "name": "image_url", - "in": "body", + "description": "

    The full URL of the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short image description.

    ", "name": "caption", - "in": "body", - "isRequired": false + "description": "

    A short image description.

    " } ] } @@ -132603,42 +133897,27 @@ }, { "type": "array of objects", - "description": "

    Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", - "maxItems": 3, "name": "actions", "in": "body", - "isRequired": false, + "description": "

    Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", "childParamsGroups": [ { - "parentName": "actions", - "parentType": "items", - "id": "actions-items", - "params": [ - { - "type": "string", - "maxLength": 20, - "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", - "name": "label", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 40, - "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", - "name": "description", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 20, - "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", - "name": "identifier", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "label", + "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "identifier", + "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", + "isRequired": true } ] } @@ -136290,47 +137569,43 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the check. For example, \"code-coverage\".

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the check. For example, \"code-coverage\".

    " }, { "type": "string", - "description": "

    The URL of the integrator's site that has the full details of the check.

    ", "name": "details_url", "in": "body", - "isRequired": false + "description": "

    The URL of the integrator's site that has the full details of the check.

    " }, { "type": "string", - "description": "

    A reference for the run on the integrator's system.

    ", "name": "external_id", "in": "body", - "isRequired": false + "description": "

    A reference for the run on the integrator's system.

    " }, { "type": "string", - "format": "date-time", - "description": "

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "string", + "name": "status", + "in": "body", "description": "

    The current status.

    ", "enum": [ "queued", "in_progress", "completed" - ], - "name": "status", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "conclusion", + "in": "body", "description": "

    Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.

    ", "enum": [ "action_required", @@ -136341,587 +137616,119 @@ "skipped", "stale", "timed_out" - ], - "name": "conclusion", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "format": "date-time", - "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "completed_at", "in": "body", - "isRequired": false + "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "object", - "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", - "properties": { - "title": { - "type": "string", - "description": "

    Required.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "**Required**.", - "isRequired": false, - "childParamsGroups": [] - }, - "summary": { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "summary", - "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": true, - "childParamsGroups": [] - }, - "text": { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "text", - "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotations": { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", - "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, - "name": "annotations", - "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#annotations-object-1) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - "images": { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, - "name": "images", - "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#annotations-object-1) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "summary" - ], "name": "output", "in": "body", - "isRequired": false, + "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", "childParamsGroups": [ { - "parentName": "output", - "parentType": "object", - "id": "output-object", - "params": [ - { - "type": "string", - "description": "

    Required.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "summary", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "text", - "in": "body", - "isRequired": false - }, - { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", - "maxItems": 50, - "name": "annotations", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "name": "images", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "string", + "name": "title", + "description": "

    Required.

    " }, { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ + "type": "string", + "name": "summary", + "description": "

    Can contain Markdown.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "text", + "description": "

    Can contain Markdown.

    " + }, + { + "type": "array of objects", + "name": "annotations", + "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "name": "path", - "in": "body", + "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start line of the annotation.

    ", "name": "start_line", - "in": "body", + "description": "

    The start line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The end line of the annotation.

    ", "name": "end_line", - "in": "body", + "description": "

    The end line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "start_column", - "in": "body", - "isRequired": false + "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "end_column", - "in": "body", - "isRequired": false + "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "string", + "name": "annotation_level", "description": "

    The level of the annotation.

    ", + "isRequired": true, "enum": [ "notice", "warning", "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "name": "message", - "in": "body", + "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "isRequired": true }, { "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", "name": "title", - "in": "body", - "isRequired": false + "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    " }, { "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", "name": "raw_details", - "in": "body", - "isRequired": false + "description": "

    Details about this annotation. The maximum size is 64 KB.

    " } ] }, { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ + "type": "array of objects", + "name": "images", + "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The alternative text for the image.

    ", "name": "alt", - "in": "body", + "description": "

    The alternative text for the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full URL of the image.

    ", "name": "image_url", - "in": "body", + "description": "

    The full URL of the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short image description.

    ", "name": "caption", - "in": "body", - "isRequired": false + "description": "

    A short image description.

    " } ] } @@ -136929,42 +137736,27 @@ }, { "type": "array of objects", - "description": "

    Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", - "maxItems": 3, "name": "actions", "in": "body", - "isRequired": false, + "description": "

    Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", "childParamsGroups": [ { - "parentName": "actions", - "parentType": "items", - "id": "actions-items", - "params": [ - { - "type": "string", - "maxLength": 20, - "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", - "name": "label", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 40, - "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", - "name": "description", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 20, - "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", - "name": "identifier", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "label", + "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "identifier", + "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", + "isRequired": true } ] } @@ -141073,9 +141865,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The sha of the head commit.

    ", "name": "head_sha", "in": "body", + "description": "

    The sha of the head commit.

    ", "isRequired": true } ], @@ -147257,32 +148049,22 @@ "bodyParameters": [ { "type": "array of objects", - "description": "

    Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

    ", "name": "auto_trigger_checks", "in": "body", - "isRequired": false, + "description": "

    Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

    ", "childParamsGroups": [ { - "parentName": "auto_trigger_checks", - "parentType": "items", - "id": "auto_trigger_checks-items", - "params": [ - { - "type": "integer", - "description": "

    The id of the GitHub App.

    ", - "name": "app_id", - "in": "body", - "isRequired": true - }, - { - "type": "boolean", - "description": "

    Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

    ", - "default": true, - "name": "setting", - "in": "body", - "isRequired": true - } - ] + "type": "integer", + "name": "app_id", + "description": "

    The id of the GitHub App.

    ", + "isRequired": true + }, + { + "type": "boolean", + "name": "setting", + "description": "

    Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

    ", + "isRequired": true, + "default": true } ] } @@ -157178,28 +157960,27 @@ ], "bodyParameters": [ { - "description": "

    Sets the state of the code scanning alert. You must provide dismissed_reason when you set the state to dismissed.

    ", "type": "string", + "name": "state", + "in": "body", + "description": "

    Sets the state of the code scanning alert. You must provide dismissed_reason when you set the state to dismissed.

    ", + "isRequired": true, "enum": [ "open", "dismissed" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", + "name": "dismissed_reason", + "in": "body", "description": "

    Required when the state is dismissed. The reason for dismissing or closing the alert.

    ", "enum": [ null, "false positive", "won't fix", "used in tests" - ], - "name": "dismissed_reason", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -158710,54 +159491,43 @@ ], "bodyParameters": [ { - "description": "

    The SHA of the commit to which the analysis you are uploading relates.

    ", "type": "string", - "minLength": 40, - "maxLength": 40, - "pattern": "^[0-9a-fA-F]+$", "name": "commit_sha", "in": "body", + "description": "

    The SHA of the commit to which the analysis you are uploading relates.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", "name": "ref", "in": "body", + "description": "

    The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", "isRequired": true }, { - "description": "

    A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

    ", "type": "string", "name": "sarif", "in": "body", + "description": "

    A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

    ", "isRequired": true }, { - "description": "

    The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

    ", "type": "string", - "format": "uri", - "examples": [ - "file:///github/workspace/" - ], "name": "checkout_uri", "in": "body", - "isRequired": false + "description": "

    The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

    " }, { - "description": "

    The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "format": "date-time", "type": "string", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { - "description": "

    The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

    ", "type": "string", "name": "tool_name", "in": "body", - "isRequired": false + "description": "

    The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

    " } ], "enabledForGitHubApps": true, @@ -159565,11 +160335,10 @@ "bodyParameters": [ { "type": "string", - "description": "

    The permission to grant the collaborator. Only valid on organization-owned repositories.

    ", - "default": "push", "name": "permission", "in": "body", - "isRequired": false + "description": "

    The permission to grant the collaborator. Only valid on organization-owned repositories.

    ", + "default": "push" } ], "enabledForGitHubApps": true, @@ -165356,6 +166125,8 @@ "bodyParameters": [ { "type": "string", + "name": "permissions", + "in": "body", "description": "

    The permissions that the associated user will have on the repository. Valid values are read, write, maintain, triage, and admin.

    ", "enum": [ "read", @@ -165363,10 +166134,7 @@ "maintain", "triage", "admin" - ], - "name": "permissions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -165375,8 +166143,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example request body", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permissions": "write" + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -181765,9 +182536,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment

    ", "isRequired": true } ], @@ -182681,31 +183452,28 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true }, { "type": "string", - "description": "

    Relative path of the file to comment on.

    ", "name": "path", "in": "body", - "isRequired": false + "description": "

    Relative path of the file to comment on.

    " }, { "type": "integer", - "description": "

    Line index in the diff to comment on.

    ", "name": "position", "in": "body", - "isRequired": false + "description": "

    Line index in the diff to comment on.

    " }, { "type": "integer", - "description": "

    Deprecated. Use position parameter instead. Line number in the file to comment on.

    ", "name": "line", "in": "body", - "isRequired": false + "description": "

    Deprecated. Use position parameter instead. Line number in the file to comment on.

    " } ], "enabledForGitHubApps": true, @@ -185890,38 +186658,35 @@ "bodyParameters": [ { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the status.

    ", + "isRequired": true, "enum": [ "error", "failure", "pending", "success" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", - "description": "

    The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
    \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
    \nhttp://ci.example.com/user/repo/build/sha

    ", "name": "target_url", "in": "body", - "isRequired": false + "description": "

    The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
    \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
    \nhttp://ci.example.com/user/repo/build/sha

    " }, { "type": "string or null", - "description": "

    A short description of the status.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the status.

    " }, { "type": "string", - "description": "

    A string label to differentiate this status from the status of other systems. This field is case-insensitive.

    ", - "default": "default", "name": "context", "in": "body", - "isRequired": false + "description": "

    A string label to differentiate this status from the status of other systems. This field is case-insensitive.

    ", + "default": "default" } ], "enabledForGitHubApps": true, @@ -186367,24 +187132,22 @@ "bodyParameters": [ { "type": "string", - "description": "

    A name for the key.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    A name for the key.

    " }, { "type": "string", - "description": "

    The contents of the key.

    ", "name": "key", "in": "body", + "description": "

    The contents of the key.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

    \n

    Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

    ", "name": "read_only", "in": "body", - "isRequired": false + "description": "

    If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

    \n

    Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

    " } ], "enabledForGitHubApps": true, @@ -187485,82 +188248,61 @@ "bodyParameters": [ { "type": "string", - "description": "

    The ref to deploy. This can be a branch, tag, or SHA.

    ", "name": "ref", "in": "body", + "description": "

    The ref to deploy. This can be a branch, tag, or SHA.

    ", "isRequired": true }, { "type": "string", - "description": "

    Specifies a task to execute (e.g., deploy or deploy:migrations).

    ", - "default": "deploy", "name": "task", "in": "body", - "isRequired": false + "description": "

    Specifies a task to execute (e.g., deploy or deploy:migrations).

    ", + "default": "deploy" }, { "type": "boolean", - "description": "

    Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

    ", - "default": true, "name": "auto_merge", "in": "body", - "isRequired": false + "description": "

    Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

    ", + "default": true }, { "type": "array of strings", - "description": "

    The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

    ", "name": "required_contexts", "in": "body", - "isRequired": false + "description": "

    The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

    " }, { - "oneOf": [ - { - "type": "object", - "additionalProperties": true - }, - { - "type": "string", - "description": "JSON payload with extra information about the deployment.", - "default": "" - } - ], + "type": "object or string", "name": "payload", "in": "body", - "type": "object or string", - "description": "

    JSON payload with extra information about the deployment.

    ", - "isRequired": false + "description": "

    JSON payload with extra information about the deployment.

    " }, { "type": "string", - "description": "

    Name for the target deployment environment (e.g., production, staging, qa).

    ", - "default": "production", "name": "environment", "in": "body", - "isRequired": false + "description": "

    Name for the target deployment environment (e.g., production, staging, qa).

    ", + "default": "production" }, { "type": "string or null", - "description": "

    Short description of the deployment.

    ", - "default": "", "name": "description", "in": "body", - "isRequired": false + "description": "

    Short description of the deployment.

    " }, { "type": "boolean", - "description": "

    Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false

    ", - "default": false, "name": "transient_environment", "in": "body", - "isRequired": false + "description": "

    Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false

    " }, { "type": "boolean", - "description": "

    Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

    ", "name": "production_environment", "in": "body", - "isRequired": false + "description": "

    Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

    " } ], "enabledForGitHubApps": true, @@ -189289,13 +190031,10 @@ ], "bodyParameters": [ { - "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "type": "string", - "examples": [ - "release/*" - ], "name": "name", "in": "body", + "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "isRequired": true } ], @@ -189580,13 +190319,10 @@ ], "bodyParameters": [ { - "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "type": "string", - "examples": [ - "release/*" - ], "name": "name", "in": "body", + "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "isRequired": true } ], @@ -191214,105 +191950,49 @@ "bodyParameters": [ { "type": "integer", - "description": "

    The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).

    ", - "examples": [ - 30 - ], "name": "wait_timer", "in": "body", - "isRequired": false + "description": "

    The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).

    " }, { "type": "array of objects or null", - "description": "

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", "name": "reviewers", "in": "body", - "isRequired": false, + "description": "

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", "childParamsGroups": [ { - "parentName": "reviewers", - "parentType": "items", - "id": "reviewers-items", - "params": [ - { - "type": "string", - "description": "

    The type of reviewer.

    ", - "enum": [ - "User", - "Team" - ], - "examples": [ - "User" - ], - "name": "type", - "in": "body" - }, - { - "type": "integer", - "description": "

    The id of the user or team who can review the deployment

    ", - "examples": [ - 4532992 - ], - "name": "id", - "in": "body" - } + "type": "string", + "name": "type", + "description": "

    The type of reviewer.

    ", + "enum": [ + "User", + "Team" ] + }, + { + "type": "integer", + "name": "id", + "description": "

    The id of the user or team who can review the deployment

    " } ] }, { "type": "object or null", - "description": "

    The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

    ", - "properties": { - "protected_branches": { - "type": "boolean", - "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", - "name": "protected_branches", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", - "isRequired": true, - "childParamsGroups": [] - }, - "custom_branch_policies": { - "type": "boolean", - "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", - "name": "custom_branch_policies", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "protected_branches", - "custom_branch_policies" - ], "name": "deployment_branch_policy", "in": "body", - "isRequired": false, + "description": "

    The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

    ", "childParamsGroups": [ { - "parentName": "deployment_branch_policy", - "parentType": "object", - "id": "deployment_branch_policy-object", - "params": [ - { - "type": "boolean", - "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", - "name": "protected_branches", - "in": "body", - "isRequired": true - }, - { - "type": "boolean", - "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", - "name": "custom_branch_policies", - "in": "body", - "isRequired": true - } - ] + "type": "boolean", + "name": "protected_branches", + "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", + "isRequired": true + }, + { + "type": "boolean", + "name": "custom_branch_policies", + "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", + "isRequired": true } ] } @@ -192870,7 +193550,10 @@ "bodyParameters": [ { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the status. When you set a transient deployment to inactive, the deployment will be shown as destroyed in GitHub.

    ", + "isRequired": true, "enum": [ "error", "failure", @@ -192879,61 +193562,48 @@ "queued", "pending", "success" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.

    ", - "default": "", "name": "target_url", "in": "body", - "isRequired": false + "description": "

    The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.

    " }, { "type": "string", - "description": "

    The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: \"\"

    ", - "default": "", "name": "log_url", "in": "body", - "isRequired": false + "description": "

    The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: \"\"

    " }, { "type": "string", - "description": "

    A short description of the status. The maximum description length is 140 characters.

    ", - "default": "", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the status. The maximum description length is 140 characters.

    " }, { "type": "string", + "name": "environment", + "in": "body", "description": "

    Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa.

    ", "enum": [ "production", "staging", "qa" - ], - "name": "environment", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "description": "

    Sets the URL for accessing your environment. Default: \"\"

    ", - "default": "", "name": "environment_url", "in": "body", - "isRequired": false + "description": "

    Sets the URL for accessing your environment. Default: \"\"

    " }, { "type": "boolean", - "description": "

    Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true

    ", "name": "auto_inactive", "in": "body", - "isRequired": false + "description": "

    Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true

    " } ], "enabledForGitHubApps": true, @@ -197013,24 +197683,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

    ", - "examples": [ - "Very **important** announcement about _nothing_." - ], "name": "announcement", "in": "body", + "description": "

    The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

    ", "isRequired": true }, { "type": "string or null", - "format": "date-time", - "description": "

    The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

    ", - "examples": [ - "\"2021-01-01T00:00:00.000-07:00\"" - ], "name": "expires_at", "in": "body", - "isRequired": false + "description": "

    The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

    " } ], "enabledForGitHubApps": false, @@ -197664,114 +198326,53 @@ "bodyParameters": [ { "type": "string", - "description": "

    Must be passed as \"web\".

    ", "name": "name", "in": "body", + "description": "

    Must be passed as \"web\".

    ", "isRequired": true }, { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", + "description": "

    Key/value pairs to provide settings for this webhook.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    " + }, + { + "type": "string", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ] }, { "type": "array of strings", - "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    ", "name": "events", "in": "body", - "isRequired": false + "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    " }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": false, @@ -198022,107 +198623,45 @@ "bodyParameters": [ { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    " + }, + { + "type": "string", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ] }, { "type": "array of strings", - "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    ", "name": "events", "in": "body", - "isRequired": false + "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    " }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": false, @@ -198341,9 +198880,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The distinguished name (DN) of the LDAP entry to map to a team.

    ", "name": "ldap_dn", "in": "body", + "description": "

    The distinguished name (DN) of the LDAP entry to map to a team.

    ", "isRequired": true } ], @@ -198520,9 +199059,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The distinguished name (DN) of the LDAP entry to map to a team.

    ", "name": "ldap_dn", "in": "body", + "description": "

    The distinguished name (DN) of the LDAP entry to map to a team.

    ", "isRequired": true } ], @@ -199293,9 +199832,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    A JSON string with the attributes enabled and when.

    \n

    The possible values for enabled are true and false. When it's false, the attribute when is ignored and the maintenance mode is turned off. when defines the time period when the maintenance was enabled.

    \n

    The possible values for when are now or any date parseable by mojombo/chronic.

    ", "name": "maintenance", "in": "body", + "description": "

    A JSON string with the attributes enabled and when.

    \n

    The possible values for enabled are true and false. When it's false, the attribute when is ignored and the maintenance mode is turned off. when defines the time period when the maintenance was enabled.

    \n

    The possible values for when are now or any date parseable by mojombo/chronic.

    ", "isRequired": true } ], @@ -200049,9 +200588,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.

    ", "name": "settings", "in": "body", + "description": "

    A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.

    ", "isRequired": true } ], @@ -200154,9 +200693,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The public SSH key.

    ", "name": "authorized_key", "in": "body", + "description": "

    The public SSH key.

    ", "isRequired": true } ], @@ -200227,9 +200766,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The public SSH key.

    ", "name": "authorized_key", "in": "body", + "description": "

    The public SSH key.

    ", "isRequired": true } ], @@ -200300,24 +200839,22 @@ "bodyParameters": [ { "type": "string", - "description": "

    The content of your .ghl license file.

    ", "name": "license", "in": "body", + "description": "

    The content of your .ghl license file.

    ", "isRequired": true }, { "type": "string", - "description": "

    You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.

    ", "name": "password", "in": "body", - "isRequired": false + "description": "

    You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.

    " }, { "type": "string", - "description": "

    An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.

    ", "name": "settings", "in": "body", - "isRequired": false + "description": "

    An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.

    " } ], "enabledForGitHubApps": false, @@ -200355,10 +200892,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The content of your new .ghl license file.

    ", "name": "license", "in": "body", - "isRequired": false + "description": "

    The content of your new .ghl license file.

    " } ], "enabledForGitHubApps": false, @@ -200624,18 +201160,16 @@ ], "bodyParameters": [ { - "description": "

    The state of enforcement for the hook on this repository.

    ", "type": "string", "name": "enforcement", "in": "body", - "isRequired": false + "description": "

    The state of enforcement for the hook on this repository.

    " }, { - "description": "

    Whether repositories can override enforcement.

    ", "type": "boolean", "name": "allow_downstream_configuration", "in": "body", - "isRequired": false + "description": "

    Whether repositories can override enforcement.

    " } ], "enabledForGitHubApps": true, @@ -200794,24 +201328,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The organization's username.

    ", "name": "login", "in": "body", + "description": "

    The organization's username.

    ", "isRequired": true }, { "type": "string", - "description": "

    The login of the user who will manage this organization.

    ", "name": "admin", "in": "body", + "description": "

    The login of the user who will manage this organization.

    ", "isRequired": true }, { "type": "string", - "description": "

    The organization's display name.

    ", "name": "profile_name", "in": "body", - "isRequired": false + "description": "

    The organization's display name.

    " } ], "enabledForGitHubApps": false, @@ -200978,9 +201511,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The organization's new name.

    ", "name": "login", "in": "body", + "description": "

    The organization's new name.

    ", "isRequired": true } ], @@ -201213,16 +201746,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new pre-receive environment's name.

    ", "name": "name", "in": "body", + "description": "

    The new pre-receive environment's name.

    ", "isRequired": true }, { "type": "string", - "description": "

    URL from which to download a tarball of this environment.

    ", "name": "image_url", "in": "body", + "description": "

    URL from which to download a tarball of this environment.

    ", "isRequired": true } ], @@ -201458,17 +201991,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    This pre-receive environment's new name.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    This pre-receive environment's new name.

    " }, { "type": "string", - "description": "

    URL from which to download a tarball of this environment.

    ", "name": "image_url", "in": "body", - "isRequired": false + "description": "

    URL from which to download a tarball of this environment.

    " } ], "enabledForGitHubApps": false, @@ -201991,49 +202522,43 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the hook.

    ", "name": "name", "in": "body", + "description": "

    The name of the hook.

    ", "isRequired": true }, { "type": "string", - "description": "

    The script that the hook runs.

    ", "name": "script", "in": "body", + "description": "

    The script that the hook runs.

    ", "isRequired": true }, { "type": "object", - "description": "

    The GitHub repository where the script is kept.

    ", - "properties": {}, - "additionalProperties": true, "name": "script_repository", "in": "body", + "description": "

    The GitHub repository where the script is kept.

    ", "isRequired": true }, { "type": "object", - "description": "

    The pre-receive environment where the script is executed.

    ", - "properties": {}, - "additionalProperties": true, "name": "environment", "in": "body", + "description": "

    The pre-receive environment where the script is executed.

    ", "isRequired": true }, { "type": "string", - "description": "

    The state of enforcement for this hook. default: disabled

    ", "name": "enforcement", "in": "body", - "isRequired": false + "description": "

    The state of enforcement for this hook. default: disabled

    " }, { "type": "boolean", - "description": "

    Whether enforcement can be overridden at the org or repo level. default: false

    ", "name": "allow_downstream_configuration", "in": "body", - "isRequired": false + "description": "

    Whether enforcement can be overridden at the org or repo level. default: false

    " } ], "enabledForGitHubApps": false, @@ -202376,49 +202901,39 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the hook.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the hook.

    " }, { "type": "string", - "description": "

    The script that the hook runs.

    ", "name": "script", "in": "body", - "isRequired": false + "description": "

    The script that the hook runs.

    " }, { "type": "object", - "description": "

    The GitHub repository where the script is kept.

    ", - "properties": {}, - "additionalProperties": true, "name": "script_repository", "in": "body", - "isRequired": false + "description": "

    The GitHub repository where the script is kept.

    " }, { "type": "object", - "description": "

    The pre-receive environment where the script is executed.

    ", - "properties": {}, - "additionalProperties": true, "name": "environment", "in": "body", - "isRequired": false + "description": "

    The pre-receive environment where the script is executed.

    " }, { "type": "string", - "description": "

    The state of enforcement for this hook.

    ", "name": "enforcement", "in": "body", - "isRequired": false + "description": "

    The state of enforcement for this hook.

    " }, { "type": "boolean", - "description": "

    Whether enforcement can be overridden at the org or repo level.

    ", "name": "allow_downstream_configuration", "in": "body", - "isRequired": false + "description": "

    Whether enforcement can be overridden at the org or repo level.

    " } ], "enabledForGitHubApps": false, @@ -202879,16 +203394,15 @@ ], "bodyParameters": [ { - "description": "

    The state of enforcement for the hook on this repository.

    ", "type": "string", + "name": "enforcement", + "in": "body", + "description": "

    The state of enforcement for the hook on this repository.

    ", "enum": [ "enabled", "disabled", "testing" - ], - "name": "enforcement", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -203627,14 +204141,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -204164,17 +204670,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The user's username.

    ", "name": "login", "in": "body", + "description": "

    The user's username.

    ", "isRequired": true }, { "type": "string", - "description": "

    Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

    ", "name": "email", "in": "body", - "isRequired": false + "description": "

    Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

    " } ], "enabledForGitHubApps": false, @@ -204408,9 +204913,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The user's new username.

    ", "name": "login", "in": "body", + "description": "

    The user's new username.

    ", "isRequired": true } ], @@ -204526,10 +205031,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    A list of scopes.

    ", "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes.

    " } ], "enabledForGitHubApps": false, @@ -204867,14 +205371,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -205670,14 +206166,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -206310,10 +206798,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    ", "name": "reason", "in": "body", - "isRequired": false + "description": "

    The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    " } ], "enabledForGitHubApps": false, @@ -206364,10 +206851,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    ", "name": "reason", "in": "body", - "isRequired": false + "description": "

    The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    " } ], "enabledForGitHubApps": false, @@ -206974,76 +207460,27 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Description of the gist

    ", "type": "string", - "examples": [ - "Example Ruby script" - ], "name": "description", "in": "body", - "isRequired": false + "description": "

    Description of the gist

    " }, { - "description": "

    Names and content for the files that make up the gist

    ", "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "content": { - "description": "

    Content of the file

    ", - "readOnly": false, - "type": "string", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "Content of the file", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "content" - ], - "rawType": "object", - "name": "key" - }, - "examples": [ - { - "hello.rb": { - "content": "puts \"Hello, World!\"" - } - } - ], "name": "files", "in": "body", + "description": "

    Names and content for the files that make up the gist

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "files", - "parentType": "object", - "id": "files-object", - "params": [ + "type": "object", + "name": "key", + "description": "

    A user-defined key to represent an item in files.

    ", + "childParamsGroups": [ { - "description": "

    A user-defined key to represent an item in files.

    ", - "type": "string", - "name": "key", - "in": "body", - "rawType": "string", - "rawDescription": "A key to represent an item in files." - } - ] - }, - { - "parentName": "key", - "parentType": "object", - "id": "key-object", - "params": [ - { - "description": "

    Content of the file

    ", - "readOnly": false, "type": "string", "name": "content", - "in": "body", + "description": "

    Content of the file

    ", "isRequired": true } ] @@ -207051,32 +207488,10 @@ ] }, { - "oneOf": [ - { - "description": "Flag indicating whether the gist is public", - "type": "boolean", - "default": false, - "examples": [ - true - ] - }, - { - "type": "string", - "default": "false", - "enum": [ - "true", - "false" - ], - "examples": [ - "true" - ] - } - ], + "type": "boolean or string", "name": "public", "in": "body", - "type": "boolean or string", - "description": "

    Flag indicating whether the gist is public

    ", - "isRequired": false + "description": "

    Flag indicating whether the gist is public

    " } ], "enabledForGitHubApps": false, @@ -210723,108 +211138,31 @@ ], "bodyParameters": [ { - "description": "

    Description of the gist

    ", "type": "string", - "examples": [ - "Example Ruby script" - ], "name": "description", "in": "body", - "isRequired": false + "description": "

    Description of the gist

    " }, { - "description": "

    Names of files to be updated

    ", "type": "object", - "additionalProperties": { - "type": [ - "object", - "null" - ], - "properties": { - "content": { - "description": "

    The new content of the file

    ", - "type": "string", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The new content of the file", - "childParamsGroups": [] - }, - "filename": { - "description": "

    The new filename for the file

    ", - "type": "string or null", - "name": "filename", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new filename for the file", - "childParamsGroups": [] - } - }, - "anyOf": [ - { - "required": [ - "content" - ] - }, - { - "required": [ - "filename" - ] - }, - { - "type": "object", - "maxProperties": 0 - } - ], - "rawType": "object", - "name": "key" - }, - "examples": [ - { - "hello.rb": { - "content": "blah", - "filename": "goodbye.rb" - } - } - ], "name": "files", "in": "body", - "isRequired": false, + "description": "

    Names of files to be updated

    ", "childParamsGroups": [ { - "parentName": "files", - "parentType": "object", - "id": "files-object", - "params": [ + "type": "object", + "name": "key", + "description": "

    A user-defined key to represent an item in files.

    ", + "childParamsGroups": [ { - "description": "

    A user-defined key to represent an item in files.

    ", - "type": "string", - "name": "key", - "in": "body", - "rawType": "string", - "rawDescription": "A key to represent an item in files." - } - ] - }, - { - "parentName": "key", - "parentType": "object", - "id": "key-object", - "params": [ - { - "description": "

    The new content of the file

    ", "type": "string", "name": "content", - "in": "body" + "description": "

    The new content of the file

    " }, { - "description": "

    The new filename for the file

    ", "type": "string or null", "name": "filename", - "in": "body" + "description": "

    The new filename for the file

    " } ] } @@ -216680,14 +217018,10 @@ ], "bodyParameters": [ { - "description": "

    The comment text.

    ", "type": "string", - "maxLength": 65535, - "examples": [ - "Body of the attachment" - ], "name": "body", "in": "body", + "description": "

    The comment text.

    ", "isRequired": true } ], @@ -217377,14 +217711,10 @@ ], "bodyParameters": [ { - "description": "

    The comment text.

    ", "type": "string", - "maxLength": 65535, - "examples": [ - "Body of the attachment" - ], "name": "body", "in": "body", + "description": "

    The comment text.

    ", "isRequired": true } ], @@ -217798,18 +218128,17 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new blob's content.

    ", "name": "content", "in": "body", + "description": "

    The new blob's content.

    ", "isRequired": true }, { "type": "string", - "description": "

    The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.

    ", - "default": "utf-8", "name": "encoding", "in": "body", - "isRequired": false + "description": "

    The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.

    ", + "default": "utf-8" } ], "enabledForGitHubApps": true, @@ -218040,171 +218369,77 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message

    ", "name": "message", "in": "body", + "description": "

    The commit message

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the tree object this commit points to

    ", "name": "tree", "in": "body", + "description": "

    The SHA of the tree object this commit points to

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

    ", "name": "parents", "in": "body", - "isRequired": false + "description": "

    The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

    " }, { "type": "object", - "description": "

    Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "author", "in": "body", - "isRequired": false, + "description": "

    Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] }, { "type": "object", - "description": "

    Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "childParamsGroups": [] - } - }, "name": "committer", "in": "body", - "isRequired": false, + "description": "

    Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - }, - { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "date", + "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] }, { "type": "string", - "description": "

    The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

    ", "name": "signature", "in": "body", - "isRequired": false + "description": "

    The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

    " } ], "enabledForGitHubApps": true, @@ -219073,27 +219308,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

    ", "name": "ref", "in": "body", + "description": "

    The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA1 value for this reference.

    ", "name": "sha", "in": "body", + "description": "

    The SHA1 value for this reference.

    ", "isRequired": true }, { "type": "string", - "examples": [ - "\"refs/heads/newbranch\"" - ], "name": "key", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -219233,18 +219464,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The SHA1 value to set this reference to

    ", "name": "sha", "in": "body", + "description": "

    The SHA1 value to set this reference to

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

    ", - "default": false, "name": "force", "in": "body", - "isRequired": false + "description": "

    Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

    " } ], "enabledForGitHubApps": true, @@ -219446,109 +219675,59 @@ "bodyParameters": [ { "type": "string", - "description": "

    The tag's name. This is typically a version (e.g., \"v0.0.1\").

    ", "name": "tag", "in": "body", + "description": "

    The tag's name. This is typically a version (e.g., \"v0.0.1\").

    ", "isRequired": true }, { "type": "string", - "description": "

    The tag message.

    ", "name": "message", "in": "body", + "description": "

    The tag message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the git object this is tagging.

    ", "name": "object", "in": "body", + "description": "

    The SHA of the git object this is tagging.

    ", "isRequired": true }, { "type": "string", + "name": "type", + "in": "body", "description": "

    The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.

    ", + "isRequired": true, "enum": [ "commit", "tree", "blob" - ], - "name": "type", - "in": "body", - "isRequired": true + ] }, { "type": "object", - "description": "

    An object with information about the individual creating the tag.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author of the tag

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author of the tag", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author of the tag

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author of the tag", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "tagger", "in": "body", - "isRequired": false, + "description": "

    An object with information about the individual creating the tag.

    ", "childParamsGroups": [ { - "parentName": "tagger", - "parentType": "object", - "id": "tagger-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author of the tag

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author of the tag

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "format": "date-time", - "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author of the tag

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author of the tag

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] } @@ -219983,68 +220162,55 @@ "bodyParameters": [ { "type": "array of objects", - "description": "

    Objects (of path, mode, type, and sha) specifying a tree structure.

    ", "name": "tree", "in": "body", + "description": "

    Objects (of path, mode, type, and sha) specifying a tree structure.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "tree", - "parentType": "items", - "id": "tree-items", - "params": [ - { - "type": "string", - "description": "

    The file referenced in the tree.

    ", - "name": "path", - "in": "body" - }, - { - "type": "string", - "description": "

    The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

    ", - "enum": [ - "100644", - "100755", - "040000", - "160000", - "120000" - ], - "name": "mode", - "in": "body" - }, - { - "type": "string", - "description": "

    Either blob, tree, or commit.

    ", - "enum": [ - "blob", - "tree", - "commit" - ], - "name": "type", - "in": "body" - }, - { - "type": "string or null", - "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", - "name": "sha", - "in": "body" - }, - { - "type": "string", - "description": "

    The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", - "name": "content", - "in": "body" - } + "type": "string", + "name": "path", + "description": "

    The file referenced in the tree.

    " + }, + { + "type": "string", + "name": "mode", + "description": "

    The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

    ", + "enum": [ + "100644", + "100755", + "040000", + "160000", + "120000" ] + }, + { + "type": "string", + "name": "type", + "description": "

    Either blob, tree, or commit.

    ", + "enum": [ + "blob", + "tree", + "commit" + ] + }, + { + "type": "string or null", + "name": "sha", + "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    " + }, + { + "type": "string", + "name": "content", + "description": "

    The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    " } ] }, { "type": "string", - "description": "

    The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

    ", "name": "base_tree", "in": "body", - "isRequired": false + "description": "

    The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

    " } ], "enabledForGitHubApps": true, @@ -227885,7 +228051,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ], "schema": { @@ -230941,63 +231108,41 @@ ], "bodyParameters": [ { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "

    The title of the issue.

    ", + "type": "string or integer", "name": "title", "in": "body", - "type": "string or integer", + "description": "

    The title of the issue.

    ", "isRequired": true }, { "type": "string", - "description": "

    The contents of the issue.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the issue.

    " }, { "type": "string or null", - "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "name": "assignee", "in": "body", - "isRequired": false + "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    " }, { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._" - } - ], - "type": "string or integer or null", + "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "isRequired": false + "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    " }, { - "type": "array of strings or array of objects", - "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", + "type": "array", "name": "labels", "in": "body", - "isRequired": false + "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    " }, { "type": "array of strings", - "description": "

    Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    " } ], "enabledForGitHubApps": true, @@ -231183,7 +231328,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -234423,7 +234569,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -237488,74 +237635,56 @@ ], "bodyParameters": [ { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "

    The title of the issue.

    ", - "type": "string or integer or null", + "type": "null or string or integer or string or integer", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the issue.

    " }, { "type": "string or null", - "description": "

    The contents of the issue.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the issue.

    " }, { "type": "string or null", - "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", "in": "body", - "isRequired": false + "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    State of the issue. Either open or closed.

    ", "enum": [ "open", "closed" - ], - "name": "state", - "in": "body", - "isRequired": false + ] }, { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._" - } - ], - "type": "string or integer or null", + "type": "string or null", + "name": "state_reason", + "in": "body", + "description": "

    The reason for the current state

    " + }, + { + "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "isRequired": false + "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    " }, { - "type": "array of strings or array of objects", - "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", + "type": "array", "name": "labels", "in": "body", - "isRequired": false + "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    " }, { "type": "array of strings", - "description": "

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    " } ], "enabledForGitHubApps": true, @@ -237743,7 +237872,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -240817,16 +240947,15 @@ "bodyParameters": [ { "type": "string", + "name": "lock_reason", + "in": "body", "description": "

    The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
    \n* off-topic
    \n* too heated
    \n* resolved
    \n* spam

    ", "enum": [ "off-topic", "too heated", "resolved", "spam" - ], - "name": "lock_reason", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -244728,10 +244857,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

    " } ], "enabledForGitHubApps": true, @@ -244913,7 +245041,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -247963,10 +248092,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

    " } ], "enabledForGitHubApps": true, @@ -248148,7 +248276,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -252732,9 +252861,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true } ], @@ -254324,9 +254453,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true } ], @@ -255276,7 +255405,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ], @@ -260139,7 +260269,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } }, "schema": { @@ -275086,10 +275217,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

    ", "name": "labels", - "in": "body" + "in": "body", + "description": "

    The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

    " } ], "enabledForGitHubApps": true, @@ -275264,10 +275394,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

    ", "name": "labels", - "in": "body" + "in": "body", + "description": "

    The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

    " } ], "enabledForGitHubApps": true, @@ -275833,24 +275962,22 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "name": "name", "in": "body", + "description": "

    The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "isRequired": true }, { "type": "string", - "description": "

    The hexadecimal color code for the label, without the leading #.

    ", "name": "color", "in": "body", - "isRequired": false + "description": "

    The hexadecimal color code for the label, without the leading #.

    " }, { "type": "string", - "description": "

    A short description of the label. Must be 100 characters or fewer.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the label. Must be 100 characters or fewer.

    " } ], "enabledForGitHubApps": true, @@ -276154,24 +276281,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "name": "new_name", "in": "body", - "isRequired": false + "description": "

    The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    " }, { "type": "string", - "description": "

    The hexadecimal color code for the label, without the leading #.

    ", "name": "color", "in": "body", - "isRequired": false + "description": "

    The hexadecimal color code for the label, without the leading #.

    " }, { "type": "string", - "description": "

    A short description of the label. Must be 100 characters or fewer.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the label. Must be 100 characters or fewer.

    " } ], "enabledForGitHubApps": true, @@ -277024,37 +277148,33 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the milestone.

    ", "name": "title", "in": "body", + "description": "

    The title of the milestone.

    ", "isRequired": true }, { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the milestone. Either open or closed.

    ", "enum": [ "open", "closed" ], - "default": "open", - "name": "state", - "in": "body", - "isRequired": false + "default": "open" }, { "type": "string", - "description": "

    A description of the milestone.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A description of the milestone.

    " }, { "type": "string", - "format": "date-time", - "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "due_on", "in": "body", - "isRequired": false + "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ], "enabledForGitHubApps": true, @@ -277897,37 +278017,32 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the milestone.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the milestone.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the milestone. Either open or closed.

    ", "enum": [ "open", "closed" ], - "default": "open", - "name": "state", - "in": "body", - "isRequired": false + "default": "open" }, { "type": "string", - "description": "

    A description of the milestone.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A description of the milestone.

    " }, { "type": "string", - "format": "date-time", - "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "due_on", "in": "body", - "isRequired": false + "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ], "enabledForGitHubApps": true, @@ -294799,33 +294914,28 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The Markdown text to render in HTML.

    ", "type": "string", "name": "text", "in": "body", + "description": "

    The Markdown text to render in HTML.

    ", "isRequired": true }, { + "type": "string", + "name": "mode", + "in": "body", "description": "

    The rendering mode. Can be either markdown or gfm.

    ", "enum": [ "markdown", "gfm" ], - "default": "markdown", - "type": "string", - "examples": [ - "markdown" - ], - "name": "mode", - "in": "body", - "isRequired": false + "default": "markdown" }, { - "description": "

    The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

    ", "type": "string", "name": "context", "in": "body", - "isRequired": false + "description": "

    The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

    " } ], "enabledForGitHubApps": true, @@ -297188,14 +297298,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -297695,55 +297797,40 @@ "parameters": [], "bodyParameters": [ { - "description": "

    A list of scopes that this authorization is in.

    ", "type": "array of strings or null", - "examples": [ - "public_repo", - "user" - ], "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes that this authorization is in.

    " }, { - "description": "

    A note to remind you what the OAuth token is for.

    ", "type": "string", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    A note to remind you what the OAuth token is for.

    " }, { - "description": "

    A URL to remind you what app the OAuth token is for.

    ", "type": "string", "name": "note_url", "in": "body", - "isRequired": false + "description": "

    A URL to remind you what app the OAuth token is for.

    " }, { - "description": "

    The OAuth app client key for which to create the token.

    ", - "maxLength": 20, "type": "string", "name": "client_id", "in": "body", - "isRequired": false + "description": "

    The OAuth app client key for which to create the token.

    " }, { - "description": "

    The OAuth app client secret for which to create the token.

    ", - "maxLength": 40, "type": "string", "name": "client_secret", "in": "body", - "isRequired": false + "description": "

    The OAuth app client secret for which to create the token.

    " }, { - "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    ", "type": "string", "name": "fingerprint", "in": "body", - "isRequired": false + "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    " } ], "enabledForGitHubApps": false, @@ -298087,14 +298174,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -298612,47 +298691,35 @@ ], "bodyParameters": [ { - "description": "

    The OAuth app client secret for which to create the token.

    ", - "maxLength": 40, "type": "string", "name": "client_secret", "in": "body", + "description": "

    The OAuth app client secret for which to create the token.

    ", "isRequired": true }, { - "description": "

    A list of scopes that this authorization is in.

    ", "type": "array of strings or null", - "examples": [ - "public_repo", - "user" - ], "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes that this authorization is in.

    " }, { - "description": "

    A note to remind you what the OAuth token is for.

    ", "type": "string", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    A note to remind you what the OAuth token is for.

    " }, { - "description": "

    A URL to remind you what app the OAuth token is for.

    ", "type": "string", "name": "note_url", "in": "body", - "isRequired": false + "description": "

    A URL to remind you what app the OAuth token is for.

    " }, { - "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    ", "type": "string", "name": "fingerprint", "in": "body", - "isRequired": false + "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    " } ], "enabledForGitHubApps": false, @@ -298998,14 +299065,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -299809,14 +299868,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -300343,40 +300394,29 @@ ], "bodyParameters": [ { - "description": "

    The OAuth app client secret for which to create the token.

    ", - "maxLength": 40, "type": "string", "name": "client_secret", "in": "body", + "description": "

    The OAuth app client secret for which to create the token.

    ", "isRequired": true }, { - "description": "

    A list of scopes that this authorization is in.

    ", "type": "array of strings or null", - "examples": [ - "public_repo", - "user" - ], "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes that this authorization is in.

    " }, { - "description": "

    A note to remind you what the OAuth token is for.

    ", "type": "string", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    A note to remind you what the OAuth token is for.

    " }, { - "description": "

    A URL to remind you what app the OAuth token is for.

    ", "type": "string", "name": "note_url", "in": "body", - "isRequired": false + "description": "

    A URL to remind you what app the OAuth token is for.

    " } ], "enabledForGitHubApps": false, @@ -300723,14 +300763,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -301535,14 +301567,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -302376,14 +302400,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -302888,53 +302904,40 @@ ], "bodyParameters": [ { - "description": "

    A list of scopes that this authorization is in.

    ", "type": "array of strings or null", - "examples": [ - "public_repo", - "user" - ], "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes that this authorization is in.

    " }, { - "description": "

    A list of scopes to add to this authorization.

    ", "type": "array of strings", "name": "add_scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes to add to this authorization.

    " }, { - "description": "

    A list of scopes to remove from this authorization.

    ", "type": "array of strings", "name": "remove_scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes to remove from this authorization.

    " }, { - "description": "

    A note to remind you what the OAuth token is for.

    ", "type": "string", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    A note to remind you what the OAuth token is for.

    " }, { - "description": "

    A URL to remind you what app the OAuth token is for.

    ", "type": "string", "name": "note_url", "in": "body", - "isRequired": false + "description": "

    A URL to remind you what app the OAuth token is for.

    " }, { - "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    ", "type": "string", "name": "fingerprint", "in": "body", - "isRequired": false + "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    " } ], "enabledForGitHubApps": false, @@ -303272,14 +303275,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -304470,69 +304465,62 @@ "bodyParameters": [ { "type": "string", - "description": "

    Billing email address. This address is not publicized.

    ", "name": "billing_email", "in": "body", - "isRequired": false + "description": "

    Billing email address. This address is not publicized.

    " }, { "type": "string", - "description": "

    The company name.

    ", "name": "company", "in": "body", - "isRequired": false + "description": "

    The company name.

    " }, { "type": "string", - "description": "

    The publicly visible email address.

    ", "name": "email", "in": "body", - "isRequired": false + "description": "

    The publicly visible email address.

    " }, { "type": "string", - "description": "

    The Twitter username of the company.

    ", "name": "twitter_username", "in": "body", - "isRequired": false + "description": "

    The Twitter username of the company.

    " }, { "type": "string", - "description": "

    The location.

    ", "name": "location", "in": "body", - "isRequired": false + "description": "

    The location.

    " }, { "type": "string", - "description": "

    The shorthand name of the company.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The shorthand name of the company.

    " }, { "type": "string", - "description": "

    The description of the company.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the company.

    " }, { "type": "boolean", - "description": "

    Whether an organization can use organization projects.

    ", "name": "has_organization_projects", "in": "body", - "isRequired": false + "description": "

    Whether an organization can use organization projects.

    " }, { "type": "boolean", - "description": "

    Whether repositories that belong to the organization can use repository projects.

    ", "name": "has_repository_projects", "in": "body", - "isRequired": false + "description": "

    Whether repositories that belong to the organization can use repository projects.

    " }, { "type": "string", + "name": "default_repository_permission", + "in": "body", "description": "

    Default permission level members have for organization repositories.

    ", "enum": [ "read", @@ -304540,69 +304528,56 @@ "admin", "none" ], - "default": "read", - "name": "default_repository_permission", - "in": "body", - "isRequired": false + "default": "read" }, { "type": "boolean", - "description": "

    Whether of non-admin organization members can create repositories. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

    ", - "default": true, "name": "members_can_create_repositories", "in": "body", - "isRequired": false + "description": "

    Whether of non-admin organization members can create repositories. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

    ", + "default": true }, { "type": "boolean", - "description": "

    Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_internal_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_private_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "string", + "name": "members_allowed_repository_creation_type", + "in": "body", "description": "

    Specifies which types of repositories non-admin organization members can create.\nNote: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See the parameter deprecation notice in the operation description for details.

    ", "enum": [ "all", "private", "none" - ], - "name": "members_allowed_repository_creation_type", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.

    ", - "default": true, "name": "members_can_create_pages", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.

    ", + "default": true }, { "type": "string", - "examples": [ - "\"http://github.blog\"" - ], "name": "blog", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -305932,14 +305907,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -307669,15 +307636,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role to give the user in the organization. Can be one of:
    \n* admin - The user will become an owner of the organization.
    \n* member - The user will become a non-owner member of the organization.

    ", "enum": [ "admin", "member" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -309517,13 +309483,13 @@ "bodyParameters": [ { "type": "string", - "description": "

    The state that the membership should be in. Only \"active\" will be accepted.

    ", - "enum": [ - "active" - ], "name": "state", "in": "body", - "isRequired": true + "description": "

    The state that the membership should be in. Only \"active\" will be accepted.

    ", + "isRequired": true, + "enum": [ + "active" + ] } ], "enabledForGitHubApps": false, @@ -310235,11 +310201,9 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

    ", - "default": false, "name": "async", "in": "body", - "isRequired": false + "description": "

    When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

    " } ], "enabledForGitHubApps": true, @@ -310597,203 +310561,66 @@ "bodyParameters": [ { "type": "string", - "description": "

    Must be passed as \"web\".

    ", "name": "name", "in": "body", + "description": "

    Must be passed as \"web\".

    ", "isRequired": true }, { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - }, - "username": { - "type": "string", - "examples": [ - "\"kdaigle\"" - ], - "name": "username", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "password": { - "type": "string", - "examples": [ - "\"password\"" - ], - "name": "password", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"kdaigle\"" - ], - "name": "username", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"password\"" - ], - "name": "password", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "username", + "description": "" + }, + { + "type": "string", + "name": "password", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, @@ -311200,162 +311027,54 @@ "bodyParameters": [ { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true }, { "type": "string", - "examples": [ - "\"web\"" - ], "name": "name", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -311727,53 +311446,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": true, @@ -312794,77 +312487,35 @@ "bodyParameters": [ { "type": "string", + "name": "build_type", + "in": "body", "description": "

    The process in which the Page will be built. Possible values are \"legacy\" and \"workflow\".

    ", "enum": [ "legacy", "workflow" - ], - "name": "build_type", - "in": "body", - "isRequired": false + ] }, { "type": "object", + "name": "source", + "in": "body", "description": "

    The source branch and directory used to publish your Pages site.

    ", - "properties": { - "branch": { + "childParamsGroups": [ + { "type": "string", - "description": "

    The repository branch used to publish your site's source files.

    ", "name": "branch", - "in": "body", - "rawType": "string", - "rawDescription": "The repository branch used to publish your site's source files.", - "isRequired": true, - "childParamsGroups": [] + "description": "

    The repository branch used to publish your site's source files.

    ", + "isRequired": true }, - "path": { + { "type": "string", + "name": "path", "description": "

    The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: /

    ", "enum": [ "/", "/docs" ], - "default": "/", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "branch" - ], - "name": "source", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "source", - "parentType": "object", - "id": "source-object", - "params": [ - { - "type": "string", - "description": "

    The repository branch used to publish your site's source files.

    ", - "name": "branch", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: /

    ", - "enum": [ - "/", - "/docs" - ], - "default": "/", - "name": "path", - "in": "body", - "isRequired": false - } - ] + "default": "/" } ] } @@ -313148,75 +312799,37 @@ "bodyParameters": [ { "type": "string or null", - "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    ", "name": "cname", "in": "body", - "isRequired": false + "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    " }, { "type": "boolean", - "description": "

    Specify whether HTTPS should be enforced for the repository.

    ", "name": "https_enforced", "in": "body", - "isRequired": false + "description": "

    Specify whether HTTPS should be enforced for the repository.

    " }, { "type": "boolean", - "description": "

    Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

    ", "name": "public", "in": "body", - "isRequired": false + "description": "

    Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

    " }, { "type": "string", + "name": "build_type", + "in": "body", "description": "

    The process by which the GitHub Pages site will be built. workflow means that the site is built by a custom GitHub Actions workflow. legacy means that the site is built by GitHub when changes are pushed to a specific branch.

    ", "enum": [ "legacy", "workflow" - ], - "name": "build_type", - "in": "body", - "isRequired": false + ] }, { - "anyOf": [ - { - "type": "string", - "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", - "enum": [ - "gh-pages", - "master", - "master /docs" - ] - }, - { - "type": "object", - "description": "Update the source for the repository. Must include the branch name and path.", - "properties": { - "branch": { - "type": "string", - "description": "The repository branch used to publish your site's source files." - }, - "path": { - "type": "string", - "description": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.", - "enum": [ - "/", - "/docs" - ] - } - }, - "required": [ - "branch", - "path" - ] - } - ], + "type": "", "name": "source", "in": "body", - "type": "", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -314798,17 +314411,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the project.

    ", "name": "name", "in": "body", + "description": "

    The name of the project.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the project.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The description of the project.

    " } ], "enabledForGitHubApps": true, @@ -315585,54 +315197,40 @@ ], "bodyParameters": [ { - "description": "

    Name of the project

    ", "type": "string", - "examples": [ - "Week One Sprint" - ], "name": "name", "in": "body", - "isRequired": false + "description": "

    Name of the project

    " }, { - "description": "

    Body of the project

    ", "type": "string or null", - "examples": [ - "This project represents the sprint of the first week in January" - ], "name": "body", "in": "body", - "isRequired": false + "description": "

    Body of the project

    " }, { - "description": "

    State of the project; either 'open' or 'closed'

    ", "type": "string", - "examples": [ - "open" - ], "name": "state", "in": "body", - "isRequired": false + "description": "

    State of the project; either 'open' or 'closed'

    " }, { - "description": "

    The baseline permission that all organization members have on this project

    ", "type": "string", + "name": "organization_permission", + "in": "body", + "description": "

    The baseline permission that all organization members have on this project

    ", "enum": [ "read", "write", "admin", "none" - ], - "name": "organization_permission", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether or not this project can be seen by everyone.

    ", "type": "boolean", "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether or not this project can be seen by everyone.

    " } ], "enabledForGitHubApps": true, @@ -316545,17 +316143,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the project.

    ", "name": "name", "in": "body", + "description": "

    The name of the project.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the project.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The description of the project.

    " } ], "enabledForGitHubApps": true, @@ -316943,24 +316540,17 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Name of the project

    ", "type": "string", - "examples": [ - "Week One Sprint" - ], "name": "name", "in": "body", + "description": "

    Name of the project

    ", "isRequired": true }, { - "description": "

    Body of the project

    ", "type": "string or null", - "examples": [ - "This project represents the sprint of the first week in January" - ], "name": "body", "in": "body", - "isRequired": false + "description": "

    Body of the project

    " } ], "enabledForGitHubApps": true, @@ -318120,24 +317710,16 @@ ], "bodyParameters": [ { - "description": "

    The project card's note

    ", "type": "string or null", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    The project card's note

    " }, { - "description": "

    Whether or not the card is archived

    ", "type": "boolean", - "examples": [ - false - ], "name": "archived", "in": "body", - "isRequired": false + "description": "

    Whether or not the card is archived

    " } ], "enabledForGitHubApps": true, @@ -318567,25 +318149,17 @@ ], "bodyParameters": [ { - "description": "

    The position of the card in a column. Can be one of: top, bottom, or after:<card_id> to place after the specified card.

    ", "type": "string", - "pattern": "^(?:top|bottom|after:\\d+)$", - "examples": [ - "bottom" - ], "name": "position", "in": "body", + "description": "

    The position of the card in a column. Can be one of: top, bottom, or after:<card_id> to place after the specified card.

    ", "isRequired": true }, { - "description": "

    The unique identifier of the column the card should be moved to

    ", "type": "integer", - "examples": [ - 42 - ], "name": "column_id", "in": "body", - "isRequired": false + "description": "

    The unique identifier of the column the card should be moved to

    " } ], "enabledForGitHubApps": true, @@ -319057,33 +318631,24 @@ ], "bodyParameters": [ { - "description": "

    The project card's note

    ", "type": "string or null", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", + "description": "

    The project card's note

    ", "isRequired": true }, { - "description": "

    The unique identifier of the content associated with the card

    ", "type": "integer", - "examples": [ - 42 - ], "name": "content_id", "in": "body", + "description": "

    The unique identifier of the content associated with the card

    ", "isRequired": true }, { - "description": "

    The piece of content associated with the card

    ", "type": "string", - "examples": [ - "PullRequest" - ], "name": "content_type", "in": "body", + "description": "

    The piece of content associated with the card

    ", "isRequired": true } ], @@ -319749,20 +319314,16 @@ ], "bodyParameters": [ { + "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant the collaborator.

    ", "enum": [ "read", "write", "admin" ], - "default": "write", - "type": "string", - "examples": [ - "write" - ], - "name": "permission", - "in": "body", - "isRequired": false + "default": "write" } ], "enabledForGitHubApps": true, @@ -320338,13 +319899,10 @@ ], "bodyParameters": [ { - "description": "

    Name of the project column

    ", "type": "string", - "examples": [ - "Remaining tasks" - ], "name": "name", "in": "body", + "description": "

    Name of the project column

    ", "isRequired": true } ], @@ -320550,14 +320108,10 @@ ], "bodyParameters": [ { - "description": "

    The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

    ", "type": "string", - "pattern": "^(?:first|last|after:\\d+)$", - "examples": [ - "last" - ], "name": "position", "in": "body", + "description": "

    The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

    ", "isRequired": true } ], @@ -320797,13 +320351,10 @@ ], "bodyParameters": [ { - "description": "

    Name of the project column

    ", "type": "string", - "examples": [ - "Remaining tasks" - ], "name": "name", "in": "body", + "description": "

    Name of the project column

    ", "isRequired": true } ], @@ -326535,55 +326086,47 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the new pull request. Required unless issue is specified.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the new pull request. Required unless issue is specified.

    " }, { "type": "string", - "description": "

    The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

    ", "name": "head", "in": "body", + "description": "

    The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

    ", "isRequired": true }, { "type": "string", - "description": "

    The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

    ", "name": "base", "in": "body", + "description": "

    The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    The contents of the pull request.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the pull request.

    " }, { "type": "boolean", - "description": "

    Indicates whether maintainers can modify the pull request.

    ", "name": "maintainer_can_modify", "in": "body", - "isRequired": false + "description": "

    Indicates whether maintainers can modify the pull request.

    " }, { "type": "boolean", - "description": "

    Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

    ", "name": "draft", "in": "body", - "isRequired": false + "description": "

    Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

    " }, { "type": "integer", - "description": "

    An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified.

    ", - "examples": [ - 1 - ], "name": "issue", "in": "body", - "isRequired": false + "description": "

    An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified.

    " } ], "enabledForGitHubApps": true, @@ -334220,42 +333763,37 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the pull request.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the pull request.

    " }, { "type": "string", - "description": "

    The contents of the pull request.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the pull request.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    State of this Pull Request. Either open or closed.

    ", "enum": [ "open", "closed" - ], - "name": "state", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "description": "

    The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

    ", "name": "base", "in": "body", - "isRequired": false + "description": "

    The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

    " }, { "type": "boolean", - "description": "

    Indicates whether maintainers can modify the pull request.

    ", "name": "maintainer_can_modify", "in": "body", - "isRequired": false + "description": "

    Indicates whether maintainers can modify the pull request.

    " } ], "enabledForGitHubApps": true, @@ -339199,36 +338737,32 @@ "bodyParameters": [ { "type": "string", - "description": "

    Title for the automatic commit message.

    ", "name": "commit_title", "in": "body", - "isRequired": false + "description": "

    Title for the automatic commit message.

    " }, { "type": "string", - "description": "

    Extra detail to append to automatic commit message.

    ", "name": "commit_message", "in": "body", - "isRequired": false + "description": "

    Extra detail to append to automatic commit message.

    " }, { "type": "string", - "description": "

    SHA that pull request head must match to allow merge.

    ", "name": "sha", "in": "body", - "isRequired": false + "description": "

    SHA that pull request head must match to allow merge.

    " }, { "type": "string", + "name": "merge_method", + "in": "body", "description": "

    Merge method to use. Possible values are merge, squash or rebase. Default is merge.

    ", "enum": [ "merge", "squash", "rebase" - ], - "name": "merge_method", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -339346,10 +338880,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

    ", "name": "expected_head_sha", "in": "body", - "isRequired": false + "description": "

    The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

    " } ], "enabledForGitHubApps": false, @@ -340738,9 +340271,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the reply to the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the reply to the review comment.

    ", "isRequired": true } ], @@ -342113,82 +341646,70 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the review comment.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

    ", "name": "commit_id", "in": "body", + "description": "

    The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

    ", "isRequired": true }, { "type": "string", - "description": "

    The relative path to the file that necessitates a comment.

    ", "name": "path", "in": "body", + "description": "

    The relative path to the file that necessitates a comment.

    ", "isRequired": true }, { "type": "integer", - "description": "

    This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    ", - "deprecated": true, - "x-github": { - "deprecationDate": "2022-11-01" - }, "name": "position", "in": "body", - "isRequired": false + "description": "

    This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    " }, { "type": "string", + "name": "side", + "in": "body", "description": "

    In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

    ", "enum": [ "LEFT", "RIGHT" - ], - "name": "side", - "in": "body", - "isRequired": false + ] }, { "type": "integer", - "description": "

    The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

    ", "name": "line", "in": "body", + "description": "

    The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

    ", "isRequired": true }, { "type": "integer", - "description": "

    Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

    ", "name": "start_line", "in": "body", - "isRequired": false + "description": "

    Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

    " }, { "type": "string", + "name": "start_side", + "in": "body", "description": "

    Required when using multi-line comments unless using in_reply_to. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

    ", "enum": [ "LEFT", "RIGHT", "side" - ], - "name": "start_side", - "in": "body", - "isRequired": false + ] }, { "type": "integer", - "description": "

    The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

    ", - "examples": [ - 2 - ], "name": "in_reply_to", "in": "body", - "isRequired": false + "description": "

    The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

    " } ], "enabledForGitHubApps": true, @@ -342837,9 +342358,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the review comment.

    ", "isRequired": true } ], @@ -343957,17 +343478,15 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of user logins that will be requested.

    ", "name": "reviewers", "in": "body", - "isRequired": false + "description": "

    An array of user logins that will be requested.

    " }, { "type": "array of strings", - "description": "

    An array of team slugs that will be requested.

    ", "name": "team_reviewers", "in": "body", - "isRequired": false + "description": "

    An array of team slugs that will be requested.

    " } ], "enabledForGitHubApps": true, @@ -349514,17 +349033,16 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of user logins that will be removed.

    ", "name": "reviewers", "in": "body", + "description": "

    An array of user logins that will be removed.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    An array of team slugs that will be removed.

    ", "name": "team_reviewers", "in": "body", - "isRequired": false + "description": "

    An array of team slugs that will be removed.

    " } ], "enabledForGitHubApps": true, @@ -355450,104 +354968,69 @@ "bodyParameters": [ { "type": "string", - "description": "

    The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

    ", "name": "commit_id", "in": "body", - "isRequired": false + "description": "

    The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

    " }, { "type": "string", - "description": "

    Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

    " }, { "type": "string", + "name": "event", + "in": "body", "description": "

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

    ", "enum": [ "APPROVE", "REQUEST_CHANGES", "COMMENT" - ], - "name": "event", - "in": "body", - "isRequired": false + ] }, { "type": "array of objects", - "description": "

    Use the following table to specify the location, destination, and contents of the draft review comment.

    ", "name": "comments", "in": "body", - "isRequired": false, + "description": "

    Use the following table to specify the location, destination, and contents of the draft review comment.

    ", "childParamsGroups": [ { - "parentName": "comments", - "parentType": "items", - "id": "comments-items", - "params": [ - { - "type": "string", - "description": "

    The relative path to the file that necessitates a review comment.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

    ", - "name": "position", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Text of the review comment.

    ", - "name": "body", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "examples": [ - 28 - ], - "name": "line", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "RIGHT" - ], - "name": "side", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "integer", - "examples": [ - 26 - ], - "name": "start_line", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "LEFT" - ], - "name": "start_side", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "path", + "description": "

    The relative path to the file that necessitates a review comment.

    ", + "isRequired": true + }, + { + "type": "integer", + "name": "position", + "description": "

    The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

    " + }, + { + "type": "string", + "name": "body", + "description": "

    Text of the review comment.

    ", + "isRequired": true + }, + { + "type": "integer", + "name": "line", + "description": "" + }, + { + "type": "string", + "name": "side", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + }, + { + "type": "string", + "name": "start_side", + "description": "" } ] } @@ -356394,9 +355877,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The body text of the pull request review.

    ", "name": "body", "in": "body", + "description": "

    The body text of the pull request review.

    ", "isRequired": true } ], @@ -357867,23 +357350,19 @@ "bodyParameters": [ { "type": "string", - "description": "

    The message for the pull request review dismissal

    ", "name": "message", "in": "body", + "description": "

    The message for the pull request review dismissal

    ", "isRequired": true }, { "type": "string", - "enum": [ - "DISMISS" - ], - "examples": [ - "\"DISMISS\"" - ], "name": "event", "in": "body", "description": "", - "isRequired": false + "enum": [ + "DISMISS" + ] } ], "enabledForGitHubApps": true, @@ -358309,22 +357788,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The body text of the pull request review

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The body text of the pull request review

    " }, { "type": "string", + "name": "event", + "in": "body", "description": "

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.

    ", + "isRequired": true, "enum": [ "APPROVE", "REQUEST_CHANGES", "COMMENT" - ], - "name": "event", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -359440,7 +358918,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -359450,10 +358931,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -360480,7 +359958,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -360490,10 +359971,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -361573,7 +361051,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the commit comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -361583,10 +361064,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -362609,7 +362087,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the issue comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -362619,10 +362100,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -363649,7 +363127,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the issue.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -363659,10 +363140,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -364685,7 +364163,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the pull request review comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -364695,10 +364176,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -365719,7 +365197,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the release.

    ", + "isRequired": true, "enum": [ "+1", "laugh", @@ -365727,10 +365208,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -366749,7 +366227,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -366759,10 +366240,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -367414,7 +366892,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -367424,10 +366905,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -368474,55 +367952,46 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the tag.

    ", "name": "tag_name", "in": "body", + "description": "

    The name of the tag.

    ", "isRequired": true }, { "type": "string", - "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    ", "name": "target_commitish", "in": "body", - "isRequired": false + "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    " }, { "type": "string", - "description": "

    The name of the release.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the release.

    " }, { "type": "string", - "description": "

    Text describing the contents of the tag.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Text describing the contents of the tag.

    " }, { "type": "boolean", - "description": "

    true to create a draft (unpublished) release, false to create a published one.

    ", - "default": false, "name": "draft", "in": "body", - "isRequired": false + "description": "

    true to create a draft (unpublished) release, false to create a published one.

    " }, { "type": "boolean", - "description": "

    true to identify the release as a prerelease. false to identify the release as a full release.

    ", - "default": false, "name": "prerelease", "in": "body", - "isRequired": false + "description": "

    true to identify the release as a prerelease. false to identify the release as a full release.

    " }, { "type": "boolean", - "description": "

    Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes.

    ", - "default": false, "name": "generate_release_notes", "in": "body", - "isRequired": false + "description": "

    Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes.

    " } ], "enabledForGitHubApps": true, @@ -369248,31 +368717,28 @@ "bodyParameters": [ { "type": "string", - "description": "

    The tag name for the release. This can be an existing tag or a new one.

    ", "name": "tag_name", "in": "body", + "description": "

    The tag name for the release. This can be an existing tag or a new one.

    ", "isRequired": true }, { "type": "string", - "description": "

    Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.

    ", "name": "target_commitish", "in": "body", - "isRequired": false + "description": "

    Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.

    " }, { "type": "string", - "description": "

    The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.

    ", "name": "previous_tag_name", "in": "body", - "isRequired": false + "description": "

    The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.

    " }, { "type": "string", - "description": "

    Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.

    ", "name": "configuration_file_path", "in": "body", - "isRequired": false + "description": "

    Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.

    " } ], "enabledForGitHubApps": true, @@ -371529,45 +370995,39 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the tag.

    ", "name": "tag_name", "in": "body", - "isRequired": false + "description": "

    The name of the tag.

    " }, { "type": "string", - "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    ", "name": "target_commitish", "in": "body", - "isRequired": false + "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    " }, { "type": "string", - "description": "

    The name of the release.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the release.

    " }, { "type": "string", - "description": "

    Text describing the contents of the tag.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Text describing the contents of the tag.

    " }, { "type": "boolean", - "description": "

    true makes the release a draft, and false publishes the release.

    ", "name": "draft", "in": "body", - "isRequired": false + "description": "

    true makes the release a draft, and false publishes the release.

    " }, { "type": "boolean", - "description": "

    true to identify the release as a prerelease, false to identify the release as a full release.

    ", "name": "prerelease", "in": "body", - "isRequired": false + "description": "

    true to identify the release as a prerelease, false to identify the release as a full release.

    " } ], "enabledForGitHubApps": true, @@ -372715,27 +372175,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The file name of the asset.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The file name of the asset.

    " }, { "type": "string", - "description": "

    An alternate short description of the asset. Used in place of the filename.

    ", "name": "label", "in": "body", - "isRequired": false + "description": "

    An alternate short description of the asset. Used in place of the filename.

    " }, { "type": "string", - "examples": [ - "\"uploaded\"" - ], "name": "state", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -376197,199 +375651,171 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the repository.

    ", "name": "name", "in": "body", + "description": "

    The name of the repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short description of the repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { "type": "string", - "description": "

    A URL with more information about the repository.

    ", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { "type": "boolean", - "description": "

    Whether the repository is private.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether the repository is private.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.

    ", "enum": [ "public", "private", "internal" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Either true to enable issues for this repository or false to disable them.

    ", - "default": true, "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Either true to enable issues for this repository or false to disable them.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", - "default": true, "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", - "default": true, "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    ", - "default": false, "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    " }, { "type": "integer", - "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    ", "name": "team_id", "in": "body", - "isRequired": false + "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    " }, { "type": "boolean", - "description": "

    Pass true to create an initial commit with empty README.

    ", - "default": false, "name": "auto_init", "in": "body", - "isRequired": false + "description": "

    Pass true to create an initial commit with empty README.

    " }, { "type": "string", - "description": "

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

    ", "name": "gitignore_template", "in": "body", - "isRequired": false + "description": "

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

    " }, { "type": "string", - "description": "

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

    ", "name": "license_template", "in": "body", - "isRequired": false + "description": "

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", - "default": true, "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", - "default": true, "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", - "default": true, "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    ", - "default": false, "name": "allow_auto_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    " }, { "type": "boolean", - "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    ", - "default": false, "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    ", - "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -383781,295 +383207,78 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the repository.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the repository.

    " }, { "type": "string", - "description": "

    A short description of the repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { "type": "string", - "description": "

    A URL with more information about the repository.

    ", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { "type": "boolean", - "description": "

    Either true to make the repository private or false to make it public. Default: false.
    \nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Either true to make the repository private or false to make it public. Default: false.
    \nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal.\"

    ", "enum": [ "public", "private", "internal" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { "type": "object or null", - "description": "

    Specify which security and analysis features to enable or disable for the repository.

    \n

    To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

    \n

    For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.

    \n

    You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

    ", - "properties": { - "advanced_security": { - "type": "object", - "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "advanced_security", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", - "childParamsGroups": [ - { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - "secret_scanning": { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", - "childParamsGroups": [ - { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - "secret_scanning_push_protection": { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning_push_protection", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", - "childParamsGroups": [ - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - } - }, "name": "security_and_analysis", "in": "body", - "isRequired": false, + "description": "

    Specify which security and analysis features to enable or disable for the repository.

    \n

    To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

    \n

    For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.

    \n

    You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

    ", "childParamsGroups": [ { - "parentName": "security_and_analysis", - "parentType": "object", - "id": "security_and_analysis-object", - "params": [ + "type": "object", + "name": "advanced_security", + "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", + "childParamsGroups": [ { - "type": "object", - "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "advanced_security", - "in": "body", - "childParamsGroups": [ - { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning", - "in": "body", - "childParamsGroups": [ - { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning_push_protection", - "in": "body", - "childParamsGroups": [ - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] + "type": "string", + "name": "status", + "description": "

    Can be enabled or disabled.

    " } ] }, { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ + "type": "object", + "name": "secret_scanning", + "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    Can be enabled or disabled.

    ", "name": "status", - "in": "body" + "description": "

    Can be enabled or disabled.

    " } ] }, { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ + "type": "object", + "name": "secret_scanning_push_protection", + "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    Can be enabled or disabled.

    ", "name": "status", - "in": "body" - } - ] - }, - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" + "description": "

    Can be enabled or disabled.

    " } ] } @@ -384077,160 +383286,135 @@ }, { "type": "boolean", - "description": "

    Either true to enable issues for this repository or false to disable them.

    ", - "default": true, "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Either true to enable issues for this repository or false to disable them.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", - "default": true, "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", - "default": true, "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    ", - "default": false, "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    " }, { "type": "string", - "description": "

    Updates the default branch for this repository.

    ", "name": "default_branch", "in": "body", - "isRequired": false + "description": "

    Updates the default branch for this repository.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", - "default": true, "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", - "default": true, "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", - "default": true, "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    ", - "default": false, "name": "allow_auto_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    " }, { "type": "boolean", - "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    ", - "default": false, "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    " }, { "type": "boolean", - "description": "

    Either true to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.

    ", - "default": false, "name": "allow_update_branch", "in": "body", - "isRequired": false + "description": "

    Either true to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    ", - "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    true to archive this repository. Note: You cannot unarchive repositories through the API.

    ", - "default": false, "name": "archived", "in": "body", - "isRequired": false + "description": "

    true to archive this repository. Note: You cannot unarchive repositories through the API.

    " }, { "type": "boolean", - "description": "

    Either true to allow private forks, or false to prevent private forks.

    ", - "default": false, "name": "allow_forking", "in": "body", - "isRequired": false + "description": "

    Either true to allow private forks, or false to prevent private forks.

    " } ], "enabledForGitHubApps": true, @@ -390339,21 +389523,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    A custom webhook event name. Must be 100 characters or fewer.

    ", - "minLength": 1, - "maxLength": 100, "name": "event_type", "in": "body", + "description": "

    A custom webhook event name. Must be 100 characters or fewer.

    ", "isRequired": true }, { "type": "object", - "description": "

    JSON payload with extra information about the webhook event that your action or workflow may use.

    ", - "additionalProperties": true, - "maxProperties": 10, "name": "client_payload", "in": "body", - "isRequired": false + "description": "

    JSON payload with extra information about the webhook event that your action or workflow may use.

    " } ], "enabledForGitHubApps": true, @@ -391030,9 +390209,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

    ", "name": "names", "in": "body", + "description": "

    An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

    ", "isRequired": true } ], @@ -391135,17 +390314,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The username or organization name the repository will be transferred to.

    ", "name": "new_owner", "in": "body", + "description": "

    The username or organization name the repository will be transferred to.

    ", "isRequired": true }, { "type": "array of integers", - "description": "

    ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

    ", "name": "team_ids", "in": "body", - "isRequired": false + "description": "

    ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

    " } ], "enabledForGitHubApps": true, @@ -393551,40 +392729,34 @@ "bodyParameters": [ { "type": "string", - "description": "

    The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

    ", "name": "owner", "in": "body", - "isRequired": false + "description": "

    The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

    " }, { "type": "string", - "description": "

    The name of the new repository.

    ", "name": "name", "in": "body", + "description": "

    The name of the new repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short description of the new repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the new repository.

    " }, { "type": "boolean", - "description": "

    Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.

    ", - "default": false, "name": "include_all_branches", "in": "body", - "isRequired": false + "description": "

    Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.

    " }, { "type": "boolean", - "description": "

    Either true to create a new private repository or false to create a new public one.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Either true to create a new private repository or false to create a new public one.

    " } ], "enabledForGitHubApps": false, @@ -399039,227 +398211,162 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The name of the repository.

    ", "type": "string", - "examples": [ - "Team Environment" - ], "name": "name", "in": "body", + "description": "

    The name of the repository.

    ", "isRequired": true }, { - "description": "

    A short description of the repository.

    ", "type": "string", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { - "description": "

    A URL with more information about the repository.

    ", "type": "string", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { - "description": "

    Whether the repository is private.

    ", - "default": false, "type": "boolean", "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether the repository is private.

    " }, { - "description": "

    Whether issues are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Whether issues are enabled.

    ", + "default": true }, { - "description": "

    Whether projects are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Whether projects are enabled.

    ", + "default": true }, { - "description": "

    Whether the wiki is enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Whether the wiki is enabled.

    ", + "default": true }, { - "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    ", "type": "integer", "name": "team_id", "in": "body", - "isRequired": false + "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    " }, { - "description": "

    Whether the repository is initialized with a minimal README.

    ", - "default": false, "type": "boolean", "name": "auto_init", "in": "body", - "isRequired": false + "description": "

    Whether the repository is initialized with a minimal README.

    " }, { - "description": "

    The desired language or platform to apply to the .gitignore.

    ", "type": "string", - "examples": [ - "Haskell" - ], "name": "gitignore_template", "in": "body", - "isRequired": false + "description": "

    The desired language or platform to apply to the .gitignore.

    " }, { - "description": "

    The license keyword of the open source license for this repository.

    ", "type": "string", - "examples": [ - "mit" - ], "name": "license_template", "in": "body", - "isRequired": false + "description": "

    The license keyword of the open source license for this repository.

    " }, { - "description": "

    Whether to allow squash merges for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Whether to allow squash merges for pull requests.

    ", + "default": true }, { - "description": "

    Whether to allow merge commits for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Whether to allow merge commits for pull requests.

    ", + "default": true }, { - "description": "

    Whether to allow rebase merges for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Whether to allow rebase merges for pull requests.

    ", + "default": true }, { - "description": "

    Whether to allow Auto-merge to be used on pull requests.

    ", - "default": false, "type": "boolean", - "examples": [ - false - ], "name": "allow_auto_merge", "in": "body", - "isRequired": false + "description": "

    Whether to allow Auto-merge to be used on pull requests.

    " }, { - "description": "

    Whether to delete head branches when pull requests are merged

    ", - "default": false, "type": "boolean", - "examples": [ - false - ], "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Whether to delete head branches when pull requests are merged

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether downloads are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_downloads", "in": "body", - "isRequired": false + "description": "

    Whether downloads are enabled.

    ", + "default": true }, { - "description": "

    Whether this repository acts as a template that can be used to generate new repositories.

    ", - "default": false, "type": "boolean", - "examples": [ - true - ], "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Whether this repository acts as a template that can be used to generate new repositories.

    " } ], "enabledForGitHubApps": false, @@ -403277,16 +402384,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.

    ", "name": "key_prefix", "in": "body", + "description": "

    The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.

    ", "isRequired": true }, { "type": "string", - "description": "

    The URL must contain <num> for the reference number.

    ", "name": "url_template", "in": "body", + "description": "

    The URL must contain <num> for the reference number.

    ", "isRequired": true } ], @@ -405355,7 +404462,7 @@ } ], "previews": [], - "descriptionHTML": "

    Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

    \n

    Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

    \n

    Note:

    \n
      \n
    • To get a repository's contents recursively, you can recursively get the tree.
      • \n
    • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
      • \n
    • This API supports files up to 1 megabyte in size.
      • \n
    \n

    If the content is a directory

    \n

    The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

    \n

    If the content is a symlink

    \n

    If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

    \n

    If the content is a submodule

    \n

    The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

    \n

    If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

    ", + "descriptionHTML": "

    Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

    \n

    Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

    \n

    Notes:

    \n
      \n
    • To get a repository's contents recursively, you can recursively get the tree.
      • \n
    • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
      • \n
    • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
      • \n
    • This API supports files up to 1 megabyte in size.
      • \n
    \n

    If the content is a directory

    \n

    The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

    \n

    If the content is a symlink

    \n

    If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

    \n

    If the content is a submodule

    \n

    The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

    \n

    If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

    ", "statusCodes": [ { "httpStatusCode": "200", @@ -405415,185 +404522,77 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message.

    ", "name": "message", "in": "body", + "description": "

    The commit message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The new file content, using Base64 encoding.

    ", "name": "content", "in": "body", + "description": "

    The new file content, using Base64 encoding.

    ", "isRequired": true }, { "type": "string", - "description": "

    Required if you are updating a file. The blob SHA of the file being replaced.

    ", "name": "sha", "in": "body", - "isRequired": false + "description": "

    Required if you are updating a file. The blob SHA of the file being replaced.

    " }, { "type": "string", - "description": "

    The branch name. Default: the repository’s default branch (usually master)

    ", "name": "branch", "in": "body", - "isRequired": false + "description": "

    The branch name. Default: the repository’s default branch (usually master)

    " }, { "type": "object", - "description": "

    The person that committed the file. Default: the authenticated user.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "examples": [ - "\"2013-01-05T13:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "committer", "in": "body", - "isRequired": false, + "description": "

    The person that committed the file. Default: the authenticated user.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "examples": [ - "\"2013-01-05T13:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "" } ] }, { "type": "object", - "description": "

    The author of the file. Default: The committer or the authenticated user if you omit committer.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "examples": [ - "\"2013-01-15T17:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "author", "in": "body", - "isRequired": false, + "description": "

    The author of the file. Default: The committer or the authenticated user if you omit committer.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "examples": [ - "\"2013-01-15T17:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "" } ] } @@ -406141,118 +405140,57 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message.

    ", "name": "message", "in": "body", + "description": "

    The commit message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The blob SHA of the file being replaced.

    ", "name": "sha", "in": "body", + "description": "

    The blob SHA of the file being replaced.

    ", "isRequired": true }, { "type": "string", - "description": "

    The branch name. Default: the repository’s default branch (usually master)

    ", "name": "branch", "in": "body", - "isRequired": false + "description": "

    The branch name. Default: the repository’s default branch (usually master)

    " }, { "type": "object", - "description": "

    object containing information about the committer.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - } - }, "name": "committer", "in": "body", - "isRequired": false, + "description": "

    object containing information about the committer.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " } ] }, { "type": "object", - "description": "

    object containing information about the author.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - } - }, "name": "author", "in": "body", - "isRequired": false, + "description": "

    object containing information about the author.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " } ] } @@ -409406,10 +408344,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    Optional parameter to specify the organization name if forking into an organization.

    ", "name": "organization", "in": "body", - "isRequired": false + "description": "

    Optional parameter to specify the organization name if forking into an organization.

    " } ], "enabledForGitHubApps": true, @@ -420696,7 +419633,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] }, @@ -427294,18 +426232,20 @@ ], "bodyParameters": [ { - "description": "

    Sets the state of the secret scanning alert. Can be either open or resolved. You must provide resolution when you set the state to resolved.

    ", "type": "string", + "name": "state", + "in": "body", + "description": "

    Sets the state of the secret scanning alert. Can be either open or resolved. You must provide resolution when you set the state to resolved.

    ", + "isRequired": true, "enum": [ "open", "resolved" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", + "name": "resolution", + "in": "body", "description": "

    Required when the state is resolved. The reason for resolving the alert.

    ", "enum": [ null, @@ -427313,10 +426253,7 @@ "wont_fix", "revoked", "used_in_tests" - ], - "name": "resolution", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -428181,68 +427118,61 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", + "description": "

    The name of the team.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "array of strings", - "description": "

    List GitHub IDs for organization members who will become team maintainers.

    ", "name": "maintainers", "in": "body", - "isRequired": false + "description": "

    List GitHub IDs for organization members who will become team maintainers.

    " }, { "type": "array of strings", - "description": "

    The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

    ", "name": "repo_names", "in": "body", - "isRequired": false + "description": "

    The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nDefault: secret
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.
    \nDefault for child team: closed

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " }, { "type": "string", - "description": "

    The distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"Update LDAP mapping for a team\" endpoint to change the LDAP DN. For more information, see \"Using LDAP.\"

    ", "name": "ldap_dn", "in": "body", - "isRequired": false + "description": "

    The distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"Update LDAP mapping for a team\" endpoint to change the LDAP DN. For more information, see \"Using LDAP.\"

    " } ], "enabledForGitHubApps": true, @@ -428538,8 +427468,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -429254,8 +428184,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -429681,48 +428611,43 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the team.

    " }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push", "admin" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer or null", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " } ], "enabledForGitHubApps": true, @@ -430018,8 +428943,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -431236,15 +430161,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"

    ", "enum": [ "read", "write", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -436275,11 +435199,10 @@ "bodyParameters": [ { "type": "string", - "description": "

    The permission to grant the team on this repository. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", - "default": "push", "name": "permission", "in": "body", - "isRequired": false + "description": "

    The permission to grant the team on this repository. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", + "default": "push" } ], "enabledForGitHubApps": true, @@ -437000,8 +435923,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -437418,48 +436341,44 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", + "description": "

    The name of the team.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push", "admin" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer or null", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " } ], "enabledForGitHubApps": true, @@ -437754,8 +436673,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -438427,8 +437346,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -439634,15 +438553,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"

    ", "enum": [ "read", "write", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -444650,15 +443568,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant the team on this repository. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", "enum": [ "pull", "push", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -445385,8 +444302,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -446294,9 +445211,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -447173,9 +446090,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -448127,9 +447044,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -448986,9 +447903,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -449984,25 +448901,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", + "description": "

    The discussion post's title.

    ", "isRequired": true }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion post's body text.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    " } ], "enabledForGitHubApps": true, @@ -450947,17 +449862,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The discussion post's title.

    " }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The discussion post's body text.

    " } ], "enabledForGitHubApps": true, @@ -451966,25 +450879,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", + "description": "

    The discussion post's title.

    ", "isRequired": true }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion post's body text.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    " } ], "enabledForGitHubApps": true, @@ -452909,17 +451820,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The discussion post's title.

    " }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The discussion post's body text.

    " } ], "enabledForGitHubApps": true, @@ -453838,15 +452747,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role that this user should have in the team.

    ", "enum": [ "member", "maintainer" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -454585,15 +453493,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role that this user should have in the team.

    ", "enum": [ "member", "maintainer" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -456050,78 +454957,52 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The new name of the user.

    ", "type": "string", - "examples": [ - "Omar Jahandar" - ], "name": "name", "in": "body", - "isRequired": false + "description": "

    The new name of the user.

    " }, { - "description": "

    The publicly visible email address of the user.

    ", "type": "string", - "examples": [ - "omar@example.com" - ], "name": "email", "in": "body", - "isRequired": false + "description": "

    The publicly visible email address of the user.

    " }, { - "description": "

    The new blog URL of the user.

    ", "type": "string", - "examples": [ - "blog.example.com" - ], "name": "blog", "in": "body", - "isRequired": false + "description": "

    The new blog URL of the user.

    " }, { - "description": "

    The new Twitter username of the user.

    ", "type": "string or null", - "examples": [ - "therealomarj" - ], "name": "twitter_username", "in": "body", - "isRequired": false + "description": "

    The new Twitter username of the user.

    " }, { - "description": "

    The new company of the user.

    ", "type": "string", - "examples": [ - "Acme corporation" - ], "name": "company", "in": "body", - "isRequired": false + "description": "

    The new company of the user.

    " }, { - "description": "

    The new location of the user.

    ", "type": "string", - "examples": [ - "Berlin, Germany" - ], "name": "location", "in": "body", - "isRequired": false + "description": "

    The new location of the user.

    " }, { - "description": "

    The new hiring availability of the user.

    ", "type": "boolean", "name": "hireable", "in": "body", - "isRequired": false + "description": "

    The new hiring availability of the user.

    " }, { - "description": "

    The new short biography of the user.

    ", "type": "string", "name": "bio", "in": "body", - "isRequired": false + "description": "

    The new short biography of the user.

    " } ], "enabledForGitHubApps": false, @@ -458346,11 +457227,10 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", "type": "array of strings", - "examples": [], "name": "emails", "in": "body", + "description": "

    Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", "isRequired": true } ], @@ -458480,10 +457360,10 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Email addresses associated with the GitHub user account.

    ", "type": "array of strings", "name": "emails", "in": "body", + "description": "

    Email addresses associated with the GitHub user account.

    ", "isRequired": true } ], @@ -460196,10 +459076,10 @@ "parameters": [], "bodyParameters": [ { - "description": "

    A GPG key in ASCII-armored format.

    ", "type": "string", "name": "armored_public_key", "in": "body", + "description": "

    A GPG key in ASCII-armored format.

    ", "isRequired": true } ], @@ -461215,21 +460095,16 @@ "parameters": [], "bodyParameters": [ { - "description": "

    A descriptive name for the new key.

    ", "type": "string", - "examples": [ - "Personal MacBook Air" - ], "name": "title", "in": "body", - "isRequired": false + "description": "

    A descriptive name for the new key.

    " }, { - "description": "

    The public SSH key to add to your GitHub account.

    ", "type": "string", - "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ", "name": "key", "in": "body", + "description": "

    The public SSH key to add to your GitHub account.

    ", "isRequired": true } ], @@ -461743,53 +460618,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": true, @@ -462824,188 +461673,63 @@ "bodyParameters": [ { "type": "string", - "description": "

    Use web to create a webhook. Default: web. This parameter only accepts the value web.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    Use web to create a webhook. Default: web. This parameter only accepts the value web.

    " }, { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "childParamsGroups": [] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ], - "name": "token", - "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ], - "name": "digest", - "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] - } - }, "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body" - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body" - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body" - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " - }, - { - "type": "string", - "examples": [ - "\"abc\"" - ], - "name": "token", - "in": "body", - "description": "" - }, - { - "type": "string", - "examples": [ - "\"sha256\"" - ], - "name": "digest", - "in": "body", - "description": "" - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    " + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "token", + "description": "" + }, + { + "type": "string", + "name": "digest", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, @@ -463631,210 +462355,70 @@ "bodyParameters": [ { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - }, - "address": { - "type": "string", - "examples": [ - "\"bar@example.com\"" - ], - "name": "address", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "room": { - "type": "string", - "examples": [ - "\"The Serious Room\"" - ], - "name": "room", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"bar@example.com\"" - ], - "name": "address", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"The Serious Room\"" - ], - "name": "room", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "address", + "description": "" + }, + { + "type": "string", + "name": "room", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for. This replaces the entire array of events.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "array of strings", - "description": "

    Determines a list of events to be added to the list of events that the Hook triggers for.

    ", "name": "add_events", "in": "body", - "isRequired": false + "description": "

    Determines a list of events to be added to the list of events that the Hook triggers for.

    " }, { "type": "array of strings", - "description": "

    Determines a list of events to be removed from the list of events that the Hook triggers for.

    ", "name": "remove_events", "in": "body", - "isRequired": false + "description": "

    Determines a list of events to be removed from the list of events that the Hook triggers for.

    " }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json index c05ebed7f2..da986888d5 100644 --- a/lib/rest/static/decorated/ghes-3.4.json +++ b/lib/rest/static/decorated/ghes-3.4.json @@ -937,27 +937,26 @@ "bodyParameters": [ { "type": "string", + "name": "enabled_organizations", + "in": "body", "description": "

    The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.

    ", + "isRequired": true, "enum": [ "all", "none", "selected" - ], - "name": "enabled_organizations", - "in": "body", - "isRequired": true + ] }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": false, @@ -1208,10 +1207,10 @@ ], "bodyParameters": [ { - "description": "

    List of organization IDs to enable for GitHub Actions.

    ", "type": "array of integers", "name": "selected_organization_ids", "in": "body", + "description": "

    List of organization IDs to enable for GitHub Actions.

    ", "isRequired": true } ], @@ -1453,16 +1452,16 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", + "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "isRequired": true } ], @@ -1607,27 +1606,26 @@ "bodyParameters": [ { "type": "string", + "name": "enabled_repositories", + "in": "body", "description": "

    The policy that controls the repositories in the organization that are allowed to run GitHub Actions.

    ", + "isRequired": true, "enum": [ "all", "none", "selected" - ], - "name": "enabled_repositories", - "in": "body", - "isRequired": true + ] }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -3262,10 +3260,10 @@ ], "bodyParameters": [ { - "description": "

    List of repository IDs to enable for GitHub Actions.

    ", "type": "array of integers", "name": "selected_repository_ids", "in": "body", + "description": "

    List of repository IDs to enable for GitHub Actions.

    ", "isRequired": true } ], @@ -3507,16 +3505,16 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", + "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "isRequired": true } ], @@ -3671,22 +3669,21 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub Actions is enabled on the repository.

    ", "name": "enabled", "in": "body", + "description": "

    Whether GitHub Actions is enabled on the repository.

    ", "isRequired": true }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -3835,16 +3832,16 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", + "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "isRequired": true } ], @@ -4269,37 +4266,33 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret.

    ", + "isRequired": true, "enum": [ "all", "private", "selected" - ], - "name": "visibility", - "in": "body", - "isRequired": true + ] }, { "type": "array of integers", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", - "isRequired": false + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    " } ], "enabledForGitHubApps": true, @@ -6736,9 +6729,9 @@ "bodyParameters": [ { "type": "array of integers", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "isRequired": true } ], @@ -7290,18 +7283,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " } ], "enabledForGitHubApps": true, @@ -7813,17 +7803,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

    ", "isRequired": true }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", + "description": "

    ID of the key you used to encrypt the secret.

    ", "isRequired": true } ], @@ -8124,44 +8113,39 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all organizations or select individual organization.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all organizations or select individual organization.

    ", "enum": [ "selected", "all" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { - "description": "

    List of organization IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_organization_ids", "in": "body", - "isRequired": false + "description": "

    List of organization IDs that can access the runner group.

    " }, { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", - "isRequired": false + "description": "

    List of runner IDs to add to the runner group.

    " }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " } ], "enabledForGitHubApps": false, @@ -8375,31 +8359,27 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", - "isRequired": false + "description": "

    Name of the runner group.

    " }, { - "description": "

    Visibility of a runner group. You can select all organizations or select individual organizations.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all organizations or select individual organizations.

    ", "enum": [ "selected", "all" ], - "default": "all", - "name": "visibility", - "in": "body", - "isRequired": false + "default": "all" }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " } ], "enabledForGitHubApps": false, @@ -8769,10 +8749,10 @@ ], "bodyParameters": [ { - "description": "

    List of organization IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_organization_ids", "in": "body", + "description": "

    List of organization IDs that can access the runner group.

    ", "isRequired": true } ], @@ -9191,10 +9171,10 @@ ], "bodyParameters": [ { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", + "description": "

    List of runner IDs to add to the runner group.

    ", "isRequired": true } ], @@ -9536,46 +9516,41 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

    ", "enum": [ "selected", "all", "private" ], - "default": "all", - "name": "visibility", - "in": "body", - "isRequired": false + "default": "all" }, { - "description": "

    List of repository IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_repository_ids", "in": "body", - "isRequired": false + "description": "

    List of repository IDs that can access the runner group.

    " }, { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", - "isRequired": false + "description": "

    List of runner IDs to add to the runner group.

    " }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " } ], "enabledForGitHubApps": true, @@ -9807,31 +9782,28 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

    ", "enum": [ "selected", "all", "private" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " } ], "enabledForGitHubApps": true, @@ -12449,10 +12421,10 @@ ], "bodyParameters": [ { - "description": "

    List of repository IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_repository_ids", "in": "body", + "description": "

    List of repository IDs that can access the runner group.

    ", "isRequired": true } ], @@ -12871,10 +12843,10 @@ ], "bodyParameters": [ { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", + "description": "

    List of runner IDs to add to the runner group.

    ", "isRequired": true } ], @@ -16706,11 +16678,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "maxItems": 100, - "description": "

    The names of the custom labels to add to the runner.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to add to the runner.

    ", "isRequired": true } ], @@ -16853,11 +16823,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 0, - "maxItems": 100, - "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "isRequired": true } ], @@ -20901,11 +20869,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "maxItems": 100, - "description": "

    The names of the custom labels to add to the runner.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to add to the runner.

    ", "isRequired": true } ], @@ -21048,11 +21014,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 0, - "maxItems": 100, - "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "isRequired": true } ], @@ -25171,11 +25135,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "maxItems": 100, - "description": "

    The names of the custom labels to add to the runner.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to add to the runner.

    ", "isRequired": true } ], @@ -25328,11 +25290,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 0, - "maxItems": 100, - "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "isRequired": true } ], @@ -37750,37 +37710,27 @@ "bodyParameters": [ { "type": "array of integers", - "description": "

    The list of environment ids to approve or reject

    ", - "examples": [ - 161171787, - 161171795 - ], "name": "environment_ids", "in": "body", + "description": "

    The list of environment ids to approve or reject

    ", "isRequired": true }, { "type": "string", + "name": "state", + "in": "body", "description": "

    Whether to approve or reject deployment to the specified environments.

    ", + "isRequired": true, "enum": [ "approved", "rejected" - ], - "examples": [ - "approved" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    A comment to accompany the deployment review

    ", - "examples": [ - "Ship it!" - ], "name": "comment", "in": "body", + "description": "

    A comment to accompany the deployment review

    ", "isRequired": true } ], @@ -44041,21 +43991,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The git reference for the workflow. The reference can be a branch or tag name.

    ", "name": "ref", "in": "body", + "description": "

    The git reference for the workflow. The reference can be a branch or tag name.

    ", "isRequired": true }, { "type": "object", - "description": "

    Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.

    ", - "additionalProperties": { - "type": "string" - }, - "maxProperties": 10, "name": "inputs", "in": "body", - "isRequired": false + "description": "

    Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.

    " } ], "enabledForGitHubApps": true, @@ -82307,19 +82252,16 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    ", "type": "string", - "format": "date-time", "name": "last_read_at", "in": "body", - "isRequired": false + "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    " }, { - "description": "

    Whether the notification has been read.

    ", "type": "boolean", "name": "read", "in": "body", - "isRequired": false + "description": "

    Whether the notification has been read.

    " } ], "enabledForGitHubApps": false, @@ -84898,12 +84840,10 @@ ], "bodyParameters": [ { - "description": "

    Whether to block all notifications from a thread.

    ", - "default": false, "type": "boolean", "name": "ignored", "in": "body", - "isRequired": false + "description": "

    Whether to block all notifications from a thread.

    " } ], "enabledForGitHubApps": false, @@ -87486,11 +87426,9 @@ "bodyParameters": [ { "type": "string", - "format": "date-time", - "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    ", "name": "last_read_at", "in": "body", - "isRequired": false + "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    " } ], "enabledForGitHubApps": false, @@ -95138,17 +95076,15 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Determines if notifications should be received from this repository.

    ", "name": "subscribed", "in": "body", - "isRequired": false + "description": "

    Determines if notifications should be received from this repository.

    " }, { "type": "boolean", - "description": "

    Determines if all notifications should be blocked from this repository.

    ", "name": "ignored", "in": "body", - "isRequired": false + "description": "

    Determines if all notifications should be blocked from this repository.

    " } ], "enabledForGitHubApps": false, @@ -101187,14 +101123,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -102116,14 +102044,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -102685,756 +102605,291 @@ ], "bodyParameters": [ { - "description": "

    List of repository names that the token should have access to

    ", "type": "array of strings", "name": "repositories", "in": "body", - "isRequired": false + "description": "

    List of repository names that the token should have access to

    " }, { - "description": "

    List of repository IDs that the token should have access to

    ", "type": "array of integers", - "examples": [ - 1 - ], "name": "repository_ids", "in": "body", - "isRequired": false + "description": "

    List of repository IDs that the token should have access to

    " }, { - "title": "App Permissions", "type": "object", + "name": "permissions", + "in": "body", "description": "

    The permissions granted to the user-to-server access token.

    ", - "properties": { - "actions": { + "childParamsGroups": [ + { "type": "string", + "name": "actions", "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", "enum": [ "read", "write" - ], - "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + ] }, - "administration": { + { "type": "string", + "name": "administration", "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", "enum": [ "read", "write" - ], - "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + ] }, - "checks": { + { "type": "string", + "name": "checks", "description": "

    The level of permission to grant the access token for checks on code.

    ", "enum": [ "read", "write" - ], - "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + ] }, - "contents": { + { "type": "string", + "name": "contents", "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", "enum": [ "read", "write" - ], - "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + ] }, - "organization_custom_roles": { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for custom roles management.", - "childParamsGroups": [] - }, - "deployments": { + { "type": "string", + "name": "deployments", "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", "enum": [ "read", "write" - ], - "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + ] }, - "environments": { + { "type": "string", + "name": "environments", "description": "

    The level of permission to grant the access token for managing repository environments.

    ", "enum": [ "read", "write" - ], - "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + ] }, - "issues": { + { "type": "string", + "name": "issues", "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", "enum": [ "read", "write" - ], - "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + ] }, - "metadata": { + { "type": "string", + "name": "metadata", "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", "enum": [ "read", "write" - ], - "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + ] }, - "packages": { + { "type": "string", + "name": "packages", "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "pages": { + { "type": "string", + "name": "pages", "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", "enum": [ "read", "write" - ], - "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + ] }, - "pull_requests": { + { "type": "string", + "name": "pull_requests", "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", "enum": [ "read", "write" - ], - "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + ] }, - "repository_hooks": { + { "type": "string", + "name": "repository_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", "enum": [ "read", "write" - ], - "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + ] }, - "repository_projects": { + { "type": "string", + "name": "repository_projects", "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", "enum": [ "read", "write", "admin" - ], - "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + ] }, - "secret_scanning_alerts": { + { "type": "string", + "name": "secret_scanning_alerts", "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + ] }, - "secrets": { + { "type": "string", + "name": "secrets", "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", "enum": [ "read", "write" - ], - "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + ] }, - "security_events": { + { "type": "string", + "name": "security_events", "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + ] }, - "single_file": { + { "type": "string", + "name": "single_file", "description": "

    The level of permission to grant the access token to manage just a single file.

    ", "enum": [ "read", "write" - ], - "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + ] }, - "statuses": { + { "type": "string", + "name": "statuses", "description": "

    The level of permission to grant the access token for commit statuses.

    ", "enum": [ "read", "write" - ], - "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + ] }, - "vulnerability_alerts": { + { "type": "string", + "name": "vulnerability_alerts", "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", "enum": [ "read", "write" - ], - "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + ] }, - "workflows": { + { "type": "string", + "name": "workflows", "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", "enum": [ "write" - ], - "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + ] }, - "members": { + { "type": "string", + "name": "members", "description": "

    The level of permission to grant the access token for organization teams and members.

    ", "enum": [ "read", "write" - ], - "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + ] }, - "organization_administration": { + { "type": "string", + "name": "organization_administration", "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + ] }, - "organization_hooks": { + { "type": "string", + "name": "organization_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + ] }, - "organization_plan": { + { "type": "string", + "name": "organization_plan", "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", "enum": [ "read" - ], - "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + ] }, - "organization_projects": { + { "type": "string", + "name": "organization_projects", "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", "enum": [ "read", "write", "admin" - ], - "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + ] }, - "organization_packages": { + { "type": "string", + "name": "organization_packages", "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "organization_secrets": { + { "type": "string", + "name": "organization_secrets", "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", "enum": [ "read", "write" - ], - "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + ] }, - "organization_self_hosted_runners": { + { "type": "string", + "name": "organization_self_hosted_runners", "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + ] }, - "organization_user_blocking": { + { "type": "string", + "name": "organization_user_blocking", "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + ] }, - "team_discussions": { + { "type": "string", + "name": "team_discussions", "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", "enum": [ "read", "write" - ], - "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - }, - "name": "permissions", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "permissions", - "parentType": "object", - "id": "permissions-object", - "params": [ - { - "type": "string", - "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", - "enum": [ - "read", - "write" - ], - "name": "actions", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", - "enum": [ - "read", - "write" - ], - "name": "administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for checks on code.

    ", - "enum": [ - "read", - "write" - ], - "name": "checks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "contents", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "deployments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for managing repository environments.

    ", - "enum": [ - "read", - "write" - ], - "name": "environments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", - "enum": [ - "read", - "write" - ], - "name": "issues", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", - "enum": [ - "read", - "write" - ], - "name": "metadata", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", - "enum": [ - "read", - "write" - ], - "name": "pages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "pull_requests", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", - "enum": [ - "read", - "write" - ], - "name": "repository_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "repository_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "secret_scanning_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "security_events", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage just a single file.

    ", - "enum": [ - "read", - "write" - ], - "name": "single_file", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for commit statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "statuses", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "vulnerability_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", - "enum": [ - "write" - ], - "name": "workflows", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization teams and members.

    ", - "enum": [ - "read", - "write" - ], - "name": "members", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", - "enum": [ - "read" - ], - "name": "organization_plan", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "organization_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_self_hosted_runners", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_user_blocking", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", - "enum": [ - "read", - "write" - ], - "name": "team_discussions", - "in": "body" - } ] } ] @@ -103645,14 +103100,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -106274,14 +105721,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -107207,14 +106646,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -108138,14 +107569,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -110751,14 +110174,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -113025,9 +112440,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", + "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "isRequired": true } ], @@ -113090,10 +112505,10 @@ ], "bodyParameters": [ { - "description": "

    The access_token of the OAuth application.

    ", "type": "string", "name": "access_token", "in": "body", + "description": "

    The access_token of the OAuth application.

    ", "isRequired": true } ], @@ -113456,14 +112871,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -113961,10 +113368,10 @@ ], "bodyParameters": [ { - "description": "

    The access_token of the OAuth application.

    ", "type": "string", "name": "access_token", "in": "body", + "description": "

    The access_token of the OAuth application.

    ", "isRequired": true } ], @@ -114327,14 +113734,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -114829,9 +114228,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", + "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "isRequired": true } ], @@ -114895,785 +114294,309 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", - "examples": [ - "e72e16c7e42f292c6912e7710c838347ae178b4a" - ], "name": "access_token", "in": "body", + "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "isRequired": true }, { - "description": "

    The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

    ", "type": "string", - "examples": [ - "octocat" - ], "name": "target", "in": "body", - "isRequired": false + "description": "

    The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

    " }, { - "description": "

    The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

    ", "type": "integer", - "examples": [ - 1 - ], "name": "target_id", "in": "body", - "isRequired": false + "description": "

    The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

    " }, { - "description": "

    The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

    ", "type": "array of strings", "name": "repositories", "in": "body", - "isRequired": false + "description": "

    The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

    " }, { - "description": "

    The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

    ", "type": "array of integers", - "examples": [ - 1 - ], "name": "repository_ids", "in": "body", - "isRequired": false + "description": "

    The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

    " }, { - "title": "App Permissions", "type": "object", + "name": "permissions", + "in": "body", "description": "

    The permissions granted to the user-to-server access token.

    ", - "properties": { - "actions": { + "childParamsGroups": [ + { "type": "string", + "name": "actions", "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", "enum": [ "read", "write" - ], - "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + ] }, - "administration": { + { "type": "string", + "name": "administration", "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", "enum": [ "read", "write" - ], - "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + ] }, - "checks": { + { "type": "string", + "name": "checks", "description": "

    The level of permission to grant the access token for checks on code.

    ", "enum": [ "read", "write" - ], - "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + ] }, - "contents": { + { "type": "string", + "name": "contents", "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", "enum": [ "read", "write" - ], - "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + ] }, - "organization_custom_roles": { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for custom roles management.", - "childParamsGroups": [] - }, - "deployments": { + { "type": "string", + "name": "deployments", "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", "enum": [ "read", "write" - ], - "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + ] }, - "environments": { + { "type": "string", + "name": "environments", "description": "

    The level of permission to grant the access token for managing repository environments.

    ", "enum": [ "read", "write" - ], - "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + ] }, - "issues": { + { "type": "string", + "name": "issues", "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", "enum": [ "read", "write" - ], - "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + ] }, - "metadata": { + { "type": "string", + "name": "metadata", "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", "enum": [ "read", "write" - ], - "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + ] }, - "packages": { + { "type": "string", + "name": "packages", "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "pages": { + { "type": "string", + "name": "pages", "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", "enum": [ "read", "write" - ], - "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + ] }, - "pull_requests": { + { "type": "string", + "name": "pull_requests", "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", "enum": [ "read", "write" - ], - "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + ] }, - "repository_hooks": { + { "type": "string", + "name": "repository_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", "enum": [ "read", "write" - ], - "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + ] }, - "repository_projects": { + { "type": "string", + "name": "repository_projects", "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", "enum": [ "read", "write", "admin" - ], - "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + ] }, - "secret_scanning_alerts": { + { "type": "string", + "name": "secret_scanning_alerts", "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + ] }, - "secrets": { + { "type": "string", + "name": "secrets", "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", "enum": [ "read", "write" - ], - "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + ] }, - "security_events": { + { "type": "string", + "name": "security_events", "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + ] }, - "single_file": { + { "type": "string", + "name": "single_file", "description": "

    The level of permission to grant the access token to manage just a single file.

    ", "enum": [ "read", "write" - ], - "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + ] }, - "statuses": { + { "type": "string", + "name": "statuses", "description": "

    The level of permission to grant the access token for commit statuses.

    ", "enum": [ "read", "write" - ], - "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + ] }, - "vulnerability_alerts": { + { "type": "string", + "name": "vulnerability_alerts", "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", "enum": [ "read", "write" - ], - "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + ] }, - "workflows": { + { "type": "string", + "name": "workflows", "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", "enum": [ "write" - ], - "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + ] }, - "members": { + { "type": "string", + "name": "members", "description": "

    The level of permission to grant the access token for organization teams and members.

    ", "enum": [ "read", "write" - ], - "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + ] }, - "organization_administration": { + { "type": "string", + "name": "organization_administration", "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + ] }, - "organization_hooks": { + { "type": "string", + "name": "organization_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + ] }, - "organization_plan": { + { "type": "string", + "name": "organization_plan", "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", "enum": [ "read" - ], - "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + ] }, - "organization_projects": { + { "type": "string", + "name": "organization_projects", "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", "enum": [ "read", "write", "admin" - ], - "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + ] }, - "organization_packages": { + { "type": "string", + "name": "organization_packages", "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "organization_secrets": { + { "type": "string", + "name": "organization_secrets", "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", "enum": [ "read", "write" - ], - "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + ] }, - "organization_self_hosted_runners": { + { "type": "string", + "name": "organization_self_hosted_runners", "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + ] }, - "organization_user_blocking": { + { "type": "string", + "name": "organization_user_blocking", "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + ] }, - "team_discussions": { + { "type": "string", + "name": "team_discussions", "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", "enum": [ "read", "write" - ], - "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - }, - "name": "permissions", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "permissions", - "parentType": "object", - "id": "permissions-object", - "params": [ - { - "type": "string", - "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", - "enum": [ - "read", - "write" - ], - "name": "actions", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", - "enum": [ - "read", - "write" - ], - "name": "administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for checks on code.

    ", - "enum": [ - "read", - "write" - ], - "name": "checks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "contents", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "deployments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for managing repository environments.

    ", - "enum": [ - "read", - "write" - ], - "name": "environments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", - "enum": [ - "read", - "write" - ], - "name": "issues", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", - "enum": [ - "read", - "write" - ], - "name": "metadata", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", - "enum": [ - "read", - "write" - ], - "name": "pages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "pull_requests", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", - "enum": [ - "read", - "write" - ], - "name": "repository_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "repository_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "secret_scanning_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "security_events", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage just a single file.

    ", - "enum": [ - "read", - "write" - ], - "name": "single_file", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for commit statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "statuses", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "vulnerability_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", - "enum": [ - "write" - ], - "name": "workflows", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization teams and members.

    ", - "enum": [ - "read", - "write" - ], - "name": "members", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", - "enum": [ - "read" - ], - "name": "organization_plan", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "organization_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_self_hosted_runners", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_user_blocking", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", - "enum": [ - "read", - "write" - ], - "name": "team_discussions", - "in": "body" - } ] } ] @@ -116073,14 +114996,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -116656,53 +115571,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": false, @@ -119605,7 +118494,2775 @@ }, "response": { "statusCode": "200", - "description": "

    Response

    " + "contentType": "application/json", + "description": "

    Response

    ", + "example": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [], + "checks": [] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + }, + "schema": { + "title": "Branch With Protection", + "description": "Branch With Protection", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "commit": { + "title": "Commit", + "description": "Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } + }, + "required": [ + "sha", + "url" + ] + } + }, + "stats": { + "type": "object", + "properties": { + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + }, + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "string" + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "html", + "self" + ] + }, + "protected": { + "type": "boolean" + }, + "protection": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enforcement_level": { + "type": "string" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string" + }, + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts", + "checks" + ] + }, + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" + ] + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } + }, + "bypass_pull_request_allowances": { + "type": "object", + "description": "Allow specific users, teams, or apps to bypass pull request requirements.", + "properties": { + "users": { + "description": "The list of users allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "require_code_owner_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "required_approving_review_count": { + "type": "integer", + "minimum": 0, + "maximum": 6, + "examples": [ + 2 + ] + } + }, + "required": [ + "dismiss_stale_reviews", + "require_code_owner_reviews" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + } + } + }, + "protection_url": { + "type": "string", + "format": "uri" + }, + "pattern": { + "type": "string", + "examples": [ + "\"mas*\"" + ] + }, + "required_approving_review_count": { + "type": "integer", + "examples": [ + 1 + ] + } + }, + "required": [ + "name", + "commit", + "_links", + "protection", + "protected", + "protection_url" + ] + } } } ], @@ -119666,9 +121323,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new name of the branch.

    ", "name": "new_name", "in": "body", + "description": "

    The new name of the branch.

    ", "isRequired": true } ], @@ -122513,9 +124170,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the branch which should be updated to match upstream.

    ", "name": "branch", "in": "body", + "description": "

    The name of the branch which should be updated to match upstream.

    ", "isRequired": true } ], @@ -122615,24 +124272,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the base branch that the head will be merged into.

    ", "name": "base", "in": "body", + "description": "

    The name of the base branch that the head will be merged into.

    ", "isRequired": true }, { "type": "string", - "description": "

    The head to merge. This can be a branch name or a commit SHA1.

    ", "name": "head", "in": "body", + "description": "

    The head to merge. This can be a branch name or a commit SHA1.

    ", "isRequired": true }, { "type": "string", - "description": "

    Commit message to use for the merge commit. If omitted, a default message will be used.

    ", "name": "commit_message", "in": "body", - "isRequired": false + "description": "

    Commit message to use for the merge commit. If omitted, a default message will be used.

    " } ], "enabledForGitHubApps": true, @@ -125704,171 +127360,38 @@ "bodyParameters": [ { "type": "object or null", - "description": "

    Require status checks to pass before merging. Set to null to disable.

    ", - "properties": { - "strict": { - "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", - "name": "strict", - "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": true, - "childParamsGroups": [] - }, - "contexts": { - "type": "array of strings", - "deprecated": true, - "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "isRequired": true, - "childParamsGroups": [] - }, - "checks": { - "type": "array of objects", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", - "items": { - "type": "object", - "required": [ - "context" - ], - "properties": { - "context": { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] - }, - "app_id": { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] - } - } - }, - "name": "checks", - "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ - { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "strict", - "contexts" - ], "name": "required_status_checks", "in": "body", + "description": "

    Require status checks to pass before merging. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "required_status_checks", - "parentType": "object", - "id": "required_status_checks-object", - "params": [ - { - "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", - "name": "strict", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "deprecated": true, - "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", - "name": "contexts", - "in": "body", - "isRequired": true - }, - { - "type": "array of objects", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", - "name": "checks", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ - { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "boolean", + "name": "strict", + "description": "

    Require branches to be up to date before merging.

    ", + "isRequired": true }, { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ + "type": "array of strings", + "name": "contexts", + "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", + "isRequired": true + }, + { + "type": "array of objects", + "name": "checks", + "description": "

    The list of status checks to require in order to merge into this branch.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The name of the required check

    ", "name": "context", - "in": "body", + "description": "

    The name of the required check

    ", "isRequired": true }, { "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", "name": "app_id", - "in": "body", - "isRequired": false + "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    " } ] } @@ -125876,407 +127399,74 @@ }, { "type": "boolean or null", - "description": "

    Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "name": "enforce_admins", "in": "body", + "description": "

    Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "isRequired": true }, { "type": "object or null", - "description": "

    Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", - "properties": { - "dismissal_restrictions": { - "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, - "name": "dismissal_restrictions", - "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", - "childParamsGroups": [ - { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] - } - ] - }, - "dismiss_stale_reviews": { - "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", - "name": "dismiss_stale_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "childParamsGroups": [] - }, - "require_code_owner_reviews": { - "type": "boolean", - "description": "

    Blocks merging pull requests until code owners review them.

    ", - "name": "require_code_owner_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", - "childParamsGroups": [] - }, - "required_approving_review_count": { - "type": "integer", - "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    ", - "name": "required_approving_review_count", - "in": "body", - "rawType": "integer", - "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", - "childParamsGroups": [] - }, - "bypass_pull_request_allowances": { - "type": "object", - "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - } - }, - "name": "bypass_pull_request_allowances", - "in": "body", - "rawType": "object", - "rawDescription": "Allow specific users, teams, or apps to bypass pull request requirements.", - "childParamsGroups": [ - { - "parentName": "bypass_pull_request_allowances", - "parentType": "object", - "id": "bypass_pull_request_allowances-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "name": "apps", - "in": "body" - } - ] - } - ] - } - }, "name": "required_pull_request_reviews", "in": "body", + "description": "

    Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "required_pull_request_reviews", - "parentType": "object", - "id": "required_pull_request_reviews-object", - "params": [ + "type": "object", + "name": "dismissal_restrictions", + "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", + "childParamsGroups": [ { - "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, - "name": "dismissal_restrictions", - "in": "body", - "childParamsGroups": [ - { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with dismissal access

    " }, { - "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", - "name": "dismiss_stale_reviews", - "in": "body" + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with dismissal access

    " }, { - "type": "boolean", - "description": "

    Blocks merging pull requests until code owners review them.

    ", - "name": "require_code_owner_reviews", - "in": "body" - }, - { - "type": "integer", - "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    ", - "name": "required_approving_review_count", - "in": "body" - }, - { - "type": "object", - "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - } - }, - "name": "bypass_pull_request_allowances", - "in": "body", - "childParamsGroups": [ - { - "parentName": "bypass_pull_request_allowances", - "parentType": "object", - "id": "bypass_pull_request_allowances-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "name": "apps", - "in": "body" - } - ] - } - ] + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with dismissal access

    " } ] }, { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] + "type": "boolean", + "name": "dismiss_stale_reviews", + "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    " }, { - "parentName": "bypass_pull_request_allowances", - "parentType": "object", - "id": "bypass_pull_request_allowances-object", - "params": [ + "type": "boolean", + "name": "require_code_owner_reviews", + "description": "

    Blocks merging pull requests until code owners review them.

    " + }, + { + "type": "integer", + "name": "required_approving_review_count", + "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    " + }, + { + "type": "object", + "name": "bypass_pull_request_allowances", + "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", + "childParamsGroups": [ { "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", "name": "users", - "in": "body" + "description": "

    The list of user logins allowed to bypass pull request requirements.

    " }, { "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", "name": "teams", - "in": "body" + "description": "

    The list of team slugs allowed to bypass pull request requirements.

    " }, { "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", "name": "apps", - "in": "body" + "description": "

    The list of app slugs allowed to bypass pull request requirements.

    " } ] } @@ -126284,120 +127474,59 @@ }, { "type": "object or null", - "description": "

    Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with push access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with push access", - "isRequired": true, - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with push access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with push access", - "isRequired": true, - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with push access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with push access", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "users", - "teams" - ], "name": "restrictions", "in": "body", + "description": "

    Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "restrictions", - "parentType": "object", - "id": "restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with push access

    ", - "name": "users", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with push access

    ", - "name": "teams", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with push access

    ", - "name": "apps", - "in": "body", - "isRequired": false - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with push access

    ", + "isRequired": true + }, + { + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with push access

    ", + "isRequired": true + }, + { + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with push access

    " } ] }, { "type": "boolean", - "description": "

    Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

    ", "name": "required_linear_history", "in": "body", - "isRequired": false + "description": "

    Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

    " }, { "type": "boolean or null", - "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "name": "allow_force_pushes", "in": "body", - "isRequired": false + "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    " }, { "type": "boolean", - "description": "

    Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

    ", "name": "allow_deletions", "in": "body", - "isRequired": false + "description": "

    Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

    ", "name": "block_creations", "in": "body", - "isRequired": false + "description": "

    If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

    " }, { "type": "boolean", - "description": "

    Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

    ", "name": "required_conversation_resolution", "in": "body", - "isRequired": false + "description": "

    Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

    " } ], "enabledForGitHubApps": true, @@ -126462,7 +127591,2001 @@ }, "response": { "statusCode": "200", - "description": "

    Response

    " + "contentType": "application/json", + "description": "

    Response

    ", + "example": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [], + "teams": [], + "apps": [] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [], + "teams": [], + "apps": [] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + }, + "schema": { + "title": "Protected Branch", + "description": "Branch protections protect branches", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "required_status_checks": { + "title": "Status Check Policy", + "description": "Status Check Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] + }, + "strict": { + "type": "boolean", + "examples": [ + true + ] + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + ] + } + }, + "required": [ + "url", + "contexts_url", + "strict", + "contexts", + "checks" + ] + }, + "required_pull_request_reviews": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "dismiss_stale_reviews": { + "type": "boolean" + }, + "require_code_owner_reviews": { + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "users", + "teams" + ] + }, + "bypass_pull_request_allowances": { + "type": "object", + "properties": { + "users": { + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + }, + "required": [ + "users", + "teams" + ] + } + }, + "required": [ + "url" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "enforce_admins": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "url", + "enabled" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + } + }, + "required": [ + "url" + ] + } } } ], @@ -128473,166 +131596,65 @@ "bodyParameters": [ { "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, "name": "dismissal_restrictions", "in": "body", - "isRequired": false, + "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", "childParamsGroups": [ { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with dismissal access

    " + }, + { + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with dismissal access

    " + }, + { + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with dismissal access

    " } ] }, { "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", "name": "dismiss_stale_reviews", "in": "body", - "isRequired": false + "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    " }, { "type": "boolean", - "description": "

    Blocks merging pull requests until code owners have reviewed.

    ", "name": "require_code_owner_reviews", "in": "body", - "isRequired": false + "description": "

    Blocks merging pull requests until code owners have reviewed.

    " }, { "type": "integer", - "description": "

    Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    ", "name": "required_approving_review_count", "in": "body", - "isRequired": false + "description": "

    Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    " }, { "type": "object", - "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - } - }, "name": "bypass_pull_request_allowances", "in": "body", - "isRequired": false, + "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", "childParamsGroups": [ { - "parentName": "bypass_pull_request_allowances", - "parentType": "object", - "id": "bypass_pull_request_allowances-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "name": "apps", - "in": "body" - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins allowed to bypass pull request requirements.

    " + }, + { + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs allowed to bypass pull request requirements.

    " + }, + { + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs allowed to bypass pull request requirements.

    " } ] } @@ -130771,46 +133793,32 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", "name": "strict", "in": "body", - "isRequired": false + "description": "

    Require branches to be up to date before merging.

    " }, { "type": "array of strings", - "deprecated": true, - "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", "name": "contexts", "in": "body", - "isRequired": false + "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    " }, { "type": "array of objects", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", "name": "checks", "in": "body", - "isRequired": false, + "description": "

    The list of status checks to require in order to merge into this branch.

    ", "childParamsGroups": [ { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ - { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "context", + "description": "

    The name of the required check

    ", + "isRequired": true + }, + { + "type": "integer", + "name": "app_id", + "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    " } ] } @@ -131120,9 +134128,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -131132,8 +134140,14 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding status checks to a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -131218,9 +134232,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -131230,8 +134244,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example updating status checks for a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -131311,9 +134330,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -131323,8 +134342,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing status checks from a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -132373,9 +135397,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -132824,9 +135848,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -133275,9 +136299,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -134016,9 +137040,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -134028,8 +137052,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -134315,9 +137344,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -134327,8 +137356,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -134614,9 +137648,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -134626,8 +137660,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -135170,9 +138209,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -135182,8 +138221,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -135436,9 +138480,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -135448,8 +138492,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -135702,9 +138751,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -135714,8 +138763,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -135962,55 +139016,52 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the check. For example, \"code-coverage\".

    ", "name": "name", "in": "body", + "description": "

    The name of the check. For example, \"code-coverage\".

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the commit.

    ", "name": "head_sha", "in": "body", + "description": "

    The SHA of the commit.

    ", "isRequired": true }, { "type": "string", - "description": "

    The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

    ", "name": "details_url", "in": "body", - "isRequired": false + "description": "

    The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

    " }, { "type": "string", - "description": "

    A reference for the run on the integrator's system.

    ", "name": "external_id", "in": "body", - "isRequired": false + "description": "

    A reference for the run on the integrator's system.

    " }, { "type": "string", + "name": "status", + "in": "body", "description": "

    The current status.

    ", "enum": [ "queued", "in_progress", "completed" ], - "default": "queued", - "name": "status", - "in": "body", - "isRequired": false + "default": "queued" }, { "type": "string", - "format": "date-time", - "description": "

    The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "string", + "name": "conclusion", + "in": "body", "description": "

    Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.

    ", "enum": [ "action_required", @@ -136021,588 +139072,120 @@ "skipped", "stale", "timed_out" - ], - "name": "conclusion", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "format": "date-time", - "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "completed_at", "in": "body", - "isRequired": false + "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "object", - "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", - "properties": { - "title": { - "type": "string", - "description": "

    The title of the check run.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the check run.", - "isRequired": true, - "childParamsGroups": [] - }, - "summary": { - "type": "string", - "maxLength": 65535, - "description": "

    The summary of the check run. This parameter supports Markdown.

    ", - "name": "summary", - "in": "body", - "rawType": "string", - "rawDescription": "The summary of the check run. This parameter supports Markdown.", - "isRequired": true, - "childParamsGroups": [] - }, - "text": { - "type": "string", - "maxLength": 65535, - "description": "

    The details of the check run. This parameter supports Markdown.

    ", - "name": "text", - "in": "body", - "rawType": "string", - "rawDescription": "The details of the check run. This parameter supports Markdown.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotations": { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", - "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, - "name": "annotations", - "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#annotations-object) description for details about how to use this parameter.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - "images": { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, - "name": "images", - "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#images-object) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "title", - "summary" - ], "name": "output", "in": "body", - "isRequired": false, + "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", "childParamsGroups": [ { - "parentName": "output", - "parentType": "object", - "id": "output-object", - "params": [ - { - "type": "string", - "description": "

    The title of the check run.

    ", - "name": "title", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 65535, - "description": "

    The summary of the check run. This parameter supports Markdown.

    ", - "name": "summary", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 65535, - "description": "

    The details of the check run. This parameter supports Markdown.

    ", - "name": "text", - "in": "body", - "isRequired": false - }, - { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", - "maxItems": 50, - "name": "annotations", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "name": "images", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "string", + "name": "title", + "description": "

    The title of the check run.

    ", + "isRequired": true }, { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ + "type": "string", + "name": "summary", + "description": "

    The summary of the check run. This parameter supports Markdown.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "text", + "description": "

    The details of the check run. This parameter supports Markdown.

    " + }, + { + "type": "array of objects", + "name": "annotations", + "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "name": "path", - "in": "body", + "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start line of the annotation.

    ", "name": "start_line", - "in": "body", + "description": "

    The start line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The end line of the annotation.

    ", "name": "end_line", - "in": "body", + "description": "

    The end line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "start_column", - "in": "body", - "isRequired": false + "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "end_column", - "in": "body", - "isRequired": false + "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "string", + "name": "annotation_level", "description": "

    The level of the annotation.

    ", + "isRequired": true, "enum": [ "notice", "warning", "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "name": "message", - "in": "body", + "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "isRequired": true }, { "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", "name": "title", - "in": "body", - "isRequired": false + "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    " }, { "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", "name": "raw_details", - "in": "body", - "isRequired": false + "description": "

    Details about this annotation. The maximum size is 64 KB.

    " } ] }, { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ + "type": "array of objects", + "name": "images", + "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The alternative text for the image.

    ", "name": "alt", - "in": "body", + "description": "

    The alternative text for the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full URL of the image.

    ", "name": "image_url", - "in": "body", + "description": "

    The full URL of the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short image description.

    ", "name": "caption", - "in": "body", - "isRequired": false + "description": "

    A short image description.

    " } ] } @@ -136610,42 +139193,27 @@ }, { "type": "array of objects", - "description": "

    Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", - "maxItems": 3, "name": "actions", "in": "body", - "isRequired": false, + "description": "

    Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", "childParamsGroups": [ { - "parentName": "actions", - "parentType": "items", - "id": "actions-items", - "params": [ - { - "type": "string", - "maxLength": 20, - "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", - "name": "label", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 40, - "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", - "name": "description", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 20, - "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", - "name": "identifier", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "label", + "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "identifier", + "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", + "isRequired": true } ] } @@ -140297,47 +142865,43 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the check. For example, \"code-coverage\".

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the check. For example, \"code-coverage\".

    " }, { "type": "string", - "description": "

    The URL of the integrator's site that has the full details of the check.

    ", "name": "details_url", "in": "body", - "isRequired": false + "description": "

    The URL of the integrator's site that has the full details of the check.

    " }, { "type": "string", - "description": "

    A reference for the run on the integrator's system.

    ", "name": "external_id", "in": "body", - "isRequired": false + "description": "

    A reference for the run on the integrator's system.

    " }, { "type": "string", - "format": "date-time", - "description": "

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "string", + "name": "status", + "in": "body", "description": "

    The current status.

    ", "enum": [ "queued", "in_progress", "completed" - ], - "name": "status", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "conclusion", + "in": "body", "description": "

    Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.

    ", "enum": [ "action_required", @@ -140348,587 +142912,119 @@ "skipped", "stale", "timed_out" - ], - "name": "conclusion", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "format": "date-time", - "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "completed_at", "in": "body", - "isRequired": false + "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "object", - "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", - "properties": { - "title": { - "type": "string", - "description": "

    Required.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "**Required**.", - "isRequired": false, - "childParamsGroups": [] - }, - "summary": { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "summary", - "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": true, - "childParamsGroups": [] - }, - "text": { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "text", - "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotations": { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", - "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, - "name": "annotations", - "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#annotations-object-1) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - "images": { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, - "name": "images", - "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#annotations-object-1) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "summary" - ], "name": "output", "in": "body", - "isRequired": false, + "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", "childParamsGroups": [ { - "parentName": "output", - "parentType": "object", - "id": "output-object", - "params": [ - { - "type": "string", - "description": "

    Required.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "summary", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "text", - "in": "body", - "isRequired": false - }, - { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", - "maxItems": 50, - "name": "annotations", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "name": "images", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "string", + "name": "title", + "description": "

    Required.

    " }, { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ + "type": "string", + "name": "summary", + "description": "

    Can contain Markdown.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "text", + "description": "

    Can contain Markdown.

    " + }, + { + "type": "array of objects", + "name": "annotations", + "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "name": "path", - "in": "body", + "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start line of the annotation.

    ", "name": "start_line", - "in": "body", + "description": "

    The start line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The end line of the annotation.

    ", "name": "end_line", - "in": "body", + "description": "

    The end line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "start_column", - "in": "body", - "isRequired": false + "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "end_column", - "in": "body", - "isRequired": false + "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "string", + "name": "annotation_level", "description": "

    The level of the annotation.

    ", + "isRequired": true, "enum": [ "notice", "warning", "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "name": "message", - "in": "body", + "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "isRequired": true }, { "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", "name": "title", - "in": "body", - "isRequired": false + "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    " }, { "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", "name": "raw_details", - "in": "body", - "isRequired": false + "description": "

    Details about this annotation. The maximum size is 64 KB.

    " } ] }, { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ + "type": "array of objects", + "name": "images", + "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The alternative text for the image.

    ", "name": "alt", - "in": "body", + "description": "

    The alternative text for the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full URL of the image.

    ", "name": "image_url", - "in": "body", + "description": "

    The full URL of the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short image description.

    ", "name": "caption", - "in": "body", - "isRequired": false + "description": "

    A short image description.

    " } ] } @@ -140936,42 +143032,27 @@ }, { "type": "array of objects", - "description": "

    Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", - "maxItems": 3, "name": "actions", "in": "body", - "isRequired": false, + "description": "

    Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", "childParamsGroups": [ { - "parentName": "actions", - "parentType": "items", - "id": "actions-items", - "params": [ - { - "type": "string", - "maxLength": 20, - "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", - "name": "label", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 40, - "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", - "name": "description", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 20, - "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", - "name": "identifier", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "label", + "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "identifier", + "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", + "isRequired": true } ] } @@ -145078,9 +147159,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The sha of the head commit.

    ", "name": "head_sha", "in": "body", + "description": "

    The sha of the head commit.

    ", "isRequired": true } ], @@ -151262,32 +153343,22 @@ "bodyParameters": [ { "type": "array of objects", - "description": "

    Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

    ", "name": "auto_trigger_checks", "in": "body", - "isRequired": false, + "description": "

    Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

    ", "childParamsGroups": [ { - "parentName": "auto_trigger_checks", - "parentType": "items", - "id": "auto_trigger_checks-items", - "params": [ - { - "type": "integer", - "description": "

    The id of the GitHub App.

    ", - "name": "app_id", - "in": "body", - "isRequired": true - }, - { - "type": "boolean", - "description": "

    Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

    ", - "default": true, - "name": "setting", - "in": "body", - "isRequired": true - } - ] + "type": "integer", + "name": "app_id", + "description": "

    The id of the GitHub App.

    ", + "isRequired": true + }, + { + "type": "boolean", + "name": "setting", + "description": "

    Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

    ", + "isRequired": true, + "default": true } ] } @@ -161269,28 +163340,27 @@ ], "bodyParameters": [ { - "description": "

    Sets the state of the code scanning alert. You must provide dismissed_reason when you set the state to dismissed.

    ", "type": "string", + "name": "state", + "in": "body", + "description": "

    Sets the state of the code scanning alert. You must provide dismissed_reason when you set the state to dismissed.

    ", + "isRequired": true, "enum": [ "open", "dismissed" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", + "name": "dismissed_reason", + "in": "body", "description": "

    Required when the state is dismissed. The reason for dismissing or closing the alert.

    ", "enum": [ null, "false positive", "won't fix", "used in tests" - ], - "name": "dismissed_reason", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -161936,6 +164006,7 @@ "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "state": "open", "fixed_at": null, "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", @@ -162787,7 +164858,7 @@ "description": "

    Service unavailable

    " } ], - "descriptionHTML": "

    Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the repo scope. For public repositories,\nyou must use an access token with public_repo scope.\nGitHub Apps must have the security_events write permission to use this endpoint.

    \n

    You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.

    \n

    When you list the analyses for a repository,\none or more will be identified as deletable in the response:

    \n
    \"deletable\": true\n
    \n

    An analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:

    \n
      \n
    • ref
      • \n
    • tool
      • \n
    • analysis_key
      • \n
    • environment
      • \n
    \n

    If you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:

    \n
    Analysis specified is not deletable.\n
    \n

    The response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\nnext_analysis_url and confirm_delete_url.\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.

    \n

    As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:

    \n

    Outer loop:

    \n
      \n
    • \n

      List the analyses for the repository, filtered by tool.

      \n
      • \n
    • \n

      Parse this list to find a deletable analysis. If found:

      \n

      Inner loop:

      \n
        \n
      • Delete the identified analysis.
        • \n
      • Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.
        • \n
      \n
      • \n
    \n

    The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

    ", + "descriptionHTML": "

    Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the repo scope. For public repositories,\nyou must use an access token with public_repo scope.\nGitHub Apps must have the security_events write permission to use this endpoint.

    \n

    You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.

    \n

    When you list the analyses for a repository,\none or more will be identified as deletable in the response:

    \n
    \"deletable\": true\n
    \n

    An analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:

    \n
      \n
    • ref
      • \n
    • tool
      • \n
    • category
      • \n
    \n

    If you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:

    \n
    Analysis specified is not deletable.\n
    \n

    The response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\nnext_analysis_url and confirm_delete_url.\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.

    \n

    As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:

    \n

    Outer loop:

    \n
      \n
    • \n

      List the analyses for the repository, filtered by tool.

      \n
      • \n
    • \n

      Parse this list to find a deletable analysis. If found:

      \n

      Inner loop:

      \n
        \n
      • Delete the identified analysis.
        • \n
      • Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.
        • \n
      \n
      • \n
    \n

    The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

    ", "subcategory": "code-scanning" }, { @@ -162818,54 +164889,43 @@ ], "bodyParameters": [ { - "description": "

    The SHA of the commit to which the analysis you are uploading relates.

    ", "type": "string", - "minLength": 40, - "maxLength": 40, - "pattern": "^[0-9a-fA-F]+$", "name": "commit_sha", "in": "body", + "description": "

    The SHA of the commit to which the analysis you are uploading relates.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", "name": "ref", "in": "body", + "description": "

    The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", "isRequired": true }, { - "description": "

    A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

    ", "type": "string", "name": "sarif", "in": "body", + "description": "

    A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

    ", "isRequired": true }, { - "description": "

    The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

    ", "type": "string", - "format": "uri", - "examples": [ - "file:///github/workspace/" - ], "name": "checkout_uri", "in": "body", - "isRequired": false + "description": "

    The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

    " }, { - "description": "

    The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "format": "date-time", "type": "string", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { - "description": "

    The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

    ", "type": "string", "name": "tool_name", "in": "body", - "isRequired": false + "description": "

    The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

    " } ], "enabledForGitHubApps": true, @@ -163685,11 +165745,10 @@ "bodyParameters": [ { "type": "string", - "description": "

    The permission to grant the collaborator. Only valid on organization-owned repositories.

    ", - "default": "push", "name": "permission", "in": "body", - "isRequired": false + "description": "

    The permission to grant the collaborator. Only valid on organization-owned repositories.

    ", + "default": "push" } ], "enabledForGitHubApps": true, @@ -169476,6 +171535,8 @@ "bodyParameters": [ { "type": "string", + "name": "permissions", + "in": "body", "description": "

    The permissions that the associated user will have on the repository. Valid values are read, write, maintain, triage, and admin.

    ", "enum": [ "read", @@ -169483,10 +171544,7 @@ "maintain", "triage", "admin" - ], - "name": "permissions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -169495,8 +171553,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example request body", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permissions": "write" + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -185885,9 +187946,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment

    ", "isRequired": true } ], @@ -186801,31 +188862,28 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true }, { "type": "string", - "description": "

    Relative path of the file to comment on.

    ", "name": "path", "in": "body", - "isRequired": false + "description": "

    Relative path of the file to comment on.

    " }, { "type": "integer", - "description": "

    Line index in the diff to comment on.

    ", "name": "position", "in": "body", - "isRequired": false + "description": "

    Line index in the diff to comment on.

    " }, { "type": "integer", - "description": "

    Deprecated. Use position parameter instead. Line number in the file to comment on.

    ", "name": "line", "in": "body", - "isRequired": false + "description": "

    Deprecated. Use position parameter instead. Line number in the file to comment on.

    " } ], "enabledForGitHubApps": true, @@ -190010,38 +192068,35 @@ "bodyParameters": [ { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the status.

    ", + "isRequired": true, "enum": [ "error", "failure", "pending", "success" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", - "description": "

    The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
    \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
    \nhttp://ci.example.com/user/repo/build/sha

    ", "name": "target_url", "in": "body", - "isRequired": false + "description": "

    The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
    \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
    \nhttp://ci.example.com/user/repo/build/sha

    " }, { "type": "string or null", - "description": "

    A short description of the status.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the status.

    " }, { "type": "string", - "description": "

    A string label to differentiate this status from the status of other systems. This field is case-insensitive.

    ", - "default": "default", "name": "context", "in": "body", - "isRequired": false + "description": "

    A string label to differentiate this status from the status of other systems. This field is case-insensitive.

    ", + "default": "default" } ], "enabledForGitHubApps": true, @@ -190702,37 +192757,33 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret.

    ", + "isRequired": true, "enum": [ "all", "private", "selected" - ], - "name": "visibility", - "in": "body", - "isRequired": true + ] }, { "type": "array of strings", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", - "isRequired": false + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    " } ], "enabledForGitHubApps": true, @@ -193169,9 +195220,9 @@ "bodyParameters": [ { "type": "array of integers", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "isRequired": true } ], @@ -193699,18 +195750,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " } ], "enabledForGitHubApps": true, @@ -193993,24 +196041,22 @@ "bodyParameters": [ { "type": "string", - "description": "

    A name for the key.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    A name for the key.

    " }, { "type": "string", - "description": "

    The contents of the key.

    ", "name": "key", "in": "body", + "description": "

    The contents of the key.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

    \n

    Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

    ", "name": "read_only", "in": "body", - "isRequired": false + "description": "

    If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

    \n

    Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

    " } ], "enabledForGitHubApps": true, @@ -195111,82 +197157,61 @@ "bodyParameters": [ { "type": "string", - "description": "

    The ref to deploy. This can be a branch, tag, or SHA.

    ", "name": "ref", "in": "body", + "description": "

    The ref to deploy. This can be a branch, tag, or SHA.

    ", "isRequired": true }, { "type": "string", - "description": "

    Specifies a task to execute (e.g., deploy or deploy:migrations).

    ", - "default": "deploy", "name": "task", "in": "body", - "isRequired": false + "description": "

    Specifies a task to execute (e.g., deploy or deploy:migrations).

    ", + "default": "deploy" }, { "type": "boolean", - "description": "

    Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

    ", - "default": true, "name": "auto_merge", "in": "body", - "isRequired": false + "description": "

    Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

    ", + "default": true }, { "type": "array of strings", - "description": "

    The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

    ", "name": "required_contexts", "in": "body", - "isRequired": false + "description": "

    The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

    " }, { - "oneOf": [ - { - "type": "object", - "additionalProperties": true - }, - { - "type": "string", - "description": "JSON payload with extra information about the deployment.", - "default": "" - } - ], + "type": "object or string", "name": "payload", "in": "body", - "type": "object or string", - "description": "

    JSON payload with extra information about the deployment.

    ", - "isRequired": false + "description": "

    JSON payload with extra information about the deployment.

    " }, { "type": "string", - "description": "

    Name for the target deployment environment (e.g., production, staging, qa).

    ", - "default": "production", "name": "environment", "in": "body", - "isRequired": false + "description": "

    Name for the target deployment environment (e.g., production, staging, qa).

    ", + "default": "production" }, { "type": "string or null", - "description": "

    Short description of the deployment.

    ", - "default": "", "name": "description", "in": "body", - "isRequired": false + "description": "

    Short description of the deployment.

    " }, { "type": "boolean", - "description": "

    Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false

    ", - "default": false, "name": "transient_environment", "in": "body", - "isRequired": false + "description": "

    Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false

    " }, { "type": "boolean", - "description": "

    Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

    ", "name": "production_environment", "in": "body", - "isRequired": false + "description": "

    Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

    " } ], "enabledForGitHubApps": true, @@ -196915,13 +198940,10 @@ ], "bodyParameters": [ { - "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "type": "string", - "examples": [ - "release/*" - ], "name": "name", "in": "body", + "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "isRequired": true } ], @@ -197206,13 +199228,10 @@ ], "bodyParameters": [ { - "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "type": "string", - "examples": [ - "release/*" - ], "name": "name", "in": "body", + "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "isRequired": true } ], @@ -198840,105 +200859,49 @@ "bodyParameters": [ { "type": "integer", - "description": "

    The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).

    ", - "examples": [ - 30 - ], "name": "wait_timer", "in": "body", - "isRequired": false + "description": "

    The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).

    " }, { "type": "array of objects or null", - "description": "

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", "name": "reviewers", "in": "body", - "isRequired": false, + "description": "

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", "childParamsGroups": [ { - "parentName": "reviewers", - "parentType": "items", - "id": "reviewers-items", - "params": [ - { - "type": "string", - "description": "

    The type of reviewer.

    ", - "enum": [ - "User", - "Team" - ], - "examples": [ - "User" - ], - "name": "type", - "in": "body" - }, - { - "type": "integer", - "description": "

    The id of the user or team who can review the deployment

    ", - "examples": [ - 4532992 - ], - "name": "id", - "in": "body" - } + "type": "string", + "name": "type", + "description": "

    The type of reviewer.

    ", + "enum": [ + "User", + "Team" ] + }, + { + "type": "integer", + "name": "id", + "description": "

    The id of the user or team who can review the deployment

    " } ] }, { "type": "object or null", - "description": "

    The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

    ", - "properties": { - "protected_branches": { - "type": "boolean", - "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", - "name": "protected_branches", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", - "isRequired": true, - "childParamsGroups": [] - }, - "custom_branch_policies": { - "type": "boolean", - "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", - "name": "custom_branch_policies", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "protected_branches", - "custom_branch_policies" - ], "name": "deployment_branch_policy", "in": "body", - "isRequired": false, + "description": "

    The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

    ", "childParamsGroups": [ { - "parentName": "deployment_branch_policy", - "parentType": "object", - "id": "deployment_branch_policy-object", - "params": [ - { - "type": "boolean", - "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", - "name": "protected_branches", - "in": "body", - "isRequired": true - }, - { - "type": "boolean", - "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", - "name": "custom_branch_policies", - "in": "body", - "isRequired": true - } - ] + "type": "boolean", + "name": "protected_branches", + "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", + "isRequired": true + }, + { + "type": "boolean", + "name": "custom_branch_policies", + "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", + "isRequired": true } ] } @@ -200496,7 +202459,10 @@ "bodyParameters": [ { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the status. When you set a transient deployment to inactive, the deployment will be shown as destroyed in GitHub.

    ", + "isRequired": true, "enum": [ "error", "failure", @@ -200505,61 +202471,48 @@ "queued", "pending", "success" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.

    ", - "default": "", "name": "target_url", "in": "body", - "isRequired": false + "description": "

    The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.

    " }, { "type": "string", - "description": "

    The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: \"\"

    ", - "default": "", "name": "log_url", "in": "body", - "isRequired": false + "description": "

    The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: \"\"

    " }, { "type": "string", - "description": "

    A short description of the status. The maximum description length is 140 characters.

    ", - "default": "", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the status. The maximum description length is 140 characters.

    " }, { "type": "string", + "name": "environment", + "in": "body", "description": "

    Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa.

    ", "enum": [ "production", "staging", "qa" - ], - "name": "environment", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "description": "

    Sets the URL for accessing your environment. Default: \"\"

    ", - "default": "", "name": "environment_url", "in": "body", - "isRequired": false + "description": "

    Sets the URL for accessing your environment. Default: \"\"

    " }, { "type": "boolean", - "description": "

    Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true

    ", "name": "auto_inactive", "in": "body", - "isRequired": false + "description": "

    Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true

    " } ], "enabledForGitHubApps": true, @@ -204639,24 +206592,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

    ", - "examples": [ - "Very **important** announcement about _nothing_." - ], "name": "announcement", "in": "body", + "description": "

    The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

    ", "isRequired": true }, { "type": "string or null", - "format": "date-time", - "description": "

    The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

    ", - "examples": [ - "\"2021-01-01T00:00:00.000-07:00\"" - ], "name": "expires_at", "in": "body", - "isRequired": false + "description": "

    The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

    " } ], "enabledForGitHubApps": false, @@ -205470,114 +207415,53 @@ "bodyParameters": [ { "type": "string", - "description": "

    Must be passed as \"web\".

    ", "name": "name", "in": "body", + "description": "

    Must be passed as \"web\".

    ", "isRequired": true }, { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", + "description": "

    Key/value pairs to provide settings for this webhook.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    " + }, + { + "type": "string", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ] }, { "type": "array of strings", - "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    ", "name": "events", "in": "body", - "isRequired": false + "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    " }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": false, @@ -205828,107 +207712,45 @@ "bodyParameters": [ { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    " + }, + { + "type": "string", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ] }, { "type": "array of strings", - "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    ", "name": "events", "in": "body", - "isRequired": false + "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    " }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": false, @@ -206147,9 +207969,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The distinguished name (DN) of the LDAP entry to map to a team.

    ", "name": "ldap_dn", "in": "body", + "description": "

    The distinguished name (DN) of the LDAP entry to map to a team.

    ", "isRequired": true } ], @@ -206326,9 +208148,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The distinguished name (DN) of the LDAP entry to map to a team.

    ", "name": "ldap_dn", "in": "body", + "description": "

    The distinguished name (DN) of the LDAP entry to map to a team.

    ", "isRequired": true } ], @@ -207099,9 +208921,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    A JSON string with the attributes enabled and when.

    \n

    The possible values for enabled are true and false. When it's false, the attribute when is ignored and the maintenance mode is turned off. when defines the time period when the maintenance was enabled.

    \n

    The possible values for when are now or any date parseable by mojombo/chronic.

    ", "name": "maintenance", "in": "body", + "description": "

    A JSON string with the attributes enabled and when.

    \n

    The possible values for enabled are true and false. When it's false, the attribute when is ignored and the maintenance mode is turned off. when defines the time period when the maintenance was enabled.

    \n

    The possible values for when are now or any date parseable by mojombo/chronic.

    ", "isRequired": true } ], @@ -207855,9 +209677,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.

    ", "name": "settings", "in": "body", + "description": "

    A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.

    ", "isRequired": true } ], @@ -207960,9 +209782,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The public SSH key.

    ", "name": "authorized_key", "in": "body", + "description": "

    The public SSH key.

    ", "isRequired": true } ], @@ -208033,9 +209855,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The public SSH key.

    ", "name": "authorized_key", "in": "body", + "description": "

    The public SSH key.

    ", "isRequired": true } ], @@ -208106,24 +209928,22 @@ "bodyParameters": [ { "type": "string", - "description": "

    The content of your .ghl license file.

    ", "name": "license", "in": "body", + "description": "

    The content of your .ghl license file.

    ", "isRequired": true }, { "type": "string", - "description": "

    You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.

    ", "name": "password", "in": "body", - "isRequired": false + "description": "

    You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.

    " }, { "type": "string", - "description": "

    An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.

    ", "name": "settings", "in": "body", - "isRequired": false + "description": "

    An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.

    " } ], "enabledForGitHubApps": false, @@ -208161,10 +209981,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The content of your new .ghl license file.

    ", "name": "license", "in": "body", - "isRequired": false + "description": "

    The content of your new .ghl license file.

    " } ], "enabledForGitHubApps": false, @@ -208430,18 +210249,16 @@ ], "bodyParameters": [ { - "description": "

    The state of enforcement for the hook on this repository.

    ", "type": "string", "name": "enforcement", "in": "body", - "isRequired": false + "description": "

    The state of enforcement for the hook on this repository.

    " }, { - "description": "

    Whether repositories can override enforcement.

    ", "type": "boolean", "name": "allow_downstream_configuration", "in": "body", - "isRequired": false + "description": "

    Whether repositories can override enforcement.

    " } ], "enabledForGitHubApps": true, @@ -208600,24 +210417,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The organization's username.

    ", "name": "login", "in": "body", + "description": "

    The organization's username.

    ", "isRequired": true }, { "type": "string", - "description": "

    The login of the user who will manage this organization.

    ", "name": "admin", "in": "body", + "description": "

    The login of the user who will manage this organization.

    ", "isRequired": true }, { "type": "string", - "description": "

    The organization's display name.

    ", "name": "profile_name", "in": "body", - "isRequired": false + "description": "

    The organization's display name.

    " } ], "enabledForGitHubApps": false, @@ -208784,9 +210600,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The organization's new name.

    ", "name": "login", "in": "body", + "description": "

    The organization's new name.

    ", "isRequired": true } ], @@ -209019,16 +210835,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new pre-receive environment's name.

    ", "name": "name", "in": "body", + "description": "

    The new pre-receive environment's name.

    ", "isRequired": true }, { "type": "string", - "description": "

    URL from which to download a tarball of this environment.

    ", "name": "image_url", "in": "body", + "description": "

    URL from which to download a tarball of this environment.

    ", "isRequired": true } ], @@ -209264,17 +211080,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    This pre-receive environment's new name.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    This pre-receive environment's new name.

    " }, { "type": "string", - "description": "

    URL from which to download a tarball of this environment.

    ", "name": "image_url", "in": "body", - "isRequired": false + "description": "

    URL from which to download a tarball of this environment.

    " } ], "enabledForGitHubApps": false, @@ -209797,49 +211611,43 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the hook.

    ", "name": "name", "in": "body", + "description": "

    The name of the hook.

    ", "isRequired": true }, { "type": "string", - "description": "

    The script that the hook runs.

    ", "name": "script", "in": "body", + "description": "

    The script that the hook runs.

    ", "isRequired": true }, { "type": "object", - "description": "

    The GitHub repository where the script is kept.

    ", - "properties": {}, - "additionalProperties": true, "name": "script_repository", "in": "body", + "description": "

    The GitHub repository where the script is kept.

    ", "isRequired": true }, { "type": "object", - "description": "

    The pre-receive environment where the script is executed.

    ", - "properties": {}, - "additionalProperties": true, "name": "environment", "in": "body", + "description": "

    The pre-receive environment where the script is executed.

    ", "isRequired": true }, { "type": "string", - "description": "

    The state of enforcement for this hook. default: disabled

    ", "name": "enforcement", "in": "body", - "isRequired": false + "description": "

    The state of enforcement for this hook. default: disabled

    " }, { "type": "boolean", - "description": "

    Whether enforcement can be overridden at the org or repo level. default: false

    ", "name": "allow_downstream_configuration", "in": "body", - "isRequired": false + "description": "

    Whether enforcement can be overridden at the org or repo level. default: false

    " } ], "enabledForGitHubApps": false, @@ -210182,49 +211990,39 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the hook.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the hook.

    " }, { "type": "string", - "description": "

    The script that the hook runs.

    ", "name": "script", "in": "body", - "isRequired": false + "description": "

    The script that the hook runs.

    " }, { "type": "object", - "description": "

    The GitHub repository where the script is kept.

    ", - "properties": {}, - "additionalProperties": true, "name": "script_repository", "in": "body", - "isRequired": false + "description": "

    The GitHub repository where the script is kept.

    " }, { "type": "object", - "description": "

    The pre-receive environment where the script is executed.

    ", - "properties": {}, - "additionalProperties": true, "name": "environment", "in": "body", - "isRequired": false + "description": "

    The pre-receive environment where the script is executed.

    " }, { "type": "string", - "description": "

    The state of enforcement for this hook.

    ", "name": "enforcement", "in": "body", - "isRequired": false + "description": "

    The state of enforcement for this hook.

    " }, { "type": "boolean", - "description": "

    Whether enforcement can be overridden at the org or repo level.

    ", "name": "allow_downstream_configuration", "in": "body", - "isRequired": false + "description": "

    Whether enforcement can be overridden at the org or repo level.

    " } ], "enabledForGitHubApps": false, @@ -210685,16 +212483,15 @@ ], "bodyParameters": [ { - "description": "

    The state of enforcement for the hook on this repository.

    ", "type": "string", + "name": "enforcement", + "in": "body", + "description": "

    The state of enforcement for the hook on this repository.

    ", "enum": [ "enabled", "disabled", "testing" - ], - "name": "enforcement", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -211433,14 +213230,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -211962,17 +213751,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The user's username.

    ", "name": "login", "in": "body", + "description": "

    The user's username.

    ", "isRequired": true }, { "type": "string", - "description": "

    Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

    ", "name": "email", "in": "body", - "isRequired": false + "description": "

    Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

    " } ], "enabledForGitHubApps": false, @@ -212206,9 +213994,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The user's new username.

    ", "name": "login", "in": "body", + "description": "

    The user's new username.

    ", "isRequired": true } ], @@ -212324,10 +214112,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    A list of scopes.

    ", "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes.

    " } ], "enabledForGitHubApps": false, @@ -212665,14 +214452,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -213460,14 +215239,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -214092,10 +215863,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    ", "name": "reason", "in": "body", - "isRequired": false + "description": "

    The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    " } ], "enabledForGitHubApps": false, @@ -214146,10 +215916,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    ", "name": "reason", "in": "body", - "isRequired": false + "description": "

    The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    " } ], "enabledForGitHubApps": false, @@ -214756,76 +216525,27 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Description of the gist

    ", "type": "string", - "examples": [ - "Example Ruby script" - ], "name": "description", "in": "body", - "isRequired": false + "description": "

    Description of the gist

    " }, { - "description": "

    Names and content for the files that make up the gist

    ", "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "content": { - "description": "

    Content of the file

    ", - "readOnly": false, - "type": "string", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "Content of the file", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "content" - ], - "rawType": "object", - "name": "key" - }, - "examples": [ - { - "hello.rb": { - "content": "puts \"Hello, World!\"" - } - } - ], "name": "files", "in": "body", + "description": "

    Names and content for the files that make up the gist

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "files", - "parentType": "object", - "id": "files-object", - "params": [ + "type": "object", + "name": "key", + "description": "

    A user-defined key to represent an item in files.

    ", + "childParamsGroups": [ { - "description": "

    A user-defined key to represent an item in files.

    ", - "type": "string", - "name": "key", - "in": "body", - "rawType": "string", - "rawDescription": "A key to represent an item in files." - } - ] - }, - { - "parentName": "key", - "parentType": "object", - "id": "key-object", - "params": [ - { - "description": "

    Content of the file

    ", - "readOnly": false, "type": "string", "name": "content", - "in": "body", + "description": "

    Content of the file

    ", "isRequired": true } ] @@ -214833,32 +216553,10 @@ ] }, { - "oneOf": [ - { - "description": "Flag indicating whether the gist is public", - "type": "boolean", - "default": false, - "examples": [ - true - ] - }, - { - "type": "string", - "default": "false", - "enum": [ - "true", - "false" - ], - "examples": [ - "true" - ] - } - ], + "type": "boolean or string", "name": "public", "in": "body", - "type": "boolean or string", - "description": "

    Flag indicating whether the gist is public

    ", - "isRequired": false + "description": "

    Flag indicating whether the gist is public

    " } ], "enabledForGitHubApps": false, @@ -218505,108 +220203,31 @@ ], "bodyParameters": [ { - "description": "

    Description of the gist

    ", "type": "string", - "examples": [ - "Example Ruby script" - ], "name": "description", "in": "body", - "isRequired": false + "description": "

    Description of the gist

    " }, { - "description": "

    Names of files to be updated

    ", "type": "object", - "additionalProperties": { - "type": [ - "object", - "null" - ], - "properties": { - "content": { - "description": "

    The new content of the file

    ", - "type": "string", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The new content of the file", - "childParamsGroups": [] - }, - "filename": { - "description": "

    The new filename for the file

    ", - "type": "string or null", - "name": "filename", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new filename for the file", - "childParamsGroups": [] - } - }, - "anyOf": [ - { - "required": [ - "content" - ] - }, - { - "required": [ - "filename" - ] - }, - { - "type": "object", - "maxProperties": 0 - } - ], - "rawType": "object", - "name": "key" - }, - "examples": [ - { - "hello.rb": { - "content": "blah", - "filename": "goodbye.rb" - } - } - ], "name": "files", "in": "body", - "isRequired": false, + "description": "

    Names of files to be updated

    ", "childParamsGroups": [ { - "parentName": "files", - "parentType": "object", - "id": "files-object", - "params": [ + "type": "object", + "name": "key", + "description": "

    A user-defined key to represent an item in files.

    ", + "childParamsGroups": [ { - "description": "

    A user-defined key to represent an item in files.

    ", - "type": "string", - "name": "key", - "in": "body", - "rawType": "string", - "rawDescription": "A key to represent an item in files." - } - ] - }, - { - "parentName": "key", - "parentType": "object", - "id": "key-object", - "params": [ - { - "description": "

    The new content of the file

    ", "type": "string", "name": "content", - "in": "body" + "description": "

    The new content of the file

    " }, { - "description": "

    The new filename for the file

    ", "type": "string or null", "name": "filename", - "in": "body" + "description": "

    The new filename for the file

    " } ] } @@ -224462,14 +226083,10 @@ ], "bodyParameters": [ { - "description": "

    The comment text.

    ", "type": "string", - "maxLength": 65535, - "examples": [ - "Body of the attachment" - ], "name": "body", "in": "body", + "description": "

    The comment text.

    ", "isRequired": true } ], @@ -225159,14 +226776,10 @@ ], "bodyParameters": [ { - "description": "

    The comment text.

    ", "type": "string", - "maxLength": 65535, - "examples": [ - "Body of the attachment" - ], "name": "body", "in": "body", + "description": "

    The comment text.

    ", "isRequired": true } ], @@ -225580,18 +227193,17 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new blob's content.

    ", "name": "content", "in": "body", + "description": "

    The new blob's content.

    ", "isRequired": true }, { "type": "string", - "description": "

    The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.

    ", - "default": "utf-8", "name": "encoding", "in": "body", - "isRequired": false + "description": "

    The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.

    ", + "default": "utf-8" } ], "enabledForGitHubApps": true, @@ -225822,171 +227434,77 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message

    ", "name": "message", "in": "body", + "description": "

    The commit message

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the tree object this commit points to

    ", "name": "tree", "in": "body", + "description": "

    The SHA of the tree object this commit points to

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

    ", "name": "parents", "in": "body", - "isRequired": false + "description": "

    The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

    " }, { "type": "object", - "description": "

    Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "author", "in": "body", - "isRequired": false, + "description": "

    Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] }, { "type": "object", - "description": "

    Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "childParamsGroups": [] - } - }, "name": "committer", "in": "body", - "isRequired": false, + "description": "

    Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - }, - { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "date", + "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] }, { "type": "string", - "description": "

    The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

    ", "name": "signature", "in": "body", - "isRequired": false + "description": "

    The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

    " } ], "enabledForGitHubApps": true, @@ -226855,27 +228373,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

    ", "name": "ref", "in": "body", + "description": "

    The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA1 value for this reference.

    ", "name": "sha", "in": "body", + "description": "

    The SHA1 value for this reference.

    ", "isRequired": true }, { "type": "string", - "examples": [ - "\"refs/heads/newbranch\"" - ], "name": "key", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -227015,18 +228529,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The SHA1 value to set this reference to

    ", "name": "sha", "in": "body", + "description": "

    The SHA1 value to set this reference to

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

    ", - "default": false, "name": "force", "in": "body", - "isRequired": false + "description": "

    Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

    " } ], "enabledForGitHubApps": true, @@ -227228,109 +228740,59 @@ "bodyParameters": [ { "type": "string", - "description": "

    The tag's name. This is typically a version (e.g., \"v0.0.1\").

    ", "name": "tag", "in": "body", + "description": "

    The tag's name. This is typically a version (e.g., \"v0.0.1\").

    ", "isRequired": true }, { "type": "string", - "description": "

    The tag message.

    ", "name": "message", "in": "body", + "description": "

    The tag message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the git object this is tagging.

    ", "name": "object", "in": "body", + "description": "

    The SHA of the git object this is tagging.

    ", "isRequired": true }, { "type": "string", + "name": "type", + "in": "body", "description": "

    The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.

    ", + "isRequired": true, "enum": [ "commit", "tree", "blob" - ], - "name": "type", - "in": "body", - "isRequired": true + ] }, { "type": "object", - "description": "

    An object with information about the individual creating the tag.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author of the tag

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author of the tag", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author of the tag

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author of the tag", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "tagger", "in": "body", - "isRequired": false, + "description": "

    An object with information about the individual creating the tag.

    ", "childParamsGroups": [ { - "parentName": "tagger", - "parentType": "object", - "id": "tagger-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author of the tag

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author of the tag

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "format": "date-time", - "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author of the tag

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author of the tag

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] } @@ -227765,68 +229227,55 @@ "bodyParameters": [ { "type": "array of objects", - "description": "

    Objects (of path, mode, type, and sha) specifying a tree structure.

    ", "name": "tree", "in": "body", + "description": "

    Objects (of path, mode, type, and sha) specifying a tree structure.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "tree", - "parentType": "items", - "id": "tree-items", - "params": [ - { - "type": "string", - "description": "

    The file referenced in the tree.

    ", - "name": "path", - "in": "body" - }, - { - "type": "string", - "description": "

    The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

    ", - "enum": [ - "100644", - "100755", - "040000", - "160000", - "120000" - ], - "name": "mode", - "in": "body" - }, - { - "type": "string", - "description": "

    Either blob, tree, or commit.

    ", - "enum": [ - "blob", - "tree", - "commit" - ], - "name": "type", - "in": "body" - }, - { - "type": "string or null", - "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", - "name": "sha", - "in": "body" - }, - { - "type": "string", - "description": "

    The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", - "name": "content", - "in": "body" - } + "type": "string", + "name": "path", + "description": "

    The file referenced in the tree.

    " + }, + { + "type": "string", + "name": "mode", + "description": "

    The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

    ", + "enum": [ + "100644", + "100755", + "040000", + "160000", + "120000" ] + }, + { + "type": "string", + "name": "type", + "description": "

    Either blob, tree, or commit.

    ", + "enum": [ + "blob", + "tree", + "commit" + ] + }, + { + "type": "string or null", + "name": "sha", + "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    " + }, + { + "type": "string", + "name": "content", + "description": "

    The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    " } ] }, { "type": "string", - "description": "

    The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

    ", "name": "base_tree", "in": "body", - "isRequired": false + "description": "

    The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

    " } ], "enabledForGitHubApps": true, @@ -235667,7 +237116,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ], "schema": { @@ -238723,63 +240173,41 @@ ], "bodyParameters": [ { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "

    The title of the issue.

    ", + "type": "string or integer", "name": "title", "in": "body", - "type": "string or integer", + "description": "

    The title of the issue.

    ", "isRequired": true }, { "type": "string", - "description": "

    The contents of the issue.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the issue.

    " }, { "type": "string or null", - "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "name": "assignee", "in": "body", - "isRequired": false + "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    " }, { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._" - } - ], - "type": "string or integer or null", + "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "isRequired": false + "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    " }, { - "type": "array of strings or array of objects", - "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", + "type": "array", "name": "labels", "in": "body", - "isRequired": false + "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    " }, { "type": "array of strings", - "description": "

    Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    " } ], "enabledForGitHubApps": true, @@ -238965,7 +240393,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -242205,7 +243634,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -245270,74 +246700,56 @@ ], "bodyParameters": [ { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "

    The title of the issue.

    ", - "type": "string or integer or null", + "type": "null or string or integer or string or integer", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the issue.

    " }, { "type": "string or null", - "description": "

    The contents of the issue.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the issue.

    " }, { "type": "string or null", - "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", "in": "body", - "isRequired": false + "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    State of the issue. Either open or closed.

    ", "enum": [ "open", "closed" - ], - "name": "state", - "in": "body", - "isRequired": false + ] }, { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._" - } - ], - "type": "string or integer or null", + "type": "string or null", + "name": "state_reason", + "in": "body", + "description": "

    The reason for the current state

    " + }, + { + "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "isRequired": false + "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    " }, { - "type": "array of strings or array of objects", - "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", + "type": "array", "name": "labels", "in": "body", - "isRequired": false + "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    " }, { "type": "array of strings", - "description": "

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    " } ], "enabledForGitHubApps": true, @@ -245525,7 +246937,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -248599,16 +250012,15 @@ "bodyParameters": [ { "type": "string", + "name": "lock_reason", + "in": "body", "description": "

    The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
    \n* off-topic
    \n* too heated
    \n* resolved
    \n* spam

    ", "enum": [ "off-topic", "too heated", "resolved", "spam" - ], - "name": "lock_reason", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -252510,10 +253922,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

    " } ], "enabledForGitHubApps": true, @@ -252695,7 +254106,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -255745,10 +257157,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

    " } ], "enabledForGitHubApps": true, @@ -255930,7 +257341,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -260514,9 +261926,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true } ], @@ -262106,9 +263518,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true } ], @@ -263058,7 +264470,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ], @@ -267921,7 +269334,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } }, "schema": { @@ -282868,10 +284282,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

    ", "name": "labels", - "in": "body" + "in": "body", + "description": "

    The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

    " } ], "enabledForGitHubApps": true, @@ -283046,10 +284459,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

    ", "name": "labels", - "in": "body" + "in": "body", + "description": "

    The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

    " } ], "enabledForGitHubApps": true, @@ -283615,24 +285027,22 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "name": "name", "in": "body", + "description": "

    The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "isRequired": true }, { "type": "string", - "description": "

    The hexadecimal color code for the label, without the leading #.

    ", "name": "color", "in": "body", - "isRequired": false + "description": "

    The hexadecimal color code for the label, without the leading #.

    " }, { "type": "string", - "description": "

    A short description of the label. Must be 100 characters or fewer.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the label. Must be 100 characters or fewer.

    " } ], "enabledForGitHubApps": true, @@ -283936,24 +285346,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "name": "new_name", "in": "body", - "isRequired": false + "description": "

    The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    " }, { "type": "string", - "description": "

    The hexadecimal color code for the label, without the leading #.

    ", "name": "color", "in": "body", - "isRequired": false + "description": "

    The hexadecimal color code for the label, without the leading #.

    " }, { "type": "string", - "description": "

    A short description of the label. Must be 100 characters or fewer.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the label. Must be 100 characters or fewer.

    " } ], "enabledForGitHubApps": true, @@ -284806,37 +286213,33 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the milestone.

    ", "name": "title", "in": "body", + "description": "

    The title of the milestone.

    ", "isRequired": true }, { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the milestone. Either open or closed.

    ", "enum": [ "open", "closed" ], - "default": "open", - "name": "state", - "in": "body", - "isRequired": false + "default": "open" }, { "type": "string", - "description": "

    A description of the milestone.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A description of the milestone.

    " }, { "type": "string", - "format": "date-time", - "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "due_on", "in": "body", - "isRequired": false + "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ], "enabledForGitHubApps": true, @@ -285679,37 +287082,32 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the milestone.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the milestone.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the milestone. Either open or closed.

    ", "enum": [ "open", "closed" ], - "default": "open", - "name": "state", - "in": "body", - "isRequired": false + "default": "open" }, { "type": "string", - "description": "

    A description of the milestone.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A description of the milestone.

    " }, { "type": "string", - "format": "date-time", - "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "due_on", "in": "body", - "isRequired": false + "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ], "enabledForGitHubApps": true, @@ -302581,33 +303979,28 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The Markdown text to render in HTML.

    ", "type": "string", "name": "text", "in": "body", + "description": "

    The Markdown text to render in HTML.

    ", "isRequired": true }, { + "type": "string", + "name": "mode", + "in": "body", "description": "

    The rendering mode. Can be either markdown or gfm.

    ", "enum": [ "markdown", "gfm" ], - "default": "markdown", - "type": "string", - "examples": [ - "markdown" - ], - "name": "mode", - "in": "body", - "isRequired": false + "default": "markdown" }, { - "description": "

    The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

    ", "type": "string", "name": "context", "in": "body", - "isRequired": false + "description": "

    The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

    " } ], "enabledForGitHubApps": true, @@ -305795,88 +307188,58 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    A list of arrays indicating which repositories should be migrated.

    ", "name": "repositories", "in": "body", + "description": "

    A list of arrays indicating which repositories should be migrated.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Indicates whether repositories should be locked (to prevent manipulation) while migrating data.

    ", - "default": false, - "examples": [ - true - ], "name": "lock_repositories", "in": "body", - "isRequired": false + "description": "

    Indicates whether repositories should be locked (to prevent manipulation) while migrating data.

    " }, { "type": "boolean", - "description": "

    Indicates whether metadata should be excluded and only git source should be included for the migration.

    ", - "default": false, "name": "exclude_metadata", "in": "body", - "isRequired": false + "description": "

    Indicates whether metadata should be excluded and only git source should be included for the migration.

    " }, { "type": "boolean", - "description": "

    Indicates whether the repository git data should be excluded from the migration.

    ", - "default": false, "name": "exclude_git_data", "in": "body", - "isRequired": false + "description": "

    Indicates whether the repository git data should be excluded from the migration.

    " }, { "type": "boolean", - "description": "

    Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).

    ", - "default": false, - "examples": [ - true - ], "name": "exclude_attachments", "in": "body", - "isRequired": false + "description": "

    Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).

    " }, { "type": "boolean", - "description": "

    Indicates whether releases should be excluded from the migration (to reduce migration archive file size).

    ", - "default": false, - "examples": [ - true - ], "name": "exclude_releases", "in": "body", - "isRequired": false + "description": "

    Indicates whether releases should be excluded from the migration (to reduce migration archive file size).

    " }, { "type": "boolean", - "description": "

    Indicates whether projects owned by the organization or users should be excluded. from the migration.

    ", - "default": false, - "examples": [ - true - ], "name": "exclude_owner_projects", "in": "body", - "isRequired": false + "description": "

    Indicates whether projects owned by the organization or users should be excluded. from the migration.

    " }, { "type": "boolean", - "description": "

    Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

    ", - "default": false, - "examples": [ - true - ], "name": "org_metadata_only", "in": "body", - "isRequired": false + "description": "

    Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

    " }, { "type": "array of strings", - "description": "

    Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: \"repositories\".

    ", "name": "exclude", "in": "body", - "isRequired": false + "description": "

    Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: \"repositories\".

    " } ], "enabledForGitHubApps": false, @@ -311486,92 +312849,52 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Lock the repositories being migrated at the start of the migration

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "lock_repositories", "in": "body", - "isRequired": false + "description": "

    Lock the repositories being migrated at the start of the migration

    " }, { - "description": "

    Indicates whether metadata should be excluded and only git source should be included for the migration.

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_metadata", "in": "body", - "isRequired": false + "description": "

    Indicates whether metadata should be excluded and only git source should be included for the migration.

    " }, { - "description": "

    Indicates whether the repository git data should be excluded from the migration.

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_git_data", "in": "body", - "isRequired": false + "description": "

    Indicates whether the repository git data should be excluded from the migration.

    " }, { - "description": "

    Do not include attachments in the migration

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_attachments", "in": "body", - "isRequired": false + "description": "

    Do not include attachments in the migration

    " }, { - "description": "

    Do not include releases in the migration

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_releases", "in": "body", - "isRequired": false + "description": "

    Do not include releases in the migration

    " }, { - "description": "

    Indicates whether projects owned by the organization or users should be excluded.

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_owner_projects", "in": "body", - "isRequired": false + "description": "

    Indicates whether projects owned by the organization or users should be excluded.

    " }, { "type": "boolean", - "description": "

    Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

    ", - "default": false, - "examples": [ - true - ], "name": "org_metadata_only", "in": "body", - "isRequired": false + "description": "

    Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

    " }, { - "description": "

    Exclude attributes from the API response to improve performance

    ", - "readOnly": false, "type": "array of strings", - "examples": [ - "repositories" - ], "name": "exclude", "in": "body", - "isRequired": false + "description": "

    Exclude attributes from the API response to improve performance

    " }, { "type": "array of strings", @@ -316849,14 +318172,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -317348,55 +318663,40 @@ "parameters": [], "bodyParameters": [ { - "description": "

    A list of scopes that this authorization is in.

    ", "type": "array of strings or null", - "examples": [ - "public_repo", - "user" - ], "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes that this authorization is in.

    " }, { - "description": "

    A note to remind you what the OAuth token is for.

    ", "type": "string", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    A note to remind you what the OAuth token is for.

    " }, { - "description": "

    A URL to remind you what app the OAuth token is for.

    ", "type": "string", "name": "note_url", "in": "body", - "isRequired": false + "description": "

    A URL to remind you what app the OAuth token is for.

    " }, { - "description": "

    The OAuth app client key for which to create the token.

    ", - "maxLength": 20, "type": "string", "name": "client_id", "in": "body", - "isRequired": false + "description": "

    The OAuth app client key for which to create the token.

    " }, { - "description": "

    The OAuth app client secret for which to create the token.

    ", - "maxLength": 40, "type": "string", "name": "client_secret", "in": "body", - "isRequired": false + "description": "

    The OAuth app client secret for which to create the token.

    " }, { - "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    ", "type": "string", "name": "fingerprint", "in": "body", - "isRequired": false + "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    " } ], "enabledForGitHubApps": false, @@ -317740,14 +319040,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -318257,47 +319549,35 @@ ], "bodyParameters": [ { - "description": "

    The OAuth app client secret for which to create the token.

    ", - "maxLength": 40, "type": "string", "name": "client_secret", "in": "body", + "description": "

    The OAuth app client secret for which to create the token.

    ", "isRequired": true }, { - "description": "

    A list of scopes that this authorization is in.

    ", "type": "array of strings or null", - "examples": [ - "public_repo", - "user" - ], "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes that this authorization is in.

    " }, { - "description": "

    A note to remind you what the OAuth token is for.

    ", "type": "string", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    A note to remind you what the OAuth token is for.

    " }, { - "description": "

    A URL to remind you what app the OAuth token is for.

    ", "type": "string", "name": "note_url", "in": "body", - "isRequired": false + "description": "

    A URL to remind you what app the OAuth token is for.

    " }, { - "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    ", "type": "string", "name": "fingerprint", "in": "body", - "isRequired": false + "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    " } ], "enabledForGitHubApps": false, @@ -318643,14 +319923,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -319446,14 +320718,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -319972,40 +321236,29 @@ ], "bodyParameters": [ { - "description": "

    The OAuth app client secret for which to create the token.

    ", - "maxLength": 40, "type": "string", "name": "client_secret", "in": "body", + "description": "

    The OAuth app client secret for which to create the token.

    ", "isRequired": true }, { - "description": "

    A list of scopes that this authorization is in.

    ", "type": "array of strings or null", - "examples": [ - "public_repo", - "user" - ], "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes that this authorization is in.

    " }, { - "description": "

    A note to remind you what the OAuth token is for.

    ", "type": "string", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    A note to remind you what the OAuth token is for.

    " }, { - "description": "

    A URL to remind you what app the OAuth token is for.

    ", "type": "string", "name": "note_url", "in": "body", - "isRequired": false + "description": "

    A URL to remind you what app the OAuth token is for.

    " } ], "enabledForGitHubApps": false, @@ -320352,14 +321605,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -321156,14 +322401,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -321989,14 +323226,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -322493,53 +323722,40 @@ ], "bodyParameters": [ { - "description": "

    A list of scopes that this authorization is in.

    ", "type": "array of strings or null", - "examples": [ - "public_repo", - "user" - ], "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes that this authorization is in.

    " }, { - "description": "

    A list of scopes to add to this authorization.

    ", "type": "array of strings", "name": "add_scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes to add to this authorization.

    " }, { - "description": "

    A list of scopes to remove from this authorization.

    ", "type": "array of strings", "name": "remove_scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes to remove from this authorization.

    " }, { - "description": "

    A note to remind you what the OAuth token is for.

    ", "type": "string", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    A note to remind you what the OAuth token is for.

    " }, { - "description": "

    A URL to remind you what app the OAuth token is for.

    ", "type": "string", "name": "note_url", "in": "body", - "isRequired": false + "description": "

    A URL to remind you what app the OAuth token is for.

    " }, { - "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    ", "type": "string", "name": "fingerprint", "in": "body", - "isRequired": false + "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    " } ], "enabledForGitHubApps": false, @@ -322877,14 +324093,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -324077,69 +325285,62 @@ "bodyParameters": [ { "type": "string", - "description": "

    Billing email address. This address is not publicized.

    ", "name": "billing_email", "in": "body", - "isRequired": false + "description": "

    Billing email address. This address is not publicized.

    " }, { "type": "string", - "description": "

    The company name.

    ", "name": "company", "in": "body", - "isRequired": false + "description": "

    The company name.

    " }, { "type": "string", - "description": "

    The publicly visible email address.

    ", "name": "email", "in": "body", - "isRequired": false + "description": "

    The publicly visible email address.

    " }, { "type": "string", - "description": "

    The Twitter username of the company.

    ", "name": "twitter_username", "in": "body", - "isRequired": false + "description": "

    The Twitter username of the company.

    " }, { "type": "string", - "description": "

    The location.

    ", "name": "location", "in": "body", - "isRequired": false + "description": "

    The location.

    " }, { "type": "string", - "description": "

    The shorthand name of the company.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The shorthand name of the company.

    " }, { "type": "string", - "description": "

    The description of the company.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the company.

    " }, { "type": "boolean", - "description": "

    Whether an organization can use organization projects.

    ", "name": "has_organization_projects", "in": "body", - "isRequired": false + "description": "

    Whether an organization can use organization projects.

    " }, { "type": "boolean", - "description": "

    Whether repositories that belong to the organization can use repository projects.

    ", "name": "has_repository_projects", "in": "body", - "isRequired": false + "description": "

    Whether repositories that belong to the organization can use repository projects.

    " }, { "type": "string", + "name": "default_repository_permission", + "in": "body", "description": "

    Default permission level members have for organization repositories.

    ", "enum": [ "read", @@ -324147,77 +325348,62 @@ "admin", "none" ], - "default": "read", - "name": "default_repository_permission", - "in": "body", - "isRequired": false + "default": "read" }, { "type": "boolean", - "description": "

    Whether of non-admin organization members can create repositories. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

    ", - "default": true, "name": "members_can_create_repositories", "in": "body", - "isRequired": false + "description": "

    Whether of non-admin organization members can create repositories. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

    ", + "default": true }, { "type": "boolean", - "description": "

    Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_internal_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_private_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "string", + "name": "members_allowed_repository_creation_type", + "in": "body", "description": "

    Specifies which types of repositories non-admin organization members can create.\nNote: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See the parameter deprecation notice in the operation description for details.

    ", "enum": [ "all", "private", "none" - ], - "name": "members_allowed_repository_creation_type", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.

    ", - "default": true, "name": "members_can_create_pages", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.

    ", + "default": true }, { "type": "boolean", - "description": "

    Whether organization members can fork private organization repositories.

    ", - "default": false, "name": "members_can_fork_private_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can fork private organization repositories.

    " }, { "type": "string", - "examples": [ - "\"http://github.blog\"" - ], "name": "blog", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -325571,14 +326757,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -326512,7 +327690,7 @@ } ], "previews": [], - "descriptionHTML": "

    List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.

    \n

    For more information on custom repository roles, see \"Managing custom repository roles for an organization\".

    ", + "descriptionHTML": "

    List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.

    \n

    To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with admin:org repo scope.\nGitHub Apps must have the organization_custom_roles:read organization permission to use this endpoint.

    \n

    For more information on custom repository roles, see \"Managing custom repository roles for an organization\".

    ", "statusCodes": [ { "httpStatusCode": "200", @@ -327395,15 +328573,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role to give the user in the organization. Can be one of:
    \n* admin - The user will become an owner of the organization.
    \n* member - The user will become a non-owner member of the organization.

    ", "enum": [ "admin", "member" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -329243,13 +330420,13 @@ "bodyParameters": [ { "type": "string", - "description": "

    The state that the membership should be in. Only \"active\" will be accepted.

    ", - "enum": [ - "active" - ], "name": "state", "in": "body", - "isRequired": true + "description": "

    The state that the membership should be in. Only \"active\" will be accepted.

    ", + "isRequired": true, + "enum": [ + "active" + ] } ], "enabledForGitHubApps": false, @@ -329961,11 +331138,9 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

    ", - "default": false, "name": "async", "in": "body", - "isRequired": false + "description": "

    When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

    " } ], "enabledForGitHubApps": true, @@ -330323,203 +331498,66 @@ "bodyParameters": [ { "type": "string", - "description": "

    Must be passed as \"web\".

    ", "name": "name", "in": "body", + "description": "

    Must be passed as \"web\".

    ", "isRequired": true }, { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - }, - "username": { - "type": "string", - "examples": [ - "\"kdaigle\"" - ], - "name": "username", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "password": { - "type": "string", - "examples": [ - "\"password\"" - ], - "name": "password", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"kdaigle\"" - ], - "name": "username", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"password\"" - ], - "name": "password", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "username", + "description": "" + }, + { + "type": "string", + "name": "password", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, @@ -330926,162 +331964,54 @@ "bodyParameters": [ { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true }, { "type": "string", - "examples": [ - "\"web\"" - ], "name": "name", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -331453,53 +332383,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": true, @@ -332520,77 +333424,35 @@ "bodyParameters": [ { "type": "string", + "name": "build_type", + "in": "body", "description": "

    The process in which the Page will be built. Possible values are \"legacy\" and \"workflow\".

    ", "enum": [ "legacy", "workflow" - ], - "name": "build_type", - "in": "body", - "isRequired": false + ] }, { "type": "object", + "name": "source", + "in": "body", "description": "

    The source branch and directory used to publish your Pages site.

    ", - "properties": { - "branch": { + "childParamsGroups": [ + { "type": "string", - "description": "

    The repository branch used to publish your site's source files.

    ", "name": "branch", - "in": "body", - "rawType": "string", - "rawDescription": "The repository branch used to publish your site's source files.", - "isRequired": true, - "childParamsGroups": [] + "description": "

    The repository branch used to publish your site's source files.

    ", + "isRequired": true }, - "path": { + { "type": "string", + "name": "path", "description": "

    The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: /

    ", "enum": [ "/", "/docs" ], - "default": "/", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "branch" - ], - "name": "source", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "source", - "parentType": "object", - "id": "source-object", - "params": [ - { - "type": "string", - "description": "

    The repository branch used to publish your site's source files.

    ", - "name": "branch", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: /

    ", - "enum": [ - "/", - "/docs" - ], - "default": "/", - "name": "path", - "in": "body", - "isRequired": false - } - ] + "default": "/" } ] } @@ -332874,75 +333736,37 @@ "bodyParameters": [ { "type": "string or null", - "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    ", "name": "cname", "in": "body", - "isRequired": false + "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    " }, { "type": "boolean", - "description": "

    Specify whether HTTPS should be enforced for the repository.

    ", "name": "https_enforced", "in": "body", - "isRequired": false + "description": "

    Specify whether HTTPS should be enforced for the repository.

    " }, { "type": "boolean", - "description": "

    Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

    ", "name": "public", "in": "body", - "isRequired": false + "description": "

    Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

    " }, { "type": "string", + "name": "build_type", + "in": "body", "description": "

    The process by which the GitHub Pages site will be built. workflow means that the site is built by a custom GitHub Actions workflow. legacy means that the site is built by GitHub when changes are pushed to a specific branch.

    ", "enum": [ "legacy", "workflow" - ], - "name": "build_type", - "in": "body", - "isRequired": false + ] }, { - "anyOf": [ - { - "type": "string", - "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", - "enum": [ - "gh-pages", - "master", - "master /docs" - ] - }, - { - "type": "object", - "description": "Update the source for the repository. Must include the branch name and path.", - "properties": { - "branch": { - "type": "string", - "description": "The repository branch used to publish your site's source files." - }, - "path": { - "type": "string", - "description": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.", - "enum": [ - "/", - "/docs" - ] - } - }, - "required": [ - "branch", - "path" - ] - } - ], + "type": "", "name": "source", "in": "body", - "type": "", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -334524,17 +335348,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the project.

    ", "name": "name", "in": "body", + "description": "

    The name of the project.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the project.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The description of the project.

    " } ], "enabledForGitHubApps": true, @@ -335311,54 +336134,40 @@ ], "bodyParameters": [ { - "description": "

    Name of the project

    ", "type": "string", - "examples": [ - "Week One Sprint" - ], "name": "name", "in": "body", - "isRequired": false + "description": "

    Name of the project

    " }, { - "description": "

    Body of the project

    ", "type": "string or null", - "examples": [ - "This project represents the sprint of the first week in January" - ], "name": "body", "in": "body", - "isRequired": false + "description": "

    Body of the project

    " }, { - "description": "

    State of the project; either 'open' or 'closed'

    ", "type": "string", - "examples": [ - "open" - ], "name": "state", "in": "body", - "isRequired": false + "description": "

    State of the project; either 'open' or 'closed'

    " }, { - "description": "

    The baseline permission that all organization members have on this project

    ", "type": "string", + "name": "organization_permission", + "in": "body", + "description": "

    The baseline permission that all organization members have on this project

    ", "enum": [ "read", "write", "admin", "none" - ], - "name": "organization_permission", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether or not this project can be seen by everyone.

    ", "type": "boolean", "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether or not this project can be seen by everyone.

    " } ], "enabledForGitHubApps": true, @@ -336271,17 +337080,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the project.

    ", "name": "name", "in": "body", + "description": "

    The name of the project.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the project.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The description of the project.

    " } ], "enabledForGitHubApps": true, @@ -336669,24 +337477,17 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Name of the project

    ", "type": "string", - "examples": [ - "Week One Sprint" - ], "name": "name", "in": "body", + "description": "

    Name of the project

    ", "isRequired": true }, { - "description": "

    Body of the project

    ", "type": "string or null", - "examples": [ - "This project represents the sprint of the first week in January" - ], "name": "body", "in": "body", - "isRequired": false + "description": "

    Body of the project

    " } ], "enabledForGitHubApps": true, @@ -337846,24 +338647,16 @@ ], "bodyParameters": [ { - "description": "

    The project card's note

    ", "type": "string or null", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    The project card's note

    " }, { - "description": "

    Whether or not the card is archived

    ", "type": "boolean", - "examples": [ - false - ], "name": "archived", "in": "body", - "isRequired": false + "description": "

    Whether or not the card is archived

    " } ], "enabledForGitHubApps": true, @@ -338293,25 +339086,17 @@ ], "bodyParameters": [ { - "description": "

    The position of the card in a column. Can be one of: top, bottom, or after:<card_id> to place after the specified card.

    ", "type": "string", - "pattern": "^(?:top|bottom|after:\\d+)$", - "examples": [ - "bottom" - ], "name": "position", "in": "body", + "description": "

    The position of the card in a column. Can be one of: top, bottom, or after:<card_id> to place after the specified card.

    ", "isRequired": true }, { - "description": "

    The unique identifier of the column the card should be moved to

    ", "type": "integer", - "examples": [ - 42 - ], "name": "column_id", "in": "body", - "isRequired": false + "description": "

    The unique identifier of the column the card should be moved to

    " } ], "enabledForGitHubApps": true, @@ -338783,33 +339568,24 @@ ], "bodyParameters": [ { - "description": "

    The project card's note

    ", "type": "string or null", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", + "description": "

    The project card's note

    ", "isRequired": true }, { - "description": "

    The unique identifier of the content associated with the card

    ", "type": "integer", - "examples": [ - 42 - ], "name": "content_id", "in": "body", + "description": "

    The unique identifier of the content associated with the card

    ", "isRequired": true }, { - "description": "

    The piece of content associated with the card

    ", "type": "string", - "examples": [ - "PullRequest" - ], "name": "content_type", "in": "body", + "description": "

    The piece of content associated with the card

    ", "isRequired": true } ], @@ -339475,20 +340251,16 @@ ], "bodyParameters": [ { + "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant the collaborator.

    ", "enum": [ "read", "write", "admin" ], - "default": "write", - "type": "string", - "examples": [ - "write" - ], - "name": "permission", - "in": "body", - "isRequired": false + "default": "write" } ], "enabledForGitHubApps": true, @@ -340064,13 +340836,10 @@ ], "bodyParameters": [ { - "description": "

    Name of the project column

    ", "type": "string", - "examples": [ - "Remaining tasks" - ], "name": "name", "in": "body", + "description": "

    Name of the project column

    ", "isRequired": true } ], @@ -340276,14 +341045,10 @@ ], "bodyParameters": [ { - "description": "

    The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

    ", "type": "string", - "pattern": "^(?:first|last|after:\\d+)$", - "examples": [ - "last" - ], "name": "position", "in": "body", + "description": "

    The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

    ", "isRequired": true } ], @@ -340523,13 +341288,10 @@ ], "bodyParameters": [ { - "description": "

    Name of the project column

    ", "type": "string", - "examples": [ - "Remaining tasks" - ], "name": "name", "in": "body", + "description": "

    Name of the project column

    ", "isRequired": true } ], @@ -346261,55 +347023,47 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the new pull request. Required unless issue is specified.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the new pull request. Required unless issue is specified.

    " }, { "type": "string", - "description": "

    The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

    ", "name": "head", "in": "body", + "description": "

    The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

    ", "isRequired": true }, { "type": "string", - "description": "

    The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

    ", "name": "base", "in": "body", + "description": "

    The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    The contents of the pull request.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the pull request.

    " }, { "type": "boolean", - "description": "

    Indicates whether maintainers can modify the pull request.

    ", "name": "maintainer_can_modify", "in": "body", - "isRequired": false + "description": "

    Indicates whether maintainers can modify the pull request.

    " }, { "type": "boolean", - "description": "

    Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

    ", "name": "draft", "in": "body", - "isRequired": false + "description": "

    Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

    " }, { "type": "integer", - "description": "

    An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified.

    ", - "examples": [ - 1 - ], "name": "issue", "in": "body", - "isRequired": false + "description": "

    An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified.

    " } ], "enabledForGitHubApps": true, @@ -353946,42 +354700,37 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the pull request.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the pull request.

    " }, { "type": "string", - "description": "

    The contents of the pull request.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the pull request.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    State of this Pull Request. Either open or closed.

    ", "enum": [ "open", "closed" - ], - "name": "state", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "description": "

    The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

    ", "name": "base", "in": "body", - "isRequired": false + "description": "

    The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

    " }, { "type": "boolean", - "description": "

    Indicates whether maintainers can modify the pull request.

    ", "name": "maintainer_can_modify", "in": "body", - "isRequired": false + "description": "

    Indicates whether maintainers can modify the pull request.

    " } ], "enabledForGitHubApps": true, @@ -358925,36 +359674,32 @@ "bodyParameters": [ { "type": "string", - "description": "

    Title for the automatic commit message.

    ", "name": "commit_title", "in": "body", - "isRequired": false + "description": "

    Title for the automatic commit message.

    " }, { "type": "string", - "description": "

    Extra detail to append to automatic commit message.

    ", "name": "commit_message", "in": "body", - "isRequired": false + "description": "

    Extra detail to append to automatic commit message.

    " }, { "type": "string", - "description": "

    SHA that pull request head must match to allow merge.

    ", "name": "sha", "in": "body", - "isRequired": false + "description": "

    SHA that pull request head must match to allow merge.

    " }, { "type": "string", + "name": "merge_method", + "in": "body", "description": "

    Merge method to use. Possible values are merge, squash or rebase. Default is merge.

    ", "enum": [ "merge", "squash", "rebase" - ], - "name": "merge_method", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -359072,10 +359817,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

    ", "name": "expected_head_sha", "in": "body", - "isRequired": false + "description": "

    The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

    " } ], "enabledForGitHubApps": false, @@ -360464,9 +361208,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the reply to the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the reply to the review comment.

    ", "isRequired": true } ], @@ -361839,82 +362583,70 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the review comment.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

    ", "name": "commit_id", "in": "body", + "description": "

    The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

    ", "isRequired": true }, { "type": "string", - "description": "

    The relative path to the file that necessitates a comment.

    ", "name": "path", "in": "body", + "description": "

    The relative path to the file that necessitates a comment.

    ", "isRequired": true }, { "type": "integer", - "description": "

    This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    ", - "deprecated": true, - "x-github": { - "deprecationDate": "2022-11-01" - }, "name": "position", "in": "body", - "isRequired": false + "description": "

    This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    " }, { "type": "string", + "name": "side", + "in": "body", "description": "

    In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

    ", "enum": [ "LEFT", "RIGHT" - ], - "name": "side", - "in": "body", - "isRequired": false + ] }, { "type": "integer", - "description": "

    The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

    ", "name": "line", "in": "body", + "description": "

    The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

    ", "isRequired": true }, { "type": "integer", - "description": "

    Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

    ", "name": "start_line", "in": "body", - "isRequired": false + "description": "

    Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

    " }, { "type": "string", + "name": "start_side", + "in": "body", "description": "

    Required when using multi-line comments unless using in_reply_to. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

    ", "enum": [ "LEFT", "RIGHT", "side" - ], - "name": "start_side", - "in": "body", - "isRequired": false + ] }, { "type": "integer", - "description": "

    The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

    ", - "examples": [ - 2 - ], "name": "in_reply_to", "in": "body", - "isRequired": false + "description": "

    The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

    " } ], "enabledForGitHubApps": true, @@ -362563,9 +363295,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the review comment.

    ", "isRequired": true } ], @@ -363683,17 +364415,15 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of user logins that will be requested.

    ", "name": "reviewers", "in": "body", - "isRequired": false + "description": "

    An array of user logins that will be requested.

    " }, { "type": "array of strings", - "description": "

    An array of team slugs that will be requested.

    ", "name": "team_reviewers", "in": "body", - "isRequired": false + "description": "

    An array of team slugs that will be requested.

    " } ], "enabledForGitHubApps": true, @@ -369240,17 +369970,16 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of user logins that will be removed.

    ", "name": "reviewers", "in": "body", + "description": "

    An array of user logins that will be removed.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    An array of team slugs that will be removed.

    ", "name": "team_reviewers", "in": "body", - "isRequired": false + "description": "

    An array of team slugs that will be removed.

    " } ], "enabledForGitHubApps": true, @@ -375176,104 +375905,69 @@ "bodyParameters": [ { "type": "string", - "description": "

    The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

    ", "name": "commit_id", "in": "body", - "isRequired": false + "description": "

    The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

    " }, { "type": "string", - "description": "

    Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

    " }, { "type": "string", + "name": "event", + "in": "body", "description": "

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

    ", "enum": [ "APPROVE", "REQUEST_CHANGES", "COMMENT" - ], - "name": "event", - "in": "body", - "isRequired": false + ] }, { "type": "array of objects", - "description": "

    Use the following table to specify the location, destination, and contents of the draft review comment.

    ", "name": "comments", "in": "body", - "isRequired": false, + "description": "

    Use the following table to specify the location, destination, and contents of the draft review comment.

    ", "childParamsGroups": [ { - "parentName": "comments", - "parentType": "items", - "id": "comments-items", - "params": [ - { - "type": "string", - "description": "

    The relative path to the file that necessitates a review comment.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

    ", - "name": "position", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Text of the review comment.

    ", - "name": "body", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "examples": [ - 28 - ], - "name": "line", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "RIGHT" - ], - "name": "side", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "integer", - "examples": [ - 26 - ], - "name": "start_line", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "LEFT" - ], - "name": "start_side", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "path", + "description": "

    The relative path to the file that necessitates a review comment.

    ", + "isRequired": true + }, + { + "type": "integer", + "name": "position", + "description": "

    The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

    " + }, + { + "type": "string", + "name": "body", + "description": "

    Text of the review comment.

    ", + "isRequired": true + }, + { + "type": "integer", + "name": "line", + "description": "" + }, + { + "type": "string", + "name": "side", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + }, + { + "type": "string", + "name": "start_side", + "description": "" } ] } @@ -376120,9 +376814,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The body text of the pull request review.

    ", "name": "body", "in": "body", + "description": "

    The body text of the pull request review.

    ", "isRequired": true } ], @@ -377593,23 +378287,19 @@ "bodyParameters": [ { "type": "string", - "description": "

    The message for the pull request review dismissal

    ", "name": "message", "in": "body", + "description": "

    The message for the pull request review dismissal

    ", "isRequired": true }, { "type": "string", - "enum": [ - "DISMISS" - ], - "examples": [ - "\"DISMISS\"" - ], "name": "event", "in": "body", "description": "", - "isRequired": false + "enum": [ + "DISMISS" + ] } ], "enabledForGitHubApps": true, @@ -378035,22 +378725,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The body text of the pull request review

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The body text of the pull request review

    " }, { "type": "string", + "name": "event", + "in": "body", "description": "

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.

    ", + "isRequired": true, "enum": [ "APPROVE", "REQUEST_CHANGES", "COMMENT" - ], - "name": "event", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -379166,7 +379855,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -379176,10 +379868,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -380206,7 +380895,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -380216,10 +380908,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -381299,7 +381988,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the commit comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -381309,10 +382001,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -382335,7 +383024,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the issue comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -382345,10 +383037,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -383375,7 +384064,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the issue.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -383385,10 +384077,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -384411,7 +385100,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the pull request review comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -384421,10 +385113,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -385445,7 +386134,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the release.

    ", + "isRequired": true, "enum": [ "+1", "laugh", @@ -385453,10 +386145,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -386475,7 +387164,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -386485,10 +387177,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -387140,7 +387829,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -387150,10 +387842,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -388200,55 +388889,46 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the tag.

    ", "name": "tag_name", "in": "body", + "description": "

    The name of the tag.

    ", "isRequired": true }, { "type": "string", - "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    ", "name": "target_commitish", "in": "body", - "isRequired": false + "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    " }, { "type": "string", - "description": "

    The name of the release.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the release.

    " }, { "type": "string", - "description": "

    Text describing the contents of the tag.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Text describing the contents of the tag.

    " }, { "type": "boolean", - "description": "

    true to create a draft (unpublished) release, false to create a published one.

    ", - "default": false, "name": "draft", "in": "body", - "isRequired": false + "description": "

    true to create a draft (unpublished) release, false to create a published one.

    " }, { "type": "boolean", - "description": "

    true to identify the release as a prerelease. false to identify the release as a full release.

    ", - "default": false, "name": "prerelease", "in": "body", - "isRequired": false + "description": "

    true to identify the release as a prerelease. false to identify the release as a full release.

    " }, { "type": "boolean", - "description": "

    Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes.

    ", - "default": false, "name": "generate_release_notes", "in": "body", - "isRequired": false + "description": "

    Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes.

    " } ], "enabledForGitHubApps": true, @@ -388974,31 +389654,28 @@ "bodyParameters": [ { "type": "string", - "description": "

    The tag name for the release. This can be an existing tag or a new one.

    ", "name": "tag_name", "in": "body", + "description": "

    The tag name for the release. This can be an existing tag or a new one.

    ", "isRequired": true }, { "type": "string", - "description": "

    Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.

    ", "name": "target_commitish", "in": "body", - "isRequired": false + "description": "

    Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.

    " }, { "type": "string", - "description": "

    The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.

    ", "name": "previous_tag_name", "in": "body", - "isRequired": false + "description": "

    The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.

    " }, { "type": "string", - "description": "

    Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.

    ", "name": "configuration_file_path", "in": "body", - "isRequired": false + "description": "

    Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.

    " } ], "enabledForGitHubApps": true, @@ -391255,45 +391932,39 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the tag.

    ", "name": "tag_name", "in": "body", - "isRequired": false + "description": "

    The name of the tag.

    " }, { "type": "string", - "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    ", "name": "target_commitish", "in": "body", - "isRequired": false + "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    " }, { "type": "string", - "description": "

    The name of the release.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the release.

    " }, { "type": "string", - "description": "

    Text describing the contents of the tag.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Text describing the contents of the tag.

    " }, { "type": "boolean", - "description": "

    true makes the release a draft, and false publishes the release.

    ", "name": "draft", "in": "body", - "isRequired": false + "description": "

    true makes the release a draft, and false publishes the release.

    " }, { "type": "boolean", - "description": "

    true to identify the release as a prerelease, false to identify the release as a full release.

    ", "name": "prerelease", "in": "body", - "isRequired": false + "description": "

    true to identify the release as a prerelease, false to identify the release as a full release.

    " } ], "enabledForGitHubApps": true, @@ -392441,27 +393112,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The file name of the asset.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The file name of the asset.

    " }, { "type": "string", - "description": "

    An alternate short description of the asset. Used in place of the filename.

    ", "name": "label", "in": "body", - "isRequired": false + "description": "

    An alternate short description of the asset. Used in place of the filename.

    " }, { "type": "string", - "examples": [ - "\"uploaded\"" - ], "name": "state", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -395923,199 +396588,171 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the repository.

    ", "name": "name", "in": "body", + "description": "

    The name of the repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short description of the repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { "type": "string", - "description": "

    A URL with more information about the repository.

    ", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { "type": "boolean", - "description": "

    Whether the repository is private.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether the repository is private.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.

    ", "enum": [ "public", "private", "internal" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Either true to enable issues for this repository or false to disable them.

    ", - "default": true, "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Either true to enable issues for this repository or false to disable them.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", - "default": true, "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", - "default": true, "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    ", - "default": false, "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    " }, { "type": "integer", - "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    ", "name": "team_id", "in": "body", - "isRequired": false + "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    " }, { "type": "boolean", - "description": "

    Pass true to create an initial commit with empty README.

    ", - "default": false, "name": "auto_init", "in": "body", - "isRequired": false + "description": "

    Pass true to create an initial commit with empty README.

    " }, { "type": "string", - "description": "

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

    ", "name": "gitignore_template", "in": "body", - "isRequired": false + "description": "

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

    " }, { "type": "string", - "description": "

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

    ", "name": "license_template", "in": "body", - "isRequired": false + "description": "

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", - "default": true, "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", - "default": true, "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", - "default": true, "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    ", - "default": false, "name": "allow_auto_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    " }, { "type": "boolean", - "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    ", - "default": false, "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    ", - "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -403507,295 +404144,78 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the repository.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the repository.

    " }, { "type": "string", - "description": "

    A short description of the repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { "type": "string", - "description": "

    A URL with more information about the repository.

    ", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { "type": "boolean", - "description": "

    Either true to make the repository private or false to make it public. Default: false.
    \nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Either true to make the repository private or false to make it public. Default: false.
    \nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal.\"

    ", "enum": [ "public", "private", "internal" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { "type": "object or null", - "description": "

    Specify which security and analysis features to enable or disable for the repository.

    \n

    To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

    \n

    For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.

    \n

    You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

    ", - "properties": { - "advanced_security": { - "type": "object", - "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "advanced_security", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", - "childParamsGroups": [ - { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - "secret_scanning": { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", - "childParamsGroups": [ - { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - "secret_scanning_push_protection": { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning_push_protection", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", - "childParamsGroups": [ - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - } - }, "name": "security_and_analysis", "in": "body", - "isRequired": false, + "description": "

    Specify which security and analysis features to enable or disable for the repository.

    \n

    To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

    \n

    For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.

    \n

    You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

    ", "childParamsGroups": [ { - "parentName": "security_and_analysis", - "parentType": "object", - "id": "security_and_analysis-object", - "params": [ + "type": "object", + "name": "advanced_security", + "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", + "childParamsGroups": [ { - "type": "object", - "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "advanced_security", - "in": "body", - "childParamsGroups": [ - { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning", - "in": "body", - "childParamsGroups": [ - { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning_push_protection", - "in": "body", - "childParamsGroups": [ - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] + "type": "string", + "name": "status", + "description": "

    Can be enabled or disabled.

    " } ] }, { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ + "type": "object", + "name": "secret_scanning", + "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    Can be enabled or disabled.

    ", "name": "status", - "in": "body" + "description": "

    Can be enabled or disabled.

    " } ] }, { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ + "type": "object", + "name": "secret_scanning_push_protection", + "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    Can be enabled or disabled.

    ", "name": "status", - "in": "body" - } - ] - }, - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" + "description": "

    Can be enabled or disabled.

    " } ] } @@ -403803,160 +404223,135 @@ }, { "type": "boolean", - "description": "

    Either true to enable issues for this repository or false to disable them.

    ", - "default": true, "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Either true to enable issues for this repository or false to disable them.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", - "default": true, "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", - "default": true, "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    ", - "default": false, "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    " }, { "type": "string", - "description": "

    Updates the default branch for this repository.

    ", "name": "default_branch", "in": "body", - "isRequired": false + "description": "

    Updates the default branch for this repository.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", - "default": true, "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", - "default": true, "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", - "default": true, "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    ", - "default": false, "name": "allow_auto_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    " }, { "type": "boolean", - "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    ", - "default": false, "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    " }, { "type": "boolean", - "description": "

    Either true to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.

    ", - "default": false, "name": "allow_update_branch", "in": "body", - "isRequired": false + "description": "

    Either true to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    ", - "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    true to archive this repository. Note: You cannot unarchive repositories through the API.

    ", - "default": false, "name": "archived", "in": "body", - "isRequired": false + "description": "

    true to archive this repository. Note: You cannot unarchive repositories through the API.

    " }, { "type": "boolean", - "description": "

    Either true to allow private forks, or false to prevent private forks.

    ", - "default": false, "name": "allow_forking", "in": "body", - "isRequired": false + "description": "

    Either true to allow private forks, or false to prevent private forks.

    " } ], "enabledForGitHubApps": true, @@ -410065,21 +410460,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    A custom webhook event name. Must be 100 characters or fewer.

    ", - "minLength": 1, - "maxLength": 100, "name": "event_type", "in": "body", + "description": "

    A custom webhook event name. Must be 100 characters or fewer.

    ", "isRequired": true }, { "type": "object", - "description": "

    JSON payload with extra information about the webhook event that your action or workflow may use.

    ", - "additionalProperties": true, - "maxProperties": 10, "name": "client_payload", "in": "body", - "isRequired": false + "description": "

    JSON payload with extra information about the webhook event that your action or workflow may use.

    " } ], "enabledForGitHubApps": true, @@ -410906,9 +411296,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

    ", "name": "names", "in": "body", + "description": "

    An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

    ", "isRequired": true } ], @@ -411011,17 +411401,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The username or organization name the repository will be transferred to.

    ", "name": "new_owner", "in": "body", + "description": "

    The username or organization name the repository will be transferred to.

    ", "isRequired": true }, { "type": "array of integers", - "description": "

    ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

    ", "name": "team_ids", "in": "body", - "isRequired": false + "description": "

    ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

    " } ], "enabledForGitHubApps": true, @@ -413427,40 +413816,34 @@ "bodyParameters": [ { "type": "string", - "description": "

    The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

    ", "name": "owner", "in": "body", - "isRequired": false + "description": "

    The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

    " }, { "type": "string", - "description": "

    The name of the new repository.

    ", "name": "name", "in": "body", + "description": "

    The name of the new repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short description of the new repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the new repository.

    " }, { "type": "boolean", - "description": "

    Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.

    ", - "default": false, "name": "include_all_branches", "in": "body", - "isRequired": false + "description": "

    Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.

    " }, { "type": "boolean", - "description": "

    Either true to create a new private repository or false to create a new public one.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Either true to create a new private repository or false to create a new public one.

    " } ], "enabledForGitHubApps": false, @@ -418915,227 +419298,162 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The name of the repository.

    ", "type": "string", - "examples": [ - "Team Environment" - ], "name": "name", "in": "body", + "description": "

    The name of the repository.

    ", "isRequired": true }, { - "description": "

    A short description of the repository.

    ", "type": "string", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { - "description": "

    A URL with more information about the repository.

    ", "type": "string", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { - "description": "

    Whether the repository is private.

    ", - "default": false, "type": "boolean", "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether the repository is private.

    " }, { - "description": "

    Whether issues are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Whether issues are enabled.

    ", + "default": true }, { - "description": "

    Whether projects are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Whether projects are enabled.

    ", + "default": true }, { - "description": "

    Whether the wiki is enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Whether the wiki is enabled.

    ", + "default": true }, { - "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    ", "type": "integer", "name": "team_id", "in": "body", - "isRequired": false + "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    " }, { - "description": "

    Whether the repository is initialized with a minimal README.

    ", - "default": false, "type": "boolean", "name": "auto_init", "in": "body", - "isRequired": false + "description": "

    Whether the repository is initialized with a minimal README.

    " }, { - "description": "

    The desired language or platform to apply to the .gitignore.

    ", "type": "string", - "examples": [ - "Haskell" - ], "name": "gitignore_template", "in": "body", - "isRequired": false + "description": "

    The desired language or platform to apply to the .gitignore.

    " }, { - "description": "

    The license keyword of the open source license for this repository.

    ", "type": "string", - "examples": [ - "mit" - ], "name": "license_template", "in": "body", - "isRequired": false + "description": "

    The license keyword of the open source license for this repository.

    " }, { - "description": "

    Whether to allow squash merges for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Whether to allow squash merges for pull requests.

    ", + "default": true }, { - "description": "

    Whether to allow merge commits for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Whether to allow merge commits for pull requests.

    ", + "default": true }, { - "description": "

    Whether to allow rebase merges for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Whether to allow rebase merges for pull requests.

    ", + "default": true }, { - "description": "

    Whether to allow Auto-merge to be used on pull requests.

    ", - "default": false, "type": "boolean", - "examples": [ - false - ], "name": "allow_auto_merge", "in": "body", - "isRequired": false + "description": "

    Whether to allow Auto-merge to be used on pull requests.

    " }, { - "description": "

    Whether to delete head branches when pull requests are merged

    ", - "default": false, "type": "boolean", - "examples": [ - false - ], "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Whether to delete head branches when pull requests are merged

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether downloads are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_downloads", "in": "body", - "isRequired": false + "description": "

    Whether downloads are enabled.

    ", + "default": true }, { - "description": "

    Whether this repository acts as a template that can be used to generate new repositories.

    ", - "default": false, "type": "boolean", - "examples": [ - true - ], "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Whether this repository acts as a template that can be used to generate new repositories.

    " } ], "enabledForGitHubApps": false, @@ -423153,16 +423471,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.

    ", "name": "key_prefix", "in": "body", + "description": "

    The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.

    ", "isRequired": true }, { "type": "string", - "description": "

    The URL must contain <num> for the reference number.

    ", "name": "url_template", "in": "body", + "description": "

    The URL must contain <num> for the reference number.

    ", "isRequired": true } ], @@ -425231,7 +425549,7 @@ } ], "previews": [], - "descriptionHTML": "

    Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

    \n

    Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

    \n

    Note:

    \n
      \n
    • To get a repository's contents recursively, you can recursively get the tree.
      • \n
    • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
      • \n
    • This API supports files up to 1 megabyte in size.
      • \n
    \n

    If the content is a directory

    \n

    The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

    \n

    If the content is a symlink

    \n

    If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

    \n

    If the content is a submodule

    \n

    The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

    \n

    If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

    ", + "descriptionHTML": "

    Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

    \n

    Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

    \n

    Notes:

    \n
      \n
    • To get a repository's contents recursively, you can recursively get the tree.
      • \n
    • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
      • \n
    • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
      • \n
    • This API supports files up to 1 megabyte in size.
      • \n
    \n

    If the content is a directory

    \n

    The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

    \n

    If the content is a symlink

    \n

    If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

    \n

    If the content is a submodule

    \n

    The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

    \n

    If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

    ", "statusCodes": [ { "httpStatusCode": "200", @@ -425291,185 +425609,77 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message.

    ", "name": "message", "in": "body", + "description": "

    The commit message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The new file content, using Base64 encoding.

    ", "name": "content", "in": "body", + "description": "

    The new file content, using Base64 encoding.

    ", "isRequired": true }, { "type": "string", - "description": "

    Required if you are updating a file. The blob SHA of the file being replaced.

    ", "name": "sha", "in": "body", - "isRequired": false + "description": "

    Required if you are updating a file. The blob SHA of the file being replaced.

    " }, { "type": "string", - "description": "

    The branch name. Default: the repository’s default branch (usually master)

    ", "name": "branch", "in": "body", - "isRequired": false + "description": "

    The branch name. Default: the repository’s default branch (usually master)

    " }, { "type": "object", - "description": "

    The person that committed the file. Default: the authenticated user.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "examples": [ - "\"2013-01-05T13:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "committer", "in": "body", - "isRequired": false, + "description": "

    The person that committed the file. Default: the authenticated user.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "examples": [ - "\"2013-01-05T13:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "" } ] }, { "type": "object", - "description": "

    The author of the file. Default: The committer or the authenticated user if you omit committer.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "examples": [ - "\"2013-01-15T17:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "author", "in": "body", - "isRequired": false, + "description": "

    The author of the file. Default: The committer or the authenticated user if you omit committer.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "examples": [ - "\"2013-01-15T17:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "" } ] } @@ -426017,118 +426227,57 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message.

    ", "name": "message", "in": "body", + "description": "

    The commit message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The blob SHA of the file being replaced.

    ", "name": "sha", "in": "body", + "description": "

    The blob SHA of the file being replaced.

    ", "isRequired": true }, { "type": "string", - "description": "

    The branch name. Default: the repository’s default branch (usually master)

    ", "name": "branch", "in": "body", - "isRequired": false + "description": "

    The branch name. Default: the repository’s default branch (usually master)

    " }, { "type": "object", - "description": "

    object containing information about the committer.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - } - }, "name": "committer", "in": "body", - "isRequired": false, + "description": "

    object containing information about the committer.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " } ] }, { "type": "object", - "description": "

    object containing information about the author.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - } - }, "name": "author", "in": "body", - "isRequired": false, + "description": "

    object containing information about the author.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " } ] } @@ -429282,10 +429431,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    Optional parameter to specify the organization name if forking into an organization.

    ", "name": "organization", "in": "body", - "isRequired": false + "description": "

    Optional parameter to specify the organization name if forking into an organization.

    " } ], "enabledForGitHubApps": true, @@ -440572,7 +440720,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] }, @@ -448263,18 +448412,20 @@ ], "bodyParameters": [ { - "description": "

    Sets the state of the secret scanning alert. Can be either open or resolved. You must provide resolution when you set the state to resolved.

    ", "type": "string", + "name": "state", + "in": "body", + "description": "

    Sets the state of the secret scanning alert. Can be either open or resolved. You must provide resolution when you set the state to resolved.

    ", + "isRequired": true, "enum": [ "open", "resolved" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", + "name": "resolution", + "in": "body", "description": "

    Required when the state is resolved. The reason for resolving the alert.

    ", "enum": [ null, @@ -448282,10 +448433,7 @@ "wont_fix", "revoked", "used_in_tests" - ], - "name": "resolution", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -449150,68 +449298,61 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", + "description": "

    The name of the team.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "array of strings", - "description": "

    List GitHub IDs for organization members who will become team maintainers.

    ", "name": "maintainers", "in": "body", - "isRequired": false + "description": "

    List GitHub IDs for organization members who will become team maintainers.

    " }, { "type": "array of strings", - "description": "

    The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

    ", "name": "repo_names", "in": "body", - "isRequired": false + "description": "

    The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nDefault: secret
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.
    \nDefault for child team: closed

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " }, { "type": "string", - "description": "

    The distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"Update LDAP mapping for a team\" endpoint to change the LDAP DN. For more information, see \"Using LDAP.\"

    ", "name": "ldap_dn", "in": "body", - "isRequired": false + "description": "

    The distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"Update LDAP mapping for a team\" endpoint to change the LDAP DN. For more information, see \"Using LDAP.\"

    " } ], "enabledForGitHubApps": true, @@ -449507,8 +449648,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -450232,8 +450373,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -450668,48 +450809,43 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the team.

    " }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push", "admin" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer or null", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " } ], "enabledForGitHubApps": true, @@ -451005,8 +451141,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -452232,15 +452368,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"

    ", "enum": [ "read", "write", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -457271,11 +457406,10 @@ "bodyParameters": [ { "type": "string", - "description": "

    The permission to grant the team on this repository. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", - "default": "push", "name": "permission", "in": "body", - "isRequired": false + "description": "

    The permission to grant the team on this repository. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", + "default": "push" } ], "enabledForGitHubApps": true, @@ -457996,8 +458130,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -458423,48 +458557,44 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", + "description": "

    The name of the team.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push", "admin" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer or null", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " } ], "enabledForGitHubApps": true, @@ -458759,8 +458889,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -459441,8 +459571,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -460657,15 +460787,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"

    ", "enum": [ "read", "write", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -465673,15 +465802,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant the team on this repository. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", "enum": [ "pull", "push", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -466408,8 +466536,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -467326,9 +467454,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -468205,9 +468333,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -469159,9 +469287,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -470018,9 +470146,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -471016,25 +471144,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", + "description": "

    The discussion post's title.

    ", "isRequired": true }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion post's body text.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    " } ], "enabledForGitHubApps": true, @@ -471979,17 +472105,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The discussion post's title.

    " }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The discussion post's body text.

    " } ], "enabledForGitHubApps": true, @@ -472998,25 +473122,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", + "description": "

    The discussion post's title.

    ", "isRequired": true }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion post's body text.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    " } ], "enabledForGitHubApps": true, @@ -473941,17 +474063,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The discussion post's title.

    " }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The discussion post's body text.

    " } ], "enabledForGitHubApps": true, @@ -474870,15 +474990,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role that this user should have in the team.

    ", "enum": [ "member", "maintainer" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -475617,15 +475736,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role that this user should have in the team.

    ", "enum": [ "member", "maintainer" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -477082,78 +477200,52 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The new name of the user.

    ", "type": "string", - "examples": [ - "Omar Jahandar" - ], "name": "name", "in": "body", - "isRequired": false + "description": "

    The new name of the user.

    " }, { - "description": "

    The publicly visible email address of the user.

    ", "type": "string", - "examples": [ - "omar@example.com" - ], "name": "email", "in": "body", - "isRequired": false + "description": "

    The publicly visible email address of the user.

    " }, { - "description": "

    The new blog URL of the user.

    ", "type": "string", - "examples": [ - "blog.example.com" - ], "name": "blog", "in": "body", - "isRequired": false + "description": "

    The new blog URL of the user.

    " }, { - "description": "

    The new Twitter username of the user.

    ", "type": "string or null", - "examples": [ - "therealomarj" - ], "name": "twitter_username", "in": "body", - "isRequired": false + "description": "

    The new Twitter username of the user.

    " }, { - "description": "

    The new company of the user.

    ", "type": "string", - "examples": [ - "Acme corporation" - ], "name": "company", "in": "body", - "isRequired": false + "description": "

    The new company of the user.

    " }, { - "description": "

    The new location of the user.

    ", "type": "string", - "examples": [ - "Berlin, Germany" - ], "name": "location", "in": "body", - "isRequired": false + "description": "

    The new location of the user.

    " }, { - "description": "

    The new hiring availability of the user.

    ", "type": "boolean", "name": "hireable", "in": "body", - "isRequired": false + "description": "

    The new hiring availability of the user.

    " }, { - "description": "

    The new short biography of the user.

    ", "type": "string", "name": "bio", "in": "body", - "isRequired": false + "description": "

    The new short biography of the user.

    " } ], "enabledForGitHubApps": false, @@ -479378,11 +479470,10 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", "type": "array of strings", - "examples": [], "name": "emails", "in": "body", + "description": "

    Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", "isRequired": true } ], @@ -479512,10 +479603,10 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Email addresses associated with the GitHub user account.

    ", "type": "array of strings", "name": "emails", "in": "body", + "description": "

    Email addresses associated with the GitHub user account.

    ", "isRequired": true } ], @@ -481228,10 +481319,10 @@ "parameters": [], "bodyParameters": [ { - "description": "

    A GPG key in ASCII-armored format.

    ", "type": "string", "name": "armored_public_key", "in": "body", + "description": "

    A GPG key in ASCII-armored format.

    ", "isRequired": true } ], @@ -482247,21 +482338,16 @@ "parameters": [], "bodyParameters": [ { - "description": "

    A descriptive name for the new key.

    ", "type": "string", - "examples": [ - "Personal MacBook Air" - ], "name": "title", "in": "body", - "isRequired": false + "description": "

    A descriptive name for the new key.

    " }, { - "description": "

    The public SSH key to add to your GitHub account.

    ", "type": "string", - "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ", "name": "key", "in": "body", + "description": "

    The public SSH key to add to your GitHub account.

    ", "isRequired": true } ], @@ -482775,53 +482861,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": true, @@ -483856,188 +483916,63 @@ "bodyParameters": [ { "type": "string", - "description": "

    Use web to create a webhook. Default: web. This parameter only accepts the value web.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    Use web to create a webhook. Default: web. This parameter only accepts the value web.

    " }, { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "childParamsGroups": [] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ], - "name": "token", - "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ], - "name": "digest", - "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] - } - }, "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body" - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body" - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body" - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " - }, - { - "type": "string", - "examples": [ - "\"abc\"" - ], - "name": "token", - "in": "body", - "description": "" - }, - { - "type": "string", - "examples": [ - "\"sha256\"" - ], - "name": "digest", - "in": "body", - "description": "" - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    " + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "token", + "description": "" + }, + { + "type": "string", + "name": "digest", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, @@ -484663,210 +484598,70 @@ "bodyParameters": [ { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - }, - "address": { - "type": "string", - "examples": [ - "\"bar@example.com\"" - ], - "name": "address", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "room": { - "type": "string", - "examples": [ - "\"The Serious Room\"" - ], - "name": "room", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"bar@example.com\"" - ], - "name": "address", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"The Serious Room\"" - ], - "name": "room", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "address", + "description": "" + }, + { + "type": "string", + "name": "room", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for. This replaces the entire array of events.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "array of strings", - "description": "

    Determines a list of events to be added to the list of events that the Hook triggers for.

    ", "name": "add_events", "in": "body", - "isRequired": false + "description": "

    Determines a list of events to be added to the list of events that the Hook triggers for.

    " }, { "type": "array of strings", - "description": "

    Determines a list of events to be removed from the list of events that the Hook triggers for.

    ", "name": "remove_events", "in": "body", - "isRequired": false + "description": "

    Determines a list of events to be removed from the list of events that the Hook triggers for.

    " }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, diff --git a/lib/rest/static/decorated/ghes-3.5.json b/lib/rest/static/decorated/ghes-3.5.json index a1669aa8d2..4b52df908b 100644 --- a/lib/rest/static/decorated/ghes-3.5.json +++ b/lib/rest/static/decorated/ghes-3.5.json @@ -989,24 +989,16 @@ ], "bodyParameters": [ { - "description": "

    For repositories in an enterprise, the default size limit for the sum of all caches in a repository, in gigabytes.

    ", "type": "integer", - "examples": [ - 10 - ], "name": "repo_cache_size_limit_in_gb", "in": "body", - "isRequired": false + "description": "

    For repositories in an enterprise, the default size limit for the sum of all caches in a repository, in gigabytes.

    " }, { - "description": "

    For repositories in an enterprise, the maximum value that can be set as the limit for the sum of all caches in a repository, in gigabytes.

    ", "type": "integer", - "examples": [ - 15 - ], "name": "max_repo_cache_size_limit_in_gb", "in": "body", - "isRequired": false + "description": "

    For repositories in an enterprise, the maximum value that can be set as the limit for the sum of all caches in a repository, in gigabytes.

    " } ], "enabledForGitHubApps": true, @@ -1433,13 +1425,10 @@ ], "bodyParameters": [ { - "description": "

    The size limit for the sum of all caches, in gigabytes.

    ", "type": "integer", - "examples": [ - 14 - ], "name": "repo_cache_size_limit_in_gb", "in": "body", + "description": "

    The size limit for the sum of all caches, in gigabytes.

    ", "isRequired": true } ], @@ -1582,27 +1571,26 @@ "bodyParameters": [ { "type": "string", + "name": "enabled_organizations", + "in": "body", "description": "

    The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.

    ", + "isRequired": true, "enum": [ "all", "none", "selected" - ], - "name": "enabled_organizations", - "in": "body", - "isRequired": true + ] }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": false, @@ -1853,10 +1841,10 @@ ], "bodyParameters": [ { - "description": "

    List of organization IDs to enable for GitHub Actions.

    ", "type": "array of integers", "name": "selected_organization_ids", "in": "body", + "description": "

    List of organization IDs to enable for GitHub Actions.

    ", "isRequired": true } ], @@ -2098,16 +2086,16 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", + "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "isRequired": true } ], @@ -2252,27 +2240,26 @@ "bodyParameters": [ { "type": "string", + "name": "enabled_repositories", + "in": "body", "description": "

    The policy that controls the repositories in the organization that are allowed to run GitHub Actions.

    ", + "isRequired": true, "enum": [ "all", "none", "selected" - ], - "name": "enabled_repositories", - "in": "body", - "isRequired": true + ] }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -3907,10 +3894,10 @@ ], "bodyParameters": [ { - "description": "

    List of repository IDs to enable for GitHub Actions.

    ", "type": "array of integers", "name": "selected_repository_ids", "in": "body", + "description": "

    List of repository IDs to enable for GitHub Actions.

    ", "isRequired": true } ], @@ -4152,16 +4139,16 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", + "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "isRequired": true } ], @@ -4292,21 +4279,19 @@ "bodyParameters": [ { "type": "string", + "name": "default_workflow_permissions", + "in": "body", "description": "

    The default workflow permissions granted to the GITHUB_TOKEN when running workflows.

    ", "enum": [ "read", "write" - ], - "name": "default_workflow_permissions", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

    ", "name": "can_approve_pull_request_reviews", "in": "body", - "isRequired": false + "description": "

    Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

    " } ], "enabledForGitHubApps": true, @@ -4460,22 +4445,21 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub Actions is enabled on the repository.

    ", "name": "enabled", "in": "body", + "description": "

    Whether GitHub Actions is enabled on the repository.

    ", "isRequired": true }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -4616,15 +4600,15 @@ "bodyParameters": [ { "type": "string", + "name": "access_level", + "in": "body", "description": "

    Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository. none means access is only possible from workflows in this repository.

    ", + "isRequired": true, "enum": [ "none", "organization", "enterprise" - ], - "name": "access_level", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -4772,16 +4756,16 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", + "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "isRequired": true } ], @@ -5206,37 +5190,33 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret.

    ", + "isRequired": true, "enum": [ "all", "private", "selected" - ], - "name": "visibility", - "in": "body", - "isRequired": true + ] }, { "type": "array of integers", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", - "isRequired": false + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    " } ], "enabledForGitHubApps": true, @@ -7679,9 +7659,9 @@ "bodyParameters": [ { "type": "array of integers", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "isRequired": true } ], @@ -8233,18 +8213,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " } ], "enabledForGitHubApps": true, @@ -8756,17 +8733,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

    ", "isRequired": true }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", + "description": "

    ID of the key you used to encrypt the secret.

    ", "isRequired": true } ], @@ -9101,59 +9077,51 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all organizations or select individual organization.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all organizations or select individual organization.

    ", "enum": [ "selected", "all" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { - "description": "

    List of organization IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_organization_ids", "in": "body", - "isRequired": false + "description": "

    List of organization IDs that can access the runner group.

    " }, { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", - "isRequired": false + "description": "

    List of runner IDs to add to the runner group.

    " }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " }, { - "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    ", "type": "boolean", - "default": false, "name": "restricted_to_workflows", "in": "body", - "isRequired": false + "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    " }, { - "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    ", "type": "array of strings", "name": "selected_workflows", "in": "body", - "isRequired": false + "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    " } ], "enabledForGitHubApps": false, @@ -9419,46 +9387,39 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", - "isRequired": false + "description": "

    Name of the runner group.

    " }, { - "description": "

    Visibility of a runner group. You can select all organizations or select individual organizations.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all organizations or select individual organizations.

    ", "enum": [ "selected", "all" ], - "default": "all", - "name": "visibility", - "in": "body", - "isRequired": false + "default": "all" }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " }, { - "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    ", "type": "boolean", - "default": false, "name": "restricted_to_workflows", "in": "body", - "isRequired": false + "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    " }, { - "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    ", "type": "array of strings", "name": "selected_workflows", "in": "body", - "isRequired": false + "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    " } ], "enabledForGitHubApps": false, @@ -9854,10 +9815,10 @@ ], "bodyParameters": [ { - "description": "

    List of organization IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_organization_ids", "in": "body", + "description": "

    List of organization IDs that can access the runner group.

    ", "isRequired": true } ], @@ -10276,10 +10237,10 @@ ], "bodyParameters": [ { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", + "description": "

    List of runner IDs to add to the runner group.

    ", "isRequired": true } ], @@ -10655,61 +10616,53 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

    ", "enum": [ "selected", "all", "private" ], - "default": "all", - "name": "visibility", - "in": "body", - "isRequired": false + "default": "all" }, { - "description": "

    List of repository IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_repository_ids", "in": "body", - "isRequired": false + "description": "

    List of repository IDs that can access the runner group.

    " }, { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", - "isRequired": false + "description": "

    List of runner IDs to add to the runner group.

    " }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " }, { - "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    ", "type": "boolean", - "default": false, "name": "restricted_to_workflows", "in": "body", - "isRequired": false + "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    " }, { - "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    ", "type": "array of strings", "name": "selected_workflows", "in": "body", - "isRequired": false + "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    " } ], "enabledForGitHubApps": true, @@ -10993,46 +10946,40 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

    ", "enum": [ "selected", "all", "private" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " }, { - "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    ", "type": "boolean", - "default": false, "name": "restricted_to_workflows", "in": "body", - "isRequired": false + "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    " }, { - "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    ", "type": "array of strings", "name": "selected_workflows", "in": "body", - "isRequired": false + "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    " } ], "enabledForGitHubApps": true, @@ -13682,10 +13629,10 @@ ], "bodyParameters": [ { - "description": "

    List of repository IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_repository_ids", "in": "body", + "description": "

    List of repository IDs that can access the runner group.

    ", "isRequired": true } ], @@ -14104,10 +14051,10 @@ ], "bodyParameters": [ { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", + "description": "

    List of runner IDs to add to the runner group.

    ", "isRequired": true } ], @@ -17939,11 +17886,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "maxItems": 100, - "description": "

    The names of the custom labels to add to the runner.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to add to the runner.

    ", "isRequired": true } ], @@ -18086,11 +18031,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 0, - "maxItems": 100, - "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "isRequired": true } ], @@ -22134,11 +22077,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "maxItems": 100, - "description": "

    The names of the custom labels to add to the runner.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to add to the runner.

    ", "isRequired": true } ], @@ -22281,11 +22222,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 0, - "maxItems": 100, - "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "isRequired": true } ], @@ -26404,11 +26343,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "maxItems": 100, - "description": "

    The names of the custom labels to add to the runner.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to add to the runner.

    ", "isRequired": true } ], @@ -26561,11 +26498,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 0, - "maxItems": 100, - "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "isRequired": true } ], @@ -45680,37 +45615,27 @@ "bodyParameters": [ { "type": "array of integers", - "description": "

    The list of environment ids to approve or reject

    ", - "examples": [ - 161171787, - 161171795 - ], "name": "environment_ids", "in": "body", + "description": "

    The list of environment ids to approve or reject

    ", "isRequired": true }, { "type": "string", + "name": "state", + "in": "body", "description": "

    Whether to approve or reject deployment to the specified environments.

    ", + "isRequired": true, "enum": [ "approved", "rejected" - ], - "examples": [ - "approved" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    A comment to accompany the deployment review

    ", - "examples": [ - "Ship it!" - ], "name": "comment", "in": "body", + "description": "

    A comment to accompany the deployment review

    ", "isRequired": true } ], @@ -52453,21 +52378,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The git reference for the workflow. The reference can be a branch or tag name.

    ", "name": "ref", "in": "body", + "description": "

    The git reference for the workflow. The reference can be a branch or tag name.

    ", "isRequired": true }, { "type": "object", - "description": "

    Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.

    ", - "additionalProperties": { - "type": "string" - }, - "maxProperties": 10, "name": "inputs", "in": "body", - "isRequired": false + "description": "

    Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.

    " } ], "enabledForGitHubApps": true, @@ -90725,19 +90645,16 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    ", "type": "string", - "format": "date-time", "name": "last_read_at", "in": "body", - "isRequired": false + "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    " }, { - "description": "

    Whether the notification has been read.

    ", "type": "boolean", "name": "read", "in": "body", - "isRequired": false + "description": "

    Whether the notification has been read.

    " } ], "enabledForGitHubApps": false, @@ -93322,12 +93239,10 @@ ], "bodyParameters": [ { - "description": "

    Whether to block all notifications from a thread.

    ", - "default": false, "type": "boolean", "name": "ignored", "in": "body", - "isRequired": false + "description": "

    Whether to block all notifications from a thread.

    " } ], "enabledForGitHubApps": false, @@ -95916,11 +95831,9 @@ "bodyParameters": [ { "type": "string", - "format": "date-time", - "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    ", "name": "last_read_at", "in": "body", - "isRequired": false + "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    " } ], "enabledForGitHubApps": false, @@ -103568,17 +103481,15 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Determines if notifications should be received from this repository.

    ", "name": "subscribed", "in": "body", - "isRequired": false + "description": "

    Determines if notifications should be received from this repository.

    " }, { "type": "boolean", - "description": "

    Determines if all notifications should be blocked from this repository.

    ", "name": "ignored", "in": "body", - "isRequired": false + "description": "

    Determines if all notifications should be blocked from this repository.

    " } ], "enabledForGitHubApps": false, @@ -109629,14 +109540,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -110558,14 +110461,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -111127,756 +111022,291 @@ ], "bodyParameters": [ { - "description": "

    List of repository names that the token should have access to

    ", "type": "array of strings", "name": "repositories", "in": "body", - "isRequired": false + "description": "

    List of repository names that the token should have access to

    " }, { - "description": "

    List of repository IDs that the token should have access to

    ", "type": "array of integers", - "examples": [ - 1 - ], "name": "repository_ids", "in": "body", - "isRequired": false + "description": "

    List of repository IDs that the token should have access to

    " }, { - "title": "App Permissions", "type": "object", + "name": "permissions", + "in": "body", "description": "

    The permissions granted to the user-to-server access token.

    ", - "properties": { - "actions": { + "childParamsGroups": [ + { "type": "string", + "name": "actions", "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", "enum": [ "read", "write" - ], - "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + ] }, - "administration": { + { "type": "string", + "name": "administration", "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", "enum": [ "read", "write" - ], - "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + ] }, - "checks": { + { "type": "string", + "name": "checks", "description": "

    The level of permission to grant the access token for checks on code.

    ", "enum": [ "read", "write" - ], - "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + ] }, - "contents": { + { "type": "string", + "name": "contents", "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", "enum": [ "read", "write" - ], - "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + ] }, - "organization_custom_roles": { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for custom roles management.", - "childParamsGroups": [] - }, - "deployments": { + { "type": "string", + "name": "deployments", "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", "enum": [ "read", "write" - ], - "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + ] }, - "environments": { + { "type": "string", + "name": "environments", "description": "

    The level of permission to grant the access token for managing repository environments.

    ", "enum": [ "read", "write" - ], - "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + ] }, - "issues": { + { "type": "string", + "name": "issues", "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", "enum": [ "read", "write" - ], - "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + ] }, - "metadata": { + { "type": "string", + "name": "metadata", "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", "enum": [ "read", "write" - ], - "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + ] }, - "packages": { + { "type": "string", + "name": "packages", "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "pages": { + { "type": "string", + "name": "pages", "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", "enum": [ "read", "write" - ], - "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + ] }, - "pull_requests": { + { "type": "string", + "name": "pull_requests", "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", "enum": [ "read", "write" - ], - "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + ] }, - "repository_hooks": { + { "type": "string", + "name": "repository_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", "enum": [ "read", "write" - ], - "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + ] }, - "repository_projects": { + { "type": "string", + "name": "repository_projects", "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", "enum": [ "read", "write", "admin" - ], - "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + ] }, - "secret_scanning_alerts": { + { "type": "string", + "name": "secret_scanning_alerts", "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + ] }, - "secrets": { + { "type": "string", + "name": "secrets", "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", "enum": [ "read", "write" - ], - "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + ] }, - "security_events": { + { "type": "string", + "name": "security_events", "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + ] }, - "single_file": { + { "type": "string", + "name": "single_file", "description": "

    The level of permission to grant the access token to manage just a single file.

    ", "enum": [ "read", "write" - ], - "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + ] }, - "statuses": { + { "type": "string", + "name": "statuses", "description": "

    The level of permission to grant the access token for commit statuses.

    ", "enum": [ "read", "write" - ], - "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + ] }, - "vulnerability_alerts": { + { "type": "string", + "name": "vulnerability_alerts", "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", "enum": [ "read", "write" - ], - "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + ] }, - "workflows": { + { "type": "string", + "name": "workflows", "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", "enum": [ "write" - ], - "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + ] }, - "members": { + { "type": "string", + "name": "members", "description": "

    The level of permission to grant the access token for organization teams and members.

    ", "enum": [ "read", "write" - ], - "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + ] }, - "organization_administration": { + { "type": "string", + "name": "organization_administration", "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + ] }, - "organization_hooks": { + { "type": "string", + "name": "organization_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + ] }, - "organization_plan": { + { "type": "string", + "name": "organization_plan", "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", "enum": [ "read" - ], - "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + ] }, - "organization_projects": { + { "type": "string", + "name": "organization_projects", "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", "enum": [ "read", "write", "admin" - ], - "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + ] }, - "organization_packages": { + { "type": "string", + "name": "organization_packages", "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "organization_secrets": { + { "type": "string", + "name": "organization_secrets", "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", "enum": [ "read", "write" - ], - "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + ] }, - "organization_self_hosted_runners": { + { "type": "string", + "name": "organization_self_hosted_runners", "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + ] }, - "organization_user_blocking": { + { "type": "string", + "name": "organization_user_blocking", "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + ] }, - "team_discussions": { + { "type": "string", + "name": "team_discussions", "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", "enum": [ "read", "write" - ], - "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - }, - "name": "permissions", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "permissions", - "parentType": "object", - "id": "permissions-object", - "params": [ - { - "type": "string", - "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", - "enum": [ - "read", - "write" - ], - "name": "actions", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", - "enum": [ - "read", - "write" - ], - "name": "administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for checks on code.

    ", - "enum": [ - "read", - "write" - ], - "name": "checks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "contents", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "deployments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for managing repository environments.

    ", - "enum": [ - "read", - "write" - ], - "name": "environments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", - "enum": [ - "read", - "write" - ], - "name": "issues", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", - "enum": [ - "read", - "write" - ], - "name": "metadata", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", - "enum": [ - "read", - "write" - ], - "name": "pages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "pull_requests", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", - "enum": [ - "read", - "write" - ], - "name": "repository_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "repository_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "secret_scanning_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "security_events", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage just a single file.

    ", - "enum": [ - "read", - "write" - ], - "name": "single_file", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for commit statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "statuses", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "vulnerability_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", - "enum": [ - "write" - ], - "name": "workflows", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization teams and members.

    ", - "enum": [ - "read", - "write" - ], - "name": "members", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", - "enum": [ - "read" - ], - "name": "organization_plan", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "organization_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_self_hosted_runners", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_user_blocking", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", - "enum": [ - "read", - "write" - ], - "name": "team_discussions", - "in": "body" - } ] } ] @@ -112087,14 +111517,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -114716,14 +114138,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -115649,14 +115063,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -116580,14 +115986,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -119193,14 +118591,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -121467,9 +120857,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", + "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "isRequired": true } ], @@ -121532,10 +120922,10 @@ ], "bodyParameters": [ { - "description": "

    The access_token of the OAuth application.

    ", "type": "string", "name": "access_token", "in": "body", + "description": "

    The access_token of the OAuth application.

    ", "isRequired": true } ], @@ -121898,14 +121288,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -122403,10 +121785,10 @@ ], "bodyParameters": [ { - "description": "

    The access_token of the OAuth application.

    ", "type": "string", "name": "access_token", "in": "body", + "description": "

    The access_token of the OAuth application.

    ", "isRequired": true } ], @@ -122769,14 +122151,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -123271,9 +122645,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", + "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "isRequired": true } ], @@ -123337,785 +122711,309 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", - "examples": [ - "e72e16c7e42f292c6912e7710c838347ae178b4a" - ], "name": "access_token", "in": "body", + "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "isRequired": true }, { - "description": "

    The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

    ", "type": "string", - "examples": [ - "octocat" - ], "name": "target", "in": "body", - "isRequired": false + "description": "

    The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

    " }, { - "description": "

    The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

    ", "type": "integer", - "examples": [ - 1 - ], "name": "target_id", "in": "body", - "isRequired": false + "description": "

    The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

    " }, { - "description": "

    The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

    ", "type": "array of strings", "name": "repositories", "in": "body", - "isRequired": false + "description": "

    The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

    " }, { - "description": "

    The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

    ", "type": "array of integers", - "examples": [ - 1 - ], "name": "repository_ids", "in": "body", - "isRequired": false + "description": "

    The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

    " }, { - "title": "App Permissions", "type": "object", + "name": "permissions", + "in": "body", "description": "

    The permissions granted to the user-to-server access token.

    ", - "properties": { - "actions": { + "childParamsGroups": [ + { "type": "string", + "name": "actions", "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", "enum": [ "read", "write" - ], - "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + ] }, - "administration": { + { "type": "string", + "name": "administration", "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", "enum": [ "read", "write" - ], - "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + ] }, - "checks": { + { "type": "string", + "name": "checks", "description": "

    The level of permission to grant the access token for checks on code.

    ", "enum": [ "read", "write" - ], - "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + ] }, - "contents": { + { "type": "string", + "name": "contents", "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", "enum": [ "read", "write" - ], - "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + ] }, - "organization_custom_roles": { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for custom roles management.", - "childParamsGroups": [] - }, - "deployments": { + { "type": "string", + "name": "deployments", "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", "enum": [ "read", "write" - ], - "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + ] }, - "environments": { + { "type": "string", + "name": "environments", "description": "

    The level of permission to grant the access token for managing repository environments.

    ", "enum": [ "read", "write" - ], - "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + ] }, - "issues": { + { "type": "string", + "name": "issues", "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", "enum": [ "read", "write" - ], - "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + ] }, - "metadata": { + { "type": "string", + "name": "metadata", "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", "enum": [ "read", "write" - ], - "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + ] }, - "packages": { + { "type": "string", + "name": "packages", "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "pages": { + { "type": "string", + "name": "pages", "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", "enum": [ "read", "write" - ], - "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + ] }, - "pull_requests": { + { "type": "string", + "name": "pull_requests", "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", "enum": [ "read", "write" - ], - "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + ] }, - "repository_hooks": { + { "type": "string", + "name": "repository_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", "enum": [ "read", "write" - ], - "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + ] }, - "repository_projects": { + { "type": "string", + "name": "repository_projects", "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", "enum": [ "read", "write", "admin" - ], - "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + ] }, - "secret_scanning_alerts": { + { "type": "string", + "name": "secret_scanning_alerts", "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + ] }, - "secrets": { + { "type": "string", + "name": "secrets", "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", "enum": [ "read", "write" - ], - "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + ] }, - "security_events": { + { "type": "string", + "name": "security_events", "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + ] }, - "single_file": { + { "type": "string", + "name": "single_file", "description": "

    The level of permission to grant the access token to manage just a single file.

    ", "enum": [ "read", "write" - ], - "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + ] }, - "statuses": { + { "type": "string", + "name": "statuses", "description": "

    The level of permission to grant the access token for commit statuses.

    ", "enum": [ "read", "write" - ], - "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + ] }, - "vulnerability_alerts": { + { "type": "string", + "name": "vulnerability_alerts", "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", "enum": [ "read", "write" - ], - "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + ] }, - "workflows": { + { "type": "string", + "name": "workflows", "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", "enum": [ "write" - ], - "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + ] }, - "members": { + { "type": "string", + "name": "members", "description": "

    The level of permission to grant the access token for organization teams and members.

    ", "enum": [ "read", "write" - ], - "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + ] }, - "organization_administration": { + { "type": "string", + "name": "organization_administration", "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + ] }, - "organization_hooks": { + { "type": "string", + "name": "organization_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + ] }, - "organization_plan": { + { "type": "string", + "name": "organization_plan", "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", "enum": [ "read" - ], - "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + ] }, - "organization_projects": { + { "type": "string", + "name": "organization_projects", "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", "enum": [ "read", "write", "admin" - ], - "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + ] }, - "organization_packages": { + { "type": "string", + "name": "organization_packages", "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "organization_secrets": { + { "type": "string", + "name": "organization_secrets", "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", "enum": [ "read", "write" - ], - "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + ] }, - "organization_self_hosted_runners": { + { "type": "string", + "name": "organization_self_hosted_runners", "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + ] }, - "organization_user_blocking": { + { "type": "string", + "name": "organization_user_blocking", "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + ] }, - "team_discussions": { + { "type": "string", + "name": "team_discussions", "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", "enum": [ "read", "write" - ], - "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - }, - "name": "permissions", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "permissions", - "parentType": "object", - "id": "permissions-object", - "params": [ - { - "type": "string", - "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", - "enum": [ - "read", - "write" - ], - "name": "actions", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", - "enum": [ - "read", - "write" - ], - "name": "administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for checks on code.

    ", - "enum": [ - "read", - "write" - ], - "name": "checks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "contents", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "deployments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for managing repository environments.

    ", - "enum": [ - "read", - "write" - ], - "name": "environments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", - "enum": [ - "read", - "write" - ], - "name": "issues", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", - "enum": [ - "read", - "write" - ], - "name": "metadata", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", - "enum": [ - "read", - "write" - ], - "name": "pages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "pull_requests", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", - "enum": [ - "read", - "write" - ], - "name": "repository_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "repository_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "secret_scanning_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "security_events", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage just a single file.

    ", - "enum": [ - "read", - "write" - ], - "name": "single_file", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for commit statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "statuses", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "vulnerability_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", - "enum": [ - "write" - ], - "name": "workflows", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization teams and members.

    ", - "enum": [ - "read", - "write" - ], - "name": "members", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", - "enum": [ - "read" - ], - "name": "organization_plan", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "organization_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_self_hosted_runners", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_user_blocking", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", - "enum": [ - "read", - "write" - ], - "name": "team_discussions", - "in": "body" - } ] } ] @@ -124515,14 +123413,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -125098,53 +123988,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": false, @@ -128047,7 +126911,2775 @@ }, "response": { "statusCode": "200", - "description": "

    Response

    " + "contentType": "application/json", + "description": "

    Response

    ", + "example": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [], + "checks": [] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + }, + "schema": { + "title": "Branch With Protection", + "description": "Branch With Protection", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "commit": { + "title": "Commit", + "description": "Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } + }, + "required": [ + "sha", + "url" + ] + } + }, + "stats": { + "type": "object", + "properties": { + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + }, + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "string" + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "html", + "self" + ] + }, + "protected": { + "type": "boolean" + }, + "protection": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enforcement_level": { + "type": "string" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string" + }, + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts", + "checks" + ] + }, + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" + ] + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } + }, + "bypass_pull_request_allowances": { + "type": "object", + "description": "Allow specific users, teams, or apps to bypass pull request requirements.", + "properties": { + "users": { + "description": "The list of users allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "require_code_owner_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "required_approving_review_count": { + "type": "integer", + "minimum": 0, + "maximum": 6, + "examples": [ + 2 + ] + } + }, + "required": [ + "dismiss_stale_reviews", + "require_code_owner_reviews" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + } + } + }, + "protection_url": { + "type": "string", + "format": "uri" + }, + "pattern": { + "type": "string", + "examples": [ + "\"mas*\"" + ] + }, + "required_approving_review_count": { + "type": "integer", + "examples": [ + 1 + ] + } + }, + "required": [ + "name", + "commit", + "_links", + "protection", + "protected", + "protection_url" + ] + } } } ], @@ -128108,9 +129740,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new name of the branch.

    ", "name": "new_name", "in": "body", + "description": "

    The new name of the branch.

    ", "isRequired": true } ], @@ -130955,9 +132587,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the branch which should be updated to match upstream.

    ", "name": "branch", "in": "body", + "description": "

    The name of the branch which should be updated to match upstream.

    ", "isRequired": true } ], @@ -131057,24 +132689,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the base branch that the head will be merged into.

    ", "name": "base", "in": "body", + "description": "

    The name of the base branch that the head will be merged into.

    ", "isRequired": true }, { "type": "string", - "description": "

    The head to merge. This can be a branch name or a commit SHA1.

    ", "name": "head", "in": "body", + "description": "

    The head to merge. This can be a branch name or a commit SHA1.

    ", "isRequired": true }, { "type": "string", - "description": "

    Commit message to use for the merge commit. If omitted, a default message will be used.

    ", "name": "commit_message", "in": "body", - "isRequired": false + "description": "

    Commit message to use for the merge commit. If omitted, a default message will be used.

    " } ], "enabledForGitHubApps": true, @@ -134146,171 +135777,38 @@ "bodyParameters": [ { "type": "object or null", - "description": "

    Require status checks to pass before merging. Set to null to disable.

    ", - "properties": { - "strict": { - "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", - "name": "strict", - "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": true, - "childParamsGroups": [] - }, - "contexts": { - "type": "array of strings", - "deprecated": true, - "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "isRequired": true, - "childParamsGroups": [] - }, - "checks": { - "type": "array of objects", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", - "items": { - "type": "object", - "required": [ - "context" - ], - "properties": { - "context": { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] - }, - "app_id": { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] - } - } - }, - "name": "checks", - "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ - { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "strict", - "contexts" - ], "name": "required_status_checks", "in": "body", + "description": "

    Require status checks to pass before merging. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "required_status_checks", - "parentType": "object", - "id": "required_status_checks-object", - "params": [ - { - "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", - "name": "strict", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "deprecated": true, - "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", - "name": "contexts", - "in": "body", - "isRequired": true - }, - { - "type": "array of objects", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", - "name": "checks", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ - { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "boolean", + "name": "strict", + "description": "

    Require branches to be up to date before merging.

    ", + "isRequired": true }, { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ + "type": "array of strings", + "name": "contexts", + "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", + "isRequired": true + }, + { + "type": "array of objects", + "name": "checks", + "description": "

    The list of status checks to require in order to merge into this branch.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The name of the required check

    ", "name": "context", - "in": "body", + "description": "

    The name of the required check

    ", "isRequired": true }, { "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", "name": "app_id", - "in": "body", - "isRequired": false + "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    " } ] } @@ -134318,407 +135816,74 @@ }, { "type": "boolean or null", - "description": "

    Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "name": "enforce_admins", "in": "body", + "description": "

    Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "isRequired": true }, { "type": "object or null", - "description": "

    Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", - "properties": { - "dismissal_restrictions": { - "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, - "name": "dismissal_restrictions", - "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", - "childParamsGroups": [ - { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] - } - ] - }, - "dismiss_stale_reviews": { - "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", - "name": "dismiss_stale_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "childParamsGroups": [] - }, - "require_code_owner_reviews": { - "type": "boolean", - "description": "

    Blocks merging pull requests until code owners review them.

    ", - "name": "require_code_owner_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", - "childParamsGroups": [] - }, - "required_approving_review_count": { - "type": "integer", - "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    ", - "name": "required_approving_review_count", - "in": "body", - "rawType": "integer", - "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", - "childParamsGroups": [] - }, - "bypass_pull_request_allowances": { - "type": "object", - "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - } - }, - "name": "bypass_pull_request_allowances", - "in": "body", - "rawType": "object", - "rawDescription": "Allow specific users, teams, or apps to bypass pull request requirements.", - "childParamsGroups": [ - { - "parentName": "bypass_pull_request_allowances", - "parentType": "object", - "id": "bypass_pull_request_allowances-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "name": "apps", - "in": "body" - } - ] - } - ] - } - }, "name": "required_pull_request_reviews", "in": "body", + "description": "

    Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "required_pull_request_reviews", - "parentType": "object", - "id": "required_pull_request_reviews-object", - "params": [ + "type": "object", + "name": "dismissal_restrictions", + "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", + "childParamsGroups": [ { - "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, - "name": "dismissal_restrictions", - "in": "body", - "childParamsGroups": [ - { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with dismissal access

    " }, { - "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", - "name": "dismiss_stale_reviews", - "in": "body" + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with dismissal access

    " }, { - "type": "boolean", - "description": "

    Blocks merging pull requests until code owners review them.

    ", - "name": "require_code_owner_reviews", - "in": "body" - }, - { - "type": "integer", - "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    ", - "name": "required_approving_review_count", - "in": "body" - }, - { - "type": "object", - "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - } - }, - "name": "bypass_pull_request_allowances", - "in": "body", - "childParamsGroups": [ - { - "parentName": "bypass_pull_request_allowances", - "parentType": "object", - "id": "bypass_pull_request_allowances-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "name": "apps", - "in": "body" - } - ] - } - ] + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with dismissal access

    " } ] }, { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] + "type": "boolean", + "name": "dismiss_stale_reviews", + "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    " }, { - "parentName": "bypass_pull_request_allowances", - "parentType": "object", - "id": "bypass_pull_request_allowances-object", - "params": [ + "type": "boolean", + "name": "require_code_owner_reviews", + "description": "

    Blocks merging pull requests until code owners review them.

    " + }, + { + "type": "integer", + "name": "required_approving_review_count", + "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    " + }, + { + "type": "object", + "name": "bypass_pull_request_allowances", + "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", + "childParamsGroups": [ { "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", "name": "users", - "in": "body" + "description": "

    The list of user logins allowed to bypass pull request requirements.

    " }, { "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", "name": "teams", - "in": "body" + "description": "

    The list of team slugs allowed to bypass pull request requirements.

    " }, { "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", "name": "apps", - "in": "body" + "description": "

    The list of app slugs allowed to bypass pull request requirements.

    " } ] } @@ -134726,120 +135891,59 @@ }, { "type": "object or null", - "description": "

    Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with push access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with push access", - "isRequired": true, - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with push access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with push access", - "isRequired": true, - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with push access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with push access", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "users", - "teams" - ], "name": "restrictions", "in": "body", + "description": "

    Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "restrictions", - "parentType": "object", - "id": "restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with push access

    ", - "name": "users", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with push access

    ", - "name": "teams", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with push access

    ", - "name": "apps", - "in": "body", - "isRequired": false - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with push access

    ", + "isRequired": true + }, + { + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with push access

    ", + "isRequired": true + }, + { + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with push access

    " } ] }, { "type": "boolean", - "description": "

    Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

    ", "name": "required_linear_history", "in": "body", - "isRequired": false + "description": "

    Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

    " }, { "type": "boolean or null", - "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "name": "allow_force_pushes", "in": "body", - "isRequired": false + "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    " }, { "type": "boolean", - "description": "

    Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

    ", "name": "allow_deletions", "in": "body", - "isRequired": false + "description": "

    Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

    ", "name": "block_creations", "in": "body", - "isRequired": false + "description": "

    If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

    " }, { "type": "boolean", - "description": "

    Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

    ", "name": "required_conversation_resolution", "in": "body", - "isRequired": false + "description": "

    Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

    " } ], "enabledForGitHubApps": true, @@ -134904,7 +136008,2001 @@ }, "response": { "statusCode": "200", - "description": "

    Response

    " + "contentType": "application/json", + "description": "

    Response

    ", + "example": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [], + "teams": [], + "apps": [] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [], + "teams": [], + "apps": [] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + }, + "schema": { + "title": "Protected Branch", + "description": "Branch protections protect branches", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "required_status_checks": { + "title": "Status Check Policy", + "description": "Status Check Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] + }, + "strict": { + "type": "boolean", + "examples": [ + true + ] + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + ] + } + }, + "required": [ + "url", + "contexts_url", + "strict", + "contexts", + "checks" + ] + }, + "required_pull_request_reviews": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "dismiss_stale_reviews": { + "type": "boolean" + }, + "require_code_owner_reviews": { + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "users", + "teams" + ] + }, + "bypass_pull_request_allowances": { + "type": "object", + "properties": { + "users": { + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + }, + "required": [ + "users", + "teams" + ] + } + }, + "required": [ + "url" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "enforce_admins": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "url", + "enabled" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + } + }, + "required": [ + "url" + ] + } } } ], @@ -136915,166 +140013,65 @@ "bodyParameters": [ { "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, "name": "dismissal_restrictions", "in": "body", - "isRequired": false, + "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", "childParamsGroups": [ { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with dismissal access

    " + }, + { + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with dismissal access

    " + }, + { + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with dismissal access

    " } ] }, { "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", "name": "dismiss_stale_reviews", "in": "body", - "isRequired": false + "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    " }, { "type": "boolean", - "description": "

    Blocks merging pull requests until code owners have reviewed.

    ", "name": "require_code_owner_reviews", "in": "body", - "isRequired": false + "description": "

    Blocks merging pull requests until code owners have reviewed.

    " }, { "type": "integer", - "description": "

    Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    ", "name": "required_approving_review_count", "in": "body", - "isRequired": false + "description": "

    Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    " }, { "type": "object", - "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - } - }, "name": "bypass_pull_request_allowances", "in": "body", - "isRequired": false, + "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", "childParamsGroups": [ { - "parentName": "bypass_pull_request_allowances", - "parentType": "object", - "id": "bypass_pull_request_allowances-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "name": "apps", - "in": "body" - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins allowed to bypass pull request requirements.

    " + }, + { + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs allowed to bypass pull request requirements.

    " + }, + { + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs allowed to bypass pull request requirements.

    " } ] } @@ -139213,46 +142210,32 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", "name": "strict", "in": "body", - "isRequired": false + "description": "

    Require branches to be up to date before merging.

    " }, { "type": "array of strings", - "deprecated": true, - "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", "name": "contexts", "in": "body", - "isRequired": false + "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    " }, { "type": "array of objects", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", "name": "checks", "in": "body", - "isRequired": false, + "description": "

    The list of status checks to require in order to merge into this branch.

    ", "childParamsGroups": [ { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ - { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "context", + "description": "

    The name of the required check

    ", + "isRequired": true + }, + { + "type": "integer", + "name": "app_id", + "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    " } ] } @@ -139562,9 +142545,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -139574,8 +142557,14 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding status checks to a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -139660,9 +142649,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -139672,8 +142661,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example updating status checks for a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -139753,9 +142747,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -139765,8 +142759,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing status checks from a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -140815,9 +143814,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -141266,9 +144265,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -141717,9 +144716,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -142458,9 +145457,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -142470,8 +145469,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -142757,9 +145761,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -142769,8 +145773,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -143056,9 +146065,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -143068,8 +146077,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -143612,9 +146626,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -143624,8 +146638,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -143878,9 +146897,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -143890,8 +146909,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -144144,9 +147168,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -144156,8 +147180,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -144404,55 +147433,52 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the check. For example, \"code-coverage\".

    ", "name": "name", "in": "body", + "description": "

    The name of the check. For example, \"code-coverage\".

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the commit.

    ", "name": "head_sha", "in": "body", + "description": "

    The SHA of the commit.

    ", "isRequired": true }, { "type": "string", - "description": "

    The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

    ", "name": "details_url", "in": "body", - "isRequired": false + "description": "

    The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

    " }, { "type": "string", - "description": "

    A reference for the run on the integrator's system.

    ", "name": "external_id", "in": "body", - "isRequired": false + "description": "

    A reference for the run on the integrator's system.

    " }, { "type": "string", + "name": "status", + "in": "body", "description": "

    The current status.

    ", "enum": [ "queued", "in_progress", "completed" ], - "default": "queued", - "name": "status", - "in": "body", - "isRequired": false + "default": "queued" }, { "type": "string", - "format": "date-time", - "description": "

    The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "string", + "name": "conclusion", + "in": "body", "description": "

    Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.

    ", "enum": [ "action_required", @@ -144463,588 +147489,120 @@ "skipped", "stale", "timed_out" - ], - "name": "conclusion", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "format": "date-time", - "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "completed_at", "in": "body", - "isRequired": false + "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "object", - "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", - "properties": { - "title": { - "type": "string", - "description": "

    The title of the check run.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the check run.", - "isRequired": true, - "childParamsGroups": [] - }, - "summary": { - "type": "string", - "maxLength": 65535, - "description": "

    The summary of the check run. This parameter supports Markdown.

    ", - "name": "summary", - "in": "body", - "rawType": "string", - "rawDescription": "The summary of the check run. This parameter supports Markdown.", - "isRequired": true, - "childParamsGroups": [] - }, - "text": { - "type": "string", - "maxLength": 65535, - "description": "

    The details of the check run. This parameter supports Markdown.

    ", - "name": "text", - "in": "body", - "rawType": "string", - "rawDescription": "The details of the check run. This parameter supports Markdown.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotations": { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", - "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, - "name": "annotations", - "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#annotations-object) description for details about how to use this parameter.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - "images": { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, - "name": "images", - "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#images-object) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "title", - "summary" - ], "name": "output", "in": "body", - "isRequired": false, + "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", "childParamsGroups": [ { - "parentName": "output", - "parentType": "object", - "id": "output-object", - "params": [ - { - "type": "string", - "description": "

    The title of the check run.

    ", - "name": "title", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 65535, - "description": "

    The summary of the check run. This parameter supports Markdown.

    ", - "name": "summary", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 65535, - "description": "

    The details of the check run. This parameter supports Markdown.

    ", - "name": "text", - "in": "body", - "isRequired": false - }, - { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", - "maxItems": 50, - "name": "annotations", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "name": "images", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "string", + "name": "title", + "description": "

    The title of the check run.

    ", + "isRequired": true }, { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ + "type": "string", + "name": "summary", + "description": "

    The summary of the check run. This parameter supports Markdown.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "text", + "description": "

    The details of the check run. This parameter supports Markdown.

    " + }, + { + "type": "array of objects", + "name": "annotations", + "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "name": "path", - "in": "body", + "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start line of the annotation.

    ", "name": "start_line", - "in": "body", + "description": "

    The start line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The end line of the annotation.

    ", "name": "end_line", - "in": "body", + "description": "

    The end line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "start_column", - "in": "body", - "isRequired": false + "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "end_column", - "in": "body", - "isRequired": false + "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "string", + "name": "annotation_level", "description": "

    The level of the annotation.

    ", + "isRequired": true, "enum": [ "notice", "warning", "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "name": "message", - "in": "body", + "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "isRequired": true }, { "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", "name": "title", - "in": "body", - "isRequired": false + "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    " }, { "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", "name": "raw_details", - "in": "body", - "isRequired": false + "description": "

    Details about this annotation. The maximum size is 64 KB.

    " } ] }, { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ + "type": "array of objects", + "name": "images", + "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The alternative text for the image.

    ", "name": "alt", - "in": "body", + "description": "

    The alternative text for the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full URL of the image.

    ", "name": "image_url", - "in": "body", + "description": "

    The full URL of the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short image description.

    ", "name": "caption", - "in": "body", - "isRequired": false + "description": "

    A short image description.

    " } ] } @@ -145052,42 +147610,27 @@ }, { "type": "array of objects", - "description": "

    Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", - "maxItems": 3, "name": "actions", "in": "body", - "isRequired": false, + "description": "

    Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", "childParamsGroups": [ { - "parentName": "actions", - "parentType": "items", - "id": "actions-items", - "params": [ - { - "type": "string", - "maxLength": 20, - "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", - "name": "label", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 40, - "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", - "name": "description", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 20, - "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", - "name": "identifier", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "label", + "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "identifier", + "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", + "isRequired": true } ] } @@ -148739,47 +151282,43 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the check. For example, \"code-coverage\".

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the check. For example, \"code-coverage\".

    " }, { "type": "string", - "description": "

    The URL of the integrator's site that has the full details of the check.

    ", "name": "details_url", "in": "body", - "isRequired": false + "description": "

    The URL of the integrator's site that has the full details of the check.

    " }, { "type": "string", - "description": "

    A reference for the run on the integrator's system.

    ", "name": "external_id", "in": "body", - "isRequired": false + "description": "

    A reference for the run on the integrator's system.

    " }, { "type": "string", - "format": "date-time", - "description": "

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "string", + "name": "status", + "in": "body", "description": "

    The current status.

    ", "enum": [ "queued", "in_progress", "completed" - ], - "name": "status", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "conclusion", + "in": "body", "description": "

    Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.

    ", "enum": [ "action_required", @@ -148790,587 +151329,119 @@ "skipped", "stale", "timed_out" - ], - "name": "conclusion", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "format": "date-time", - "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "completed_at", "in": "body", - "isRequired": false + "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "object", - "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", - "properties": { - "title": { - "type": "string", - "description": "

    Required.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "**Required**.", - "isRequired": false, - "childParamsGroups": [] - }, - "summary": { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "summary", - "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": true, - "childParamsGroups": [] - }, - "text": { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "text", - "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotations": { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", - "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, - "name": "annotations", - "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#annotations-object-1) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - "images": { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, - "name": "images", - "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#annotations-object-1) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "summary" - ], "name": "output", "in": "body", - "isRequired": false, + "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", "childParamsGroups": [ { - "parentName": "output", - "parentType": "object", - "id": "output-object", - "params": [ - { - "type": "string", - "description": "

    Required.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "summary", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "text", - "in": "body", - "isRequired": false - }, - { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", - "maxItems": 50, - "name": "annotations", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "name": "images", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "string", + "name": "title", + "description": "

    Required.

    " }, { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ + "type": "string", + "name": "summary", + "description": "

    Can contain Markdown.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "text", + "description": "

    Can contain Markdown.

    " + }, + { + "type": "array of objects", + "name": "annotations", + "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "name": "path", - "in": "body", + "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start line of the annotation.

    ", "name": "start_line", - "in": "body", + "description": "

    The start line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The end line of the annotation.

    ", "name": "end_line", - "in": "body", + "description": "

    The end line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "start_column", - "in": "body", - "isRequired": false + "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "end_column", - "in": "body", - "isRequired": false + "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "string", + "name": "annotation_level", "description": "

    The level of the annotation.

    ", + "isRequired": true, "enum": [ "notice", "warning", "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "name": "message", - "in": "body", + "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "isRequired": true }, { "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", "name": "title", - "in": "body", - "isRequired": false + "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    " }, { "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", "name": "raw_details", - "in": "body", - "isRequired": false + "description": "

    Details about this annotation. The maximum size is 64 KB.

    " } ] }, { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ + "type": "array of objects", + "name": "images", + "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The alternative text for the image.

    ", "name": "alt", - "in": "body", + "description": "

    The alternative text for the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full URL of the image.

    ", "name": "image_url", - "in": "body", + "description": "

    The full URL of the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short image description.

    ", "name": "caption", - "in": "body", - "isRequired": false + "description": "

    A short image description.

    " } ] } @@ -149378,42 +151449,27 @@ }, { "type": "array of objects", - "description": "

    Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", - "maxItems": 3, "name": "actions", "in": "body", - "isRequired": false, + "description": "

    Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", "childParamsGroups": [ { - "parentName": "actions", - "parentType": "items", - "id": "actions-items", - "params": [ - { - "type": "string", - "maxLength": 20, - "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", - "name": "label", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 40, - "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", - "name": "description", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 20, - "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", - "name": "identifier", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "label", + "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "identifier", + "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", + "isRequired": true } ] } @@ -153520,9 +155576,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The sha of the head commit.

    ", "name": "head_sha", "in": "body", + "description": "

    The sha of the head commit.

    ", "isRequired": true } ], @@ -159716,32 +161772,22 @@ "bodyParameters": [ { "type": "array of objects", - "description": "

    Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

    ", "name": "auto_trigger_checks", "in": "body", - "isRequired": false, + "description": "

    Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

    ", "childParamsGroups": [ { - "parentName": "auto_trigger_checks", - "parentType": "items", - "id": "auto_trigger_checks-items", - "params": [ - { - "type": "integer", - "description": "

    The id of the GitHub App.

    ", - "name": "app_id", - "in": "body", - "isRequired": true - }, - { - "type": "boolean", - "description": "

    Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

    ", - "default": true, - "name": "setting", - "in": "body", - "isRequired": true - } - ] + "type": "integer", + "name": "app_id", + "description": "

    The id of the GitHub App.

    ", + "isRequired": true + }, + { + "type": "boolean", + "name": "setting", + "description": "

    Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

    ", + "isRequired": true, + "default": true } ] } @@ -171133,28 +173179,27 @@ ], "bodyParameters": [ { - "description": "

    Sets the state of the code scanning alert. You must provide dismissed_reason when you set the state to dismissed.

    ", "type": "string", + "name": "state", + "in": "body", + "description": "

    Sets the state of the code scanning alert. You must provide dismissed_reason when you set the state to dismissed.

    ", + "isRequired": true, "enum": [ "open", "dismissed" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", + "name": "dismissed_reason", + "in": "body", "description": "

    Required when the state is dismissed. The reason for dismissing or closing the alert.

    ", "enum": [ null, "false positive", "won't fix", "used in tests" - ], - "name": "dismissed_reason", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -171800,6 +173845,7 @@ "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "state": "open", "fixed_at": null, "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", @@ -172651,7 +174697,7 @@ "description": "

    Service unavailable

    " } ], - "descriptionHTML": "

    Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the repo scope. For public repositories,\nyou must use an access token with public_repo scope.\nGitHub Apps must have the security_events write permission to use this endpoint.

    \n

    You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.

    \n

    When you list the analyses for a repository,\none or more will be identified as deletable in the response:

    \n
    \"deletable\": true\n
    \n

    An analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:

    \n
      \n
    • ref
      • \n
    • tool
      • \n
    • analysis_key
      • \n
    • environment
      • \n
    \n

    If you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:

    \n
    Analysis specified is not deletable.\n
    \n

    The response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\nnext_analysis_url and confirm_delete_url.\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.

    \n

    As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:

    \n

    Outer loop:

    \n
      \n
    • \n

      List the analyses for the repository, filtered by tool.

      \n
      • \n
    • \n

      Parse this list to find a deletable analysis. If found:

      \n

      Inner loop:

      \n
        \n
      • Delete the identified analysis.
        • \n
      • Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.
        • \n
      \n
      • \n
    \n

    The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

    ", + "descriptionHTML": "

    Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the repo scope. For public repositories,\nyou must use an access token with public_repo scope.\nGitHub Apps must have the security_events write permission to use this endpoint.

    \n

    You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.

    \n

    When you list the analyses for a repository,\none or more will be identified as deletable in the response:

    \n
    \"deletable\": true\n
    \n

    An analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:

    \n
      \n
    • ref
      • \n
    • tool
      • \n
    • category
      • \n
    \n

    If you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:

    \n
    Analysis specified is not deletable.\n
    \n

    The response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\nnext_analysis_url and confirm_delete_url.\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.

    \n

    As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:

    \n

    Outer loop:

    \n
      \n
    • \n

      List the analyses for the repository, filtered by tool.

      \n
      • \n
    • \n

      Parse this list to find a deletable analysis. If found:

      \n

      Inner loop:

      \n
        \n
      • Delete the identified analysis.
        • \n
      • Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.
        • \n
      \n
      • \n
    \n

    The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

    ", "subcategory": "code-scanning" }, { @@ -172682,54 +174728,43 @@ ], "bodyParameters": [ { - "description": "

    The SHA of the commit to which the analysis you are uploading relates.

    ", "type": "string", - "minLength": 40, - "maxLength": 40, - "pattern": "^[0-9a-fA-F]+$", "name": "commit_sha", "in": "body", + "description": "

    The SHA of the commit to which the analysis you are uploading relates.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", "name": "ref", "in": "body", + "description": "

    The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", "isRequired": true }, { - "description": "

    A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

    ", "type": "string", "name": "sarif", "in": "body", + "description": "

    A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

    ", "isRequired": true }, { - "description": "

    The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

    ", "type": "string", - "format": "uri", - "examples": [ - "file:///github/workspace/" - ], "name": "checkout_uri", "in": "body", - "isRequired": false + "description": "

    The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

    " }, { - "description": "

    The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "format": "date-time", "type": "string", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { - "description": "

    The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

    ", "type": "string", "name": "tool_name", "in": "body", - "isRequired": false + "description": "

    The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

    " } ], "enabledForGitHubApps": true, @@ -173558,11 +175593,10 @@ "bodyParameters": [ { "type": "string", - "description": "

    The permission to grant the collaborator. Only valid on organization-owned repositories.

    ", - "default": "push", "name": "permission", "in": "body", - "isRequired": false + "description": "

    The permission to grant the collaborator. Only valid on organization-owned repositories.

    ", + "default": "push" } ], "enabledForGitHubApps": true, @@ -179375,6 +181409,8 @@ "bodyParameters": [ { "type": "string", + "name": "permissions", + "in": "body", "description": "

    The permissions that the associated user will have on the repository. Valid values are read, write, maintain, triage, and admin.

    ", "enum": [ "read", @@ -179382,10 +181418,7 @@ "maintain", "triage", "admin" - ], - "name": "permissions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -179394,8 +181427,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example request body", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permissions": "write" + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -195796,9 +197832,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment

    ", "isRequired": true } ], @@ -196712,31 +198748,28 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true }, { "type": "string", - "description": "

    Relative path of the file to comment on.

    ", "name": "path", "in": "body", - "isRequired": false + "description": "

    Relative path of the file to comment on.

    " }, { "type": "integer", - "description": "

    Line index in the diff to comment on.

    ", "name": "position", "in": "body", - "isRequired": false + "description": "

    Line index in the diff to comment on.

    " }, { "type": "integer", - "description": "

    Deprecated. Use position parameter instead. Line number in the file to comment on.

    ", "name": "line", "in": "body", - "isRequired": false + "description": "

    Deprecated. Use position parameter instead. Line number in the file to comment on.

    " } ], "enabledForGitHubApps": true, @@ -199927,38 +201960,35 @@ "bodyParameters": [ { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the status.

    ", + "isRequired": true, "enum": [ "error", "failure", "pending", "success" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", - "description": "

    The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
    \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
    \nhttp://ci.example.com/user/repo/build/sha

    ", "name": "target_url", "in": "body", - "isRequired": false + "description": "

    The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
    \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
    \nhttp://ci.example.com/user/repo/build/sha

    " }, { "type": "string or null", - "description": "

    A short description of the status.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the status.

    " }, { "type": "string", - "description": "

    A string label to differentiate this status from the status of other systems. This field is case-insensitive.

    ", - "default": "default", "name": "context", "in": "body", - "isRequired": false + "description": "

    A string label to differentiate this status from the status of other systems. This field is case-insensitive.

    ", + "default": "default" } ], "enabledForGitHubApps": true, @@ -200619,37 +202649,33 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret.

    ", + "isRequired": true, "enum": [ "all", "private", "selected" - ], - "name": "visibility", - "in": "body", - "isRequired": true + ] }, { "type": "array of strings", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", - "isRequired": false + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    " } ], "enabledForGitHubApps": true, @@ -203092,9 +205118,9 @@ "bodyParameters": [ { "type": "array of integers", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "isRequired": true } ], @@ -203622,18 +205648,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " } ], "enabledForGitHubApps": true, @@ -203916,24 +205939,22 @@ "bodyParameters": [ { "type": "string", - "description": "

    A name for the key.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    A name for the key.

    " }, { "type": "string", - "description": "

    The contents of the key.

    ", "name": "key", "in": "body", + "description": "

    The contents of the key.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

    \n

    Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

    ", "name": "read_only", "in": "body", - "isRequired": false + "description": "

    If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

    \n

    Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

    " } ], "enabledForGitHubApps": true, @@ -205034,82 +207055,61 @@ "bodyParameters": [ { "type": "string", - "description": "

    The ref to deploy. This can be a branch, tag, or SHA.

    ", "name": "ref", "in": "body", + "description": "

    The ref to deploy. This can be a branch, tag, or SHA.

    ", "isRequired": true }, { "type": "string", - "description": "

    Specifies a task to execute (e.g., deploy or deploy:migrations).

    ", - "default": "deploy", "name": "task", "in": "body", - "isRequired": false + "description": "

    Specifies a task to execute (e.g., deploy or deploy:migrations).

    ", + "default": "deploy" }, { "type": "boolean", - "description": "

    Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

    ", - "default": true, "name": "auto_merge", "in": "body", - "isRequired": false + "description": "

    Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

    ", + "default": true }, { "type": "array of strings", - "description": "

    The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

    ", "name": "required_contexts", "in": "body", - "isRequired": false + "description": "

    The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

    " }, { - "oneOf": [ - { - "type": "object", - "additionalProperties": true - }, - { - "type": "string", - "description": "JSON payload with extra information about the deployment.", - "default": "" - } - ], + "type": "object or string", "name": "payload", "in": "body", - "type": "object or string", - "description": "

    JSON payload with extra information about the deployment.

    ", - "isRequired": false + "description": "

    JSON payload with extra information about the deployment.

    " }, { "type": "string", - "description": "

    Name for the target deployment environment (e.g., production, staging, qa).

    ", - "default": "production", "name": "environment", "in": "body", - "isRequired": false + "description": "

    Name for the target deployment environment (e.g., production, staging, qa).

    ", + "default": "production" }, { "type": "string or null", - "description": "

    Short description of the deployment.

    ", - "default": "", "name": "description", "in": "body", - "isRequired": false + "description": "

    Short description of the deployment.

    " }, { "type": "boolean", - "description": "

    Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false

    ", - "default": false, "name": "transient_environment", "in": "body", - "isRequired": false + "description": "

    Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false

    " }, { "type": "boolean", - "description": "

    Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

    ", "name": "production_environment", "in": "body", - "isRequired": false + "description": "

    Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

    " } ], "enabledForGitHubApps": true, @@ -206838,13 +208838,10 @@ ], "bodyParameters": [ { - "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "type": "string", - "examples": [ - "release/*" - ], "name": "name", "in": "body", + "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "isRequired": true } ], @@ -207129,13 +209126,10 @@ ], "bodyParameters": [ { - "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "type": "string", - "examples": [ - "release/*" - ], "name": "name", "in": "body", + "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "isRequired": true } ], @@ -208763,105 +210757,49 @@ "bodyParameters": [ { "type": "integer", - "description": "

    The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).

    ", - "examples": [ - 30 - ], "name": "wait_timer", "in": "body", - "isRequired": false + "description": "

    The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).

    " }, { "type": "array of objects or null", - "description": "

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", "name": "reviewers", "in": "body", - "isRequired": false, + "description": "

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", "childParamsGroups": [ { - "parentName": "reviewers", - "parentType": "items", - "id": "reviewers-items", - "params": [ - { - "type": "string", - "description": "

    The type of reviewer.

    ", - "enum": [ - "User", - "Team" - ], - "examples": [ - "User" - ], - "name": "type", - "in": "body" - }, - { - "type": "integer", - "description": "

    The id of the user or team who can review the deployment

    ", - "examples": [ - 4532992 - ], - "name": "id", - "in": "body" - } + "type": "string", + "name": "type", + "description": "

    The type of reviewer.

    ", + "enum": [ + "User", + "Team" ] + }, + { + "type": "integer", + "name": "id", + "description": "

    The id of the user or team who can review the deployment

    " } ] }, { "type": "object or null", - "description": "

    The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

    ", - "properties": { - "protected_branches": { - "type": "boolean", - "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", - "name": "protected_branches", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", - "isRequired": true, - "childParamsGroups": [] - }, - "custom_branch_policies": { - "type": "boolean", - "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", - "name": "custom_branch_policies", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "protected_branches", - "custom_branch_policies" - ], "name": "deployment_branch_policy", "in": "body", - "isRequired": false, + "description": "

    The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

    ", "childParamsGroups": [ { - "parentName": "deployment_branch_policy", - "parentType": "object", - "id": "deployment_branch_policy-object", - "params": [ - { - "type": "boolean", - "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", - "name": "protected_branches", - "in": "body", - "isRequired": true - }, - { - "type": "boolean", - "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", - "name": "custom_branch_policies", - "in": "body", - "isRequired": true - } - ] + "type": "boolean", + "name": "protected_branches", + "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", + "isRequired": true + }, + { + "type": "boolean", + "name": "custom_branch_policies", + "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", + "isRequired": true } ] } @@ -210419,7 +212357,10 @@ "bodyParameters": [ { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the status. When you set a transient deployment to inactive, the deployment will be shown as destroyed in GitHub.

    ", + "isRequired": true, "enum": [ "error", "failure", @@ -210428,61 +212369,48 @@ "queued", "pending", "success" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.

    ", - "default": "", "name": "target_url", "in": "body", - "isRequired": false + "description": "

    The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.

    " }, { "type": "string", - "description": "

    The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: \"\"

    ", - "default": "", "name": "log_url", "in": "body", - "isRequired": false + "description": "

    The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: \"\"

    " }, { "type": "string", - "description": "

    A short description of the status. The maximum description length is 140 characters.

    ", - "default": "", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the status. The maximum description length is 140 characters.

    " }, { "type": "string", + "name": "environment", + "in": "body", "description": "

    Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa.

    ", "enum": [ "production", "staging", "qa" - ], - "name": "environment", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "description": "

    Sets the URL for accessing your environment. Default: \"\"

    ", - "default": "", "name": "environment_url", "in": "body", - "isRequired": false + "description": "

    Sets the URL for accessing your environment. Default: \"\"

    " }, { "type": "boolean", - "description": "

    Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true

    ", "name": "auto_inactive", "in": "body", - "isRequired": false + "description": "

    Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true

    " } ], "enabledForGitHubApps": true, @@ -214562,24 +216490,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

    ", - "examples": [ - "Very **important** announcement about _nothing_." - ], "name": "announcement", "in": "body", + "description": "

    The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

    ", "isRequired": true }, { "type": "string or null", - "format": "date-time", - "description": "

    The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

    ", - "examples": [ - "\"2021-01-01T00:00:00.000-07:00\"" - ], "name": "expires_at", "in": "body", - "isRequired": false + "description": "

    The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

    " } ], "enabledForGitHubApps": false, @@ -215393,114 +217313,53 @@ "bodyParameters": [ { "type": "string", - "description": "

    Must be passed as \"web\".

    ", "name": "name", "in": "body", + "description": "

    Must be passed as \"web\".

    ", "isRequired": true }, { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", + "description": "

    Key/value pairs to provide settings for this webhook.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    " + }, + { + "type": "string", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ] }, { "type": "array of strings", - "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    ", "name": "events", "in": "body", - "isRequired": false + "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    " }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": false, @@ -215751,107 +217610,45 @@ "bodyParameters": [ { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    " + }, + { + "type": "string", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ] }, { "type": "array of strings", - "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    ", "name": "events", "in": "body", - "isRequired": false + "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    " }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": false, @@ -216070,9 +217867,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The distinguished name (DN) of the LDAP entry to map to a team.

    ", "name": "ldap_dn", "in": "body", + "description": "

    The distinguished name (DN) of the LDAP entry to map to a team.

    ", "isRequired": true } ], @@ -216249,9 +218046,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The distinguished name (DN) of the LDAP entry to map to a team.

    ", "name": "ldap_dn", "in": "body", + "description": "

    The distinguished name (DN) of the LDAP entry to map to a team.

    ", "isRequired": true } ], @@ -217022,9 +218819,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    A JSON string with the attributes enabled and when.

    \n

    The possible values for enabled are true and false. When it's false, the attribute when is ignored and the maintenance mode is turned off. when defines the time period when the maintenance was enabled.

    \n

    The possible values for when are now or any date parseable by mojombo/chronic.

    ", "name": "maintenance", "in": "body", + "description": "

    A JSON string with the attributes enabled and when.

    \n

    The possible values for enabled are true and false. When it's false, the attribute when is ignored and the maintenance mode is turned off. when defines the time period when the maintenance was enabled.

    \n

    The possible values for when are now or any date parseable by mojombo/chronic.

    ", "isRequired": true } ], @@ -217778,9 +219575,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.

    ", "name": "settings", "in": "body", + "description": "

    A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.

    ", "isRequired": true } ], @@ -217883,9 +219680,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The public SSH key.

    ", "name": "authorized_key", "in": "body", + "description": "

    The public SSH key.

    ", "isRequired": true } ], @@ -217956,9 +219753,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The public SSH key.

    ", "name": "authorized_key", "in": "body", + "description": "

    The public SSH key.

    ", "isRequired": true } ], @@ -218029,24 +219826,22 @@ "bodyParameters": [ { "type": "string", - "description": "

    The content of your .ghl license file.

    ", "name": "license", "in": "body", + "description": "

    The content of your .ghl license file.

    ", "isRequired": true }, { "type": "string", - "description": "

    You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.

    ", "name": "password", "in": "body", - "isRequired": false + "description": "

    You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.

    " }, { "type": "string", - "description": "

    An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.

    ", "name": "settings", "in": "body", - "isRequired": false + "description": "

    An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.

    " } ], "enabledForGitHubApps": false, @@ -218084,10 +219879,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The content of your new .ghl license file.

    ", "name": "license", "in": "body", - "isRequired": false + "description": "

    The content of your new .ghl license file.

    " } ], "enabledForGitHubApps": false, @@ -218353,18 +220147,16 @@ ], "bodyParameters": [ { - "description": "

    The state of enforcement for the hook on this repository.

    ", "type": "string", "name": "enforcement", "in": "body", - "isRequired": false + "description": "

    The state of enforcement for the hook on this repository.

    " }, { - "description": "

    Whether repositories can override enforcement.

    ", "type": "boolean", "name": "allow_downstream_configuration", "in": "body", - "isRequired": false + "description": "

    Whether repositories can override enforcement.

    " } ], "enabledForGitHubApps": true, @@ -218523,24 +220315,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The organization's username.

    ", "name": "login", "in": "body", + "description": "

    The organization's username.

    ", "isRequired": true }, { "type": "string", - "description": "

    The login of the user who will manage this organization.

    ", "name": "admin", "in": "body", + "description": "

    The login of the user who will manage this organization.

    ", "isRequired": true }, { "type": "string", - "description": "

    The organization's display name.

    ", "name": "profile_name", "in": "body", - "isRequired": false + "description": "

    The organization's display name.

    " } ], "enabledForGitHubApps": false, @@ -218707,9 +220498,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The organization's new name.

    ", "name": "login", "in": "body", + "description": "

    The organization's new name.

    ", "isRequired": true } ], @@ -218942,16 +220733,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new pre-receive environment's name.

    ", "name": "name", "in": "body", + "description": "

    The new pre-receive environment's name.

    ", "isRequired": true }, { "type": "string", - "description": "

    URL from which to download a tarball of this environment.

    ", "name": "image_url", "in": "body", + "description": "

    URL from which to download a tarball of this environment.

    ", "isRequired": true } ], @@ -219187,17 +220978,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    This pre-receive environment's new name.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    This pre-receive environment's new name.

    " }, { "type": "string", - "description": "

    URL from which to download a tarball of this environment.

    ", "name": "image_url", "in": "body", - "isRequired": false + "description": "

    URL from which to download a tarball of this environment.

    " } ], "enabledForGitHubApps": false, @@ -219720,49 +221509,43 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the hook.

    ", "name": "name", "in": "body", + "description": "

    The name of the hook.

    ", "isRequired": true }, { "type": "string", - "description": "

    The script that the hook runs.

    ", "name": "script", "in": "body", + "description": "

    The script that the hook runs.

    ", "isRequired": true }, { "type": "object", - "description": "

    The GitHub repository where the script is kept.

    ", - "properties": {}, - "additionalProperties": true, "name": "script_repository", "in": "body", + "description": "

    The GitHub repository where the script is kept.

    ", "isRequired": true }, { "type": "object", - "description": "

    The pre-receive environment where the script is executed.

    ", - "properties": {}, - "additionalProperties": true, "name": "environment", "in": "body", + "description": "

    The pre-receive environment where the script is executed.

    ", "isRequired": true }, { "type": "string", - "description": "

    The state of enforcement for this hook. default: disabled

    ", "name": "enforcement", "in": "body", - "isRequired": false + "description": "

    The state of enforcement for this hook. default: disabled

    " }, { "type": "boolean", - "description": "

    Whether enforcement can be overridden at the org or repo level. default: false

    ", "name": "allow_downstream_configuration", "in": "body", - "isRequired": false + "description": "

    Whether enforcement can be overridden at the org or repo level. default: false

    " } ], "enabledForGitHubApps": false, @@ -220105,49 +221888,39 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the hook.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the hook.

    " }, { "type": "string", - "description": "

    The script that the hook runs.

    ", "name": "script", "in": "body", - "isRequired": false + "description": "

    The script that the hook runs.

    " }, { "type": "object", - "description": "

    The GitHub repository where the script is kept.

    ", - "properties": {}, - "additionalProperties": true, "name": "script_repository", "in": "body", - "isRequired": false + "description": "

    The GitHub repository where the script is kept.

    " }, { "type": "object", - "description": "

    The pre-receive environment where the script is executed.

    ", - "properties": {}, - "additionalProperties": true, "name": "environment", "in": "body", - "isRequired": false + "description": "

    The pre-receive environment where the script is executed.

    " }, { "type": "string", - "description": "

    The state of enforcement for this hook.

    ", "name": "enforcement", "in": "body", - "isRequired": false + "description": "

    The state of enforcement for this hook.

    " }, { "type": "boolean", - "description": "

    Whether enforcement can be overridden at the org or repo level.

    ", "name": "allow_downstream_configuration", "in": "body", - "isRequired": false + "description": "

    Whether enforcement can be overridden at the org or repo level.

    " } ], "enabledForGitHubApps": false, @@ -220608,16 +222381,15 @@ ], "bodyParameters": [ { - "description": "

    The state of enforcement for the hook on this repository.

    ", "type": "string", + "name": "enforcement", + "in": "body", + "description": "

    The state of enforcement for the hook on this repository.

    ", "enum": [ "enabled", "disabled", "testing" - ], - "name": "enforcement", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -221356,14 +223128,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -221885,17 +223649,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The user's username.

    ", "name": "login", "in": "body", + "description": "

    The user's username.

    ", "isRequired": true }, { "type": "string", - "description": "

    Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

    ", "name": "email", "in": "body", - "isRequired": false + "description": "

    Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

    " } ], "enabledForGitHubApps": false, @@ -222129,9 +223892,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The user's new username.

    ", "name": "login", "in": "body", + "description": "

    The user's new username.

    ", "isRequired": true } ], @@ -222247,10 +224010,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    A list of scopes.

    ", "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes.

    " } ], "enabledForGitHubApps": false, @@ -222588,14 +224350,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -223383,14 +225137,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -224015,10 +225761,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    ", "name": "reason", "in": "body", - "isRequired": false + "description": "

    The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    " } ], "enabledForGitHubApps": false, @@ -224069,10 +225814,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    ", "name": "reason", "in": "body", - "isRequired": false + "description": "

    The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    " } ], "enabledForGitHubApps": false, @@ -224679,76 +226423,27 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Description of the gist

    ", "type": "string", - "examples": [ - "Example Ruby script" - ], "name": "description", "in": "body", - "isRequired": false + "description": "

    Description of the gist

    " }, { - "description": "

    Names and content for the files that make up the gist

    ", "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "content": { - "description": "

    Content of the file

    ", - "readOnly": false, - "type": "string", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "Content of the file", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "content" - ], - "rawType": "object", - "name": "key" - }, - "examples": [ - { - "hello.rb": { - "content": "puts \"Hello, World!\"" - } - } - ], "name": "files", "in": "body", + "description": "

    Names and content for the files that make up the gist

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "files", - "parentType": "object", - "id": "files-object", - "params": [ + "type": "object", + "name": "key", + "description": "

    A user-defined key to represent an item in files.

    ", + "childParamsGroups": [ { - "description": "

    A user-defined key to represent an item in files.

    ", - "type": "string", - "name": "key", - "in": "body", - "rawType": "string", - "rawDescription": "A key to represent an item in files." - } - ] - }, - { - "parentName": "key", - "parentType": "object", - "id": "key-object", - "params": [ - { - "description": "

    Content of the file

    ", - "readOnly": false, "type": "string", "name": "content", - "in": "body", + "description": "

    Content of the file

    ", "isRequired": true } ] @@ -224756,32 +226451,10 @@ ] }, { - "oneOf": [ - { - "description": "Flag indicating whether the gist is public", - "type": "boolean", - "default": false, - "examples": [ - true - ] - }, - { - "type": "string", - "default": "false", - "enum": [ - "true", - "false" - ], - "examples": [ - "true" - ] - } - ], + "type": "boolean or string", "name": "public", "in": "body", - "type": "boolean or string", - "description": "

    Flag indicating whether the gist is public

    ", - "isRequired": false + "description": "

    Flag indicating whether the gist is public

    " } ], "enabledForGitHubApps": false, @@ -228428,108 +230101,31 @@ ], "bodyParameters": [ { - "description": "

    Description of the gist

    ", "type": "string", - "examples": [ - "Example Ruby script" - ], "name": "description", "in": "body", - "isRequired": false + "description": "

    Description of the gist

    " }, { - "description": "

    Names of files to be updated

    ", "type": "object", - "additionalProperties": { - "type": [ - "object", - "null" - ], - "properties": { - "content": { - "description": "

    The new content of the file

    ", - "type": "string", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The new content of the file", - "childParamsGroups": [] - }, - "filename": { - "description": "

    The new filename for the file

    ", - "type": "string or null", - "name": "filename", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new filename for the file", - "childParamsGroups": [] - } - }, - "anyOf": [ - { - "required": [ - "content" - ] - }, - { - "required": [ - "filename" - ] - }, - { - "type": "object", - "maxProperties": 0 - } - ], - "rawType": "object", - "name": "key" - }, - "examples": [ - { - "hello.rb": { - "content": "blah", - "filename": "goodbye.rb" - } - } - ], "name": "files", "in": "body", - "isRequired": false, + "description": "

    Names of files to be updated

    ", "childParamsGroups": [ { - "parentName": "files", - "parentType": "object", - "id": "files-object", - "params": [ + "type": "object", + "name": "key", + "description": "

    A user-defined key to represent an item in files.

    ", + "childParamsGroups": [ { - "description": "

    A user-defined key to represent an item in files.

    ", - "type": "string", - "name": "key", - "in": "body", - "rawType": "string", - "rawDescription": "A key to represent an item in files." - } - ] - }, - { - "parentName": "key", - "parentType": "object", - "id": "key-object", - "params": [ - { - "description": "

    The new content of the file

    ", "type": "string", "name": "content", - "in": "body" + "description": "

    The new content of the file

    " }, { - "description": "

    The new filename for the file

    ", "type": "string or null", "name": "filename", - "in": "body" + "description": "

    The new filename for the file

    " } ] } @@ -234385,14 +235981,10 @@ ], "bodyParameters": [ { - "description": "

    The comment text.

    ", "type": "string", - "maxLength": 65535, - "examples": [ - "Body of the attachment" - ], "name": "body", "in": "body", + "description": "

    The comment text.

    ", "isRequired": true } ], @@ -235082,14 +236674,10 @@ ], "bodyParameters": [ { - "description": "

    The comment text.

    ", "type": "string", - "maxLength": 65535, - "examples": [ - "Body of the attachment" - ], "name": "body", "in": "body", + "description": "

    The comment text.

    ", "isRequired": true } ], @@ -235503,18 +237091,17 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new blob's content.

    ", "name": "content", "in": "body", + "description": "

    The new blob's content.

    ", "isRequired": true }, { "type": "string", - "description": "

    The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.

    ", - "default": "utf-8", "name": "encoding", "in": "body", - "isRequired": false + "description": "

    The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.

    ", + "default": "utf-8" } ], "enabledForGitHubApps": true, @@ -235745,171 +237332,77 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message

    ", "name": "message", "in": "body", + "description": "

    The commit message

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the tree object this commit points to

    ", "name": "tree", "in": "body", + "description": "

    The SHA of the tree object this commit points to

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

    ", "name": "parents", "in": "body", - "isRequired": false + "description": "

    The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

    " }, { "type": "object", - "description": "

    Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "author", "in": "body", - "isRequired": false, + "description": "

    Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] }, { "type": "object", - "description": "

    Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "childParamsGroups": [] - } - }, "name": "committer", "in": "body", - "isRequired": false, + "description": "

    Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - }, - { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "date", + "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] }, { "type": "string", - "description": "

    The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

    ", "name": "signature", "in": "body", - "isRequired": false + "description": "

    The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

    " } ], "enabledForGitHubApps": true, @@ -236778,27 +238271,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

    ", "name": "ref", "in": "body", + "description": "

    The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA1 value for this reference.

    ", "name": "sha", "in": "body", + "description": "

    The SHA1 value for this reference.

    ", "isRequired": true }, { "type": "string", - "examples": [ - "\"refs/heads/newbranch\"" - ], "name": "key", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -236938,18 +238427,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The SHA1 value to set this reference to

    ", "name": "sha", "in": "body", + "description": "

    The SHA1 value to set this reference to

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

    ", - "default": false, "name": "force", "in": "body", - "isRequired": false + "description": "

    Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

    " } ], "enabledForGitHubApps": true, @@ -237151,109 +238638,59 @@ "bodyParameters": [ { "type": "string", - "description": "

    The tag's name. This is typically a version (e.g., \"v0.0.1\").

    ", "name": "tag", "in": "body", + "description": "

    The tag's name. This is typically a version (e.g., \"v0.0.1\").

    ", "isRequired": true }, { "type": "string", - "description": "

    The tag message.

    ", "name": "message", "in": "body", + "description": "

    The tag message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the git object this is tagging.

    ", "name": "object", "in": "body", + "description": "

    The SHA of the git object this is tagging.

    ", "isRequired": true }, { "type": "string", + "name": "type", + "in": "body", "description": "

    The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.

    ", + "isRequired": true, "enum": [ "commit", "tree", "blob" - ], - "name": "type", - "in": "body", - "isRequired": true + ] }, { "type": "object", - "description": "

    An object with information about the individual creating the tag.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author of the tag

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author of the tag", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author of the tag

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author of the tag", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "tagger", "in": "body", - "isRequired": false, + "description": "

    An object with information about the individual creating the tag.

    ", "childParamsGroups": [ { - "parentName": "tagger", - "parentType": "object", - "id": "tagger-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author of the tag

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author of the tag

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "format": "date-time", - "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author of the tag

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author of the tag

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] } @@ -237688,68 +239125,55 @@ "bodyParameters": [ { "type": "array of objects", - "description": "

    Objects (of path, mode, type, and sha) specifying a tree structure.

    ", "name": "tree", "in": "body", + "description": "

    Objects (of path, mode, type, and sha) specifying a tree structure.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "tree", - "parentType": "items", - "id": "tree-items", - "params": [ - { - "type": "string", - "description": "

    The file referenced in the tree.

    ", - "name": "path", - "in": "body" - }, - { - "type": "string", - "description": "

    The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

    ", - "enum": [ - "100644", - "100755", - "040000", - "160000", - "120000" - ], - "name": "mode", - "in": "body" - }, - { - "type": "string", - "description": "

    Either blob, tree, or commit.

    ", - "enum": [ - "blob", - "tree", - "commit" - ], - "name": "type", - "in": "body" - }, - { - "type": "string or null", - "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", - "name": "sha", - "in": "body" - }, - { - "type": "string", - "description": "

    The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", - "name": "content", - "in": "body" - } + "type": "string", + "name": "path", + "description": "

    The file referenced in the tree.

    " + }, + { + "type": "string", + "name": "mode", + "description": "

    The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

    ", + "enum": [ + "100644", + "100755", + "040000", + "160000", + "120000" ] + }, + { + "type": "string", + "name": "type", + "description": "

    Either blob, tree, or commit.

    ", + "enum": [ + "blob", + "tree", + "commit" + ] + }, + { + "type": "string or null", + "name": "sha", + "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    " + }, + { + "type": "string", + "name": "content", + "description": "

    The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    " } ] }, { "type": "string", - "description": "

    The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

    ", "name": "base_tree", "in": "body", - "isRequired": false + "description": "

    The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

    " } ], "enabledForGitHubApps": true, @@ -245590,7 +247014,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ], "schema": { @@ -248646,63 +250071,41 @@ ], "bodyParameters": [ { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "

    The title of the issue.

    ", + "type": "string or integer", "name": "title", "in": "body", - "type": "string or integer", + "description": "

    The title of the issue.

    ", "isRequired": true }, { "type": "string", - "description": "

    The contents of the issue.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the issue.

    " }, { "type": "string or null", - "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "name": "assignee", "in": "body", - "isRequired": false + "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    " }, { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._" - } - ], - "type": "string or integer or null", + "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "isRequired": false + "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    " }, { - "type": "array of strings or array of objects", - "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", + "type": "array", "name": "labels", "in": "body", - "isRequired": false + "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    " }, { "type": "array of strings", - "description": "

    Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    " } ], "enabledForGitHubApps": true, @@ -248888,7 +250291,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -252128,7 +253532,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -255193,74 +256598,56 @@ ], "bodyParameters": [ { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "

    The title of the issue.

    ", - "type": "string or integer or null", + "type": "null or string or integer or string or integer", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the issue.

    " }, { "type": "string or null", - "description": "

    The contents of the issue.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the issue.

    " }, { "type": "string or null", - "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", "in": "body", - "isRequired": false + "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    State of the issue. Either open or closed.

    ", "enum": [ "open", "closed" - ], - "name": "state", - "in": "body", - "isRequired": false + ] }, { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._" - } - ], - "type": "string or integer or null", + "type": "string or null", + "name": "state_reason", + "in": "body", + "description": "

    The reason for the current state

    " + }, + { + "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "isRequired": false + "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    " }, { - "type": "array of strings or array of objects", - "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", + "type": "array", "name": "labels", "in": "body", - "isRequired": false + "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    " }, { "type": "array of strings", - "description": "

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    " } ], "enabledForGitHubApps": true, @@ -255448,7 +256835,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -258522,16 +259910,15 @@ "bodyParameters": [ { "type": "string", + "name": "lock_reason", + "in": "body", "description": "

    The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
    \n* off-topic
    \n* too heated
    \n* resolved
    \n* spam

    ", "enum": [ "off-topic", "too heated", "resolved", "spam" - ], - "name": "lock_reason", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -262433,10 +263820,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

    " } ], "enabledForGitHubApps": true, @@ -262618,7 +264004,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -265668,10 +267055,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

    " } ], "enabledForGitHubApps": true, @@ -265853,7 +267239,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -270437,9 +271824,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true } ], @@ -272029,9 +273416,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true } ], @@ -272981,7 +274368,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ], @@ -277844,7 +279232,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } }, "schema": { @@ -292791,10 +294180,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

    ", "name": "labels", - "in": "body" + "in": "body", + "description": "

    The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

    " } ], "enabledForGitHubApps": true, @@ -292969,10 +294357,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

    ", "name": "labels", - "in": "body" + "in": "body", + "description": "

    The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

    " } ], "enabledForGitHubApps": true, @@ -293538,24 +294925,22 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "name": "name", "in": "body", + "description": "

    The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "isRequired": true }, { "type": "string", - "description": "

    The hexadecimal color code for the label, without the leading #.

    ", "name": "color", "in": "body", - "isRequired": false + "description": "

    The hexadecimal color code for the label, without the leading #.

    " }, { "type": "string", - "description": "

    A short description of the label. Must be 100 characters or fewer.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the label. Must be 100 characters or fewer.

    " } ], "enabledForGitHubApps": true, @@ -293859,24 +295244,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "name": "new_name", "in": "body", - "isRequired": false + "description": "

    The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    " }, { "type": "string", - "description": "

    The hexadecimal color code for the label, without the leading #.

    ", "name": "color", "in": "body", - "isRequired": false + "description": "

    The hexadecimal color code for the label, without the leading #.

    " }, { "type": "string", - "description": "

    A short description of the label. Must be 100 characters or fewer.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the label. Must be 100 characters or fewer.

    " } ], "enabledForGitHubApps": true, @@ -294729,37 +296111,33 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the milestone.

    ", "name": "title", "in": "body", + "description": "

    The title of the milestone.

    ", "isRequired": true }, { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the milestone. Either open or closed.

    ", "enum": [ "open", "closed" ], - "default": "open", - "name": "state", - "in": "body", - "isRequired": false + "default": "open" }, { "type": "string", - "description": "

    A description of the milestone.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A description of the milestone.

    " }, { "type": "string", - "format": "date-time", - "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "due_on", "in": "body", - "isRequired": false + "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ], "enabledForGitHubApps": true, @@ -295602,37 +296980,32 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the milestone.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the milestone.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the milestone. Either open or closed.

    ", "enum": [ "open", "closed" ], - "default": "open", - "name": "state", - "in": "body", - "isRequired": false + "default": "open" }, { "type": "string", - "description": "

    A description of the milestone.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A description of the milestone.

    " }, { "type": "string", - "format": "date-time", - "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "due_on", "in": "body", - "isRequired": false + "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ], "enabledForGitHubApps": true, @@ -312504,33 +313877,28 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The Markdown text to render in HTML.

    ", "type": "string", "name": "text", "in": "body", + "description": "

    The Markdown text to render in HTML.

    ", "isRequired": true }, { + "type": "string", + "name": "mode", + "in": "body", "description": "

    The rendering mode. Can be either markdown or gfm.

    ", "enum": [ "markdown", "gfm" ], - "default": "markdown", - "type": "string", - "examples": [ - "markdown" - ], - "name": "mode", - "in": "body", - "isRequired": false + "default": "markdown" }, { - "description": "

    The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

    ", "type": "string", "name": "context", "in": "body", - "isRequired": false + "description": "

    The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

    " } ], "enabledForGitHubApps": true, @@ -315718,88 +317086,58 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    A list of arrays indicating which repositories should be migrated.

    ", "name": "repositories", "in": "body", + "description": "

    A list of arrays indicating which repositories should be migrated.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Indicates whether repositories should be locked (to prevent manipulation) while migrating data.

    ", - "default": false, - "examples": [ - true - ], "name": "lock_repositories", "in": "body", - "isRequired": false + "description": "

    Indicates whether repositories should be locked (to prevent manipulation) while migrating data.

    " }, { "type": "boolean", - "description": "

    Indicates whether metadata should be excluded and only git source should be included for the migration.

    ", - "default": false, "name": "exclude_metadata", "in": "body", - "isRequired": false + "description": "

    Indicates whether metadata should be excluded and only git source should be included for the migration.

    " }, { "type": "boolean", - "description": "

    Indicates whether the repository git data should be excluded from the migration.

    ", - "default": false, "name": "exclude_git_data", "in": "body", - "isRequired": false + "description": "

    Indicates whether the repository git data should be excluded from the migration.

    " }, { "type": "boolean", - "description": "

    Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).

    ", - "default": false, - "examples": [ - true - ], "name": "exclude_attachments", "in": "body", - "isRequired": false + "description": "

    Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).

    " }, { "type": "boolean", - "description": "

    Indicates whether releases should be excluded from the migration (to reduce migration archive file size).

    ", - "default": false, - "examples": [ - true - ], "name": "exclude_releases", "in": "body", - "isRequired": false + "description": "

    Indicates whether releases should be excluded from the migration (to reduce migration archive file size).

    " }, { "type": "boolean", - "description": "

    Indicates whether projects owned by the organization or users should be excluded. from the migration.

    ", - "default": false, - "examples": [ - true - ], "name": "exclude_owner_projects", "in": "body", - "isRequired": false + "description": "

    Indicates whether projects owned by the organization or users should be excluded. from the migration.

    " }, { "type": "boolean", - "description": "

    Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

    ", - "default": false, - "examples": [ - true - ], "name": "org_metadata_only", "in": "body", - "isRequired": false + "description": "

    Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

    " }, { "type": "array of strings", - "description": "

    Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: \"repositories\".

    ", "name": "exclude", "in": "body", - "isRequired": false + "description": "

    Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: \"repositories\".

    " } ], "enabledForGitHubApps": false, @@ -321409,92 +322747,52 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Lock the repositories being migrated at the start of the migration

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "lock_repositories", "in": "body", - "isRequired": false + "description": "

    Lock the repositories being migrated at the start of the migration

    " }, { - "description": "

    Indicates whether metadata should be excluded and only git source should be included for the migration.

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_metadata", "in": "body", - "isRequired": false + "description": "

    Indicates whether metadata should be excluded and only git source should be included for the migration.

    " }, { - "description": "

    Indicates whether the repository git data should be excluded from the migration.

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_git_data", "in": "body", - "isRequired": false + "description": "

    Indicates whether the repository git data should be excluded from the migration.

    " }, { - "description": "

    Do not include attachments in the migration

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_attachments", "in": "body", - "isRequired": false + "description": "

    Do not include attachments in the migration

    " }, { - "description": "

    Do not include releases in the migration

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_releases", "in": "body", - "isRequired": false + "description": "

    Do not include releases in the migration

    " }, { - "description": "

    Indicates whether projects owned by the organization or users should be excluded.

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_owner_projects", "in": "body", - "isRequired": false + "description": "

    Indicates whether projects owned by the organization or users should be excluded.

    " }, { "type": "boolean", - "description": "

    Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

    ", - "default": false, - "examples": [ - true - ], "name": "org_metadata_only", "in": "body", - "isRequired": false + "description": "

    Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

    " }, { - "description": "

    Exclude attributes from the API response to improve performance

    ", - "readOnly": false, "type": "array of strings", - "examples": [ - "repositories" - ], "name": "exclude", "in": "body", - "isRequired": false + "description": "

    Exclude attributes from the API response to improve performance

    " }, { "type": "array of strings", @@ -326778,14 +328076,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -327277,55 +328567,40 @@ "parameters": [], "bodyParameters": [ { - "description": "

    A list of scopes that this authorization is in.

    ", "type": "array of strings or null", - "examples": [ - "public_repo", - "user" - ], "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes that this authorization is in.

    " }, { - "description": "

    A note to remind you what the OAuth token is for.

    ", "type": "string", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    A note to remind you what the OAuth token is for.

    " }, { - "description": "

    A URL to remind you what app the OAuth token is for.

    ", "type": "string", "name": "note_url", "in": "body", - "isRequired": false + "description": "

    A URL to remind you what app the OAuth token is for.

    " }, { - "description": "

    The OAuth app client key for which to create the token.

    ", - "maxLength": 20, "type": "string", "name": "client_id", "in": "body", - "isRequired": false + "description": "

    The OAuth app client key for which to create the token.

    " }, { - "description": "

    The OAuth app client secret for which to create the token.

    ", - "maxLength": 40, "type": "string", "name": "client_secret", "in": "body", - "isRequired": false + "description": "

    The OAuth app client secret for which to create the token.

    " }, { - "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    ", "type": "string", "name": "fingerprint", "in": "body", - "isRequired": false + "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    " } ], "enabledForGitHubApps": false, @@ -327669,14 +328944,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -328186,47 +329453,35 @@ ], "bodyParameters": [ { - "description": "

    The OAuth app client secret for which to create the token.

    ", - "maxLength": 40, "type": "string", "name": "client_secret", "in": "body", + "description": "

    The OAuth app client secret for which to create the token.

    ", "isRequired": true }, { - "description": "

    A list of scopes that this authorization is in.

    ", "type": "array of strings or null", - "examples": [ - "public_repo", - "user" - ], "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes that this authorization is in.

    " }, { - "description": "

    A note to remind you what the OAuth token is for.

    ", "type": "string", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    A note to remind you what the OAuth token is for.

    " }, { - "description": "

    A URL to remind you what app the OAuth token is for.

    ", "type": "string", "name": "note_url", "in": "body", - "isRequired": false + "description": "

    A URL to remind you what app the OAuth token is for.

    " }, { - "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    ", "type": "string", "name": "fingerprint", "in": "body", - "isRequired": false + "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    " } ], "enabledForGitHubApps": false, @@ -328572,14 +329827,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -329375,14 +330622,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -329901,40 +331140,29 @@ ], "bodyParameters": [ { - "description": "

    The OAuth app client secret for which to create the token.

    ", - "maxLength": 40, "type": "string", "name": "client_secret", "in": "body", + "description": "

    The OAuth app client secret for which to create the token.

    ", "isRequired": true }, { - "description": "

    A list of scopes that this authorization is in.

    ", "type": "array of strings or null", - "examples": [ - "public_repo", - "user" - ], "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes that this authorization is in.

    " }, { - "description": "

    A note to remind you what the OAuth token is for.

    ", "type": "string", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    A note to remind you what the OAuth token is for.

    " }, { - "description": "

    A URL to remind you what app the OAuth token is for.

    ", "type": "string", "name": "note_url", "in": "body", - "isRequired": false + "description": "

    A URL to remind you what app the OAuth token is for.

    " } ], "enabledForGitHubApps": false, @@ -330281,14 +331509,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -331085,14 +332305,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -331918,14 +333130,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -332422,53 +333626,40 @@ ], "bodyParameters": [ { - "description": "

    A list of scopes that this authorization is in.

    ", "type": "array of strings or null", - "examples": [ - "public_repo", - "user" - ], "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes that this authorization is in.

    " }, { - "description": "

    A list of scopes to add to this authorization.

    ", "type": "array of strings", "name": "add_scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes to add to this authorization.

    " }, { - "description": "

    A list of scopes to remove from this authorization.

    ", "type": "array of strings", "name": "remove_scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes to remove from this authorization.

    " }, { - "description": "

    A note to remind you what the OAuth token is for.

    ", "type": "string", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    A note to remind you what the OAuth token is for.

    " }, { - "description": "

    A URL to remind you what app the OAuth token is for.

    ", "type": "string", "name": "note_url", "in": "body", - "isRequired": false + "description": "

    A URL to remind you what app the OAuth token is for.

    " }, { - "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    ", "type": "string", "name": "fingerprint", "in": "body", - "isRequired": false + "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    " } ], "enabledForGitHubApps": false, @@ -332806,14 +333997,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -334006,69 +335189,62 @@ "bodyParameters": [ { "type": "string", - "description": "

    Billing email address. This address is not publicized.

    ", "name": "billing_email", "in": "body", - "isRequired": false + "description": "

    Billing email address. This address is not publicized.

    " }, { "type": "string", - "description": "

    The company name.

    ", "name": "company", "in": "body", - "isRequired": false + "description": "

    The company name.

    " }, { "type": "string", - "description": "

    The publicly visible email address.

    ", "name": "email", "in": "body", - "isRequired": false + "description": "

    The publicly visible email address.

    " }, { "type": "string", - "description": "

    The Twitter username of the company.

    ", "name": "twitter_username", "in": "body", - "isRequired": false + "description": "

    The Twitter username of the company.

    " }, { "type": "string", - "description": "

    The location.

    ", "name": "location", "in": "body", - "isRequired": false + "description": "

    The location.

    " }, { "type": "string", - "description": "

    The shorthand name of the company.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The shorthand name of the company.

    " }, { "type": "string", - "description": "

    The description of the company.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the company.

    " }, { "type": "boolean", - "description": "

    Whether an organization can use organization projects.

    ", "name": "has_organization_projects", "in": "body", - "isRequired": false + "description": "

    Whether an organization can use organization projects.

    " }, { "type": "boolean", - "description": "

    Whether repositories that belong to the organization can use repository projects.

    ", "name": "has_repository_projects", "in": "body", - "isRequired": false + "description": "

    Whether repositories that belong to the organization can use repository projects.

    " }, { "type": "string", + "name": "default_repository_permission", + "in": "body", "description": "

    Default permission level members have for organization repositories.

    ", "enum": [ "read", @@ -334076,77 +335252,62 @@ "admin", "none" ], - "default": "read", - "name": "default_repository_permission", - "in": "body", - "isRequired": false + "default": "read" }, { "type": "boolean", - "description": "

    Whether of non-admin organization members can create repositories. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

    ", - "default": true, "name": "members_can_create_repositories", "in": "body", - "isRequired": false + "description": "

    Whether of non-admin organization members can create repositories. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

    ", + "default": true }, { "type": "boolean", - "description": "

    Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_internal_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_private_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "string", + "name": "members_allowed_repository_creation_type", + "in": "body", "description": "

    Specifies which types of repositories non-admin organization members can create.\nNote: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See the parameter deprecation notice in the operation description for details.

    ", "enum": [ "all", "private", "none" - ], - "name": "members_allowed_repository_creation_type", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.

    ", - "default": true, "name": "members_can_create_pages", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.

    ", + "default": true }, { "type": "boolean", - "description": "

    Whether organization members can fork private organization repositories.

    ", - "default": false, "name": "members_can_fork_private_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can fork private organization repositories.

    " }, { "type": "string", - "examples": [ - "\"http://github.blog\"" - ], "name": "blog", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -335500,14 +336661,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -336441,7 +337594,7 @@ } ], "previews": [], - "descriptionHTML": "

    List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.

    \n

    For more information on custom repository roles, see \"Managing custom repository roles for an organization\".

    ", + "descriptionHTML": "

    List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.

    \n

    To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with admin:org repo scope.\nGitHub Apps must have the organization_custom_roles:read organization permission to use this endpoint.

    \n

    For more information on custom repository roles, see \"Managing custom repository roles for an organization\".

    ", "statusCodes": [ { "httpStatusCode": "200", @@ -337324,15 +338477,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role to give the user in the organization. Can be one of:
    \n* admin - The user will become an owner of the organization.
    \n* member - The user will become a non-owner member of the organization.

    ", "enum": [ "admin", "member" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -339172,13 +340324,13 @@ "bodyParameters": [ { "type": "string", - "description": "

    The state that the membership should be in. Only \"active\" will be accepted.

    ", - "enum": [ - "active" - ], "name": "state", "in": "body", - "isRequired": true + "description": "

    The state that the membership should be in. Only \"active\" will be accepted.

    ", + "isRequired": true, + "enum": [ + "active" + ] } ], "enabledForGitHubApps": false, @@ -339890,11 +341042,9 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

    ", - "default": false, "name": "async", "in": "body", - "isRequired": false + "description": "

    When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

    " } ], "enabledForGitHubApps": true, @@ -340252,203 +341402,66 @@ "bodyParameters": [ { "type": "string", - "description": "

    Must be passed as \"web\".

    ", "name": "name", "in": "body", + "description": "

    Must be passed as \"web\".

    ", "isRequired": true }, { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - }, - "username": { - "type": "string", - "examples": [ - "\"kdaigle\"" - ], - "name": "username", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "password": { - "type": "string", - "examples": [ - "\"password\"" - ], - "name": "password", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"kdaigle\"" - ], - "name": "username", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"password\"" - ], - "name": "password", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "username", + "description": "" + }, + { + "type": "string", + "name": "password", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, @@ -340855,162 +341868,54 @@ "bodyParameters": [ { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true }, { "type": "string", - "examples": [ - "\"web\"" - ], "name": "name", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -341382,53 +342287,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": true, @@ -342449,77 +343328,35 @@ "bodyParameters": [ { "type": "string", + "name": "build_type", + "in": "body", "description": "

    The process in which the Page will be built. Possible values are \"legacy\" and \"workflow\".

    ", "enum": [ "legacy", "workflow" - ], - "name": "build_type", - "in": "body", - "isRequired": false + ] }, { "type": "object", + "name": "source", + "in": "body", "description": "

    The source branch and directory used to publish your Pages site.

    ", - "properties": { - "branch": { + "childParamsGroups": [ + { "type": "string", - "description": "

    The repository branch used to publish your site's source files.

    ", "name": "branch", - "in": "body", - "rawType": "string", - "rawDescription": "The repository branch used to publish your site's source files.", - "isRequired": true, - "childParamsGroups": [] + "description": "

    The repository branch used to publish your site's source files.

    ", + "isRequired": true }, - "path": { + { "type": "string", + "name": "path", "description": "

    The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: /

    ", "enum": [ "/", "/docs" ], - "default": "/", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "branch" - ], - "name": "source", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "source", - "parentType": "object", - "id": "source-object", - "params": [ - { - "type": "string", - "description": "

    The repository branch used to publish your site's source files.

    ", - "name": "branch", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: /

    ", - "enum": [ - "/", - "/docs" - ], - "default": "/", - "name": "path", - "in": "body", - "isRequired": false - } - ] + "default": "/" } ] } @@ -342803,75 +343640,37 @@ "bodyParameters": [ { "type": "string or null", - "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    ", "name": "cname", "in": "body", - "isRequired": false + "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    " }, { "type": "boolean", - "description": "

    Specify whether HTTPS should be enforced for the repository.

    ", "name": "https_enforced", "in": "body", - "isRequired": false + "description": "

    Specify whether HTTPS should be enforced for the repository.

    " }, { "type": "boolean", - "description": "

    Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

    ", "name": "public", "in": "body", - "isRequired": false + "description": "

    Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

    " }, { "type": "string", + "name": "build_type", + "in": "body", "description": "

    The process by which the GitHub Pages site will be built. workflow means that the site is built by a custom GitHub Actions workflow. legacy means that the site is built by GitHub when changes are pushed to a specific branch.

    ", "enum": [ "legacy", "workflow" - ], - "name": "build_type", - "in": "body", - "isRequired": false + ] }, { - "anyOf": [ - { - "type": "string", - "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", - "enum": [ - "gh-pages", - "master", - "master /docs" - ] - }, - { - "type": "object", - "description": "Update the source for the repository. Must include the branch name and path.", - "properties": { - "branch": { - "type": "string", - "description": "The repository branch used to publish your site's source files." - }, - "path": { - "type": "string", - "description": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.", - "enum": [ - "/", - "/docs" - ] - } - }, - "required": [ - "branch", - "path" - ] - } - ], + "type": "", "name": "source", "in": "body", - "type": "", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -344453,17 +345252,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the project.

    ", "name": "name", "in": "body", + "description": "

    The name of the project.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the project.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The description of the project.

    " } ], "enabledForGitHubApps": true, @@ -345240,54 +346038,40 @@ ], "bodyParameters": [ { - "description": "

    Name of the project

    ", "type": "string", - "examples": [ - "Week One Sprint" - ], "name": "name", "in": "body", - "isRequired": false + "description": "

    Name of the project

    " }, { - "description": "

    Body of the project

    ", "type": "string or null", - "examples": [ - "This project represents the sprint of the first week in January" - ], "name": "body", "in": "body", - "isRequired": false + "description": "

    Body of the project

    " }, { - "description": "

    State of the project; either 'open' or 'closed'

    ", "type": "string", - "examples": [ - "open" - ], "name": "state", "in": "body", - "isRequired": false + "description": "

    State of the project; either 'open' or 'closed'

    " }, { - "description": "

    The baseline permission that all organization members have on this project

    ", "type": "string", + "name": "organization_permission", + "in": "body", + "description": "

    The baseline permission that all organization members have on this project

    ", "enum": [ "read", "write", "admin", "none" - ], - "name": "organization_permission", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether or not this project can be seen by everyone.

    ", "type": "boolean", "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether or not this project can be seen by everyone.

    " } ], "enabledForGitHubApps": true, @@ -346200,17 +346984,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the project.

    ", "name": "name", "in": "body", + "description": "

    The name of the project.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the project.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The description of the project.

    " } ], "enabledForGitHubApps": true, @@ -346598,24 +347381,17 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Name of the project

    ", "type": "string", - "examples": [ - "Week One Sprint" - ], "name": "name", "in": "body", + "description": "

    Name of the project

    ", "isRequired": true }, { - "description": "

    Body of the project

    ", "type": "string or null", - "examples": [ - "This project represents the sprint of the first week in January" - ], "name": "body", "in": "body", - "isRequired": false + "description": "

    Body of the project

    " } ], "enabledForGitHubApps": true, @@ -347775,24 +348551,16 @@ ], "bodyParameters": [ { - "description": "

    The project card's note

    ", "type": "string or null", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    The project card's note

    " }, { - "description": "

    Whether or not the card is archived

    ", "type": "boolean", - "examples": [ - false - ], "name": "archived", "in": "body", - "isRequired": false + "description": "

    Whether or not the card is archived

    " } ], "enabledForGitHubApps": true, @@ -348222,25 +348990,17 @@ ], "bodyParameters": [ { - "description": "

    The position of the card in a column. Can be one of: top, bottom, or after:<card_id> to place after the specified card.

    ", "type": "string", - "pattern": "^(?:top|bottom|after:\\d+)$", - "examples": [ - "bottom" - ], "name": "position", "in": "body", + "description": "

    The position of the card in a column. Can be one of: top, bottom, or after:<card_id> to place after the specified card.

    ", "isRequired": true }, { - "description": "

    The unique identifier of the column the card should be moved to

    ", "type": "integer", - "examples": [ - 42 - ], "name": "column_id", "in": "body", - "isRequired": false + "description": "

    The unique identifier of the column the card should be moved to

    " } ], "enabledForGitHubApps": true, @@ -348712,33 +349472,24 @@ ], "bodyParameters": [ { - "description": "

    The project card's note

    ", "type": "string or null", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", + "description": "

    The project card's note

    ", "isRequired": true }, { - "description": "

    The unique identifier of the content associated with the card

    ", "type": "integer", - "examples": [ - 42 - ], "name": "content_id", "in": "body", + "description": "

    The unique identifier of the content associated with the card

    ", "isRequired": true }, { - "description": "

    The piece of content associated with the card

    ", "type": "string", - "examples": [ - "PullRequest" - ], "name": "content_type", "in": "body", + "description": "

    The piece of content associated with the card

    ", "isRequired": true } ], @@ -349404,20 +350155,16 @@ ], "bodyParameters": [ { + "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant the collaborator.

    ", "enum": [ "read", "write", "admin" ], - "default": "write", - "type": "string", - "examples": [ - "write" - ], - "name": "permission", - "in": "body", - "isRequired": false + "default": "write" } ], "enabledForGitHubApps": true, @@ -349993,13 +350740,10 @@ ], "bodyParameters": [ { - "description": "

    Name of the project column

    ", "type": "string", - "examples": [ - "Remaining tasks" - ], "name": "name", "in": "body", + "description": "

    Name of the project column

    ", "isRequired": true } ], @@ -350205,14 +350949,10 @@ ], "bodyParameters": [ { - "description": "

    The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

    ", "type": "string", - "pattern": "^(?:first|last|after:\\d+)$", - "examples": [ - "last" - ], "name": "position", "in": "body", + "description": "

    The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

    ", "isRequired": true } ], @@ -350452,13 +351192,10 @@ ], "bodyParameters": [ { - "description": "

    Name of the project column

    ", "type": "string", - "examples": [ - "Remaining tasks" - ], "name": "name", "in": "body", + "description": "

    Name of the project column

    ", "isRequired": true } ], @@ -356190,55 +356927,47 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the new pull request. Required unless issue is specified.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the new pull request. Required unless issue is specified.

    " }, { "type": "string", - "description": "

    The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

    ", "name": "head", "in": "body", + "description": "

    The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

    ", "isRequired": true }, { "type": "string", - "description": "

    The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

    ", "name": "base", "in": "body", + "description": "

    The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    The contents of the pull request.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the pull request.

    " }, { "type": "boolean", - "description": "

    Indicates whether maintainers can modify the pull request.

    ", "name": "maintainer_can_modify", "in": "body", - "isRequired": false + "description": "

    Indicates whether maintainers can modify the pull request.

    " }, { "type": "boolean", - "description": "

    Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

    ", "name": "draft", "in": "body", - "isRequired": false + "description": "

    Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

    " }, { "type": "integer", - "description": "

    An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified.

    ", - "examples": [ - 1 - ], "name": "issue", "in": "body", - "isRequired": false + "description": "

    An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified.

    " } ], "enabledForGitHubApps": true, @@ -363875,42 +364604,37 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the pull request.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the pull request.

    " }, { "type": "string", - "description": "

    The contents of the pull request.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the pull request.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    State of this Pull Request. Either open or closed.

    ", "enum": [ "open", "closed" - ], - "name": "state", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "description": "

    The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

    ", "name": "base", "in": "body", - "isRequired": false + "description": "

    The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

    " }, { "type": "boolean", - "description": "

    Indicates whether maintainers can modify the pull request.

    ", "name": "maintainer_can_modify", "in": "body", - "isRequired": false + "description": "

    Indicates whether maintainers can modify the pull request.

    " } ], "enabledForGitHubApps": true, @@ -368854,36 +369578,32 @@ "bodyParameters": [ { "type": "string", - "description": "

    Title for the automatic commit message.

    ", "name": "commit_title", "in": "body", - "isRequired": false + "description": "

    Title for the automatic commit message.

    " }, { "type": "string", - "description": "

    Extra detail to append to automatic commit message.

    ", "name": "commit_message", "in": "body", - "isRequired": false + "description": "

    Extra detail to append to automatic commit message.

    " }, { "type": "string", - "description": "

    SHA that pull request head must match to allow merge.

    ", "name": "sha", "in": "body", - "isRequired": false + "description": "

    SHA that pull request head must match to allow merge.

    " }, { "type": "string", + "name": "merge_method", + "in": "body", "description": "

    Merge method to use. Possible values are merge, squash or rebase. Default is merge.

    ", "enum": [ "merge", "squash", "rebase" - ], - "name": "merge_method", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -369001,10 +369721,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

    ", "name": "expected_head_sha", "in": "body", - "isRequired": false + "description": "

    The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

    " } ], "enabledForGitHubApps": false, @@ -370393,9 +371112,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the reply to the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the reply to the review comment.

    ", "isRequired": true } ], @@ -371768,82 +372487,70 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the review comment.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

    ", "name": "commit_id", "in": "body", + "description": "

    The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

    ", "isRequired": true }, { "type": "string", - "description": "

    The relative path to the file that necessitates a comment.

    ", "name": "path", "in": "body", + "description": "

    The relative path to the file that necessitates a comment.

    ", "isRequired": true }, { "type": "integer", - "description": "

    This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    ", - "deprecated": true, - "x-github": { - "deprecationDate": "2022-11-01" - }, "name": "position", "in": "body", - "isRequired": false + "description": "

    This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    " }, { "type": "string", + "name": "side", + "in": "body", "description": "

    In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

    ", "enum": [ "LEFT", "RIGHT" - ], - "name": "side", - "in": "body", - "isRequired": false + ] }, { "type": "integer", - "description": "

    The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

    ", "name": "line", "in": "body", + "description": "

    The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

    ", "isRequired": true }, { "type": "integer", - "description": "

    Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

    ", "name": "start_line", "in": "body", - "isRequired": false + "description": "

    Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

    " }, { "type": "string", + "name": "start_side", + "in": "body", "description": "

    Required when using multi-line comments unless using in_reply_to. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

    ", "enum": [ "LEFT", "RIGHT", "side" - ], - "name": "start_side", - "in": "body", - "isRequired": false + ] }, { "type": "integer", - "description": "

    The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

    ", - "examples": [ - 2 - ], "name": "in_reply_to", "in": "body", - "isRequired": false + "description": "

    The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

    " } ], "enabledForGitHubApps": true, @@ -372492,9 +373199,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the review comment.

    ", "isRequired": true } ], @@ -373612,17 +374319,15 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of user logins that will be requested.

    ", "name": "reviewers", "in": "body", - "isRequired": false + "description": "

    An array of user logins that will be requested.

    " }, { "type": "array of strings", - "description": "

    An array of team slugs that will be requested.

    ", "name": "team_reviewers", "in": "body", - "isRequired": false + "description": "

    An array of team slugs that will be requested.

    " } ], "enabledForGitHubApps": true, @@ -379169,17 +379874,16 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of user logins that will be removed.

    ", "name": "reviewers", "in": "body", + "description": "

    An array of user logins that will be removed.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    An array of team slugs that will be removed.

    ", "name": "team_reviewers", "in": "body", - "isRequired": false + "description": "

    An array of team slugs that will be removed.

    " } ], "enabledForGitHubApps": true, @@ -385105,104 +385809,69 @@ "bodyParameters": [ { "type": "string", - "description": "

    The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

    ", "name": "commit_id", "in": "body", - "isRequired": false + "description": "

    The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

    " }, { "type": "string", - "description": "

    Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

    " }, { "type": "string", + "name": "event", + "in": "body", "description": "

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

    ", "enum": [ "APPROVE", "REQUEST_CHANGES", "COMMENT" - ], - "name": "event", - "in": "body", - "isRequired": false + ] }, { "type": "array of objects", - "description": "

    Use the following table to specify the location, destination, and contents of the draft review comment.

    ", "name": "comments", "in": "body", - "isRequired": false, + "description": "

    Use the following table to specify the location, destination, and contents of the draft review comment.

    ", "childParamsGroups": [ { - "parentName": "comments", - "parentType": "items", - "id": "comments-items", - "params": [ - { - "type": "string", - "description": "

    The relative path to the file that necessitates a review comment.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

    ", - "name": "position", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Text of the review comment.

    ", - "name": "body", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "examples": [ - 28 - ], - "name": "line", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "RIGHT" - ], - "name": "side", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "integer", - "examples": [ - 26 - ], - "name": "start_line", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "LEFT" - ], - "name": "start_side", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "path", + "description": "

    The relative path to the file that necessitates a review comment.

    ", + "isRequired": true + }, + { + "type": "integer", + "name": "position", + "description": "

    The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

    " + }, + { + "type": "string", + "name": "body", + "description": "

    Text of the review comment.

    ", + "isRequired": true + }, + { + "type": "integer", + "name": "line", + "description": "" + }, + { + "type": "string", + "name": "side", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + }, + { + "type": "string", + "name": "start_side", + "description": "" } ] } @@ -386049,9 +386718,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The body text of the pull request review.

    ", "name": "body", "in": "body", + "description": "

    The body text of the pull request review.

    ", "isRequired": true } ], @@ -387522,23 +388191,19 @@ "bodyParameters": [ { "type": "string", - "description": "

    The message for the pull request review dismissal

    ", "name": "message", "in": "body", + "description": "

    The message for the pull request review dismissal

    ", "isRequired": true }, { "type": "string", - "enum": [ - "DISMISS" - ], - "examples": [ - "\"DISMISS\"" - ], "name": "event", "in": "body", "description": "", - "isRequired": false + "enum": [ + "DISMISS" + ] } ], "enabledForGitHubApps": true, @@ -387964,22 +388629,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The body text of the pull request review

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The body text of the pull request review

    " }, { "type": "string", + "name": "event", + "in": "body", "description": "

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.

    ", + "isRequired": true, "enum": [ "APPROVE", "REQUEST_CHANGES", "COMMENT" - ], - "name": "event", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -389095,7 +389759,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -389105,10 +389772,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -390135,7 +390799,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -390145,10 +390812,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -391167,7 +391831,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the commit comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -391177,10 +391844,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -392203,7 +392867,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the issue comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -392213,10 +392880,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -393243,7 +393907,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the issue.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -393253,10 +393920,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -394279,7 +394943,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the pull request review comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -394289,10 +394956,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -395313,7 +395977,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the release.

    ", + "isRequired": true, "enum": [ "+1", "laugh", @@ -395321,10 +395988,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -396343,7 +397007,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -396353,10 +397020,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -397008,7 +397672,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -397018,10 +397685,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -398068,55 +398732,46 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the tag.

    ", "name": "tag_name", "in": "body", + "description": "

    The name of the tag.

    ", "isRequired": true }, { "type": "string", - "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    ", "name": "target_commitish", "in": "body", - "isRequired": false + "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    " }, { "type": "string", - "description": "

    The name of the release.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the release.

    " }, { "type": "string", - "description": "

    Text describing the contents of the tag.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Text describing the contents of the tag.

    " }, { "type": "boolean", - "description": "

    true to create a draft (unpublished) release, false to create a published one.

    ", - "default": false, "name": "draft", "in": "body", - "isRequired": false + "description": "

    true to create a draft (unpublished) release, false to create a published one.

    " }, { "type": "boolean", - "description": "

    true to identify the release as a prerelease. false to identify the release as a full release.

    ", - "default": false, "name": "prerelease", "in": "body", - "isRequired": false + "description": "

    true to identify the release as a prerelease. false to identify the release as a full release.

    " }, { "type": "boolean", - "description": "

    Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes.

    ", - "default": false, "name": "generate_release_notes", "in": "body", - "isRequired": false + "description": "

    Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes.

    " } ], "enabledForGitHubApps": true, @@ -398842,31 +399497,28 @@ "bodyParameters": [ { "type": "string", - "description": "

    The tag name for the release. This can be an existing tag or a new one.

    ", "name": "tag_name", "in": "body", + "description": "

    The tag name for the release. This can be an existing tag or a new one.

    ", "isRequired": true }, { "type": "string", - "description": "

    Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.

    ", "name": "target_commitish", "in": "body", - "isRequired": false + "description": "

    Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.

    " }, { "type": "string", - "description": "

    The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.

    ", "name": "previous_tag_name", "in": "body", - "isRequired": false + "description": "

    The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.

    " }, { "type": "string", - "description": "

    Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.

    ", "name": "configuration_file_path", "in": "body", - "isRequired": false + "description": "

    Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.

    " } ], "enabledForGitHubApps": true, @@ -401123,45 +401775,39 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the tag.

    ", "name": "tag_name", "in": "body", - "isRequired": false + "description": "

    The name of the tag.

    " }, { "type": "string", - "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    ", "name": "target_commitish", "in": "body", - "isRequired": false + "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    " }, { "type": "string", - "description": "

    The name of the release.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the release.

    " }, { "type": "string", - "description": "

    Text describing the contents of the tag.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Text describing the contents of the tag.

    " }, { "type": "boolean", - "description": "

    true makes the release a draft, and false publishes the release.

    ", "name": "draft", "in": "body", - "isRequired": false + "description": "

    true makes the release a draft, and false publishes the release.

    " }, { "type": "boolean", - "description": "

    true to identify the release as a prerelease, false to identify the release as a full release.

    ", "name": "prerelease", "in": "body", - "isRequired": false + "description": "

    true to identify the release as a prerelease, false to identify the release as a full release.

    " } ], "enabledForGitHubApps": true, @@ -402309,27 +402955,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The file name of the asset.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The file name of the asset.

    " }, { "type": "string", - "description": "

    An alternate short description of the asset. Used in place of the filename.

    ", "name": "label", "in": "body", - "isRequired": false + "description": "

    An alternate short description of the asset. Used in place of the filename.

    " }, { "type": "string", - "examples": [ - "\"uploaded\"" - ], "name": "state", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -405797,199 +406437,171 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the repository.

    ", "name": "name", "in": "body", + "description": "

    The name of the repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short description of the repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { "type": "string", - "description": "

    A URL with more information about the repository.

    ", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { "type": "boolean", - "description": "

    Whether the repository is private.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether the repository is private.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.

    ", "enum": [ "public", "private", "internal" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Either true to enable issues for this repository or false to disable them.

    ", - "default": true, "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Either true to enable issues for this repository or false to disable them.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", - "default": true, "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", - "default": true, "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    ", - "default": false, "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    " }, { "type": "integer", - "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    ", "name": "team_id", "in": "body", - "isRequired": false + "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    " }, { "type": "boolean", - "description": "

    Pass true to create an initial commit with empty README.

    ", - "default": false, "name": "auto_init", "in": "body", - "isRequired": false + "description": "

    Pass true to create an initial commit with empty README.

    " }, { "type": "string", - "description": "

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

    ", "name": "gitignore_template", "in": "body", - "isRequired": false + "description": "

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

    " }, { "type": "string", - "description": "

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

    ", "name": "license_template", "in": "body", - "isRequired": false + "description": "

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", - "default": true, "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", - "default": true, "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", - "default": true, "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    ", - "default": false, "name": "allow_auto_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    " }, { "type": "boolean", - "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    ", - "default": false, "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    ", - "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -413381,295 +413993,78 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the repository.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the repository.

    " }, { "type": "string", - "description": "

    A short description of the repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { "type": "string", - "description": "

    A URL with more information about the repository.

    ", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { "type": "boolean", - "description": "

    Either true to make the repository private or false to make it public. Default: false.
    \nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Either true to make the repository private or false to make it public. Default: false.
    \nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal.\"

    ", "enum": [ "public", "private", "internal" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { "type": "object or null", - "description": "

    Specify which security and analysis features to enable or disable for the repository.

    \n

    To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

    \n

    For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.

    \n

    You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

    ", - "properties": { - "advanced_security": { - "type": "object", - "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "advanced_security", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", - "childParamsGroups": [ - { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - "secret_scanning": { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", - "childParamsGroups": [ - { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - "secret_scanning_push_protection": { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning_push_protection", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", - "childParamsGroups": [ - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - } - }, "name": "security_and_analysis", "in": "body", - "isRequired": false, + "description": "

    Specify which security and analysis features to enable or disable for the repository.

    \n

    To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

    \n

    For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.

    \n

    You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

    ", "childParamsGroups": [ { - "parentName": "security_and_analysis", - "parentType": "object", - "id": "security_and_analysis-object", - "params": [ + "type": "object", + "name": "advanced_security", + "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", + "childParamsGroups": [ { - "type": "object", - "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "advanced_security", - "in": "body", - "childParamsGroups": [ - { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning", - "in": "body", - "childParamsGroups": [ - { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning_push_protection", - "in": "body", - "childParamsGroups": [ - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] + "type": "string", + "name": "status", + "description": "

    Can be enabled or disabled.

    " } ] }, { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ + "type": "object", + "name": "secret_scanning", + "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    Can be enabled or disabled.

    ", "name": "status", - "in": "body" + "description": "

    Can be enabled or disabled.

    " } ] }, { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ + "type": "object", + "name": "secret_scanning_push_protection", + "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    Can be enabled or disabled.

    ", "name": "status", - "in": "body" - } - ] - }, - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" + "description": "

    Can be enabled or disabled.

    " } ] } @@ -413677,160 +414072,135 @@ }, { "type": "boolean", - "description": "

    Either true to enable issues for this repository or false to disable them.

    ", - "default": true, "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Either true to enable issues for this repository or false to disable them.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", - "default": true, "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", - "default": true, "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    ", - "default": false, "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    " }, { "type": "string", - "description": "

    Updates the default branch for this repository.

    ", "name": "default_branch", "in": "body", - "isRequired": false + "description": "

    Updates the default branch for this repository.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", - "default": true, "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", - "default": true, "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", - "default": true, "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    ", - "default": false, "name": "allow_auto_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    " }, { "type": "boolean", - "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    ", - "default": false, "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    " }, { "type": "boolean", - "description": "

    Either true to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.

    ", - "default": false, "name": "allow_update_branch", "in": "body", - "isRequired": false + "description": "

    Either true to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    ", - "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    true to archive this repository. Note: You cannot unarchive repositories through the API.

    ", - "default": false, "name": "archived", "in": "body", - "isRequired": false + "description": "

    true to archive this repository. Note: You cannot unarchive repositories through the API.

    " }, { "type": "boolean", - "description": "

    Either true to allow private forks, or false to prevent private forks.

    ", - "default": false, "name": "allow_forking", "in": "body", - "isRequired": false + "description": "

    Either true to allow private forks, or false to prevent private forks.

    " } ], "enabledForGitHubApps": true, @@ -420107,21 +420477,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    A custom webhook event name. Must be 100 characters or fewer.

    ", - "minLength": 1, - "maxLength": 100, "name": "event_type", "in": "body", + "description": "

    A custom webhook event name. Must be 100 characters or fewer.

    ", "isRequired": true }, { "type": "object", - "description": "

    JSON payload with extra information about the webhook event that your action or workflow may use.

    ", - "additionalProperties": true, - "maxProperties": 10, "name": "client_payload", "in": "body", - "isRequired": false + "description": "

    JSON payload with extra information about the webhook event that your action or workflow may use.

    " } ], "enabledForGitHubApps": true, @@ -420948,9 +421313,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

    ", "name": "names", "in": "body", + "description": "

    An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

    ", "isRequired": true } ], @@ -421053,17 +421418,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The username or organization name the repository will be transferred to.

    ", "name": "new_owner", "in": "body", + "description": "

    The username or organization name the repository will be transferred to.

    ", "isRequired": true }, { "type": "array of integers", - "description": "

    ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

    ", "name": "team_ids", "in": "body", - "isRequired": false + "description": "

    ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

    " } ], "enabledForGitHubApps": true, @@ -423475,40 +423839,34 @@ "bodyParameters": [ { "type": "string", - "description": "

    The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

    ", "name": "owner", "in": "body", - "isRequired": false + "description": "

    The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

    " }, { "type": "string", - "description": "

    The name of the new repository.

    ", "name": "name", "in": "body", + "description": "

    The name of the new repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short description of the new repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the new repository.

    " }, { "type": "boolean", - "description": "

    Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.

    ", - "default": false, "name": "include_all_branches", "in": "body", - "isRequired": false + "description": "

    Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.

    " }, { "type": "boolean", - "description": "

    Either true to create a new private repository or false to create a new public one.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Either true to create a new private repository or false to create a new public one.

    " } ], "enabledForGitHubApps": false, @@ -428969,227 +429327,162 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The name of the repository.

    ", "type": "string", - "examples": [ - "Team Environment" - ], "name": "name", "in": "body", + "description": "

    The name of the repository.

    ", "isRequired": true }, { - "description": "

    A short description of the repository.

    ", "type": "string", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { - "description": "

    A URL with more information about the repository.

    ", "type": "string", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { - "description": "

    Whether the repository is private.

    ", - "default": false, "type": "boolean", "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether the repository is private.

    " }, { - "description": "

    Whether issues are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Whether issues are enabled.

    ", + "default": true }, { - "description": "

    Whether projects are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Whether projects are enabled.

    ", + "default": true }, { - "description": "

    Whether the wiki is enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Whether the wiki is enabled.

    ", + "default": true }, { - "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    ", "type": "integer", "name": "team_id", "in": "body", - "isRequired": false + "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    " }, { - "description": "

    Whether the repository is initialized with a minimal README.

    ", - "default": false, "type": "boolean", "name": "auto_init", "in": "body", - "isRequired": false + "description": "

    Whether the repository is initialized with a minimal README.

    " }, { - "description": "

    The desired language or platform to apply to the .gitignore.

    ", "type": "string", - "examples": [ - "Haskell" - ], "name": "gitignore_template", "in": "body", - "isRequired": false + "description": "

    The desired language or platform to apply to the .gitignore.

    " }, { - "description": "

    The license keyword of the open source license for this repository.

    ", "type": "string", - "examples": [ - "mit" - ], "name": "license_template", "in": "body", - "isRequired": false + "description": "

    The license keyword of the open source license for this repository.

    " }, { - "description": "

    Whether to allow squash merges for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Whether to allow squash merges for pull requests.

    ", + "default": true }, { - "description": "

    Whether to allow merge commits for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Whether to allow merge commits for pull requests.

    ", + "default": true }, { - "description": "

    Whether to allow rebase merges for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Whether to allow rebase merges for pull requests.

    ", + "default": true }, { - "description": "

    Whether to allow Auto-merge to be used on pull requests.

    ", - "default": false, "type": "boolean", - "examples": [ - false - ], "name": "allow_auto_merge", "in": "body", - "isRequired": false + "description": "

    Whether to allow Auto-merge to be used on pull requests.

    " }, { - "description": "

    Whether to delete head branches when pull requests are merged

    ", - "default": false, "type": "boolean", - "examples": [ - false - ], "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Whether to delete head branches when pull requests are merged

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether downloads are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_downloads", "in": "body", - "isRequired": false + "description": "

    Whether downloads are enabled.

    ", + "default": true }, { - "description": "

    Whether this repository acts as a template that can be used to generate new repositories.

    ", - "default": false, "type": "boolean", - "examples": [ - true - ], "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Whether this repository acts as a template that can be used to generate new repositories.

    " } ], "enabledForGitHubApps": false, @@ -433213,16 +433506,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.

    ", "name": "key_prefix", "in": "body", + "description": "

    The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.

    ", "isRequired": true }, { "type": "string", - "description": "

    The URL must contain <num> for the reference number.

    ", "name": "url_template", "in": "body", + "description": "

    The URL must contain <num> for the reference number.

    ", "isRequired": true } ], @@ -435291,7 +435584,7 @@ } ], "previews": [], - "descriptionHTML": "

    Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

    \n

    Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

    \n

    Note:

    \n
      \n
    • To get a repository's contents recursively, you can recursively get the tree.
      • \n
    • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
      • \n
    • This API supports files up to 1 megabyte in size.
      • \n
    \n

    If the content is a directory

    \n

    The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

    \n

    If the content is a symlink

    \n

    If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

    \n

    If the content is a submodule

    \n

    The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

    \n

    If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

    ", + "descriptionHTML": "

    Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

    \n

    Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

    \n

    Notes:

    \n
      \n
    • To get a repository's contents recursively, you can recursively get the tree.
      • \n
    • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
      • \n
    • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
      • \n
    • This API supports files up to 1 megabyte in size.
      • \n
    \n

    If the content is a directory

    \n

    The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

    \n

    If the content is a symlink

    \n

    If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

    \n

    If the content is a submodule

    \n

    The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

    \n

    If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

    ", "statusCodes": [ { "httpStatusCode": "200", @@ -435351,185 +435644,77 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message.

    ", "name": "message", "in": "body", + "description": "

    The commit message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The new file content, using Base64 encoding.

    ", "name": "content", "in": "body", + "description": "

    The new file content, using Base64 encoding.

    ", "isRequired": true }, { "type": "string", - "description": "

    Required if you are updating a file. The blob SHA of the file being replaced.

    ", "name": "sha", "in": "body", - "isRequired": false + "description": "

    Required if you are updating a file. The blob SHA of the file being replaced.

    " }, { "type": "string", - "description": "

    The branch name. Default: the repository’s default branch (usually master)

    ", "name": "branch", "in": "body", - "isRequired": false + "description": "

    The branch name. Default: the repository’s default branch (usually master)

    " }, { "type": "object", - "description": "

    The person that committed the file. Default: the authenticated user.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "examples": [ - "\"2013-01-05T13:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "committer", "in": "body", - "isRequired": false, + "description": "

    The person that committed the file. Default: the authenticated user.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "examples": [ - "\"2013-01-05T13:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "" } ] }, { "type": "object", - "description": "

    The author of the file. Default: The committer or the authenticated user if you omit committer.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "examples": [ - "\"2013-01-15T17:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "author", "in": "body", - "isRequired": false, + "description": "

    The author of the file. Default: The committer or the authenticated user if you omit committer.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "examples": [ - "\"2013-01-15T17:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "" } ] } @@ -436077,118 +436262,57 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message.

    ", "name": "message", "in": "body", + "description": "

    The commit message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The blob SHA of the file being replaced.

    ", "name": "sha", "in": "body", + "description": "

    The blob SHA of the file being replaced.

    ", "isRequired": true }, { "type": "string", - "description": "

    The branch name. Default: the repository’s default branch (usually master)

    ", "name": "branch", "in": "body", - "isRequired": false + "description": "

    The branch name. Default: the repository’s default branch (usually master)

    " }, { "type": "object", - "description": "

    object containing information about the committer.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - } - }, "name": "committer", "in": "body", - "isRequired": false, + "description": "

    object containing information about the committer.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " } ] }, { "type": "object", - "description": "

    object containing information about the author.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - } - }, "name": "author", "in": "body", - "isRequired": false, + "description": "

    object containing information about the author.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " } ] } @@ -439348,10 +439472,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    Optional parameter to specify the organization name if forking into an organization.

    ", "name": "organization", "in": "body", - "isRequired": false + "description": "

    Optional parameter to specify the organization name if forking into an organization.

    " } ], "enabledForGitHubApps": true, @@ -445409,9 +445532,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    An optional glob pattern to match against when enforcing tag protection.

    ", "name": "pattern", "in": "body", + "description": "

    An optional glob pattern to match against when enforcing tag protection.

    ", "isRequired": true } ], @@ -450957,7 +451080,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] }, @@ -458665,18 +458789,20 @@ ], "bodyParameters": [ { - "description": "

    Sets the state of the secret scanning alert. Can be either open or resolved. You must provide resolution when you set the state to resolved.

    ", "type": "string", + "name": "state", + "in": "body", + "description": "

    Sets the state of the secret scanning alert. Can be either open or resolved. You must provide resolution when you set the state to resolved.

    ", + "isRequired": true, "enum": [ "open", "resolved" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", + "name": "resolution", + "in": "body", "description": "

    Required when the state is resolved. The reason for resolving the alert.

    ", "enum": [ null, @@ -458684,10 +458810,7 @@ "wont_fix", "revoked", "used_in_tests" - ], - "name": "resolution", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -459557,68 +459680,61 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", + "description": "

    The name of the team.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "array of strings", - "description": "

    List GitHub IDs for organization members who will become team maintainers.

    ", "name": "maintainers", "in": "body", - "isRequired": false + "description": "

    List GitHub IDs for organization members who will become team maintainers.

    " }, { "type": "array of strings", - "description": "

    The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

    ", "name": "repo_names", "in": "body", - "isRequired": false + "description": "

    The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nDefault: secret
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.
    \nDefault for child team: closed

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " }, { "type": "string", - "description": "

    The distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"Update LDAP mapping for a team\" endpoint to change the LDAP DN. For more information, see \"Using LDAP.\"

    ", "name": "ldap_dn", "in": "body", - "isRequired": false + "description": "

    The distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"Update LDAP mapping for a team\" endpoint to change the LDAP DN. For more information, see \"Using LDAP.\"

    " } ], "enabledForGitHubApps": true, @@ -459914,8 +460030,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -460639,8 +460755,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -461075,48 +461191,43 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the team.

    " }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push", "admin" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer or null", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " } ], "enabledForGitHubApps": true, @@ -461412,8 +461523,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -462639,15 +462750,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"

    ", "enum": [ "read", "write", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -467692,11 +467802,10 @@ "bodyParameters": [ { "type": "string", - "description": "

    The permission to grant the team on this repository. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", - "default": "push", "name": "permission", "in": "body", - "isRequired": false + "description": "

    The permission to grant the team on this repository. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", + "default": "push" } ], "enabledForGitHubApps": true, @@ -468417,8 +468526,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -468844,48 +468953,44 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", + "description": "

    The name of the team.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push", "admin" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer or null", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " } ], "enabledForGitHubApps": true, @@ -469180,8 +469285,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -469862,8 +469967,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -471078,15 +471183,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"

    ", "enum": [ "read", "write", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -476108,15 +476212,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant the team on this repository. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", "enum": [ "pull", "push", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -476843,8 +476946,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -477761,9 +477864,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -478640,9 +478743,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -479594,9 +479697,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -480453,9 +480556,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -481451,25 +481554,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", + "description": "

    The discussion post's title.

    ", "isRequired": true }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion post's body text.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    " } ], "enabledForGitHubApps": true, @@ -482414,17 +482515,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The discussion post's title.

    " }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The discussion post's body text.

    " } ], "enabledForGitHubApps": true, @@ -483433,25 +483532,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", + "description": "

    The discussion post's title.

    ", "isRequired": true }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion post's body text.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    " } ], "enabledForGitHubApps": true, @@ -484376,17 +484473,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The discussion post's title.

    " }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The discussion post's body text.

    " } ], "enabledForGitHubApps": true, @@ -485305,15 +485400,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role that this user should have in the team.

    ", "enum": [ "member", "maintainer" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -486052,15 +486146,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role that this user should have in the team.

    ", "enum": [ "member", "maintainer" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -487517,78 +487610,52 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The new name of the user.

    ", "type": "string", - "examples": [ - "Omar Jahandar" - ], "name": "name", "in": "body", - "isRequired": false + "description": "

    The new name of the user.

    " }, { - "description": "

    The publicly visible email address of the user.

    ", "type": "string", - "examples": [ - "omar@example.com" - ], "name": "email", "in": "body", - "isRequired": false + "description": "

    The publicly visible email address of the user.

    " }, { - "description": "

    The new blog URL of the user.

    ", "type": "string", - "examples": [ - "blog.example.com" - ], "name": "blog", "in": "body", - "isRequired": false + "description": "

    The new blog URL of the user.

    " }, { - "description": "

    The new Twitter username of the user.

    ", "type": "string or null", - "examples": [ - "therealomarj" - ], "name": "twitter_username", "in": "body", - "isRequired": false + "description": "

    The new Twitter username of the user.

    " }, { - "description": "

    The new company of the user.

    ", "type": "string", - "examples": [ - "Acme corporation" - ], "name": "company", "in": "body", - "isRequired": false + "description": "

    The new company of the user.

    " }, { - "description": "

    The new location of the user.

    ", "type": "string", - "examples": [ - "Berlin, Germany" - ], "name": "location", "in": "body", - "isRequired": false + "description": "

    The new location of the user.

    " }, { - "description": "

    The new hiring availability of the user.

    ", "type": "boolean", "name": "hireable", "in": "body", - "isRequired": false + "description": "

    The new hiring availability of the user.

    " }, { - "description": "

    The new short biography of the user.

    ", "type": "string", "name": "bio", "in": "body", - "isRequired": false + "description": "

    The new short biography of the user.

    " } ], "enabledForGitHubApps": false, @@ -489813,11 +489880,10 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", "type": "array of strings", - "examples": [], "name": "emails", "in": "body", + "description": "

    Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", "isRequired": true } ], @@ -489947,10 +490013,10 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Email addresses associated with the GitHub user account.

    ", "type": "array of strings", "name": "emails", "in": "body", + "description": "

    Email addresses associated with the GitHub user account.

    ", "isRequired": true } ], @@ -491663,10 +491729,10 @@ "parameters": [], "bodyParameters": [ { - "description": "

    A GPG key in ASCII-armored format.

    ", "type": "string", "name": "armored_public_key", "in": "body", + "description": "

    A GPG key in ASCII-armored format.

    ", "isRequired": true } ], @@ -492682,21 +492748,16 @@ "parameters": [], "bodyParameters": [ { - "description": "

    A descriptive name for the new key.

    ", "type": "string", - "examples": [ - "Personal MacBook Air" - ], "name": "title", "in": "body", - "isRequired": false + "description": "

    A descriptive name for the new key.

    " }, { - "description": "

    The public SSH key to add to your GitHub account.

    ", "type": "string", - "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ", "name": "key", "in": "body", + "description": "

    The public SSH key to add to your GitHub account.

    ", "isRequired": true } ], @@ -493210,53 +493271,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": true, @@ -494291,188 +494326,63 @@ "bodyParameters": [ { "type": "string", - "description": "

    Use web to create a webhook. Default: web. This parameter only accepts the value web.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    Use web to create a webhook. Default: web. This parameter only accepts the value web.

    " }, { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "childParamsGroups": [] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ], - "name": "token", - "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ], - "name": "digest", - "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] - } - }, "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body" - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body" - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body" - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " - }, - { - "type": "string", - "examples": [ - "\"abc\"" - ], - "name": "token", - "in": "body", - "description": "" - }, - { - "type": "string", - "examples": [ - "\"sha256\"" - ], - "name": "digest", - "in": "body", - "description": "" - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    " + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "token", + "description": "" + }, + { + "type": "string", + "name": "digest", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, @@ -495098,210 +495008,70 @@ "bodyParameters": [ { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - }, - "address": { - "type": "string", - "examples": [ - "\"bar@example.com\"" - ], - "name": "address", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "room": { - "type": "string", - "examples": [ - "\"The Serious Room\"" - ], - "name": "room", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"bar@example.com\"" - ], - "name": "address", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"The Serious Room\"" - ], - "name": "room", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "address", + "description": "" + }, + { + "type": "string", + "name": "room", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for. This replaces the entire array of events.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "array of strings", - "description": "

    Determines a list of events to be added to the list of events that the Hook triggers for.

    ", "name": "add_events", "in": "body", - "isRequired": false + "description": "

    Determines a list of events to be added to the list of events that the Hook triggers for.

    " }, { "type": "array of strings", - "description": "

    Determines a list of events to be removed from the list of events that the Hook triggers for.

    ", "name": "remove_events", "in": "body", - "isRequired": false + "description": "

    Determines a list of events to be removed from the list of events that the Hook triggers for.

    " }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, diff --git a/lib/rest/static/decorated/ghes-3.6.json b/lib/rest/static/decorated/ghes-3.6.json index 6cf4441923..3b5fa4e904 100644 --- a/lib/rest/static/decorated/ghes-3.6.json +++ b/lib/rest/static/decorated/ghes-3.6.json @@ -1024,24 +1024,16 @@ ], "bodyParameters": [ { - "description": "

    For repositories in an enterprise, the default size limit for the sum of all caches in a repository, in gigabytes.

    ", "type": "integer", - "examples": [ - 10 - ], "name": "repo_cache_size_limit_in_gb", "in": "body", - "isRequired": false + "description": "

    For repositories in an enterprise, the default size limit for the sum of all caches in a repository, in gigabytes.

    " }, { - "description": "

    For repositories in an enterprise, the maximum value that can be set as the limit for the sum of all caches in a repository, in gigabytes.

    ", "type": "integer", - "examples": [ - 15 - ], "name": "max_repo_cache_size_limit_in_gb", "in": "body", - "isRequired": false + "description": "

    For repositories in an enterprise, the maximum value that can be set as the limit for the sum of all caches in a repository, in gigabytes.

    " } ], "enabledForGitHubApps": true, @@ -1468,13 +1460,10 @@ ], "bodyParameters": [ { - "description": "

    The size limit for the sum of all caches, in gigabytes.

    ", "type": "integer", - "examples": [ - 14 - ], "name": "repo_cache_size_limit_in_gb", "in": "body", + "description": "

    The size limit for the sum of all caches, in gigabytes.

    ", "isRequired": true } ], @@ -1617,27 +1606,26 @@ "bodyParameters": [ { "type": "string", + "name": "enabled_organizations", + "in": "body", "description": "

    The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.

    ", + "isRequired": true, "enum": [ "all", "none", "selected" - ], - "name": "enabled_organizations", - "in": "body", - "isRequired": true + ] }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": false, @@ -1888,10 +1876,10 @@ ], "bodyParameters": [ { - "description": "

    List of organization IDs to enable for GitHub Actions.

    ", "type": "array of integers", "name": "selected_organization_ids", "in": "body", + "description": "

    List of organization IDs to enable for GitHub Actions.

    ", "isRequired": true } ], @@ -2133,16 +2121,16 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", + "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "isRequired": true } ], @@ -2273,21 +2261,19 @@ "bodyParameters": [ { "type": "string", + "name": "default_workflow_permissions", + "in": "body", "description": "

    The default workflow permissions granted to the GITHUB_TOKEN when running workflows.

    ", "enum": [ "read", "write" - ], - "name": "default_workflow_permissions", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

    ", "name": "can_approve_pull_request_reviews", "in": "body", - "isRequired": false + "description": "

    Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

    " } ], "enabledForGitHubApps": true, @@ -2427,27 +2413,26 @@ "bodyParameters": [ { "type": "string", + "name": "enabled_repositories", + "in": "body", "description": "

    The policy that controls the repositories in the organization that are allowed to run GitHub Actions.

    ", + "isRequired": true, "enum": [ "all", "none", "selected" - ], - "name": "enabled_repositories", - "in": "body", - "isRequired": true + ] }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -4163,10 +4148,10 @@ ], "bodyParameters": [ { - "description": "

    List of repository IDs to enable for GitHub Actions.

    ", "type": "array of integers", "name": "selected_repository_ids", "in": "body", + "description": "

    List of repository IDs to enable for GitHub Actions.

    ", "isRequired": true } ], @@ -4408,16 +4393,16 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", + "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "isRequired": true } ], @@ -4548,21 +4533,19 @@ "bodyParameters": [ { "type": "string", + "name": "default_workflow_permissions", + "in": "body", "description": "

    The default workflow permissions granted to the GITHUB_TOKEN when running workflows.

    ", "enum": [ "read", "write" - ], - "name": "default_workflow_permissions", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

    ", "name": "can_approve_pull_request_reviews", "in": "body", - "isRequired": false + "description": "

    Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

    " } ], "enabledForGitHubApps": true, @@ -4716,22 +4699,21 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub Actions is enabled on the repository.

    ", "name": "enabled", "in": "body", + "description": "

    Whether GitHub Actions is enabled on the repository.

    ", "isRequired": true }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -4872,15 +4854,15 @@ "bodyParameters": [ { "type": "string", + "name": "access_level", + "in": "body", "description": "

    Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository. none means access is only possible from workflows in this repository.

    ", + "isRequired": true, "enum": [ "none", "organization", "enterprise" - ], - "name": "access_level", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -5028,16 +5010,16 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", + "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "isRequired": true } ], @@ -5188,21 +5170,19 @@ "bodyParameters": [ { "type": "string", + "name": "default_workflow_permissions", + "in": "body", "description": "

    The default workflow permissions granted to the GITHUB_TOKEN when running workflows.

    ", "enum": [ "read", "write" - ], - "name": "default_workflow_permissions", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

    ", "name": "can_approve_pull_request_reviews", "in": "body", - "isRequired": false + "description": "

    Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

    " } ], "enabledForGitHubApps": true, @@ -5626,37 +5606,33 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret.

    ", + "isRequired": true, "enum": [ "all", "private", "selected" - ], - "name": "visibility", - "in": "body", - "isRequired": true + ] }, { "type": "array of integers", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", - "isRequired": false + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    " } ], "enabledForGitHubApps": true, @@ -8186,9 +8162,9 @@ "bodyParameters": [ { "type": "array of integers", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "isRequired": true } ], @@ -8740,18 +8716,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " } ], "enabledForGitHubApps": true, @@ -9263,17 +9236,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

    ", "isRequired": true }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", + "description": "

    ID of the key you used to encrypt the secret.

    ", "isRequired": true } ], @@ -9617,59 +9589,51 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all organizations or select individual organization.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all organizations or select individual organization.

    ", "enum": [ "selected", "all" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { - "description": "

    List of organization IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_organization_ids", "in": "body", - "isRequired": false + "description": "

    List of organization IDs that can access the runner group.

    " }, { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", - "isRequired": false + "description": "

    List of runner IDs to add to the runner group.

    " }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " }, { - "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    ", "type": "boolean", - "default": false, "name": "restricted_to_workflows", "in": "body", - "isRequired": false + "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    " }, { - "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    ", "type": "array of strings", "name": "selected_workflows", "in": "body", - "isRequired": false + "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    " } ], "enabledForGitHubApps": false, @@ -9935,46 +9899,39 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", - "isRequired": false + "description": "

    Name of the runner group.

    " }, { - "description": "

    Visibility of a runner group. You can select all organizations or select individual organizations.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all organizations or select individual organizations.

    ", "enum": [ "selected", "all" ], - "default": "all", - "name": "visibility", - "in": "body", - "isRequired": false + "default": "all" }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " }, { - "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    ", "type": "boolean", - "default": false, "name": "restricted_to_workflows", "in": "body", - "isRequired": false + "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    " }, { - "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    ", "type": "array of strings", "name": "selected_workflows", "in": "body", - "isRequired": false + "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    " } ], "enabledForGitHubApps": false, @@ -10370,10 +10327,10 @@ ], "bodyParameters": [ { - "description": "

    List of organization IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_organization_ids", "in": "body", + "description": "

    List of organization IDs that can access the runner group.

    ", "isRequired": true } ], @@ -10792,10 +10749,10 @@ ], "bodyParameters": [ { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", + "description": "

    List of runner IDs to add to the runner group.

    ", "isRequired": true } ], @@ -11180,61 +11137,53 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

    ", "enum": [ "selected", "all", "private" ], - "default": "all", - "name": "visibility", - "in": "body", - "isRequired": false + "default": "all" }, { - "description": "

    List of repository IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_repository_ids", "in": "body", - "isRequired": false + "description": "

    List of repository IDs that can access the runner group.

    " }, { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", - "isRequired": false + "description": "

    List of runner IDs to add to the runner group.

    " }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " }, { - "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    ", "type": "boolean", - "default": false, "name": "restricted_to_workflows", "in": "body", - "isRequired": false + "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    " }, { - "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    ", "type": "array of strings", "name": "selected_workflows", "in": "body", - "isRequired": false + "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    " } ], "enabledForGitHubApps": true, @@ -11518,46 +11467,40 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

    ", "enum": [ "selected", "all", "private" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " }, { - "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    ", "type": "boolean", - "default": false, "name": "restricted_to_workflows", "in": "body", - "isRequired": false + "description": "

    If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

    " }, { - "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    ", "type": "array of strings", "name": "selected_workflows", "in": "body", - "isRequired": false + "description": "

    List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

    " } ], "enabledForGitHubApps": true, @@ -14294,10 +14237,10 @@ ], "bodyParameters": [ { - "description": "

    List of repository IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_repository_ids", "in": "body", + "description": "

    List of repository IDs that can access the runner group.

    ", "isRequired": true } ], @@ -14716,10 +14659,10 @@ ], "bodyParameters": [ { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", + "description": "

    List of runner IDs to add to the runner group.

    ", "isRequired": true } ], @@ -18713,11 +18656,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "maxItems": 100, - "description": "

    The names of the custom labels to add to the runner.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to add to the runner.

    ", "isRequired": true } ], @@ -18860,11 +18801,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 0, - "maxItems": 100, - "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "isRequired": true } ], @@ -23070,11 +23009,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "maxItems": 100, - "description": "

    The names of the custom labels to add to the runner.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to add to the runner.

    ", "isRequired": true } ], @@ -23217,11 +23154,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 0, - "maxItems": 100, - "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "isRequired": true } ], @@ -27502,11 +27437,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "maxItems": 100, - "description": "

    The names of the custom labels to add to the runner.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to add to the runner.

    ", "isRequired": true } ], @@ -27659,11 +27592,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 0, - "maxItems": 100, - "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "name": "labels", "in": "body", + "description": "

    The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

    ", "isRequired": true } ], @@ -29566,11 +29497,9 @@ "bodyParameters": [ { "type": "boolean", - "default": false, - "description": "

    Whether to enable debug logging for the re-run.

    ", "name": "enable_debug_logging", "in": "body", - "isRequired": false + "description": "

    Whether to enable debug logging for the re-run.

    " } ], "enabledForGitHubApps": true, @@ -47442,37 +47371,27 @@ "bodyParameters": [ { "type": "array of integers", - "description": "

    The list of environment ids to approve or reject

    ", - "examples": [ - 161171787, - 161171795 - ], "name": "environment_ids", "in": "body", + "description": "

    The list of environment ids to approve or reject

    ", "isRequired": true }, { "type": "string", + "name": "state", + "in": "body", "description": "

    Whether to approve or reject deployment to the specified environments.

    ", + "isRequired": true, "enum": [ "approved", "rejected" - ], - "examples": [ - "approved" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    A comment to accompany the deployment review

    ", - "examples": [ - "Ship it!" - ], "name": "comment", "in": "body", + "description": "

    A comment to accompany the deployment review

    ", "isRequired": true } ], @@ -48233,11 +48152,9 @@ "bodyParameters": [ { "type": "boolean", - "default": false, - "description": "

    Whether to enable debug logging for the re-run.

    ", "name": "enable_debug_logging", "in": "body", - "isRequired": false + "description": "

    Whether to enable debug logging for the re-run.

    " } ], "enabledForGitHubApps": false, @@ -48318,11 +48235,9 @@ "bodyParameters": [ { "type": "boolean", - "default": false, - "description": "

    Whether to enable debug logging for the re-run.

    ", "name": "enable_debug_logging", "in": "body", - "isRequired": false + "description": "

    Whether to enable debug logging for the re-run.

    " } ], "enabledForGitHubApps": true, @@ -54440,21 +54355,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The git reference for the workflow. The reference can be a branch or tag name.

    ", "name": "ref", "in": "body", + "description": "

    The git reference for the workflow. The reference can be a branch or tag name.

    ", "isRequired": true }, { "type": "object", - "description": "

    Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.

    ", - "additionalProperties": { - "type": "string" - }, - "maxProperties": 10, "name": "inputs", "in": "body", - "isRequired": false + "description": "

    Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.

    " } ], "enabledForGitHubApps": true, @@ -93528,19 +93438,16 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    ", "type": "string", - "format": "date-time", "name": "last_read_at", "in": "body", - "isRequired": false + "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    " }, { - "description": "

    Whether the notification has been read.

    ", "type": "boolean", "name": "read", "in": "body", - "isRequired": false + "description": "

    Whether the notification has been read.

    " } ], "enabledForGitHubApps": false, @@ -96212,12 +96119,10 @@ ], "bodyParameters": [ { - "description": "

    Whether to block all notifications from a thread.

    ", - "default": false, "type": "boolean", "name": "ignored", "in": "body", - "isRequired": false + "description": "

    Whether to block all notifications from a thread.

    " } ], "enabledForGitHubApps": false, @@ -98893,11 +98798,9 @@ "bodyParameters": [ { "type": "string", - "format": "date-time", - "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    ", "name": "last_read_at", "in": "body", - "isRequired": false + "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    " } ], "enabledForGitHubApps": false, @@ -106869,17 +106772,15 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Determines if notifications should be received from this repository.

    ", "name": "subscribed", "in": "body", - "isRequired": false + "description": "

    Determines if notifications should be received from this repository.

    " }, { "type": "boolean", - "description": "

    Determines if all notifications should be blocked from this repository.

    ", "name": "ignored", "in": "body", - "isRequired": false + "description": "

    Determines if all notifications should be blocked from this repository.

    " } ], "enabledForGitHubApps": false, @@ -113104,14 +113005,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -114033,14 +113926,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -114602,756 +114487,291 @@ ], "bodyParameters": [ { - "description": "

    List of repository names that the token should have access to

    ", "type": "array of strings", "name": "repositories", "in": "body", - "isRequired": false + "description": "

    List of repository names that the token should have access to

    " }, { - "description": "

    List of repository IDs that the token should have access to

    ", "type": "array of integers", - "examples": [ - 1 - ], "name": "repository_ids", "in": "body", - "isRequired": false + "description": "

    List of repository IDs that the token should have access to

    " }, { - "title": "App Permissions", "type": "object", + "name": "permissions", + "in": "body", "description": "

    The permissions granted to the user-to-server access token.

    ", - "properties": { - "actions": { + "childParamsGroups": [ + { "type": "string", + "name": "actions", "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", "enum": [ "read", "write" - ], - "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + ] }, - "administration": { + { "type": "string", + "name": "administration", "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", "enum": [ "read", "write" - ], - "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + ] }, - "checks": { + { "type": "string", + "name": "checks", "description": "

    The level of permission to grant the access token for checks on code.

    ", "enum": [ "read", "write" - ], - "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + ] }, - "contents": { + { "type": "string", + "name": "contents", "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", "enum": [ "read", "write" - ], - "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + ] }, - "organization_custom_roles": { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for custom roles management.", - "childParamsGroups": [] - }, - "deployments": { + { "type": "string", + "name": "deployments", "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", "enum": [ "read", "write" - ], - "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + ] }, - "environments": { + { "type": "string", + "name": "environments", "description": "

    The level of permission to grant the access token for managing repository environments.

    ", "enum": [ "read", "write" - ], - "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + ] }, - "issues": { + { "type": "string", + "name": "issues", "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", "enum": [ "read", "write" - ], - "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + ] }, - "metadata": { + { "type": "string", + "name": "metadata", "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", "enum": [ "read", "write" - ], - "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + ] }, - "packages": { + { "type": "string", + "name": "packages", "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "pages": { + { "type": "string", + "name": "pages", "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", "enum": [ "read", "write" - ], - "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + ] }, - "pull_requests": { + { "type": "string", + "name": "pull_requests", "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", "enum": [ "read", "write" - ], - "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + ] }, - "repository_hooks": { + { "type": "string", + "name": "repository_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", "enum": [ "read", "write" - ], - "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + ] }, - "repository_projects": { + { "type": "string", + "name": "repository_projects", "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", "enum": [ "read", "write", "admin" - ], - "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + ] }, - "secret_scanning_alerts": { + { "type": "string", + "name": "secret_scanning_alerts", "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + ] }, - "secrets": { + { "type": "string", + "name": "secrets", "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", "enum": [ "read", "write" - ], - "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + ] }, - "security_events": { + { "type": "string", + "name": "security_events", "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + ] }, - "single_file": { + { "type": "string", + "name": "single_file", "description": "

    The level of permission to grant the access token to manage just a single file.

    ", "enum": [ "read", "write" - ], - "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + ] }, - "statuses": { + { "type": "string", + "name": "statuses", "description": "

    The level of permission to grant the access token for commit statuses.

    ", "enum": [ "read", "write" - ], - "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + ] }, - "vulnerability_alerts": { + { "type": "string", + "name": "vulnerability_alerts", "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", "enum": [ "read", "write" - ], - "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + ] }, - "workflows": { + { "type": "string", + "name": "workflows", "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", "enum": [ "write" - ], - "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + ] }, - "members": { + { "type": "string", + "name": "members", "description": "

    The level of permission to grant the access token for organization teams and members.

    ", "enum": [ "read", "write" - ], - "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + ] }, - "organization_administration": { + { "type": "string", + "name": "organization_administration", "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + ] }, - "organization_hooks": { + { "type": "string", + "name": "organization_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + ] }, - "organization_plan": { + { "type": "string", + "name": "organization_plan", "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", "enum": [ "read" - ], - "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + ] }, - "organization_projects": { + { "type": "string", + "name": "organization_projects", "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", "enum": [ "read", "write", "admin" - ], - "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + ] }, - "organization_packages": { + { "type": "string", + "name": "organization_packages", "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "organization_secrets": { + { "type": "string", + "name": "organization_secrets", "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", "enum": [ "read", "write" - ], - "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + ] }, - "organization_self_hosted_runners": { + { "type": "string", + "name": "organization_self_hosted_runners", "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + ] }, - "organization_user_blocking": { + { "type": "string", + "name": "organization_user_blocking", "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + ] }, - "team_discussions": { + { "type": "string", + "name": "team_discussions", "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", "enum": [ "read", "write" - ], - "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - }, - "name": "permissions", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "permissions", - "parentType": "object", - "id": "permissions-object", - "params": [ - { - "type": "string", - "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", - "enum": [ - "read", - "write" - ], - "name": "actions", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", - "enum": [ - "read", - "write" - ], - "name": "administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for checks on code.

    ", - "enum": [ - "read", - "write" - ], - "name": "checks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "contents", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "deployments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for managing repository environments.

    ", - "enum": [ - "read", - "write" - ], - "name": "environments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", - "enum": [ - "read", - "write" - ], - "name": "issues", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", - "enum": [ - "read", - "write" - ], - "name": "metadata", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", - "enum": [ - "read", - "write" - ], - "name": "pages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "pull_requests", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", - "enum": [ - "read", - "write" - ], - "name": "repository_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "repository_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "secret_scanning_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "security_events", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage just a single file.

    ", - "enum": [ - "read", - "write" - ], - "name": "single_file", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for commit statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "statuses", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "vulnerability_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", - "enum": [ - "write" - ], - "name": "workflows", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization teams and members.

    ", - "enum": [ - "read", - "write" - ], - "name": "members", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", - "enum": [ - "read" - ], - "name": "organization_plan", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "organization_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_self_hosted_runners", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_user_blocking", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", - "enum": [ - "read", - "write" - ], - "name": "team_discussions", - "in": "body" - } ] } ] @@ -115562,14 +114982,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -118272,14 +117684,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -119205,14 +118609,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -120136,14 +119532,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -122830,14 +122218,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -125185,9 +124565,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", + "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "isRequired": true } ], @@ -125250,10 +124630,10 @@ ], "bodyParameters": [ { - "description": "

    The access_token of the OAuth application.

    ", "type": "string", "name": "access_token", "in": "body", + "description": "

    The access_token of the OAuth application.

    ", "isRequired": true } ], @@ -125616,14 +124996,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -126121,10 +125493,10 @@ ], "bodyParameters": [ { - "description": "

    The access_token of the OAuth application.

    ", "type": "string", "name": "access_token", "in": "body", + "description": "

    The access_token of the OAuth application.

    ", "isRequired": true } ], @@ -126487,14 +125859,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -126989,9 +126353,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", + "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "isRequired": true } ], @@ -127055,785 +126419,309 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", - "examples": [ - "e72e16c7e42f292c6912e7710c838347ae178b4a" - ], "name": "access_token", "in": "body", + "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "isRequired": true }, { - "description": "

    The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

    ", "type": "string", - "examples": [ - "octocat" - ], "name": "target", "in": "body", - "isRequired": false + "description": "

    The name of the user or organization to scope the user-to-server access token to. Required unless target_id is specified.

    " }, { - "description": "

    The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

    ", "type": "integer", - "examples": [ - 1 - ], "name": "target_id", "in": "body", - "isRequired": false + "description": "

    The ID of the user or organization to scope the user-to-server access token to. Required unless target is specified.

    " }, { - "description": "

    The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

    ", "type": "array of strings", "name": "repositories", "in": "body", - "isRequired": false + "description": "

    The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

    " }, { - "description": "

    The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

    ", "type": "array of integers", - "examples": [ - 1 - ], "name": "repository_ids", "in": "body", - "isRequired": false + "description": "

    The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

    " }, { - "title": "App Permissions", "type": "object", + "name": "permissions", + "in": "body", "description": "

    The permissions granted to the user-to-server access token.

    ", - "properties": { - "actions": { + "childParamsGroups": [ + { "type": "string", + "name": "actions", "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", "enum": [ "read", "write" - ], - "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + ] }, - "administration": { + { "type": "string", + "name": "administration", "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", "enum": [ "read", "write" - ], - "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + ] }, - "checks": { + { "type": "string", + "name": "checks", "description": "

    The level of permission to grant the access token for checks on code.

    ", "enum": [ "read", "write" - ], - "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + ] }, - "contents": { + { "type": "string", + "name": "contents", "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", "enum": [ "read", "write" - ], - "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + ] }, - "organization_custom_roles": { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for custom roles management.", - "childParamsGroups": [] - }, - "deployments": { + { "type": "string", + "name": "deployments", "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", "enum": [ "read", "write" - ], - "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + ] }, - "environments": { + { "type": "string", + "name": "environments", "description": "

    The level of permission to grant the access token for managing repository environments.

    ", "enum": [ "read", "write" - ], - "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + ] }, - "issues": { + { "type": "string", + "name": "issues", "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", "enum": [ "read", "write" - ], - "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + ] }, - "metadata": { + { "type": "string", + "name": "metadata", "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", "enum": [ "read", "write" - ], - "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + ] }, - "packages": { + { "type": "string", + "name": "packages", "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "pages": { + { "type": "string", + "name": "pages", "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", "enum": [ "read", "write" - ], - "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + ] }, - "pull_requests": { + { "type": "string", + "name": "pull_requests", "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", "enum": [ "read", "write" - ], - "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + ] }, - "repository_hooks": { + { "type": "string", + "name": "repository_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", "enum": [ "read", "write" - ], - "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + ] }, - "repository_projects": { + { "type": "string", + "name": "repository_projects", "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", "enum": [ "read", "write", "admin" - ], - "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + ] }, - "secret_scanning_alerts": { + { "type": "string", + "name": "secret_scanning_alerts", "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + ] }, - "secrets": { + { "type": "string", + "name": "secrets", "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", "enum": [ "read", "write" - ], - "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + ] }, - "security_events": { + { "type": "string", + "name": "security_events", "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + ] }, - "single_file": { + { "type": "string", + "name": "single_file", "description": "

    The level of permission to grant the access token to manage just a single file.

    ", "enum": [ "read", "write" - ], - "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + ] }, - "statuses": { + { "type": "string", + "name": "statuses", "description": "

    The level of permission to grant the access token for commit statuses.

    ", "enum": [ "read", "write" - ], - "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + ] }, - "vulnerability_alerts": { + { "type": "string", + "name": "vulnerability_alerts", "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", "enum": [ "read", "write" - ], - "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + ] }, - "workflows": { + { "type": "string", + "name": "workflows", "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", "enum": [ "write" - ], - "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + ] }, - "members": { + { "type": "string", + "name": "members", "description": "

    The level of permission to grant the access token for organization teams and members.

    ", "enum": [ "read", "write" - ], - "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + ] }, - "organization_administration": { + { "type": "string", + "name": "organization_administration", "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + ] }, - "organization_hooks": { + { "type": "string", + "name": "organization_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + ] }, - "organization_plan": { + { "type": "string", + "name": "organization_plan", "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", "enum": [ "read" - ], - "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + ] }, - "organization_projects": { + { "type": "string", + "name": "organization_projects", "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", "enum": [ "read", "write", "admin" - ], - "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + ] }, - "organization_packages": { + { "type": "string", + "name": "organization_packages", "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "organization_secrets": { + { "type": "string", + "name": "organization_secrets", "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", "enum": [ "read", "write" - ], - "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + ] }, - "organization_self_hosted_runners": { + { "type": "string", + "name": "organization_self_hosted_runners", "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + ] }, - "organization_user_blocking": { + { "type": "string", + "name": "organization_user_blocking", "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + ] }, - "team_discussions": { + { "type": "string", + "name": "team_discussions", "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", "enum": [ "read", "write" - ], - "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - }, - "name": "permissions", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "permissions", - "parentType": "object", - "id": "permissions-object", - "params": [ - { - "type": "string", - "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", - "enum": [ - "read", - "write" - ], - "name": "actions", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", - "enum": [ - "read", - "write" - ], - "name": "administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for checks on code.

    ", - "enum": [ - "read", - "write" - ], - "name": "checks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "contents", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "deployments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for managing repository environments.

    ", - "enum": [ - "read", - "write" - ], - "name": "environments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", - "enum": [ - "read", - "write" - ], - "name": "issues", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", - "enum": [ - "read", - "write" - ], - "name": "metadata", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", - "enum": [ - "read", - "write" - ], - "name": "pages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "pull_requests", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", - "enum": [ - "read", - "write" - ], - "name": "repository_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "repository_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "secret_scanning_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "security_events", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage just a single file.

    ", - "enum": [ - "read", - "write" - ], - "name": "single_file", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for commit statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "statuses", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "vulnerability_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", - "enum": [ - "write" - ], - "name": "workflows", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization teams and members.

    ", - "enum": [ - "read", - "write" - ], - "name": "members", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", - "enum": [ - "read" - ], - "name": "organization_plan", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "organization_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_self_hosted_runners", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_user_blocking", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", - "enum": [ - "read", - "write" - ], - "name": "team_discussions", - "in": "body" - } ] } ] @@ -128233,14 +127121,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -128816,53 +127696,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": false, @@ -131765,7 +130619,2775 @@ }, "response": { "statusCode": "200", - "description": "

    Response

    " + "contentType": "application/json", + "description": "

    Response

    ", + "example": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [], + "checks": [] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + }, + "schema": { + "title": "Branch With Protection", + "description": "Branch With Protection", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "commit": { + "title": "Commit", + "description": "Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } + }, + "required": [ + "sha", + "url" + ] + } + }, + "stats": { + "type": "object", + "properties": { + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + }, + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "string" + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "html", + "self" + ] + }, + "protected": { + "type": "boolean" + }, + "protection": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enforcement_level": { + "type": "string" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string" + }, + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts", + "checks" + ] + }, + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" + ] + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } + }, + "bypass_pull_request_allowances": { + "type": "object", + "description": "Allow specific users, teams, or apps to bypass pull request requirements.", + "properties": { + "users": { + "description": "The list of users allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "require_code_owner_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "required_approving_review_count": { + "type": "integer", + "minimum": 0, + "maximum": 6, + "examples": [ + 2 + ] + } + }, + "required": [ + "dismiss_stale_reviews", + "require_code_owner_reviews" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + } + } + }, + "protection_url": { + "type": "string", + "format": "uri" + }, + "pattern": { + "type": "string", + "examples": [ + "\"mas*\"" + ] + }, + "required_approving_review_count": { + "type": "integer", + "examples": [ + 1 + ] + } + }, + "required": [ + "name", + "commit", + "_links", + "protection", + "protected", + "protection_url" + ] + } } } ], @@ -131826,9 +133448,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new name of the branch.

    ", "name": "new_name", "in": "body", + "description": "

    The new name of the branch.

    ", "isRequired": true } ], @@ -134673,9 +136295,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the branch which should be updated to match upstream.

    ", "name": "branch", "in": "body", + "description": "

    The name of the branch which should be updated to match upstream.

    ", "isRequired": true } ], @@ -134775,24 +136397,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the base branch that the head will be merged into.

    ", "name": "base", "in": "body", + "description": "

    The name of the base branch that the head will be merged into.

    ", "isRequired": true }, { "type": "string", - "description": "

    The head to merge. This can be a branch name or a commit SHA1.

    ", "name": "head", "in": "body", + "description": "

    The head to merge. This can be a branch name or a commit SHA1.

    ", "isRequired": true }, { "type": "string", - "description": "

    Commit message to use for the merge commit. If omitted, a default message will be used.

    ", "name": "commit_message", "in": "body", - "isRequired": false + "description": "

    Commit message to use for the merge commit. If omitted, a default message will be used.

    " } ], "enabledForGitHubApps": true, @@ -137864,171 +139485,38 @@ "bodyParameters": [ { "type": "object or null", - "description": "

    Require status checks to pass before merging. Set to null to disable.

    ", - "properties": { - "strict": { - "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", - "name": "strict", - "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": true, - "childParamsGroups": [] - }, - "contexts": { - "type": "array of strings", - "deprecated": true, - "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "isRequired": true, - "childParamsGroups": [] - }, - "checks": { - "type": "array of objects", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", - "items": { - "type": "object", - "required": [ - "context" - ], - "properties": { - "context": { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] - }, - "app_id": { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] - } - } - }, - "name": "checks", - "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ - { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "strict", - "contexts" - ], "name": "required_status_checks", "in": "body", + "description": "

    Require status checks to pass before merging. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "required_status_checks", - "parentType": "object", - "id": "required_status_checks-object", - "params": [ - { - "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", - "name": "strict", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "deprecated": true, - "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", - "name": "contexts", - "in": "body", - "isRequired": true - }, - { - "type": "array of objects", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", - "name": "checks", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ - { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "boolean", + "name": "strict", + "description": "

    Require branches to be up to date before merging.

    ", + "isRequired": true }, { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ + "type": "array of strings", + "name": "contexts", + "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", + "isRequired": true + }, + { + "type": "array of objects", + "name": "checks", + "description": "

    The list of status checks to require in order to merge into this branch.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The name of the required check

    ", "name": "context", - "in": "body", + "description": "

    The name of the required check

    ", "isRequired": true }, { "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", "name": "app_id", - "in": "body", - "isRequired": false + "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    " } ] } @@ -138036,407 +139524,74 @@ }, { "type": "boolean or null", - "description": "

    Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "name": "enforce_admins", "in": "body", + "description": "

    Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "isRequired": true }, { "type": "object or null", - "description": "

    Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", - "properties": { - "dismissal_restrictions": { - "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, - "name": "dismissal_restrictions", - "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", - "childParamsGroups": [ - { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] - } - ] - }, - "dismiss_stale_reviews": { - "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", - "name": "dismiss_stale_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "childParamsGroups": [] - }, - "require_code_owner_reviews": { - "type": "boolean", - "description": "

    Blocks merging pull requests until code owners review them.

    ", - "name": "require_code_owner_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", - "childParamsGroups": [] - }, - "required_approving_review_count": { - "type": "integer", - "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    ", - "name": "required_approving_review_count", - "in": "body", - "rawType": "integer", - "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", - "childParamsGroups": [] - }, - "bypass_pull_request_allowances": { - "type": "object", - "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - } - }, - "name": "bypass_pull_request_allowances", - "in": "body", - "rawType": "object", - "rawDescription": "Allow specific users, teams, or apps to bypass pull request requirements.", - "childParamsGroups": [ - { - "parentName": "bypass_pull_request_allowances", - "parentType": "object", - "id": "bypass_pull_request_allowances-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "name": "apps", - "in": "body" - } - ] - } - ] - } - }, "name": "required_pull_request_reviews", "in": "body", + "description": "

    Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "required_pull_request_reviews", - "parentType": "object", - "id": "required_pull_request_reviews-object", - "params": [ + "type": "object", + "name": "dismissal_restrictions", + "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", + "childParamsGroups": [ { - "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, - "name": "dismissal_restrictions", - "in": "body", - "childParamsGroups": [ - { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with dismissal access

    " }, { - "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", - "name": "dismiss_stale_reviews", - "in": "body" + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with dismissal access

    " }, { - "type": "boolean", - "description": "

    Blocks merging pull requests until code owners review them.

    ", - "name": "require_code_owner_reviews", - "in": "body" - }, - { - "type": "integer", - "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    ", - "name": "required_approving_review_count", - "in": "body" - }, - { - "type": "object", - "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - } - }, - "name": "bypass_pull_request_allowances", - "in": "body", - "childParamsGroups": [ - { - "parentName": "bypass_pull_request_allowances", - "parentType": "object", - "id": "bypass_pull_request_allowances-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "name": "apps", - "in": "body" - } - ] - } - ] + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with dismissal access

    " } ] }, { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] + "type": "boolean", + "name": "dismiss_stale_reviews", + "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    " }, { - "parentName": "bypass_pull_request_allowances", - "parentType": "object", - "id": "bypass_pull_request_allowances-object", - "params": [ + "type": "boolean", + "name": "require_code_owner_reviews", + "description": "

    Blocks merging pull requests until code owners review them.

    " + }, + { + "type": "integer", + "name": "required_approving_review_count", + "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    " + }, + { + "type": "object", + "name": "bypass_pull_request_allowances", + "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", + "childParamsGroups": [ { "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", "name": "users", - "in": "body" + "description": "

    The list of user logins allowed to bypass pull request requirements.

    " }, { "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", "name": "teams", - "in": "body" + "description": "

    The list of team slugs allowed to bypass pull request requirements.

    " }, { "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", "name": "apps", - "in": "body" + "description": "

    The list of app slugs allowed to bypass pull request requirements.

    " } ] } @@ -138444,120 +139599,59 @@ }, { "type": "object or null", - "description": "

    Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with push access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with push access", - "isRequired": true, - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with push access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with push access", - "isRequired": true, - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with push access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with push access", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "users", - "teams" - ], "name": "restrictions", "in": "body", + "description": "

    Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "restrictions", - "parentType": "object", - "id": "restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with push access

    ", - "name": "users", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with push access

    ", - "name": "teams", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with push access

    ", - "name": "apps", - "in": "body", - "isRequired": false - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with push access

    ", + "isRequired": true + }, + { + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with push access

    ", + "isRequired": true + }, + { + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with push access

    " } ] }, { "type": "boolean", - "description": "

    Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

    ", "name": "required_linear_history", "in": "body", - "isRequired": false + "description": "

    Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

    " }, { "type": "boolean or null", - "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "name": "allow_force_pushes", "in": "body", - "isRequired": false + "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    " }, { "type": "boolean", - "description": "

    Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

    ", "name": "allow_deletions", "in": "body", - "isRequired": false + "description": "

    Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

    ", "name": "block_creations", "in": "body", - "isRequired": false + "description": "

    If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

    " }, { "type": "boolean", - "description": "

    Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

    ", "name": "required_conversation_resolution", "in": "body", - "isRequired": false + "description": "

    Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

    " } ], "enabledForGitHubApps": true, @@ -138622,7 +139716,2001 @@ }, "response": { "statusCode": "200", - "description": "

    Response

    " + "contentType": "application/json", + "description": "

    Response

    ", + "example": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [], + "teams": [], + "apps": [] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [], + "teams": [], + "apps": [] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + }, + "schema": { + "title": "Protected Branch", + "description": "Branch protections protect branches", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "required_status_checks": { + "title": "Status Check Policy", + "description": "Status Check Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] + }, + "strict": { + "type": "boolean", + "examples": [ + true + ] + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + ] + } + }, + "required": [ + "url", + "contexts_url", + "strict", + "contexts", + "checks" + ] + }, + "required_pull_request_reviews": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "dismiss_stale_reviews": { + "type": "boolean" + }, + "require_code_owner_reviews": { + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "users", + "teams" + ] + }, + "bypass_pull_request_allowances": { + "type": "object", + "properties": { + "users": { + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + }, + "required": [ + "users", + "teams" + ] + } + }, + "required": [ + "url" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "enforce_admins": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "url", + "enabled" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + } + }, + "required": [ + "url" + ] + } } } ], @@ -140633,166 +143721,65 @@ "bodyParameters": [ { "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, "name": "dismissal_restrictions", "in": "body", - "isRequired": false, + "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", "childParamsGroups": [ { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with dismissal access

    " + }, + { + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with dismissal access

    " + }, + { + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with dismissal access

    " } ] }, { "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", "name": "dismiss_stale_reviews", "in": "body", - "isRequired": false + "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    " }, { "type": "boolean", - "description": "

    Blocks merging pull requests until code owners have reviewed.

    ", "name": "require_code_owner_reviews", "in": "body", - "isRequired": false + "description": "

    Blocks merging pull requests until code owners have reviewed.

    " }, { "type": "integer", - "description": "

    Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    ", "name": "required_approving_review_count", "in": "body", - "isRequired": false + "description": "

    Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    " }, { "type": "object", - "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - } - }, "name": "bypass_pull_request_allowances", "in": "body", - "isRequired": false, + "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", "childParamsGroups": [ { - "parentName": "bypass_pull_request_allowances", - "parentType": "object", - "id": "bypass_pull_request_allowances-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "name": "apps", - "in": "body" - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins allowed to bypass pull request requirements.

    " + }, + { + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs allowed to bypass pull request requirements.

    " + }, + { + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs allowed to bypass pull request requirements.

    " } ] } @@ -142931,46 +145918,32 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", "name": "strict", "in": "body", - "isRequired": false + "description": "

    Require branches to be up to date before merging.

    " }, { "type": "array of strings", - "deprecated": true, - "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", "name": "contexts", "in": "body", - "isRequired": false + "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    " }, { "type": "array of objects", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", "name": "checks", "in": "body", - "isRequired": false, + "description": "

    The list of status checks to require in order to merge into this branch.

    ", "childParamsGroups": [ { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ - { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "context", + "description": "

    The name of the required check

    ", + "isRequired": true + }, + { + "type": "integer", + "name": "app_id", + "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    " } ] } @@ -143280,9 +146253,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -143292,8 +146265,14 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding status checks to a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -143378,9 +146357,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -143390,8 +146369,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example updating status checks for a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -143471,9 +146455,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -143483,8 +146467,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing status checks from a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -144533,9 +147522,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -144984,9 +147973,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -145435,9 +148424,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -146176,9 +149165,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -146188,8 +149177,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -146475,9 +149469,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -146487,8 +149481,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -146774,9 +149773,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -146786,8 +149785,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -147330,9 +150334,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -147342,8 +150346,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -147596,9 +150605,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -147608,8 +150617,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -147862,9 +150876,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -147874,8 +150888,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -148122,55 +151141,52 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the check. For example, \"code-coverage\".

    ", "name": "name", "in": "body", + "description": "

    The name of the check. For example, \"code-coverage\".

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the commit.

    ", "name": "head_sha", "in": "body", + "description": "

    The SHA of the commit.

    ", "isRequired": true }, { "type": "string", - "description": "

    The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

    ", "name": "details_url", "in": "body", - "isRequired": false + "description": "

    The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

    " }, { "type": "string", - "description": "

    A reference for the run on the integrator's system.

    ", "name": "external_id", "in": "body", - "isRequired": false + "description": "

    A reference for the run on the integrator's system.

    " }, { "type": "string", + "name": "status", + "in": "body", "description": "

    The current status.

    ", "enum": [ "queued", "in_progress", "completed" ], - "default": "queued", - "name": "status", - "in": "body", - "isRequired": false + "default": "queued" }, { "type": "string", - "format": "date-time", - "description": "

    The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "string", + "name": "conclusion", + "in": "body", "description": "

    Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.

    ", "enum": [ "action_required", @@ -148181,588 +151197,120 @@ "skipped", "stale", "timed_out" - ], - "name": "conclusion", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "format": "date-time", - "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "completed_at", "in": "body", - "isRequired": false + "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "object", - "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", - "properties": { - "title": { - "type": "string", - "description": "

    The title of the check run.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the check run.", - "isRequired": true, - "childParamsGroups": [] - }, - "summary": { - "type": "string", - "maxLength": 65535, - "description": "

    The summary of the check run. This parameter supports Markdown.

    ", - "name": "summary", - "in": "body", - "rawType": "string", - "rawDescription": "The summary of the check run. This parameter supports Markdown.", - "isRequired": true, - "childParamsGroups": [] - }, - "text": { - "type": "string", - "maxLength": 65535, - "description": "

    The details of the check run. This parameter supports Markdown.

    ", - "name": "text", - "in": "body", - "rawType": "string", - "rawDescription": "The details of the check run. This parameter supports Markdown.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotations": { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", - "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, - "name": "annotations", - "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#annotations-object) description for details about how to use this parameter.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - "images": { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, - "name": "images", - "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#images-object) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "title", - "summary" - ], "name": "output", "in": "body", - "isRequired": false, + "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", "childParamsGroups": [ { - "parentName": "output", - "parentType": "object", - "id": "output-object", - "params": [ - { - "type": "string", - "description": "

    The title of the check run.

    ", - "name": "title", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 65535, - "description": "

    The summary of the check run. This parameter supports Markdown.

    ", - "name": "summary", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 65535, - "description": "

    The details of the check run. This parameter supports Markdown.

    ", - "name": "text", - "in": "body", - "isRequired": false - }, - { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", - "maxItems": 50, - "name": "annotations", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "name": "images", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "string", + "name": "title", + "description": "

    The title of the check run.

    ", + "isRequired": true }, { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ + "type": "string", + "name": "summary", + "description": "

    The summary of the check run. This parameter supports Markdown.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "text", + "description": "

    The details of the check run. This parameter supports Markdown.

    " + }, + { + "type": "array of objects", + "name": "annotations", + "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "name": "path", - "in": "body", + "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start line of the annotation.

    ", "name": "start_line", - "in": "body", + "description": "

    The start line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The end line of the annotation.

    ", "name": "end_line", - "in": "body", + "description": "

    The end line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "start_column", - "in": "body", - "isRequired": false + "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "end_column", - "in": "body", - "isRequired": false + "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "string", + "name": "annotation_level", "description": "

    The level of the annotation.

    ", + "isRequired": true, "enum": [ "notice", "warning", "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "name": "message", - "in": "body", + "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "isRequired": true }, { "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", "name": "title", - "in": "body", - "isRequired": false + "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    " }, { "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", "name": "raw_details", - "in": "body", - "isRequired": false + "description": "

    Details about this annotation. The maximum size is 64 KB.

    " } ] }, { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ + "type": "array of objects", + "name": "images", + "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The alternative text for the image.

    ", "name": "alt", - "in": "body", + "description": "

    The alternative text for the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full URL of the image.

    ", "name": "image_url", - "in": "body", + "description": "

    The full URL of the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short image description.

    ", "name": "caption", - "in": "body", - "isRequired": false + "description": "

    A short image description.

    " } ] } @@ -148770,42 +151318,27 @@ }, { "type": "array of objects", - "description": "

    Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", - "maxItems": 3, "name": "actions", "in": "body", - "isRequired": false, + "description": "

    Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", "childParamsGroups": [ { - "parentName": "actions", - "parentType": "items", - "id": "actions-items", - "params": [ - { - "type": "string", - "maxLength": 20, - "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", - "name": "label", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 40, - "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", - "name": "description", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 20, - "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", - "name": "identifier", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "label", + "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "identifier", + "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", + "isRequired": true } ] } @@ -152457,47 +154990,43 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the check. For example, \"code-coverage\".

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the check. For example, \"code-coverage\".

    " }, { "type": "string", - "description": "

    The URL of the integrator's site that has the full details of the check.

    ", "name": "details_url", "in": "body", - "isRequired": false + "description": "

    The URL of the integrator's site that has the full details of the check.

    " }, { "type": "string", - "description": "

    A reference for the run on the integrator's system.

    ", "name": "external_id", "in": "body", - "isRequired": false + "description": "

    A reference for the run on the integrator's system.

    " }, { "type": "string", - "format": "date-time", - "description": "

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "string", + "name": "status", + "in": "body", "description": "

    The current status.

    ", "enum": [ "queued", "in_progress", "completed" - ], - "name": "status", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "conclusion", + "in": "body", "description": "

    Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.

    ", "enum": [ "action_required", @@ -152508,587 +155037,119 @@ "skipped", "stale", "timed_out" - ], - "name": "conclusion", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "format": "date-time", - "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "completed_at", "in": "body", - "isRequired": false + "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "object", - "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", - "properties": { - "title": { - "type": "string", - "description": "

    Required.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "**Required**.", - "isRequired": false, - "childParamsGroups": [] - }, - "summary": { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "summary", - "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": true, - "childParamsGroups": [] - }, - "text": { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "text", - "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotations": { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", - "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, - "name": "annotations", - "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#annotations-object-1) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - "images": { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, - "name": "images", - "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#annotations-object-1) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "summary" - ], "name": "output", "in": "body", - "isRequired": false, + "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", "childParamsGroups": [ { - "parentName": "output", - "parentType": "object", - "id": "output-object", - "params": [ - { - "type": "string", - "description": "

    Required.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "summary", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "text", - "in": "body", - "isRequired": false - }, - { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", - "maxItems": 50, - "name": "annotations", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "name": "images", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "string", + "name": "title", + "description": "

    Required.

    " }, { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ + "type": "string", + "name": "summary", + "description": "

    Can contain Markdown.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "text", + "description": "

    Can contain Markdown.

    " + }, + { + "type": "array of objects", + "name": "annotations", + "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "name": "path", - "in": "body", + "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start line of the annotation.

    ", "name": "start_line", - "in": "body", + "description": "

    The start line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The end line of the annotation.

    ", "name": "end_line", - "in": "body", + "description": "

    The end line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "start_column", - "in": "body", - "isRequired": false + "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "end_column", - "in": "body", - "isRequired": false + "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "string", + "name": "annotation_level", "description": "

    The level of the annotation.

    ", + "isRequired": true, "enum": [ "notice", "warning", "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "name": "message", - "in": "body", + "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "isRequired": true }, { "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", "name": "title", - "in": "body", - "isRequired": false + "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    " }, { "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", "name": "raw_details", - "in": "body", - "isRequired": false + "description": "

    Details about this annotation. The maximum size is 64 KB.

    " } ] }, { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ + "type": "array of objects", + "name": "images", + "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The alternative text for the image.

    ", "name": "alt", - "in": "body", + "description": "

    The alternative text for the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full URL of the image.

    ", "name": "image_url", - "in": "body", + "description": "

    The full URL of the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short image description.

    ", "name": "caption", - "in": "body", - "isRequired": false + "description": "

    A short image description.

    " } ] } @@ -153096,42 +155157,27 @@ }, { "type": "array of objects", - "description": "

    Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", - "maxItems": 3, "name": "actions", "in": "body", - "isRequired": false, + "description": "

    Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", "childParamsGroups": [ { - "parentName": "actions", - "parentType": "items", - "id": "actions-items", - "params": [ - { - "type": "string", - "maxLength": 20, - "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", - "name": "label", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 40, - "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", - "name": "description", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 20, - "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", - "name": "identifier", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "label", + "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "identifier", + "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", + "isRequired": true } ] } @@ -157238,9 +159284,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The sha of the head commit.

    ", "name": "head_sha", "in": "body", + "description": "

    The sha of the head commit.

    ", "isRequired": true } ], @@ -163608,32 +165654,22 @@ "bodyParameters": [ { "type": "array of objects", - "description": "

    Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

    ", "name": "auto_trigger_checks", "in": "body", - "isRequired": false, + "description": "

    Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

    ", "childParamsGroups": [ { - "parentName": "auto_trigger_checks", - "parentType": "items", - "id": "auto_trigger_checks-items", - "params": [ - { - "type": "integer", - "description": "

    The id of the GitHub App.

    ", - "name": "app_id", - "in": "body", - "isRequired": true - }, - { - "type": "boolean", - "description": "

    Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

    ", - "default": true, - "name": "setting", - "in": "body", - "isRequired": true - } - ] + "type": "integer", + "name": "app_id", + "description": "

    The id of the GitHub App.

    ", + "isRequired": true + }, + { + "type": "boolean", + "name": "setting", + "description": "

    Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

    ", + "isRequired": true, + "default": true } ] } @@ -175316,36 +177352,33 @@ ], "bodyParameters": [ { - "description": "

    Sets the state of the code scanning alert. You must provide dismissed_reason when you set the state to dismissed.

    ", "type": "string", + "name": "state", + "in": "body", + "description": "

    Sets the state of the code scanning alert. You must provide dismissed_reason when you set the state to dismissed.

    ", + "isRequired": true, "enum": [ "open", "dismissed" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", + "name": "dismissed_reason", + "in": "body", "description": "

    Required when the state is dismissed. The reason for dismissing or closing the alert.

    ", "enum": [ null, "false positive", "won't fix", "used in tests" - ], - "name": "dismissed_reason", - "in": "body", - "isRequired": false + ] }, { "type": "string or null", - "description": "

    The dismissal comment associated with the dismissal of the alert.

    ", - "maxLength": 280, "name": "dismissed_comment", "in": "body", - "isRequired": false + "description": "

    The dismissal comment associated with the dismissal of the alert.

    " } ], "enabledForGitHubApps": true, @@ -176001,6 +178034,7 @@ "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "state": "open", "fixed_at": null, "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", @@ -176852,7 +178886,7 @@ "description": "

    Service unavailable

    " } ], - "descriptionHTML": "

    Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the repo scope. For public repositories,\nyou must use an access token with public_repo scope.\nGitHub Apps must have the security_events write permission to use this endpoint.

    \n

    You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.

    \n

    When you list the analyses for a repository,\none or more will be identified as deletable in the response:

    \n
    \"deletable\": true\n
    \n

    An analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:

    \n
      \n
    • ref
      • \n
    • tool
      • \n
    • analysis_key
      • \n
    • environment
      • \n
    \n

    If you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:

    \n
    Analysis specified is not deletable.\n
    \n

    The response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\nnext_analysis_url and confirm_delete_url.\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.

    \n

    As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:

    \n

    Outer loop:

    \n
      \n
    • \n

      List the analyses for the repository, filtered by tool.

      \n
      • \n
    • \n

      Parse this list to find a deletable analysis. If found:

      \n

      Inner loop:

      \n
        \n
      • Delete the identified analysis.
        • \n
      • Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.
        • \n
      \n
      • \n
    \n

    The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

    ", + "descriptionHTML": "

    Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the repo scope. For public repositories,\nyou must use an access token with public_repo scope.\nGitHub Apps must have the security_events write permission to use this endpoint.

    \n

    You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.

    \n

    When you list the analyses for a repository,\none or more will be identified as deletable in the response:

    \n
    \"deletable\": true\n
    \n

    An analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:

    \n
      \n
    • ref
      • \n
    • tool
      • \n
    • category
      • \n
    \n

    If you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:

    \n
    Analysis specified is not deletable.\n
    \n

    The response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\nnext_analysis_url and confirm_delete_url.\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.

    \n

    As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:

    \n

    Outer loop:

    \n
      \n
    • \n

      List the analyses for the repository, filtered by tool.

      \n
      • \n
    • \n

      Parse this list to find a deletable analysis. If found:

      \n

      Inner loop:

      \n
        \n
      • Delete the identified analysis.
        • \n
      • Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.
        • \n
      \n
      • \n
    \n

    The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

    ", "subcategory": "code-scanning" }, { @@ -176883,54 +178917,43 @@ ], "bodyParameters": [ { - "description": "

    The SHA of the commit to which the analysis you are uploading relates.

    ", "type": "string", - "minLength": 40, - "maxLength": 40, - "pattern": "^[0-9a-fA-F]+$", "name": "commit_sha", "in": "body", + "description": "

    The SHA of the commit to which the analysis you are uploading relates.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", "name": "ref", "in": "body", + "description": "

    The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", "isRequired": true }, { - "description": "

    A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

    ", "type": "string", "name": "sarif", "in": "body", + "description": "

    A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

    ", "isRequired": true }, { - "description": "

    The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

    ", "type": "string", - "format": "uri", - "examples": [ - "file:///github/workspace/" - ], "name": "checkout_uri", "in": "body", - "isRequired": false + "description": "

    The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

    " }, { - "description": "

    The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "format": "date-time", "type": "string", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { - "description": "

    The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

    ", "type": "string", "name": "tool_name", "in": "body", - "isRequired": false + "description": "

    The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

    " } ], "enabledForGitHubApps": true, @@ -177759,11 +179782,10 @@ "bodyParameters": [ { "type": "string", - "description": "

    The permission to grant the collaborator. Only valid on organization-owned repositories.

    ", - "default": "push", "name": "permission", "in": "body", - "isRequired": false + "description": "

    The permission to grant the collaborator. Only valid on organization-owned repositories.

    ", + "default": "push" } ], "enabledForGitHubApps": true, @@ -183750,6 +185772,8 @@ "bodyParameters": [ { "type": "string", + "name": "permissions", + "in": "body", "description": "

    The permissions that the associated user will have on the repository. Valid values are read, write, maintain, triage, and admin.

    ", "enum": [ "read", @@ -183757,10 +185781,7 @@ "maintain", "triage", "admin" - ], - "name": "permissions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -183769,8 +185790,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example request body", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permissions": "write" + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -200507,9 +202531,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment

    ", "isRequired": true } ], @@ -201423,31 +203447,28 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true }, { "type": "string", - "description": "

    Relative path of the file to comment on.

    ", "name": "path", "in": "body", - "isRequired": false + "description": "

    Relative path of the file to comment on.

    " }, { "type": "integer", - "description": "

    Line index in the diff to comment on.

    ", "name": "position", "in": "body", - "isRequired": false + "description": "

    Line index in the diff to comment on.

    " }, { "type": "integer", - "description": "

    Deprecated. Use position parameter instead. Line number in the file to comment on.

    ", "name": "line", "in": "body", - "isRequired": false + "description": "

    Deprecated. Use position parameter instead. Line number in the file to comment on.

    " } ], "enabledForGitHubApps": true, @@ -204725,38 +206746,35 @@ "bodyParameters": [ { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the status.

    ", + "isRequired": true, "enum": [ "error", "failure", "pending", "success" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", - "description": "

    The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
    \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
    \nhttp://ci.example.com/user/repo/build/sha

    ", "name": "target_url", "in": "body", - "isRequired": false + "description": "

    The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
    \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
    \nhttp://ci.example.com/user/repo/build/sha

    " }, { "type": "string or null", - "description": "

    A short description of the status.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the status.

    " }, { "type": "string", - "description": "

    A string label to differentiate this status from the status of other systems. This field is case-insensitive.

    ", - "default": "default", "name": "context", "in": "body", - "isRequired": false + "description": "

    A string label to differentiate this status from the status of other systems. This field is case-insensitive.

    ", + "default": "default" } ], "enabledForGitHubApps": true, @@ -205417,37 +207435,33 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret.

    ", + "isRequired": true, "enum": [ "all", "private", "selected" - ], - "name": "visibility", - "in": "body", - "isRequired": true + ] }, { "type": "array of strings", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", - "isRequired": false + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    " } ], "enabledForGitHubApps": true, @@ -207977,9 +209991,9 @@ "bodyParameters": [ { "type": "array of integers", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "isRequired": true } ], @@ -208507,18 +210521,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " } ], "enabledForGitHubApps": true, @@ -209046,24 +211057,22 @@ "bodyParameters": [ { "type": "string", - "description": "

    A name for the key.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    A name for the key.

    " }, { "type": "string", - "description": "

    The contents of the key.

    ", "name": "key", "in": "body", + "description": "

    The contents of the key.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

    \n

    Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

    ", "name": "read_only", "in": "body", - "isRequired": false + "description": "

    If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

    \n

    Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

    " } ], "enabledForGitHubApps": true, @@ -210164,82 +212173,61 @@ "bodyParameters": [ { "type": "string", - "description": "

    The ref to deploy. This can be a branch, tag, or SHA.

    ", "name": "ref", "in": "body", + "description": "

    The ref to deploy. This can be a branch, tag, or SHA.

    ", "isRequired": true }, { "type": "string", - "description": "

    Specifies a task to execute (e.g., deploy or deploy:migrations).

    ", - "default": "deploy", "name": "task", "in": "body", - "isRequired": false + "description": "

    Specifies a task to execute (e.g., deploy or deploy:migrations).

    ", + "default": "deploy" }, { "type": "boolean", - "description": "

    Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

    ", - "default": true, "name": "auto_merge", "in": "body", - "isRequired": false + "description": "

    Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

    ", + "default": true }, { "type": "array of strings", - "description": "

    The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

    ", "name": "required_contexts", "in": "body", - "isRequired": false + "description": "

    The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

    " }, { - "oneOf": [ - { - "type": "object", - "additionalProperties": true - }, - { - "type": "string", - "description": "JSON payload with extra information about the deployment.", - "default": "" - } - ], + "type": "object or string", "name": "payload", "in": "body", - "type": "object or string", - "description": "

    JSON payload with extra information about the deployment.

    ", - "isRequired": false + "description": "

    JSON payload with extra information about the deployment.

    " }, { "type": "string", - "description": "

    Name for the target deployment environment (e.g., production, staging, qa).

    ", - "default": "production", "name": "environment", "in": "body", - "isRequired": false + "description": "

    Name for the target deployment environment (e.g., production, staging, qa).

    ", + "default": "production" }, { "type": "string or null", - "description": "

    Short description of the deployment.

    ", - "default": "", "name": "description", "in": "body", - "isRequired": false + "description": "

    Short description of the deployment.

    " }, { "type": "boolean", - "description": "

    Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false

    ", - "default": false, "name": "transient_environment", "in": "body", - "isRequired": false + "description": "

    Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false

    " }, { "type": "boolean", - "description": "

    Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

    ", "name": "production_environment", "in": "body", - "isRequired": false + "description": "

    Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

    " } ], "enabledForGitHubApps": true, @@ -211968,13 +213956,10 @@ ], "bodyParameters": [ { - "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "type": "string", - "examples": [ - "release/*" - ], "name": "name", "in": "body", + "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "isRequired": true } ], @@ -212259,13 +214244,10 @@ ], "bodyParameters": [ { - "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "type": "string", - "examples": [ - "release/*" - ], "name": "name", "in": "body", + "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "isRequired": true } ], @@ -213893,105 +215875,49 @@ "bodyParameters": [ { "type": "integer", - "description": "

    The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).

    ", - "examples": [ - 30 - ], "name": "wait_timer", "in": "body", - "isRequired": false + "description": "

    The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).

    " }, { "type": "array of objects or null", - "description": "

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", "name": "reviewers", "in": "body", - "isRequired": false, + "description": "

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", "childParamsGroups": [ { - "parentName": "reviewers", - "parentType": "items", - "id": "reviewers-items", - "params": [ - { - "type": "string", - "description": "

    The type of reviewer.

    ", - "enum": [ - "User", - "Team" - ], - "examples": [ - "User" - ], - "name": "type", - "in": "body" - }, - { - "type": "integer", - "description": "

    The id of the user or team who can review the deployment

    ", - "examples": [ - 4532992 - ], - "name": "id", - "in": "body" - } + "type": "string", + "name": "type", + "description": "

    The type of reviewer.

    ", + "enum": [ + "User", + "Team" ] + }, + { + "type": "integer", + "name": "id", + "description": "

    The id of the user or team who can review the deployment

    " } ] }, { "type": "object or null", - "description": "

    The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

    ", - "properties": { - "protected_branches": { - "type": "boolean", - "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", - "name": "protected_branches", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", - "isRequired": true, - "childParamsGroups": [] - }, - "custom_branch_policies": { - "type": "boolean", - "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", - "name": "custom_branch_policies", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "protected_branches", - "custom_branch_policies" - ], "name": "deployment_branch_policy", "in": "body", - "isRequired": false, + "description": "

    The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

    ", "childParamsGroups": [ { - "parentName": "deployment_branch_policy", - "parentType": "object", - "id": "deployment_branch_policy-object", - "params": [ - { - "type": "boolean", - "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", - "name": "protected_branches", - "in": "body", - "isRequired": true - }, - { - "type": "boolean", - "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", - "name": "custom_branch_policies", - "in": "body", - "isRequired": true - } - ] + "type": "boolean", + "name": "protected_branches", + "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", + "isRequired": true + }, + { + "type": "boolean", + "name": "custom_branch_policies", + "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", + "isRequired": true } ] } @@ -215549,7 +217475,10 @@ "bodyParameters": [ { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the status. When you set a transient deployment to inactive, the deployment will be shown as destroyed in GitHub.

    ", + "isRequired": true, "enum": [ "error", "failure", @@ -215558,61 +217487,48 @@ "queued", "pending", "success" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.

    ", - "default": "", "name": "target_url", "in": "body", - "isRequired": false + "description": "

    The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.

    " }, { "type": "string", - "description": "

    The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: \"\"

    ", - "default": "", "name": "log_url", "in": "body", - "isRequired": false + "description": "

    The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: \"\"

    " }, { "type": "string", - "description": "

    A short description of the status. The maximum description length is 140 characters.

    ", - "default": "", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the status. The maximum description length is 140 characters.

    " }, { "type": "string", + "name": "environment", + "in": "body", "description": "

    Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa.

    ", "enum": [ "production", "staging", "qa" - ], - "name": "environment", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "description": "

    Sets the URL for accessing your environment. Default: \"\"

    ", - "default": "", "name": "environment_url", "in": "body", - "isRequired": false + "description": "

    Sets the URL for accessing your environment. Default: \"\"

    " }, { "type": "boolean", - "description": "

    Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true

    ", "name": "auto_inactive", "in": "body", - "isRequired": false + "description": "

    Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true

    " } ], "enabledForGitHubApps": true, @@ -219692,24 +221608,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

    ", - "examples": [ - "Very **important** announcement about _nothing_." - ], "name": "announcement", "in": "body", + "description": "

    The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

    ", "isRequired": true }, { "type": "string or null", - "format": "date-time", - "description": "

    The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

    ", - "examples": [ - "\"2021-01-01T00:00:00.000-07:00\"" - ], "name": "expires_at", "in": "body", - "isRequired": false + "description": "

    The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

    " } ], "enabledForGitHubApps": false, @@ -220523,114 +222431,53 @@ "bodyParameters": [ { "type": "string", - "description": "

    Must be passed as \"web\".

    ", "name": "name", "in": "body", + "description": "

    Must be passed as \"web\".

    ", "isRequired": true }, { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", + "description": "

    Key/value pairs to provide settings for this webhook.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    " + }, + { + "type": "string", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ] }, { "type": "array of strings", - "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    ", "name": "events", "in": "body", - "isRequired": false + "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    " }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": false, @@ -220881,107 +222728,45 @@ "bodyParameters": [ { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    " + }, + { + "type": "string", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ] }, { "type": "array of strings", - "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    ", "name": "events", "in": "body", - "isRequired": false + "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    " }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": false, @@ -221200,9 +222985,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The distinguished name (DN) of the LDAP entry to map to a team.

    ", "name": "ldap_dn", "in": "body", + "description": "

    The distinguished name (DN) of the LDAP entry to map to a team.

    ", "isRequired": true } ], @@ -221379,9 +223164,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The distinguished name (DN) of the LDAP entry to map to a team.

    ", "name": "ldap_dn", "in": "body", + "description": "

    The distinguished name (DN) of the LDAP entry to map to a team.

    ", "isRequired": true } ], @@ -222152,9 +223937,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    A JSON string with the attributes enabled and when.

    \n

    The possible values for enabled are true and false. When it's false, the attribute when is ignored and the maintenance mode is turned off. when defines the time period when the maintenance was enabled.

    \n

    The possible values for when are now or any date parseable by mojombo/chronic.

    ", "name": "maintenance", "in": "body", + "description": "

    A JSON string with the attributes enabled and when.

    \n

    The possible values for enabled are true and false. When it's false, the attribute when is ignored and the maintenance mode is turned off. when defines the time period when the maintenance was enabled.

    \n

    The possible values for when are now or any date parseable by mojombo/chronic.

    ", "isRequired": true } ], @@ -222908,9 +224693,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.

    ", "name": "settings", "in": "body", + "description": "

    A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.

    ", "isRequired": true } ], @@ -223013,9 +224798,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The public SSH key.

    ", "name": "authorized_key", "in": "body", + "description": "

    The public SSH key.

    ", "isRequired": true } ], @@ -223086,9 +224871,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The public SSH key.

    ", "name": "authorized_key", "in": "body", + "description": "

    The public SSH key.

    ", "isRequired": true } ], @@ -223159,24 +224944,22 @@ "bodyParameters": [ { "type": "string", - "description": "

    The content of your .ghl license file.

    ", "name": "license", "in": "body", + "description": "

    The content of your .ghl license file.

    ", "isRequired": true }, { "type": "string", - "description": "

    You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.

    ", "name": "password", "in": "body", - "isRequired": false + "description": "

    You must provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.

    " }, { "type": "string", - "description": "

    An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.

    ", "name": "settings", "in": "body", - "isRequired": false + "description": "

    An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.

    " } ], "enabledForGitHubApps": false, @@ -223214,10 +224997,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The content of your new .ghl license file.

    ", "name": "license", "in": "body", - "isRequired": false + "description": "

    The content of your new .ghl license file.

    " } ], "enabledForGitHubApps": false, @@ -223483,18 +225265,16 @@ ], "bodyParameters": [ { - "description": "

    The state of enforcement for the hook on this repository.

    ", "type": "string", "name": "enforcement", "in": "body", - "isRequired": false + "description": "

    The state of enforcement for the hook on this repository.

    " }, { - "description": "

    Whether repositories can override enforcement.

    ", "type": "boolean", "name": "allow_downstream_configuration", "in": "body", - "isRequired": false + "description": "

    Whether repositories can override enforcement.

    " } ], "enabledForGitHubApps": true, @@ -223653,24 +225433,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The organization's username.

    ", "name": "login", "in": "body", + "description": "

    The organization's username.

    ", "isRequired": true }, { "type": "string", - "description": "

    The login of the user who will manage this organization.

    ", "name": "admin", "in": "body", + "description": "

    The login of the user who will manage this organization.

    ", "isRequired": true }, { "type": "string", - "description": "

    The organization's display name.

    ", "name": "profile_name", "in": "body", - "isRequired": false + "description": "

    The organization's display name.

    " } ], "enabledForGitHubApps": false, @@ -223837,9 +225616,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The organization's new name.

    ", "name": "login", "in": "body", + "description": "

    The organization's new name.

    ", "isRequired": true } ], @@ -224072,16 +225851,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new pre-receive environment's name.

    ", "name": "name", "in": "body", + "description": "

    The new pre-receive environment's name.

    ", "isRequired": true }, { "type": "string", - "description": "

    URL from which to download a tarball of this environment.

    ", "name": "image_url", "in": "body", + "description": "

    URL from which to download a tarball of this environment.

    ", "isRequired": true } ], @@ -224317,17 +226096,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    This pre-receive environment's new name.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    This pre-receive environment's new name.

    " }, { "type": "string", - "description": "

    URL from which to download a tarball of this environment.

    ", "name": "image_url", "in": "body", - "isRequired": false + "description": "

    URL from which to download a tarball of this environment.

    " } ], "enabledForGitHubApps": false, @@ -224850,49 +226627,43 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the hook.

    ", "name": "name", "in": "body", + "description": "

    The name of the hook.

    ", "isRequired": true }, { "type": "string", - "description": "

    The script that the hook runs.

    ", "name": "script", "in": "body", + "description": "

    The script that the hook runs.

    ", "isRequired": true }, { "type": "object", - "description": "

    The GitHub repository where the script is kept.

    ", - "properties": {}, - "additionalProperties": true, "name": "script_repository", "in": "body", + "description": "

    The GitHub repository where the script is kept.

    ", "isRequired": true }, { "type": "object", - "description": "

    The pre-receive environment where the script is executed.

    ", - "properties": {}, - "additionalProperties": true, "name": "environment", "in": "body", + "description": "

    The pre-receive environment where the script is executed.

    ", "isRequired": true }, { "type": "string", - "description": "

    The state of enforcement for this hook. default: disabled

    ", "name": "enforcement", "in": "body", - "isRequired": false + "description": "

    The state of enforcement for this hook. default: disabled

    " }, { "type": "boolean", - "description": "

    Whether enforcement can be overridden at the org or repo level. default: false

    ", "name": "allow_downstream_configuration", "in": "body", - "isRequired": false + "description": "

    Whether enforcement can be overridden at the org or repo level. default: false

    " } ], "enabledForGitHubApps": false, @@ -225235,49 +227006,39 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the hook.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the hook.

    " }, { "type": "string", - "description": "

    The script that the hook runs.

    ", "name": "script", "in": "body", - "isRequired": false + "description": "

    The script that the hook runs.

    " }, { "type": "object", - "description": "

    The GitHub repository where the script is kept.

    ", - "properties": {}, - "additionalProperties": true, "name": "script_repository", "in": "body", - "isRequired": false + "description": "

    The GitHub repository where the script is kept.

    " }, { "type": "object", - "description": "

    The pre-receive environment where the script is executed.

    ", - "properties": {}, - "additionalProperties": true, "name": "environment", "in": "body", - "isRequired": false + "description": "

    The pre-receive environment where the script is executed.

    " }, { "type": "string", - "description": "

    The state of enforcement for this hook.

    ", "name": "enforcement", "in": "body", - "isRequired": false + "description": "

    The state of enforcement for this hook.

    " }, { "type": "boolean", - "description": "

    Whether enforcement can be overridden at the org or repo level.

    ", "name": "allow_downstream_configuration", "in": "body", - "isRequired": false + "description": "

    Whether enforcement can be overridden at the org or repo level.

    " } ], "enabledForGitHubApps": false, @@ -225738,16 +227499,15 @@ ], "bodyParameters": [ { - "description": "

    The state of enforcement for the hook on this repository.

    ", "type": "string", + "name": "enforcement", + "in": "body", + "description": "

    The state of enforcement for the hook on this repository.

    ", "enum": [ "enabled", "disabled", "testing" - ], - "name": "enforcement", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -226486,14 +228246,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -227015,17 +228767,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The user's username.

    ", "name": "login", "in": "body", + "description": "

    The user's username.

    ", "isRequired": true }, { "type": "string", - "description": "

    Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

    ", "name": "email", "in": "body", - "isRequired": false + "description": "

    Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"

    " } ], "enabledForGitHubApps": false, @@ -227259,9 +229010,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The user's new username.

    ", "name": "login", "in": "body", + "description": "

    The user's new username.

    ", "isRequired": true } ], @@ -227377,10 +229128,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    A list of scopes.

    ", "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes.

    " } ], "enabledForGitHubApps": false, @@ -227718,14 +229468,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -228513,14 +230255,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -229145,10 +230879,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    ", "name": "reason", "in": "body", - "isRequired": false + "description": "

    The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    " } ], "enabledForGitHubApps": false, @@ -229199,10 +230932,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    ", "name": "reason", "in": "body", - "isRequired": false + "description": "

    The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    " } ], "enabledForGitHubApps": false, @@ -229809,76 +231541,27 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Description of the gist

    ", "type": "string", - "examples": [ - "Example Ruby script" - ], "name": "description", "in": "body", - "isRequired": false + "description": "

    Description of the gist

    " }, { - "description": "

    Names and content for the files that make up the gist

    ", "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "content": { - "description": "

    Content of the file

    ", - "readOnly": false, - "type": "string", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "Content of the file", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "content" - ], - "rawType": "object", - "name": "key" - }, - "examples": [ - { - "hello.rb": { - "content": "puts \"Hello, World!\"" - } - } - ], "name": "files", "in": "body", + "description": "

    Names and content for the files that make up the gist

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "files", - "parentType": "object", - "id": "files-object", - "params": [ + "type": "object", + "name": "key", + "description": "

    A user-defined key to represent an item in files.

    ", + "childParamsGroups": [ { - "description": "

    A user-defined key to represent an item in files.

    ", - "type": "string", - "name": "key", - "in": "body", - "rawType": "string", - "rawDescription": "A key to represent an item in files." - } - ] - }, - { - "parentName": "key", - "parentType": "object", - "id": "key-object", - "params": [ - { - "description": "

    Content of the file

    ", - "readOnly": false, "type": "string", "name": "content", - "in": "body", + "description": "

    Content of the file

    ", "isRequired": true } ] @@ -229886,32 +231569,10 @@ ] }, { - "oneOf": [ - { - "description": "Flag indicating whether the gist is public", - "type": "boolean", - "default": false, - "examples": [ - true - ] - }, - { - "type": "string", - "default": "false", - "enum": [ - "true", - "false" - ], - "examples": [ - "true" - ] - } - ], + "type": "boolean or string", "name": "public", "in": "body", - "type": "boolean or string", - "description": "

    Flag indicating whether the gist is public

    ", - "isRequired": false + "description": "

    Flag indicating whether the gist is public

    " } ], "enabledForGitHubApps": false, @@ -233558,108 +235219,31 @@ ], "bodyParameters": [ { - "description": "

    Description of the gist

    ", "type": "string", - "examples": [ - "Example Ruby script" - ], "name": "description", "in": "body", - "isRequired": false + "description": "

    Description of the gist

    " }, { - "description": "

    Names of files to be updated

    ", "type": "object", - "additionalProperties": { - "type": [ - "object", - "null" - ], - "properties": { - "content": { - "description": "

    The new content of the file

    ", - "type": "string", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The new content of the file", - "childParamsGroups": [] - }, - "filename": { - "description": "

    The new filename for the file

    ", - "type": "string or null", - "name": "filename", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new filename for the file", - "childParamsGroups": [] - } - }, - "anyOf": [ - { - "required": [ - "content" - ] - }, - { - "required": [ - "filename" - ] - }, - { - "type": "object", - "maxProperties": 0 - } - ], - "rawType": "object", - "name": "key" - }, - "examples": [ - { - "hello.rb": { - "content": "blah", - "filename": "goodbye.rb" - } - } - ], "name": "files", "in": "body", - "isRequired": false, + "description": "

    Names of files to be updated

    ", "childParamsGroups": [ { - "parentName": "files", - "parentType": "object", - "id": "files-object", - "params": [ + "type": "object", + "name": "key", + "description": "

    A user-defined key to represent an item in files.

    ", + "childParamsGroups": [ { - "description": "

    A user-defined key to represent an item in files.

    ", - "type": "string", - "name": "key", - "in": "body", - "rawType": "string", - "rawDescription": "A key to represent an item in files." - } - ] - }, - { - "parentName": "key", - "parentType": "object", - "id": "key-object", - "params": [ - { - "description": "

    The new content of the file

    ", "type": "string", "name": "content", - "in": "body" + "description": "

    The new content of the file

    " }, { - "description": "

    The new filename for the file

    ", "type": "string or null", "name": "filename", - "in": "body" + "description": "

    The new filename for the file

    " } ] } @@ -239515,14 +241099,10 @@ ], "bodyParameters": [ { - "description": "

    The comment text.

    ", "type": "string", - "maxLength": 65535, - "examples": [ - "Body of the attachment" - ], "name": "body", "in": "body", + "description": "

    The comment text.

    ", "isRequired": true } ], @@ -240212,14 +241792,10 @@ ], "bodyParameters": [ { - "description": "

    The comment text.

    ", "type": "string", - "maxLength": 65535, - "examples": [ - "Body of the attachment" - ], "name": "body", "in": "body", + "description": "

    The comment text.

    ", "isRequired": true } ], @@ -240633,18 +242209,17 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new blob's content.

    ", "name": "content", "in": "body", + "description": "

    The new blob's content.

    ", "isRequired": true }, { "type": "string", - "description": "

    The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.

    ", - "default": "utf-8", "name": "encoding", "in": "body", - "isRequired": false + "description": "

    The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.

    ", + "default": "utf-8" } ], "enabledForGitHubApps": true, @@ -240875,171 +242450,77 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message

    ", "name": "message", "in": "body", + "description": "

    The commit message

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the tree object this commit points to

    ", "name": "tree", "in": "body", + "description": "

    The SHA of the tree object this commit points to

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

    ", "name": "parents", "in": "body", - "isRequired": false + "description": "

    The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

    " }, { "type": "object", - "description": "

    Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "author", "in": "body", - "isRequired": false, + "description": "

    Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] }, { "type": "object", - "description": "

    Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "childParamsGroups": [] - } - }, "name": "committer", "in": "body", - "isRequired": false, + "description": "

    Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - }, - { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "date", + "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] }, { "type": "string", - "description": "

    The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

    ", "name": "signature", "in": "body", - "isRequired": false + "description": "

    The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

    " } ], "enabledForGitHubApps": true, @@ -241908,27 +243389,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

    ", "name": "ref", "in": "body", + "description": "

    The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA1 value for this reference.

    ", "name": "sha", "in": "body", + "description": "

    The SHA1 value for this reference.

    ", "isRequired": true }, { "type": "string", - "examples": [ - "\"refs/heads/newbranch\"" - ], "name": "key", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -242068,18 +243545,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The SHA1 value to set this reference to

    ", "name": "sha", "in": "body", + "description": "

    The SHA1 value to set this reference to

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

    ", - "default": false, "name": "force", "in": "body", - "isRequired": false + "description": "

    Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

    " } ], "enabledForGitHubApps": true, @@ -242281,109 +243756,59 @@ "bodyParameters": [ { "type": "string", - "description": "

    The tag's name. This is typically a version (e.g., \"v0.0.1\").

    ", "name": "tag", "in": "body", + "description": "

    The tag's name. This is typically a version (e.g., \"v0.0.1\").

    ", "isRequired": true }, { "type": "string", - "description": "

    The tag message.

    ", "name": "message", "in": "body", + "description": "

    The tag message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the git object this is tagging.

    ", "name": "object", "in": "body", + "description": "

    The SHA of the git object this is tagging.

    ", "isRequired": true }, { "type": "string", + "name": "type", + "in": "body", "description": "

    The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.

    ", + "isRequired": true, "enum": [ "commit", "tree", "blob" - ], - "name": "type", - "in": "body", - "isRequired": true + ] }, { "type": "object", - "description": "

    An object with information about the individual creating the tag.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author of the tag

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author of the tag", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author of the tag

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author of the tag", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "tagger", "in": "body", - "isRequired": false, + "description": "

    An object with information about the individual creating the tag.

    ", "childParamsGroups": [ { - "parentName": "tagger", - "parentType": "object", - "id": "tagger-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author of the tag

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author of the tag

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "format": "date-time", - "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author of the tag

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author of the tag

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] } @@ -242818,68 +244243,55 @@ "bodyParameters": [ { "type": "array of objects", - "description": "

    Objects (of path, mode, type, and sha) specifying a tree structure.

    ", "name": "tree", "in": "body", + "description": "

    Objects (of path, mode, type, and sha) specifying a tree structure.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "tree", - "parentType": "items", - "id": "tree-items", - "params": [ - { - "type": "string", - "description": "

    The file referenced in the tree.

    ", - "name": "path", - "in": "body" - }, - { - "type": "string", - "description": "

    The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

    ", - "enum": [ - "100644", - "100755", - "040000", - "160000", - "120000" - ], - "name": "mode", - "in": "body" - }, - { - "type": "string", - "description": "

    Either blob, tree, or commit.

    ", - "enum": [ - "blob", - "tree", - "commit" - ], - "name": "type", - "in": "body" - }, - { - "type": "string or null", - "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", - "name": "sha", - "in": "body" - }, - { - "type": "string", - "description": "

    The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", - "name": "content", - "in": "body" - } + "type": "string", + "name": "path", + "description": "

    The file referenced in the tree.

    " + }, + { + "type": "string", + "name": "mode", + "description": "

    The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

    ", + "enum": [ + "100644", + "100755", + "040000", + "160000", + "120000" ] + }, + { + "type": "string", + "name": "type", + "description": "

    Either blob, tree, or commit.

    ", + "enum": [ + "blob", + "tree", + "commit" + ] + }, + { + "type": "string or null", + "name": "sha", + "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    " + }, + { + "type": "string", + "name": "content", + "description": "

    The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    " } ] }, { "type": "string", - "description": "

    The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

    ", "name": "base_tree", "in": "body", - "isRequired": false + "description": "

    The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

    " } ], "enabledForGitHubApps": true, @@ -250882,7 +252294,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ], "schema": { @@ -254019,63 +255432,41 @@ ], "bodyParameters": [ { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "

    The title of the issue.

    ", + "type": "string or integer", "name": "title", "in": "body", - "type": "string or integer", + "description": "

    The title of the issue.

    ", "isRequired": true }, { "type": "string", - "description": "

    The contents of the issue.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the issue.

    " }, { "type": "string or null", - "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "name": "assignee", "in": "body", - "isRequired": false + "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    " }, { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._" - } - ], - "type": "string or integer or null", + "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "isRequired": false + "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    " }, { - "type": "array of strings or array of objects", - "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", + "type": "array", "name": "labels", "in": "body", - "isRequired": false + "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    " }, { "type": "array of strings", - "description": "

    Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    " } ], "enabledForGitHubApps": true, @@ -254261,7 +255652,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -257582,7 +258974,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -260728,74 +262121,56 @@ ], "bodyParameters": [ { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "

    The title of the issue.

    ", - "type": "string or integer or null", + "type": "null or string or integer or string or integer", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the issue.

    " }, { "type": "string or null", - "description": "

    The contents of the issue.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the issue.

    " }, { "type": "string or null", - "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", "in": "body", - "isRequired": false + "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    State of the issue. Either open or closed.

    ", "enum": [ "open", "closed" - ], - "name": "state", - "in": "body", - "isRequired": false + ] }, { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._" - } - ], - "type": "string or integer or null", + "type": "string or null", + "name": "state_reason", + "in": "body", + "description": "

    The reason for the current state

    " + }, + { + "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "isRequired": false + "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    " }, { - "type": "array of strings or array of objects", - "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", + "type": "array", "name": "labels", "in": "body", - "isRequired": false + "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    " }, { "type": "array of strings", - "description": "

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    " } ], "enabledForGitHubApps": true, @@ -260983,7 +262358,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -264138,16 +265514,15 @@ "bodyParameters": [ { "type": "string", + "name": "lock_reason", + "in": "body", "description": "

    The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
    \n* off-topic
    \n* too heated
    \n* resolved
    \n* spam

    ", "enum": [ "off-topic", "too heated", "resolved", "spam" - ], - "name": "lock_reason", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -268130,10 +269505,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

    " } ], "enabledForGitHubApps": true, @@ -268315,7 +269689,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -271446,10 +272821,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

    " } ], "enabledForGitHubApps": true, @@ -271631,7 +273005,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -276296,9 +277671,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true } ], @@ -277888,9 +279263,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true } ], @@ -278840,7 +280215,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ], @@ -283784,7 +285160,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } }, "schema": { @@ -298812,10 +300189,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

    ", "name": "labels", - "in": "body" + "in": "body", + "description": "

    The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

    " } ], "enabledForGitHubApps": true, @@ -298990,10 +300366,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

    ", "name": "labels", - "in": "body" + "in": "body", + "description": "

    The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

    " } ], "enabledForGitHubApps": true, @@ -299559,24 +300934,22 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "name": "name", "in": "body", + "description": "

    The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "isRequired": true }, { "type": "string", - "description": "

    The hexadecimal color code for the label, without the leading #.

    ", "name": "color", "in": "body", - "isRequired": false + "description": "

    The hexadecimal color code for the label, without the leading #.

    " }, { "type": "string", - "description": "

    A short description of the label. Must be 100 characters or fewer.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the label. Must be 100 characters or fewer.

    " } ], "enabledForGitHubApps": true, @@ -299880,24 +301253,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "name": "new_name", "in": "body", - "isRequired": false + "description": "

    The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    " }, { "type": "string", - "description": "

    The hexadecimal color code for the label, without the leading #.

    ", "name": "color", "in": "body", - "isRequired": false + "description": "

    The hexadecimal color code for the label, without the leading #.

    " }, { "type": "string", - "description": "

    A short description of the label. Must be 100 characters or fewer.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the label. Must be 100 characters or fewer.

    " } ], "enabledForGitHubApps": true, @@ -300750,37 +302120,33 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the milestone.

    ", "name": "title", "in": "body", + "description": "

    The title of the milestone.

    ", "isRequired": true }, { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the milestone. Either open or closed.

    ", "enum": [ "open", "closed" ], - "default": "open", - "name": "state", - "in": "body", - "isRequired": false + "default": "open" }, { "type": "string", - "description": "

    A description of the milestone.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A description of the milestone.

    " }, { "type": "string", - "format": "date-time", - "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "due_on", "in": "body", - "isRequired": false + "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ], "enabledForGitHubApps": true, @@ -301623,37 +302989,32 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the milestone.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the milestone.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the milestone. Either open or closed.

    ", "enum": [ "open", "closed" ], - "default": "open", - "name": "state", - "in": "body", - "isRequired": false + "default": "open" }, { "type": "string", - "description": "

    A description of the milestone.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A description of the milestone.

    " }, { "type": "string", - "format": "date-time", - "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "due_on", "in": "body", - "isRequired": false + "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ], "enabledForGitHubApps": true, @@ -318606,33 +319967,28 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The Markdown text to render in HTML.

    ", "type": "string", "name": "text", "in": "body", + "description": "

    The Markdown text to render in HTML.

    ", "isRequired": true }, { + "type": "string", + "name": "mode", + "in": "body", "description": "

    The rendering mode. Can be either markdown or gfm.

    ", "enum": [ "markdown", "gfm" ], - "default": "markdown", - "type": "string", - "examples": [ - "markdown" - ], - "name": "mode", - "in": "body", - "isRequired": false + "default": "markdown" }, { - "description": "

    The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

    ", "type": "string", "name": "context", "in": "body", - "isRequired": false + "description": "

    The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

    " } ], "enabledForGitHubApps": true, @@ -321901,88 +323257,58 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    A list of arrays indicating which repositories should be migrated.

    ", "name": "repositories", "in": "body", + "description": "

    A list of arrays indicating which repositories should be migrated.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Indicates whether repositories should be locked (to prevent manipulation) while migrating data.

    ", - "default": false, - "examples": [ - true - ], "name": "lock_repositories", "in": "body", - "isRequired": false + "description": "

    Indicates whether repositories should be locked (to prevent manipulation) while migrating data.

    " }, { "type": "boolean", - "description": "

    Indicates whether metadata should be excluded and only git source should be included for the migration.

    ", - "default": false, "name": "exclude_metadata", "in": "body", - "isRequired": false + "description": "

    Indicates whether metadata should be excluded and only git source should be included for the migration.

    " }, { "type": "boolean", - "description": "

    Indicates whether the repository git data should be excluded from the migration.

    ", - "default": false, "name": "exclude_git_data", "in": "body", - "isRequired": false + "description": "

    Indicates whether the repository git data should be excluded from the migration.

    " }, { "type": "boolean", - "description": "

    Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).

    ", - "default": false, - "examples": [ - true - ], "name": "exclude_attachments", "in": "body", - "isRequired": false + "description": "

    Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).

    " }, { "type": "boolean", - "description": "

    Indicates whether releases should be excluded from the migration (to reduce migration archive file size).

    ", - "default": false, - "examples": [ - true - ], "name": "exclude_releases", "in": "body", - "isRequired": false + "description": "

    Indicates whether releases should be excluded from the migration (to reduce migration archive file size).

    " }, { "type": "boolean", - "description": "

    Indicates whether projects owned by the organization or users should be excluded. from the migration.

    ", - "default": false, - "examples": [ - true - ], "name": "exclude_owner_projects", "in": "body", - "isRequired": false + "description": "

    Indicates whether projects owned by the organization or users should be excluded. from the migration.

    " }, { "type": "boolean", - "description": "

    Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

    ", - "default": false, - "examples": [ - true - ], "name": "org_metadata_only", "in": "body", - "isRequired": false + "description": "

    Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

    " }, { "type": "array of strings", - "description": "

    Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: \"repositories\".

    ", "name": "exclude", "in": "body", - "isRequired": false + "description": "

    Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: \"repositories\".

    " } ], "enabledForGitHubApps": false, @@ -327835,92 +329161,52 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Lock the repositories being migrated at the start of the migration

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "lock_repositories", "in": "body", - "isRequired": false + "description": "

    Lock the repositories being migrated at the start of the migration

    " }, { - "description": "

    Indicates whether metadata should be excluded and only git source should be included for the migration.

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_metadata", "in": "body", - "isRequired": false + "description": "

    Indicates whether metadata should be excluded and only git source should be included for the migration.

    " }, { - "description": "

    Indicates whether the repository git data should be excluded from the migration.

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_git_data", "in": "body", - "isRequired": false + "description": "

    Indicates whether the repository git data should be excluded from the migration.

    " }, { - "description": "

    Do not include attachments in the migration

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_attachments", "in": "body", - "isRequired": false + "description": "

    Do not include attachments in the migration

    " }, { - "description": "

    Do not include releases in the migration

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_releases", "in": "body", - "isRequired": false + "description": "

    Do not include releases in the migration

    " }, { - "description": "

    Indicates whether projects owned by the organization or users should be excluded.

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_owner_projects", "in": "body", - "isRequired": false + "description": "

    Indicates whether projects owned by the organization or users should be excluded.

    " }, { "type": "boolean", - "description": "

    Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

    ", - "default": false, - "examples": [ - true - ], "name": "org_metadata_only", "in": "body", - "isRequired": false + "description": "

    Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

    " }, { - "description": "

    Exclude attributes from the API response to improve performance

    ", - "readOnly": false, "type": "array of strings", - "examples": [ - "repositories" - ], "name": "exclude", "in": "body", - "isRequired": false + "description": "

    Exclude attributes from the API response to improve performance

    " }, { "type": "array of strings", @@ -333372,14 +334658,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -333871,55 +335149,40 @@ "parameters": [], "bodyParameters": [ { - "description": "

    A list of scopes that this authorization is in.

    ", "type": "array of strings or null", - "examples": [ - "public_repo", - "user" - ], "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes that this authorization is in.

    " }, { - "description": "

    A note to remind you what the OAuth token is for.

    ", "type": "string", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    A note to remind you what the OAuth token is for.

    " }, { - "description": "

    A URL to remind you what app the OAuth token is for.

    ", "type": "string", "name": "note_url", "in": "body", - "isRequired": false + "description": "

    A URL to remind you what app the OAuth token is for.

    " }, { - "description": "

    The OAuth app client key for which to create the token.

    ", - "maxLength": 20, "type": "string", "name": "client_id", "in": "body", - "isRequired": false + "description": "

    The OAuth app client key for which to create the token.

    " }, { - "description": "

    The OAuth app client secret for which to create the token.

    ", - "maxLength": 40, "type": "string", "name": "client_secret", "in": "body", - "isRequired": false + "description": "

    The OAuth app client secret for which to create the token.

    " }, { - "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    ", "type": "string", "name": "fingerprint", "in": "body", - "isRequired": false + "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    " } ], "enabledForGitHubApps": false, @@ -334263,14 +335526,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -334780,47 +336035,35 @@ ], "bodyParameters": [ { - "description": "

    The OAuth app client secret for which to create the token.

    ", - "maxLength": 40, "type": "string", "name": "client_secret", "in": "body", + "description": "

    The OAuth app client secret for which to create the token.

    ", "isRequired": true }, { - "description": "

    A list of scopes that this authorization is in.

    ", "type": "array of strings or null", - "examples": [ - "public_repo", - "user" - ], "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes that this authorization is in.

    " }, { - "description": "

    A note to remind you what the OAuth token is for.

    ", "type": "string", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    A note to remind you what the OAuth token is for.

    " }, { - "description": "

    A URL to remind you what app the OAuth token is for.

    ", "type": "string", "name": "note_url", "in": "body", - "isRequired": false + "description": "

    A URL to remind you what app the OAuth token is for.

    " }, { - "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    ", "type": "string", "name": "fingerprint", "in": "body", - "isRequired": false + "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    " } ], "enabledForGitHubApps": false, @@ -335166,14 +336409,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -335969,14 +337204,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -336495,40 +337722,29 @@ ], "bodyParameters": [ { - "description": "

    The OAuth app client secret for which to create the token.

    ", - "maxLength": 40, "type": "string", "name": "client_secret", "in": "body", + "description": "

    The OAuth app client secret for which to create the token.

    ", "isRequired": true }, { - "description": "

    A list of scopes that this authorization is in.

    ", "type": "array of strings or null", - "examples": [ - "public_repo", - "user" - ], "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes that this authorization is in.

    " }, { - "description": "

    A note to remind you what the OAuth token is for.

    ", "type": "string", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    A note to remind you what the OAuth token is for.

    " }, { - "description": "

    A URL to remind you what app the OAuth token is for.

    ", "type": "string", "name": "note_url", "in": "body", - "isRequired": false + "description": "

    A URL to remind you what app the OAuth token is for.

    " } ], "enabledForGitHubApps": false, @@ -336875,14 +338091,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -337679,14 +338887,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -338512,14 +339712,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -339016,53 +340208,40 @@ ], "bodyParameters": [ { - "description": "

    A list of scopes that this authorization is in.

    ", "type": "array of strings or null", - "examples": [ - "public_repo", - "user" - ], "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes that this authorization is in.

    " }, { - "description": "

    A list of scopes to add to this authorization.

    ", "type": "array of strings", "name": "add_scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes to add to this authorization.

    " }, { - "description": "

    A list of scopes to remove from this authorization.

    ", "type": "array of strings", "name": "remove_scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes to remove from this authorization.

    " }, { - "description": "

    A note to remind you what the OAuth token is for.

    ", "type": "string", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    A note to remind you what the OAuth token is for.

    " }, { - "description": "

    A URL to remind you what app the OAuth token is for.

    ", "type": "string", "name": "note_url", "in": "body", - "isRequired": false + "description": "

    A URL to remind you what app the OAuth token is for.

    " }, { - "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    ", "type": "string", "name": "fingerprint", "in": "body", - "isRequired": false + "description": "

    A unique string to distinguish an authorization from others created for the same client ID and user.

    " } ], "enabledForGitHubApps": false, @@ -339400,14 +340579,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -340606,69 +341777,62 @@ "bodyParameters": [ { "type": "string", - "description": "

    Billing email address. This address is not publicized.

    ", "name": "billing_email", "in": "body", - "isRequired": false + "description": "

    Billing email address. This address is not publicized.

    " }, { "type": "string", - "description": "

    The company name.

    ", "name": "company", "in": "body", - "isRequired": false + "description": "

    The company name.

    " }, { "type": "string", - "description": "

    The publicly visible email address.

    ", "name": "email", "in": "body", - "isRequired": false + "description": "

    The publicly visible email address.

    " }, { "type": "string", - "description": "

    The Twitter username of the company.

    ", "name": "twitter_username", "in": "body", - "isRequired": false + "description": "

    The Twitter username of the company.

    " }, { "type": "string", - "description": "

    The location.

    ", "name": "location", "in": "body", - "isRequired": false + "description": "

    The location.

    " }, { "type": "string", - "description": "

    The shorthand name of the company.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The shorthand name of the company.

    " }, { "type": "string", - "description": "

    The description of the company.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the company.

    " }, { "type": "boolean", - "description": "

    Whether an organization can use organization projects.

    ", "name": "has_organization_projects", "in": "body", - "isRequired": false + "description": "

    Whether an organization can use organization projects.

    " }, { "type": "boolean", - "description": "

    Whether repositories that belong to the organization can use repository projects.

    ", "name": "has_repository_projects", "in": "body", - "isRequired": false + "description": "

    Whether repositories that belong to the organization can use repository projects.

    " }, { "type": "string", + "name": "default_repository_permission", + "in": "body", "description": "

    Default permission level members have for organization repositories.

    ", "enum": [ "read", @@ -340676,85 +341840,68 @@ "admin", "none" ], - "default": "read", - "name": "default_repository_permission", - "in": "body", - "isRequired": false + "default": "read" }, { "type": "boolean", - "description": "

    Whether of non-admin organization members can create repositories. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

    ", - "default": true, "name": "members_can_create_repositories", "in": "body", - "isRequired": false + "description": "

    Whether of non-admin organization members can create repositories. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

    ", + "default": true }, { "type": "boolean", - "description": "

    Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_internal_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_private_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "string", + "name": "members_allowed_repository_creation_type", + "in": "body", "description": "

    Specifies which types of repositories non-admin organization members can create.\nNote: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See the parameter deprecation notice in the operation description for details.

    ", "enum": [ "all", "private", "none" - ], - "name": "members_allowed_repository_creation_type", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.

    ", - "default": true, "name": "members_can_create_pages", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.

    ", + "default": true }, { "type": "boolean", - "description": "

    Whether organization members can fork private organization repositories.

    ", - "default": false, "name": "members_can_fork_private_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can fork private organization repositories.

    " }, { "type": "boolean", - "description": "

    Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.

    ", - "default": false, "name": "web_commit_signoff_required", "in": "body", - "isRequired": false + "description": "

    Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.

    " }, { "type": "string", - "examples": [ - "\"http://github.blog\"" - ], "name": "blog", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -342115,14 +343262,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -343056,7 +344195,7 @@ } ], "previews": [], - "descriptionHTML": "

    List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.

    \n

    For more information on custom repository roles, see \"Managing custom repository roles for an organization\".

    ", + "descriptionHTML": "

    List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.

    \n

    To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with admin:org repo scope.\nGitHub Apps must have the organization_custom_roles:read organization permission to use this endpoint.

    \n

    For more information on custom repository roles, see \"Managing custom repository roles for an organization\".

    ", "statusCodes": [ { "httpStatusCode": "200", @@ -343939,15 +345078,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role to give the user in the organization. Can be one of:
    \n* admin - The user will become an owner of the organization.
    \n* member - The user will become a non-owner member of the organization.

    ", "enum": [ "admin", "member" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -345787,13 +346925,13 @@ "bodyParameters": [ { "type": "string", - "description": "

    The state that the membership should be in. Only \"active\" will be accepted.

    ", - "enum": [ - "active" - ], "name": "state", "in": "body", - "isRequired": true + "description": "

    The state that the membership should be in. Only \"active\" will be accepted.

    ", + "isRequired": true, + "enum": [ + "active" + ] } ], "enabledForGitHubApps": false, @@ -346505,11 +347643,9 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

    ", - "default": false, "name": "async", "in": "body", - "isRequired": false + "description": "

    When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

    " } ], "enabledForGitHubApps": true, @@ -346867,203 +348003,66 @@ "bodyParameters": [ { "type": "string", - "description": "

    Must be passed as \"web\".

    ", "name": "name", "in": "body", + "description": "

    Must be passed as \"web\".

    ", "isRequired": true }, { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - }, - "username": { - "type": "string", - "examples": [ - "\"kdaigle\"" - ], - "name": "username", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "password": { - "type": "string", - "examples": [ - "\"password\"" - ], - "name": "password", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"kdaigle\"" - ], - "name": "username", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"password\"" - ], - "name": "password", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "username", + "description": "" + }, + { + "type": "string", + "name": "password", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, @@ -347470,162 +348469,54 @@ "bodyParameters": [ { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true }, { "type": "string", - "examples": [ - "\"web\"" - ], "name": "name", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -347997,53 +348888,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": true, @@ -349064,77 +349929,35 @@ "bodyParameters": [ { "type": "string", + "name": "build_type", + "in": "body", "description": "

    The process in which the Page will be built. Possible values are \"legacy\" and \"workflow\".

    ", "enum": [ "legacy", "workflow" - ], - "name": "build_type", - "in": "body", - "isRequired": false + ] }, { "type": "object", + "name": "source", + "in": "body", "description": "

    The source branch and directory used to publish your Pages site.

    ", - "properties": { - "branch": { + "childParamsGroups": [ + { "type": "string", - "description": "

    The repository branch used to publish your site's source files.

    ", "name": "branch", - "in": "body", - "rawType": "string", - "rawDescription": "The repository branch used to publish your site's source files.", - "isRequired": true, - "childParamsGroups": [] + "description": "

    The repository branch used to publish your site's source files.

    ", + "isRequired": true }, - "path": { + { "type": "string", + "name": "path", "description": "

    The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: /

    ", "enum": [ "/", "/docs" ], - "default": "/", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "branch" - ], - "name": "source", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "source", - "parentType": "object", - "id": "source-object", - "params": [ - { - "type": "string", - "description": "

    The repository branch used to publish your site's source files.

    ", - "name": "branch", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: /

    ", - "enum": [ - "/", - "/docs" - ], - "default": "/", - "name": "path", - "in": "body", - "isRequired": false - } - ] + "default": "/" } ] } @@ -349418,75 +350241,37 @@ "bodyParameters": [ { "type": "string or null", - "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    ", "name": "cname", "in": "body", - "isRequired": false + "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    " }, { "type": "boolean", - "description": "

    Specify whether HTTPS should be enforced for the repository.

    ", "name": "https_enforced", "in": "body", - "isRequired": false + "description": "

    Specify whether HTTPS should be enforced for the repository.

    " }, { "type": "boolean", - "description": "

    Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

    ", "name": "public", "in": "body", - "isRequired": false + "description": "

    Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

    " }, { "type": "string", + "name": "build_type", + "in": "body", "description": "

    The process by which the GitHub Pages site will be built. workflow means that the site is built by a custom GitHub Actions workflow. legacy means that the site is built by GitHub when changes are pushed to a specific branch.

    ", "enum": [ "legacy", "workflow" - ], - "name": "build_type", - "in": "body", - "isRequired": false + ] }, { - "anyOf": [ - { - "type": "string", - "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", - "enum": [ - "gh-pages", - "master", - "master /docs" - ] - }, - { - "type": "object", - "description": "Update the source for the repository. Must include the branch name and path.", - "properties": { - "branch": { - "type": "string", - "description": "The repository branch used to publish your site's source files." - }, - "path": { - "type": "string", - "description": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.", - "enum": [ - "/", - "/docs" - ] - } - }, - "required": [ - "branch", - "path" - ] - } - ], + "type": "", "name": "source", "in": "body", - "type": "", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -351068,17 +351853,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the project.

    ", "name": "name", "in": "body", + "description": "

    The name of the project.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the project.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The description of the project.

    " } ], "enabledForGitHubApps": true, @@ -351855,54 +352639,40 @@ ], "bodyParameters": [ { - "description": "

    Name of the project

    ", "type": "string", - "examples": [ - "Week One Sprint" - ], "name": "name", "in": "body", - "isRequired": false + "description": "

    Name of the project

    " }, { - "description": "

    Body of the project

    ", "type": "string or null", - "examples": [ - "This project represents the sprint of the first week in January" - ], "name": "body", "in": "body", - "isRequired": false + "description": "

    Body of the project

    " }, { - "description": "

    State of the project; either 'open' or 'closed'

    ", "type": "string", - "examples": [ - "open" - ], "name": "state", "in": "body", - "isRequired": false + "description": "

    State of the project; either 'open' or 'closed'

    " }, { - "description": "

    The baseline permission that all organization members have on this project

    ", "type": "string", + "name": "organization_permission", + "in": "body", + "description": "

    The baseline permission that all organization members have on this project

    ", "enum": [ "read", "write", "admin", "none" - ], - "name": "organization_permission", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether or not this project can be seen by everyone.

    ", "type": "boolean", "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether or not this project can be seen by everyone.

    " } ], "enabledForGitHubApps": true, @@ -352815,17 +353585,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the project.

    ", "name": "name", "in": "body", + "description": "

    The name of the project.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the project.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The description of the project.

    " } ], "enabledForGitHubApps": true, @@ -353213,24 +353982,17 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Name of the project

    ", "type": "string", - "examples": [ - "Week One Sprint" - ], "name": "name", "in": "body", + "description": "

    Name of the project

    ", "isRequired": true }, { - "description": "

    Body of the project

    ", "type": "string or null", - "examples": [ - "This project represents the sprint of the first week in January" - ], "name": "body", "in": "body", - "isRequired": false + "description": "

    Body of the project

    " } ], "enabledForGitHubApps": true, @@ -354390,24 +355152,16 @@ ], "bodyParameters": [ { - "description": "

    The project card's note

    ", "type": "string or null", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    The project card's note

    " }, { - "description": "

    Whether or not the card is archived

    ", "type": "boolean", - "examples": [ - false - ], "name": "archived", "in": "body", - "isRequired": false + "description": "

    Whether or not the card is archived

    " } ], "enabledForGitHubApps": true, @@ -354837,25 +355591,17 @@ ], "bodyParameters": [ { - "description": "

    The position of the card in a column. Can be one of: top, bottom, or after:<card_id> to place after the specified card.

    ", "type": "string", - "pattern": "^(?:top|bottom|after:\\d+)$", - "examples": [ - "bottom" - ], "name": "position", "in": "body", + "description": "

    The position of the card in a column. Can be one of: top, bottom, or after:<card_id> to place after the specified card.

    ", "isRequired": true }, { - "description": "

    The unique identifier of the column the card should be moved to

    ", "type": "integer", - "examples": [ - 42 - ], "name": "column_id", "in": "body", - "isRequired": false + "description": "

    The unique identifier of the column the card should be moved to

    " } ], "enabledForGitHubApps": true, @@ -355327,33 +356073,24 @@ ], "bodyParameters": [ { - "description": "

    The project card's note

    ", "type": "string or null", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", + "description": "

    The project card's note

    ", "isRequired": true }, { - "description": "

    The unique identifier of the content associated with the card

    ", "type": "integer", - "examples": [ - 42 - ], "name": "content_id", "in": "body", + "description": "

    The unique identifier of the content associated with the card

    ", "isRequired": true }, { - "description": "

    The piece of content associated with the card

    ", "type": "string", - "examples": [ - "PullRequest" - ], "name": "content_type", "in": "body", + "description": "

    The piece of content associated with the card

    ", "isRequired": true } ], @@ -356019,20 +356756,16 @@ ], "bodyParameters": [ { + "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant the collaborator.

    ", "enum": [ "read", "write", "admin" ], - "default": "write", - "type": "string", - "examples": [ - "write" - ], - "name": "permission", - "in": "body", - "isRequired": false + "default": "write" } ], "enabledForGitHubApps": true, @@ -356608,13 +357341,10 @@ ], "bodyParameters": [ { - "description": "

    Name of the project column

    ", "type": "string", - "examples": [ - "Remaining tasks" - ], "name": "name", "in": "body", + "description": "

    Name of the project column

    ", "isRequired": true } ], @@ -356820,14 +357550,10 @@ ], "bodyParameters": [ { - "description": "

    The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

    ", "type": "string", - "pattern": "^(?:first|last|after:\\d+)$", - "examples": [ - "last" - ], "name": "position", "in": "body", + "description": "

    The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

    ", "isRequired": true } ], @@ -357067,13 +357793,10 @@ ], "bodyParameters": [ { - "description": "

    Name of the project column

    ", "type": "string", - "examples": [ - "Remaining tasks" - ], "name": "name", "in": "body", + "description": "

    Name of the project column

    ", "isRequired": true } ], @@ -362967,55 +363690,47 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the new pull request. Required unless issue is specified.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the new pull request. Required unless issue is specified.

    " }, { "type": "string", - "description": "

    The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

    ", "name": "head", "in": "body", + "description": "

    The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

    ", "isRequired": true }, { "type": "string", - "description": "

    The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

    ", "name": "base", "in": "body", + "description": "

    The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    The contents of the pull request.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the pull request.

    " }, { "type": "boolean", - "description": "

    Indicates whether maintainers can modify the pull request.

    ", "name": "maintainer_can_modify", "in": "body", - "isRequired": false + "description": "

    Indicates whether maintainers can modify the pull request.

    " }, { "type": "boolean", - "description": "

    Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

    ", "name": "draft", "in": "body", - "isRequired": false + "description": "

    Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

    " }, { "type": "integer", - "description": "

    An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified.

    ", - "examples": [ - 1 - ], "name": "issue", "in": "body", - "isRequired": false + "description": "

    An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified.

    " } ], "enabledForGitHubApps": true, @@ -370664,42 +371379,37 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the pull request.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the pull request.

    " }, { "type": "string", - "description": "

    The contents of the pull request.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the pull request.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    State of this Pull Request. Either open or closed.

    ", "enum": [ "open", "closed" - ], - "name": "state", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "description": "

    The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

    ", "name": "base", "in": "body", - "isRequired": false + "description": "

    The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

    " }, { "type": "boolean", - "description": "

    Indicates whether maintainers can modify the pull request.

    ", "name": "maintainer_can_modify", "in": "body", - "isRequired": false + "description": "

    Indicates whether maintainers can modify the pull request.

    " } ], "enabledForGitHubApps": true, @@ -375649,36 +376359,32 @@ "bodyParameters": [ { "type": "string", - "description": "

    Title for the automatic commit message.

    ", "name": "commit_title", "in": "body", - "isRequired": false + "description": "

    Title for the automatic commit message.

    " }, { "type": "string", - "description": "

    Extra detail to append to automatic commit message.

    ", "name": "commit_message", "in": "body", - "isRequired": false + "description": "

    Extra detail to append to automatic commit message.

    " }, { "type": "string", - "description": "

    SHA that pull request head must match to allow merge.

    ", "name": "sha", "in": "body", - "isRequired": false + "description": "

    SHA that pull request head must match to allow merge.

    " }, { "type": "string", + "name": "merge_method", + "in": "body", "description": "

    Merge method to use. Possible values are merge, squash or rebase. Default is merge.

    ", "enum": [ "merge", "squash", "rebase" - ], - "name": "merge_method", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -375796,10 +376502,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

    ", "name": "expected_head_sha", "in": "body", - "isRequired": false + "description": "

    The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

    " } ], "enabledForGitHubApps": false, @@ -377188,9 +377893,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the reply to the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the reply to the review comment.

    ", "isRequired": true } ], @@ -378563,82 +379268,70 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the review comment.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

    ", "name": "commit_id", "in": "body", + "description": "

    The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

    ", "isRequired": true }, { "type": "string", - "description": "

    The relative path to the file that necessitates a comment.

    ", "name": "path", "in": "body", + "description": "

    The relative path to the file that necessitates a comment.

    ", "isRequired": true }, { "type": "integer", - "description": "

    This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    ", - "deprecated": true, - "x-github": { - "deprecationDate": "2022-11-01" - }, "name": "position", "in": "body", - "isRequired": false + "description": "

    This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    " }, { "type": "string", + "name": "side", + "in": "body", "description": "

    In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

    ", "enum": [ "LEFT", "RIGHT" - ], - "name": "side", - "in": "body", - "isRequired": false + ] }, { "type": "integer", - "description": "

    The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

    ", "name": "line", "in": "body", + "description": "

    The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

    ", "isRequired": true }, { "type": "integer", - "description": "

    Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

    ", "name": "start_line", "in": "body", - "isRequired": false + "description": "

    Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

    " }, { "type": "string", + "name": "start_side", + "in": "body", "description": "

    Required when using multi-line comments unless using in_reply_to. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

    ", "enum": [ "LEFT", "RIGHT", "side" - ], - "name": "start_side", - "in": "body", - "isRequired": false + ] }, { "type": "integer", - "description": "

    The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

    ", - "examples": [ - 2 - ], "name": "in_reply_to", "in": "body", - "isRequired": false + "description": "

    The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

    " } ], "enabledForGitHubApps": true, @@ -379287,9 +379980,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the review comment.

    ", "isRequired": true } ], @@ -380407,17 +381100,15 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of user logins that will be requested.

    ", "name": "reviewers", "in": "body", - "isRequired": false + "description": "

    An array of user logins that will be requested.

    " }, { "type": "array of strings", - "description": "

    An array of team slugs that will be requested.

    ", "name": "team_reviewers", "in": "body", - "isRequired": false + "description": "

    An array of team slugs that will be requested.

    " } ], "enabledForGitHubApps": true, @@ -386126,17 +386817,16 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of user logins that will be removed.

    ", "name": "reviewers", "in": "body", + "description": "

    An array of user logins that will be removed.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    An array of team slugs that will be removed.

    ", "name": "team_reviewers", "in": "body", - "isRequired": false + "description": "

    An array of team slugs that will be removed.

    " } ], "enabledForGitHubApps": true, @@ -392224,104 +392914,69 @@ "bodyParameters": [ { "type": "string", - "description": "

    The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

    ", "name": "commit_id", "in": "body", - "isRequired": false + "description": "

    The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

    " }, { "type": "string", - "description": "

    Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

    " }, { "type": "string", + "name": "event", + "in": "body", "description": "

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

    ", "enum": [ "APPROVE", "REQUEST_CHANGES", "COMMENT" - ], - "name": "event", - "in": "body", - "isRequired": false + ] }, { "type": "array of objects", - "description": "

    Use the following table to specify the location, destination, and contents of the draft review comment.

    ", "name": "comments", "in": "body", - "isRequired": false, + "description": "

    Use the following table to specify the location, destination, and contents of the draft review comment.

    ", "childParamsGroups": [ { - "parentName": "comments", - "parentType": "items", - "id": "comments-items", - "params": [ - { - "type": "string", - "description": "

    The relative path to the file that necessitates a review comment.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

    ", - "name": "position", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Text of the review comment.

    ", - "name": "body", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "examples": [ - 28 - ], - "name": "line", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "RIGHT" - ], - "name": "side", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "integer", - "examples": [ - 26 - ], - "name": "start_line", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "LEFT" - ], - "name": "start_side", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "path", + "description": "

    The relative path to the file that necessitates a review comment.

    ", + "isRequired": true + }, + { + "type": "integer", + "name": "position", + "description": "

    The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

    " + }, + { + "type": "string", + "name": "body", + "description": "

    Text of the review comment.

    ", + "isRequired": true + }, + { + "type": "integer", + "name": "line", + "description": "" + }, + { + "type": "string", + "name": "side", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + }, + { + "type": "string", + "name": "start_side", + "description": "" } ] } @@ -393168,9 +393823,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The body text of the pull request review.

    ", "name": "body", "in": "body", + "description": "

    The body text of the pull request review.

    ", "isRequired": true } ], @@ -394641,23 +395296,19 @@ "bodyParameters": [ { "type": "string", - "description": "

    The message for the pull request review dismissal

    ", "name": "message", "in": "body", + "description": "

    The message for the pull request review dismissal

    ", "isRequired": true }, { "type": "string", - "enum": [ - "DISMISS" - ], - "examples": [ - "\"DISMISS\"" - ], "name": "event", "in": "body", "description": "", - "isRequired": false + "enum": [ + "DISMISS" + ] } ], "enabledForGitHubApps": true, @@ -395083,22 +395734,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The body text of the pull request review

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The body text of the pull request review

    " }, { "type": "string", + "name": "event", + "in": "body", "description": "

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.

    ", + "isRequired": true, "enum": [ "APPROVE", "REQUEST_CHANGES", "COMMENT" - ], - "name": "event", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -396214,7 +396864,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -396224,10 +396877,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -397254,7 +397904,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -397264,10 +397917,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -398286,7 +398936,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the commit comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -398296,10 +398949,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -399322,7 +399972,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the issue comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -399332,10 +399985,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -400362,7 +401012,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the issue.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -400372,10 +401025,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -401398,7 +402048,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the pull request review comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -401408,10 +402061,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -402432,7 +403082,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the release.

    ", + "isRequired": true, "enum": [ "+1", "laugh", @@ -402440,10 +403093,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -403462,7 +404112,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -403472,10 +404125,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -404127,7 +404777,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -404137,10 +404790,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -405187,55 +405837,46 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the tag.

    ", "name": "tag_name", "in": "body", + "description": "

    The name of the tag.

    ", "isRequired": true }, { "type": "string", - "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    ", "name": "target_commitish", "in": "body", - "isRequired": false + "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    " }, { "type": "string", - "description": "

    The name of the release.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the release.

    " }, { "type": "string", - "description": "

    Text describing the contents of the tag.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Text describing the contents of the tag.

    " }, { "type": "boolean", - "description": "

    true to create a draft (unpublished) release, false to create a published one.

    ", - "default": false, "name": "draft", "in": "body", - "isRequired": false + "description": "

    true to create a draft (unpublished) release, false to create a published one.

    " }, { "type": "boolean", - "description": "

    true to identify the release as a prerelease. false to identify the release as a full release.

    ", - "default": false, "name": "prerelease", "in": "body", - "isRequired": false + "description": "

    true to identify the release as a prerelease. false to identify the release as a full release.

    " }, { "type": "boolean", - "description": "

    Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes.

    ", - "default": false, "name": "generate_release_notes", "in": "body", - "isRequired": false + "description": "

    Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes.

    " } ], "enabledForGitHubApps": true, @@ -405961,31 +406602,28 @@ "bodyParameters": [ { "type": "string", - "description": "

    The tag name for the release. This can be an existing tag or a new one.

    ", "name": "tag_name", "in": "body", + "description": "

    The tag name for the release. This can be an existing tag or a new one.

    ", "isRequired": true }, { "type": "string", - "description": "

    Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.

    ", "name": "target_commitish", "in": "body", - "isRequired": false + "description": "

    Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.

    " }, { "type": "string", - "description": "

    The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.

    ", "name": "previous_tag_name", "in": "body", - "isRequired": false + "description": "

    The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.

    " }, { "type": "string", - "description": "

    Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.

    ", "name": "configuration_file_path", "in": "body", - "isRequired": false + "description": "

    Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.

    " } ], "enabledForGitHubApps": true, @@ -408242,45 +408880,39 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the tag.

    ", "name": "tag_name", "in": "body", - "isRequired": false + "description": "

    The name of the tag.

    " }, { "type": "string", - "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    ", "name": "target_commitish", "in": "body", - "isRequired": false + "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    " }, { "type": "string", - "description": "

    The name of the release.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the release.

    " }, { "type": "string", - "description": "

    Text describing the contents of the tag.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Text describing the contents of the tag.

    " }, { "type": "boolean", - "description": "

    true makes the release a draft, and false publishes the release.

    ", "name": "draft", "in": "body", - "isRequired": false + "description": "

    true makes the release a draft, and false publishes the release.

    " }, { "type": "boolean", - "description": "

    true to identify the release as a prerelease, false to identify the release as a full release.

    ", "name": "prerelease", "in": "body", - "isRequired": false + "description": "

    true to identify the release as a prerelease, false to identify the release as a full release.

    " } ], "enabledForGitHubApps": true, @@ -409428,27 +410060,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The file name of the asset.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The file name of the asset.

    " }, { "type": "string", - "description": "

    An alternate short description of the asset. Used in place of the filename.

    ", "name": "label", "in": "body", - "isRequired": false + "description": "

    An alternate short description of the asset. Used in place of the filename.

    " }, { "type": "string", - "examples": [ - "\"uploaded\"" - ], "name": "state", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -413003,199 +413629,171 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the repository.

    ", "name": "name", "in": "body", + "description": "

    The name of the repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short description of the repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { "type": "string", - "description": "

    A URL with more information about the repository.

    ", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { "type": "boolean", - "description": "

    Whether the repository is private.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether the repository is private.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.

    ", "enum": [ "public", "private", "internal" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Either true to enable issues for this repository or false to disable them.

    ", - "default": true, "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Either true to enable issues for this repository or false to disable them.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", - "default": true, "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", - "default": true, "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    ", - "default": false, "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    " }, { "type": "integer", - "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    ", "name": "team_id", "in": "body", - "isRequired": false + "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    " }, { "type": "boolean", - "description": "

    Pass true to create an initial commit with empty README.

    ", - "default": false, "name": "auto_init", "in": "body", - "isRequired": false + "description": "

    Pass true to create an initial commit with empty README.

    " }, { "type": "string", - "description": "

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

    ", "name": "gitignore_template", "in": "body", - "isRequired": false + "description": "

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

    " }, { "type": "string", - "description": "

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

    ", "name": "license_template", "in": "body", - "isRequired": false + "description": "

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", - "default": true, "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", - "default": true, "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", - "default": true, "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    ", - "default": false, "name": "allow_auto_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    " }, { "type": "boolean", - "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    ", - "default": false, "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    ", - "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -420969,295 +421567,78 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the repository.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the repository.

    " }, { "type": "string", - "description": "

    A short description of the repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { "type": "string", - "description": "

    A URL with more information about the repository.

    ", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { "type": "boolean", - "description": "

    Either true to make the repository private or false to make it public. Default: false.
    \nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Either true to make the repository private or false to make it public. Default: false.
    \nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal.\"

    ", "enum": [ "public", "private", "internal" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { "type": "object or null", - "description": "

    Specify which security and analysis features to enable or disable for the repository.

    \n

    To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

    \n

    For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.

    \n

    You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

    ", - "properties": { - "advanced_security": { - "type": "object", - "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "advanced_security", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", - "childParamsGroups": [ - { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - "secret_scanning": { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", - "childParamsGroups": [ - { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - "secret_scanning_push_protection": { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning_push_protection", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", - "childParamsGroups": [ - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - } - }, "name": "security_and_analysis", "in": "body", - "isRequired": false, + "description": "

    Specify which security and analysis features to enable or disable for the repository.

    \n

    To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

    \n

    For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.

    \n

    You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

    ", "childParamsGroups": [ { - "parentName": "security_and_analysis", - "parentType": "object", - "id": "security_and_analysis-object", - "params": [ + "type": "object", + "name": "advanced_security", + "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", + "childParamsGroups": [ { - "type": "object", - "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "advanced_security", - "in": "body", - "childParamsGroups": [ - { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning", - "in": "body", - "childParamsGroups": [ - { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning_push_protection", - "in": "body", - "childParamsGroups": [ - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] + "type": "string", + "name": "status", + "description": "

    Can be enabled or disabled.

    " } ] }, { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ + "type": "object", + "name": "secret_scanning", + "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    Can be enabled or disabled.

    ", "name": "status", - "in": "body" + "description": "

    Can be enabled or disabled.

    " } ] }, { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ + "type": "object", + "name": "secret_scanning_push_protection", + "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    Can be enabled or disabled.

    ", "name": "status", - "in": "body" - } - ] - }, - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" + "description": "

    Can be enabled or disabled.

    " } ] } @@ -421265,168 +421646,141 @@ }, { "type": "boolean", - "description": "

    Either true to enable issues for this repository or false to disable them.

    ", - "default": true, "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Either true to enable issues for this repository or false to disable them.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", - "default": true, "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", - "default": true, "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    ", - "default": false, "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    " }, { "type": "string", - "description": "

    Updates the default branch for this repository.

    ", "name": "default_branch", "in": "body", - "isRequired": false + "description": "

    Updates the default branch for this repository.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", - "default": true, "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", - "default": true, "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", - "default": true, "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    ", - "default": false, "name": "allow_auto_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    " }, { "type": "boolean", - "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    ", - "default": false, "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    " }, { "type": "boolean", - "description": "

    Either true to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.

    ", - "default": false, "name": "allow_update_branch", "in": "body", - "isRequired": false + "description": "

    Either true to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    ", - "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    true to archive this repository. Note: You cannot unarchive repositories through the API.

    ", - "default": false, "name": "archived", "in": "body", - "isRequired": false + "description": "

    true to archive this repository. Note: You cannot unarchive repositories through the API.

    " }, { "type": "boolean", - "description": "

    Either true to allow private forks, or false to prevent private forks.

    ", - "default": false, "name": "allow_forking", "in": "body", - "isRequired": false + "description": "

    Either true to allow private forks, or false to prevent private forks.

    " }, { "type": "boolean", - "description": "

    Either true to require contributors to sign off on web-based commits, or false to not require contributors to sign off on web-based commits.

    ", - "default": false, "name": "web_commit_signoff_required", "in": "body", - "isRequired": false + "description": "

    Either true to require contributors to sign off on web-based commits, or false to not require contributors to sign off on web-based commits.

    " } ], "enabledForGitHubApps": true, @@ -428006,21 +428360,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    A custom webhook event name. Must be 100 characters or fewer.

    ", - "minLength": 1, - "maxLength": 100, "name": "event_type", "in": "body", + "description": "

    A custom webhook event name. Must be 100 characters or fewer.

    ", "isRequired": true }, { "type": "object", - "description": "

    JSON payload with extra information about the webhook event that your action or workflow may use.

    ", - "additionalProperties": true, - "maxProperties": 10, "name": "client_payload", "in": "body", - "isRequired": false + "description": "

    JSON payload with extra information about the webhook event that your action or workflow may use.

    " } ], "enabledForGitHubApps": true, @@ -428847,9 +429196,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

    ", "name": "names", "in": "body", + "description": "

    An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

    ", "isRequired": true } ], @@ -428952,17 +429301,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The username or organization name the repository will be transferred to.

    ", "name": "new_owner", "in": "body", + "description": "

    The username or organization name the repository will be transferred to.

    ", "isRequired": true }, { "type": "array of integers", - "description": "

    ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

    ", "name": "team_ids", "in": "body", - "isRequired": false + "description": "

    ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

    " } ], "enabledForGitHubApps": true, @@ -431461,40 +431809,34 @@ "bodyParameters": [ { "type": "string", - "description": "

    The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

    ", "name": "owner", "in": "body", - "isRequired": false + "description": "

    The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

    " }, { "type": "string", - "description": "

    The name of the new repository.

    ", "name": "name", "in": "body", + "description": "

    The name of the new repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short description of the new repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the new repository.

    " }, { "type": "boolean", - "description": "

    Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.

    ", - "default": false, "name": "include_all_branches", "in": "body", - "isRequired": false + "description": "

    Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.

    " }, { "type": "boolean", - "description": "

    Either true to create a new private repository or false to create a new public one.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Either true to create a new private repository or false to create a new public one.

    " } ], "enabledForGitHubApps": false, @@ -437204,227 +437546,162 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The name of the repository.

    ", "type": "string", - "examples": [ - "Team Environment" - ], "name": "name", "in": "body", + "description": "

    The name of the repository.

    ", "isRequired": true }, { - "description": "

    A short description of the repository.

    ", "type": "string", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { - "description": "

    A URL with more information about the repository.

    ", "type": "string", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { - "description": "

    Whether the repository is private.

    ", - "default": false, "type": "boolean", "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether the repository is private.

    " }, { - "description": "

    Whether issues are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Whether issues are enabled.

    ", + "default": true }, { - "description": "

    Whether projects are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Whether projects are enabled.

    ", + "default": true }, { - "description": "

    Whether the wiki is enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Whether the wiki is enabled.

    ", + "default": true }, { - "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    ", "type": "integer", "name": "team_id", "in": "body", - "isRequired": false + "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    " }, { - "description": "

    Whether the repository is initialized with a minimal README.

    ", - "default": false, "type": "boolean", "name": "auto_init", "in": "body", - "isRequired": false + "description": "

    Whether the repository is initialized with a minimal README.

    " }, { - "description": "

    The desired language or platform to apply to the .gitignore.

    ", "type": "string", - "examples": [ - "Haskell" - ], "name": "gitignore_template", "in": "body", - "isRequired": false + "description": "

    The desired language or platform to apply to the .gitignore.

    " }, { - "description": "

    The license keyword of the open source license for this repository.

    ", "type": "string", - "examples": [ - "mit" - ], "name": "license_template", "in": "body", - "isRequired": false + "description": "

    The license keyword of the open source license for this repository.

    " }, { - "description": "

    Whether to allow squash merges for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Whether to allow squash merges for pull requests.

    ", + "default": true }, { - "description": "

    Whether to allow merge commits for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Whether to allow merge commits for pull requests.

    ", + "default": true }, { - "description": "

    Whether to allow rebase merges for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Whether to allow rebase merges for pull requests.

    ", + "default": true }, { - "description": "

    Whether to allow Auto-merge to be used on pull requests.

    ", - "default": false, "type": "boolean", - "examples": [ - false - ], "name": "allow_auto_merge", "in": "body", - "isRequired": false + "description": "

    Whether to allow Auto-merge to be used on pull requests.

    " }, { - "description": "

    Whether to delete head branches when pull requests are merged

    ", - "default": false, "type": "boolean", - "examples": [ - false - ], "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Whether to delete head branches when pull requests are merged

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether downloads are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_downloads", "in": "body", - "isRequired": false + "description": "

    Whether downloads are enabled.

    ", + "default": true }, { - "description": "

    Whether this repository acts as a template that can be used to generate new repositories.

    ", - "default": false, "type": "boolean", - "examples": [ - true - ], "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Whether this repository acts as a template that can be used to generate new repositories.

    " } ], "enabledForGitHubApps": false, @@ -441616,16 +441893,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.

    ", "name": "key_prefix", "in": "body", + "description": "

    The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.

    ", "isRequired": true }, { "type": "string", - "description": "

    The URL must contain <num> for the reference number.

    ", "name": "url_template", "in": "body", + "description": "

    The URL must contain <num> for the reference number.

    ", "isRequired": true } ], @@ -443694,7 +443971,7 @@ } ], "previews": [], - "descriptionHTML": "

    Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

    \n

    Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

    \n

    Note:

    \n
      \n
    • To get a repository's contents recursively, you can recursively get the tree.
      • \n
    • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
      • \n
    \n

    Size limits

    \n

    If the requested file's size is:

    \n
      \n
    • 1 MB or smaller: All features of this endpoint are supported.
      • \n
    • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
      • \n
    • Greater than 100 MB: This endpoint is not supported.
      • \n
    \n

    If the content is a directory

    \n

    The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

    \n

    If the content is a symlink

    \n

    If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

    \n

    If the content is a submodule

    \n

    The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

    \n

    If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

    ", + "descriptionHTML": "

    Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

    \n

    Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

    \n

    Notes:

    \n
      \n
    • To get a repository's contents recursively, you can recursively get the tree.
      • \n
    • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
      • \n
    • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
      • \n
    \n

    Size limits

    \n

    If the requested file's size is:

    \n
      \n
    • 1 MB or smaller: All features of this endpoint are supported.
      • \n
    • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
      • \n
    • Greater than 100 MB: This endpoint is not supported.
      • \n
    \n

    If the content is a directory

    \n

    The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

    \n

    If the content is a symlink

    \n

    If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

    \n

    If the content is a submodule

    \n

    The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

    \n

    If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

    ", "statusCodes": [ { "httpStatusCode": "200", @@ -443754,185 +444031,77 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message.

    ", "name": "message", "in": "body", + "description": "

    The commit message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The new file content, using Base64 encoding.

    ", "name": "content", "in": "body", + "description": "

    The new file content, using Base64 encoding.

    ", "isRequired": true }, { "type": "string", - "description": "

    Required if you are updating a file. The blob SHA of the file being replaced.

    ", "name": "sha", "in": "body", - "isRequired": false + "description": "

    Required if you are updating a file. The blob SHA of the file being replaced.

    " }, { "type": "string", - "description": "

    The branch name. Default: the repository’s default branch (usually master)

    ", "name": "branch", "in": "body", - "isRequired": false + "description": "

    The branch name. Default: the repository’s default branch (usually master)

    " }, { "type": "object", - "description": "

    The person that committed the file. Default: the authenticated user.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "examples": [ - "\"2013-01-05T13:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "committer", "in": "body", - "isRequired": false, + "description": "

    The person that committed the file. Default: the authenticated user.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "examples": [ - "\"2013-01-05T13:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "" } ] }, { "type": "object", - "description": "

    The author of the file. Default: The committer or the authenticated user if you omit committer.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "examples": [ - "\"2013-01-15T17:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "author", "in": "body", - "isRequired": false, + "description": "

    The author of the file. Default: The committer or the authenticated user if you omit committer.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "examples": [ - "\"2013-01-15T17:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "" } ] } @@ -444480,118 +444649,57 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message.

    ", "name": "message", "in": "body", + "description": "

    The commit message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The blob SHA of the file being replaced.

    ", "name": "sha", "in": "body", + "description": "

    The blob SHA of the file being replaced.

    ", "isRequired": true }, { "type": "string", - "description": "

    The branch name. Default: the repository’s default branch (usually master)

    ", "name": "branch", "in": "body", - "isRequired": false + "description": "

    The branch name. Default: the repository’s default branch (usually master)

    " }, { "type": "object", - "description": "

    object containing information about the committer.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - } - }, "name": "committer", "in": "body", - "isRequired": false, + "description": "

    object containing information about the committer.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " } ] }, { "type": "object", - "description": "

    object containing information about the author.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - } - }, "name": "author", "in": "body", - "isRequired": false, + "description": "

    object containing information about the author.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " } ] } @@ -447838,10 +447946,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    Optional parameter to specify the organization name if forking into an organization.

    ", "name": "organization", "in": "body", - "isRequired": false + "description": "

    Optional parameter to specify the organization name if forking into an organization.

    " } ], "enabledForGitHubApps": true, @@ -454202,9 +454309,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    An optional glob pattern to match against when enforcing tag protection.

    ", "name": "pattern", "in": "body", + "description": "

    An optional glob pattern to match against when enforcing tag protection.

    ", "isRequired": true } ], @@ -459924,7 +460031,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] }, @@ -468616,18 +468724,20 @@ ], "bodyParameters": [ { - "description": "

    Sets the state of the secret scanning alert. Can be either open or resolved. You must provide resolution when you set the state to resolved.

    ", "type": "string", + "name": "state", + "in": "body", + "description": "

    Sets the state of the secret scanning alert. Can be either open or resolved. You must provide resolution when you set the state to resolved.

    ", + "isRequired": true, "enum": [ "open", "resolved" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", + "name": "resolution", + "in": "body", "description": "

    Required when the state is resolved. The reason for resolving the alert.

    ", "enum": [ null, @@ -468635,10 +468745,7 @@ "wont_fix", "revoked", "used_in_tests" - ], - "name": "resolution", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -469694,68 +469801,61 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", + "description": "

    The name of the team.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "array of strings", - "description": "

    List GitHub IDs for organization members who will become team maintainers.

    ", "name": "maintainers", "in": "body", - "isRequired": false + "description": "

    List GitHub IDs for organization members who will become team maintainers.

    " }, { "type": "array of strings", - "description": "

    The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

    ", "name": "repo_names", "in": "body", - "isRequired": false + "description": "

    The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nDefault: secret
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.
    \nDefault for child team: closed

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " }, { "type": "string", - "description": "

    The distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"Update LDAP mapping for a team\" endpoint to change the LDAP DN. For more information, see \"Using LDAP.\"

    ", "name": "ldap_dn", "in": "body", - "isRequired": false + "description": "

    The distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"Update LDAP mapping for a team\" endpoint to change the LDAP DN. For more information, see \"Using LDAP.\"

    " } ], "enabledForGitHubApps": true, @@ -470051,8 +470151,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -470782,8 +470882,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -471224,48 +471324,43 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the team.

    " }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push", "admin" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer or null", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " } ], "enabledForGitHubApps": true, @@ -471561,8 +471656,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -472794,15 +472889,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"

    ", "enum": [ "read", "write", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -478023,11 +478117,10 @@ "bodyParameters": [ { "type": "string", - "description": "

    The permission to grant the team on this repository. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", - "default": "push", "name": "permission", "in": "body", - "isRequired": false + "description": "

    The permission to grant the team on this repository. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", + "default": "push" } ], "enabledForGitHubApps": true, @@ -478748,8 +478841,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -479181,48 +479274,44 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", + "description": "

    The name of the team.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push", "admin" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer or null", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " } ], "enabledForGitHubApps": true, @@ -479517,8 +479606,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -480205,8 +480294,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -481427,15 +481516,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"

    ", "enum": [ "read", "write", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -486633,15 +486721,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant the team on this repository. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", "enum": [ "pull", "push", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -487368,8 +487455,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -488292,9 +488379,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -489171,9 +489258,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -490125,9 +490212,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -490984,9 +491071,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -491982,25 +492069,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", + "description": "

    The discussion post's title.

    ", "isRequired": true }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion post's body text.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    " } ], "enabledForGitHubApps": true, @@ -492945,17 +493030,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The discussion post's title.

    " }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The discussion post's body text.

    " } ], "enabledForGitHubApps": true, @@ -493964,25 +494047,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", + "description": "

    The discussion post's title.

    ", "isRequired": true }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion post's body text.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    " } ], "enabledForGitHubApps": true, @@ -494907,17 +494988,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The discussion post's title.

    " }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The discussion post's body text.

    " } ], "enabledForGitHubApps": true, @@ -495836,15 +495915,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role that this user should have in the team.

    ", "enum": [ "member", "maintainer" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -496583,15 +496661,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role that this user should have in the team.

    ", "enum": [ "member", "maintainer" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -498048,78 +498125,52 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The new name of the user.

    ", "type": "string", - "examples": [ - "Omar Jahandar" - ], "name": "name", "in": "body", - "isRequired": false + "description": "

    The new name of the user.

    " }, { - "description": "

    The publicly visible email address of the user.

    ", "type": "string", - "examples": [ - "omar@example.com" - ], "name": "email", "in": "body", - "isRequired": false + "description": "

    The publicly visible email address of the user.

    " }, { - "description": "

    The new blog URL of the user.

    ", "type": "string", - "examples": [ - "blog.example.com" - ], "name": "blog", "in": "body", - "isRequired": false + "description": "

    The new blog URL of the user.

    " }, { - "description": "

    The new Twitter username of the user.

    ", "type": "string or null", - "examples": [ - "therealomarj" - ], "name": "twitter_username", "in": "body", - "isRequired": false + "description": "

    The new Twitter username of the user.

    " }, { - "description": "

    The new company of the user.

    ", "type": "string", - "examples": [ - "Acme corporation" - ], "name": "company", "in": "body", - "isRequired": false + "description": "

    The new company of the user.

    " }, { - "description": "

    The new location of the user.

    ", "type": "string", - "examples": [ - "Berlin, Germany" - ], "name": "location", "in": "body", - "isRequired": false + "description": "

    The new location of the user.

    " }, { - "description": "

    The new hiring availability of the user.

    ", "type": "boolean", "name": "hireable", "in": "body", - "isRequired": false + "description": "

    The new hiring availability of the user.

    " }, { - "description": "

    The new short biography of the user.

    ", "type": "string", "name": "bio", "in": "body", - "isRequired": false + "description": "

    The new short biography of the user.

    " } ], "enabledForGitHubApps": false, @@ -500344,11 +500395,10 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", "type": "array of strings", - "examples": [], "name": "emails", "in": "body", + "description": "

    Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", "isRequired": true } ], @@ -500478,10 +500528,10 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Email addresses associated with the GitHub user account.

    ", "type": "array of strings", "name": "emails", "in": "body", + "description": "

    Email addresses associated with the GitHub user account.

    ", "isRequired": true } ], @@ -502217,17 +502267,16 @@ "parameters": [], "bodyParameters": [ { - "description": "

    A descriptive name for the new key.

    ", "type": "string", "name": "name", "in": "body", - "isRequired": false + "description": "

    A descriptive name for the new key.

    " }, { - "description": "

    A GPG key in ASCII-armored format.

    ", "type": "string", "name": "armored_public_key", "in": "body", + "description": "

    A GPG key in ASCII-armored format.

    ", "isRequired": true } ], @@ -503312,21 +503361,16 @@ "parameters": [], "bodyParameters": [ { - "description": "

    A descriptive name for the new key.

    ", "type": "string", - "examples": [ - "Personal MacBook Air" - ], "name": "title", "in": "body", - "isRequired": false + "description": "

    A descriptive name for the new key.

    " }, { - "description": "

    The public SSH key to add to your GitHub account.

    ", "type": "string", - "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ", "name": "key", "in": "body", + "description": "

    The public SSH key to add to your GitHub account.

    ", "isRequired": true } ], @@ -503840,53 +503884,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": true, @@ -504921,188 +504939,63 @@ "bodyParameters": [ { "type": "string", - "description": "

    Use web to create a webhook. Default: web. This parameter only accepts the value web.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    Use web to create a webhook. Default: web. This parameter only accepts the value web.

    " }, { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "childParamsGroups": [] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ], - "name": "token", - "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ], - "name": "digest", - "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] - } - }, "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body" - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body" - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body" - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " - }, - { - "type": "string", - "examples": [ - "\"abc\"" - ], - "name": "token", - "in": "body", - "description": "" - }, - { - "type": "string", - "examples": [ - "\"sha256\"" - ], - "name": "digest", - "in": "body", - "description": "" - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    " + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "token", + "description": "" + }, + { + "type": "string", + "name": "digest", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, @@ -505728,210 +505621,70 @@ "bodyParameters": [ { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - }, - "address": { - "type": "string", - "examples": [ - "\"bar@example.com\"" - ], - "name": "address", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "room": { - "type": "string", - "examples": [ - "\"The Serious Room\"" - ], - "name": "room", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"bar@example.com\"" - ], - "name": "address", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"The Serious Room\"" - ], - "name": "room", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "address", + "description": "" + }, + { + "type": "string", + "name": "room", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for. This replaces the entire array of events.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "array of strings", - "description": "

    Determines a list of events to be added to the list of events that the Hook triggers for.

    ", "name": "add_events", "in": "body", - "isRequired": false + "description": "

    Determines a list of events to be added to the list of events that the Hook triggers for.

    " }, { "type": "array of strings", - "description": "

    Determines a list of events to be removed from the list of events that the Hook triggers for.

    ", "name": "remove_events", "in": "body", - "isRequired": false + "description": "

    Determines a list of events to be removed from the list of events that the Hook triggers for.

    " }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index db54a01063..340aace2d9 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -972,27 +972,26 @@ "bodyParameters": [ { "type": "string", + "name": "enabled_organizations", + "in": "body", "description": "

    The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.

    ", + "isRequired": true, "enum": [ "all", "none", "selected" - ], - "name": "enabled_organizations", - "in": "body", - "isRequired": true + ] }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": false, @@ -1243,10 +1242,10 @@ ], "bodyParameters": [ { - "description": "

    List of organization IDs to enable for GitHub Actions.

    ", "type": "array of integers", "name": "selected_organization_ids", "in": "body", + "description": "

    List of organization IDs to enable for GitHub Actions.

    ", "isRequired": true } ], @@ -1488,24 +1487,21 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", - "isRequired": false + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    " }, { "type": "boolean", - "description": "

    Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

    ", "name": "verified_allowed", "in": "body", - "isRequired": false + "description": "

    Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

    " }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", - "isRequired": false + "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    " } ], "enabledForGitHubApps": false, @@ -1649,27 +1645,26 @@ "bodyParameters": [ { "type": "string", + "name": "enabled_repositories", + "in": "body", "description": "

    The policy that controls the repositories in the organization that are allowed to run GitHub Actions.

    ", + "isRequired": true, "enum": [ "all", "none", "selected" - ], - "name": "enabled_repositories", - "in": "body", - "isRequired": true + ] }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -3309,10 +3304,10 @@ ], "bodyParameters": [ { - "description": "

    List of repository IDs to enable for GitHub Actions.

    ", "type": "array of integers", "name": "selected_repository_ids", "in": "body", + "description": "

    List of repository IDs to enable for GitHub Actions.

    ", "isRequired": true } ], @@ -3554,24 +3549,21 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", - "isRequired": false + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    " }, { "type": "boolean", - "description": "

    Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

    ", "name": "verified_allowed", "in": "body", - "isRequired": false + "description": "

    Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

    " }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", - "isRequired": false + "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    " } ], "enabledForGitHubApps": true, @@ -3725,22 +3717,21 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub Actions is enabled on the repository.

    ", "name": "enabled", "in": "body", + "description": "

    Whether GitHub Actions is enabled on the repository.

    ", "isRequired": true }, { "type": "string", + "name": "allowed_actions", + "in": "body", "description": "

    The permissions policy that controls the actions that are allowed to run.

    ", "enum": [ "all", "local_only", "selected" - ], - "name": "allowed_actions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -3889,24 +3880,21 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    ", "name": "github_owned_allowed", "in": "body", - "isRequired": false + "description": "

    Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

    " }, { "type": "boolean", - "description": "

    Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

    ", "name": "verified_allowed", "in": "body", - "isRequired": false + "description": "

    Whether actions from GitHub Marketplace verified creators are allowed. Set to true to allow all actions by GitHub Marketplace verified creators.

    " }, { "type": "array of strings", - "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    ", "name": "patterns_allowed", "in": "body", - "isRequired": false + "description": "

    Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

    " } ], "enabledForGitHubApps": true, @@ -4330,37 +4318,33 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret.

    ", + "isRequired": true, "enum": [ "all", "private", "selected" - ], - "name": "visibility", - "in": "body", - "isRequired": true + ] }, { "type": "array of integers", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", - "isRequired": false + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

    " } ], "enabledForGitHubApps": true, @@ -6814,9 +6798,9 @@ "bodyParameters": [ { "type": "array of integers", - "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "name": "selected_repository_ids", "in": "body", + "description": "

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

    ", "isRequired": true } ], @@ -7368,18 +7352,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    ", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", - "isRequired": false + "description": "

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

    " }, { "type": "string", - "description": "

    ID of the key you used to encrypt the secret.

    ", "name": "key_id", "in": "body", - "isRequired": false + "description": "

    ID of the key you used to encrypt the secret.

    " } ], "enabledForGitHubApps": true, @@ -7679,44 +7660,39 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all organizations or select individual organization.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all organizations or select individual organization.

    ", "enum": [ "selected", "all" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { - "description": "

    List of organization IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_organization_ids", "in": "body", - "isRequired": false + "description": "

    List of organization IDs that can access the runner group.

    " }, { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", - "isRequired": false + "description": "

    List of runner IDs to add to the runner group.

    " }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " } ], "enabledForGitHubApps": false, @@ -7930,31 +7906,27 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", - "isRequired": false + "description": "

    Name of the runner group.

    " }, { - "description": "

    Visibility of a runner group. You can select all organizations or select individual organizations.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all organizations or select individual organizations.

    ", "enum": [ "selected", "all" ], - "default": "all", - "name": "visibility", - "in": "body", - "isRequired": false + "default": "all" }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " } ], "enabledForGitHubApps": false, @@ -8339,10 +8311,10 @@ ], "bodyParameters": [ { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", + "description": "

    List of runner IDs to add to the runner group.

    ", "isRequired": true } ], @@ -8684,46 +8656,41 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

    ", "enum": [ "selected", "all", "private" ], - "default": "all", - "name": "visibility", - "in": "body", - "isRequired": false + "default": "all" }, { - "description": "

    List of repository IDs that can access the runner group.

    ", "type": "array of integers", "name": "selected_repository_ids", "in": "body", - "isRequired": false + "description": "

    List of repository IDs that can access the runner group.

    " }, { - "description": "

    List of runner IDs to add to the runner group.

    ", "type": "array of integers", "name": "runners", "in": "body", - "isRequired": false + "description": "

    List of runner IDs to add to the runner group.

    " }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " } ], "enabledForGitHubApps": true, @@ -8955,31 +8922,28 @@ ], "bodyParameters": [ { - "description": "

    Name of the runner group.

    ", "type": "string", "name": "name", "in": "body", + "description": "

    Name of the runner group.

    ", "isRequired": true }, { - "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

    ", "type": "string", + "name": "visibility", + "in": "body", + "description": "

    Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

    ", "enum": [ "selected", "all", "private" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether the runner group can be used by public repositories.

    ", "type": "boolean", - "default": false, "name": "allows_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether the runner group can be used by public repositories.

    " } ], "enabledForGitHubApps": true, @@ -43852,21 +43816,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The git reference for the workflow. The reference can be a branch or tag name.

    ", "name": "ref", "in": "body", + "description": "

    The git reference for the workflow. The reference can be a branch or tag name.

    ", "isRequired": true }, { "type": "object", - "description": "

    Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.

    ", - "additionalProperties": { - "type": "string" - }, - "maxProperties": 10, "name": "inputs", "in": "body", - "isRequired": false + "description": "

    Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.

    " } ], "enabledForGitHubApps": true, @@ -58645,19 +58604,16 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    ", "type": "string", - "format": "date-time", "name": "last_read_at", "in": "body", - "isRequired": false + "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    " }, { - "description": "

    Whether the notification has been read.

    ", "type": "boolean", "name": "read", "in": "body", - "isRequired": false + "description": "

    Whether the notification has been read.

    " } ], "enabledForGitHubApps": false, @@ -61253,12 +61209,10 @@ ], "bodyParameters": [ { - "description": "

    Whether to block all notifications from a thread.

    ", - "default": false, "type": "boolean", "name": "ignored", "in": "body", - "isRequired": false + "description": "

    Whether to block all notifications from a thread.

    " } ], "enabledForGitHubApps": false, @@ -63858,11 +63812,9 @@ "bodyParameters": [ { "type": "string", - "format": "date-time", - "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    ", "name": "last_read_at", "in": "body", - "isRequired": false + "description": "

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

    " } ], "enabledForGitHubApps": false, @@ -71530,17 +71482,15 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Determines if notifications should be received from this repository.

    ", "name": "subscribed", "in": "body", - "isRequired": false + "description": "

    Determines if notifications should be received from this repository.

    " }, { "type": "boolean", - "description": "

    Determines if all notifications should be blocked from this repository.

    ", "name": "ignored", "in": "body", - "isRequired": false + "description": "

    Determines if all notifications should be blocked from this repository.

    " } ], "enabledForGitHubApps": false, @@ -77613,14 +77563,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -78542,14 +78484,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -79111,756 +79045,291 @@ ], "bodyParameters": [ { - "description": "

    List of repository names that the token should have access to

    ", "type": "array of strings", "name": "repositories", "in": "body", - "isRequired": false + "description": "

    List of repository names that the token should have access to

    " }, { - "description": "

    List of repository IDs that the token should have access to

    ", "type": "array of integers", - "examples": [ - 1 - ], "name": "repository_ids", "in": "body", - "isRequired": false + "description": "

    List of repository IDs that the token should have access to

    " }, { - "title": "App Permissions", "type": "object", + "name": "permissions", + "in": "body", "description": "

    The permissions granted to the user-to-server access token.

    ", - "properties": { - "actions": { + "childParamsGroups": [ + { "type": "string", + "name": "actions", "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", "enum": [ "read", "write" - ], - "name": "actions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "childParamsGroups": [] + ] }, - "administration": { + { "type": "string", + "name": "administration", "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", "enum": [ "read", "write" - ], - "name": "administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "childParamsGroups": [] + ] }, - "checks": { + { "type": "string", + "name": "checks", "description": "

    The level of permission to grant the access token for checks on code.

    ", "enum": [ "read", "write" - ], - "name": "checks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for checks on code.", - "childParamsGroups": [] + ] }, - "contents": { + { "type": "string", + "name": "contents", "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", "enum": [ "read", "write" - ], - "name": "contents", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "childParamsGroups": [] + ] }, - "organization_custom_roles": { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for custom roles management.", - "childParamsGroups": [] - }, - "deployments": { + { "type": "string", + "name": "deployments", "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", "enum": [ "read", "write" - ], - "name": "deployments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for deployments and deployment statuses.", - "childParamsGroups": [] + ] }, - "environments": { + { "type": "string", + "name": "environments", "description": "

    The level of permission to grant the access token for managing repository environments.

    ", "enum": [ "read", "write" - ], - "name": "environments", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for managing repository environments.", - "childParamsGroups": [] + ] }, - "issues": { + { "type": "string", + "name": "issues", "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", "enum": [ "read", "write" - ], - "name": "issues", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "childParamsGroups": [] + ] }, - "metadata": { + { "type": "string", + "name": "metadata", "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", "enum": [ "read", "write" - ], - "name": "metadata", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "childParamsGroups": [] + ] }, - "packages": { + { "type": "string", + "name": "packages", "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "pages": { + { "type": "string", + "name": "pages", "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", "enum": [ "read", "write" - ], - "name": "pages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "childParamsGroups": [] + ] }, - "pull_requests": { + { "type": "string", + "name": "pull_requests", "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", "enum": [ "read", "write" - ], - "name": "pull_requests", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "childParamsGroups": [] + ] }, - "repository_hooks": { + { "type": "string", + "name": "repository_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", "enum": [ "read", "write" - ], - "name": "repository_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "childParamsGroups": [] + ] }, - "repository_projects": { + { "type": "string", + "name": "repository_projects", "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", "enum": [ "read", "write", "admin" - ], - "name": "repository_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "childParamsGroups": [] + ] }, - "secret_scanning_alerts": { + { "type": "string", + "name": "secret_scanning_alerts", "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "secret_scanning_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "childParamsGroups": [] + ] }, - "secrets": { + { "type": "string", + "name": "secrets", "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", "enum": [ "read", "write" - ], - "name": "secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage repository secrets.", - "childParamsGroups": [] + ] }, - "security_events": { + { "type": "string", + "name": "security_events", "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", "enum": [ "read", "write" - ], - "name": "security_events", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "childParamsGroups": [] + ] }, - "single_file": { + { "type": "string", + "name": "single_file", "description": "

    The level of permission to grant the access token to manage just a single file.

    ", "enum": [ "read", "write" - ], - "name": "single_file", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage just a single file.", - "childParamsGroups": [] + ] }, - "statuses": { + { "type": "string", + "name": "statuses", "description": "

    The level of permission to grant the access token for commit statuses.

    ", "enum": [ "read", "write" - ], - "name": "statuses", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for commit statuses.", - "childParamsGroups": [] + ] }, - "vulnerability_alerts": { + { "type": "string", + "name": "vulnerability_alerts", "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", "enum": [ "read", "write" - ], - "name": "vulnerability_alerts", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage Dependabot alerts.", - "childParamsGroups": [] + ] }, - "workflows": { + { "type": "string", + "name": "workflows", "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", "enum": [ "write" - ], - "name": "workflows", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "childParamsGroups": [] + ] }, - "members": { + { "type": "string", + "name": "members", "description": "

    The level of permission to grant the access token for organization teams and members.

    ", "enum": [ "read", "write" - ], - "name": "members", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization teams and members.", - "childParamsGroups": [] + ] }, - "organization_administration": { + { "type": "string", + "name": "organization_administration", "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_administration", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage access to an organization.", - "childParamsGroups": [] + ] }, - "organization_hooks": { + { "type": "string", + "name": "organization_hooks", "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_hooks", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "childParamsGroups": [] + ] }, - "organization_plan": { + { "type": "string", + "name": "organization_plan", "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", "enum": [ "read" - ], - "name": "organization_plan", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for viewing an organization's plan.", - "childParamsGroups": [] + ] }, - "organization_projects": { + { "type": "string", + "name": "organization_projects", "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", "enum": [ "read", "write", "admin" - ], - "name": "organization_projects", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "childParamsGroups": [] + ] }, - "organization_packages": { + { "type": "string", + "name": "organization_packages", "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", "enum": [ "read", "write" - ], - "name": "organization_packages", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "childParamsGroups": [] + ] }, - "organization_secrets": { + { "type": "string", + "name": "organization_secrets", "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", "enum": [ "read", "write" - ], - "name": "organization_secrets", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage organization secrets.", - "childParamsGroups": [] + ] }, - "organization_self_hosted_runners": { + { "type": "string", + "name": "organization_self_hosted_runners", "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_self_hosted_runners", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "childParamsGroups": [] + ] }, - "organization_user_blocking": { + { "type": "string", + "name": "organization_user_blocking", "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", "enum": [ "read", "write" - ], - "name": "organization_user_blocking", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "childParamsGroups": [] + ] }, - "team_discussions": { + { "type": "string", + "name": "team_discussions", "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", "enum": [ "read", "write" - ], - "name": "team_discussions", - "in": "body", - "rawType": "string", - "rawDescription": "The level of permission to grant the access token to manage team discussions and related comments.", - "childParamsGroups": [] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - }, - "name": "permissions", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "permissions", - "parentType": "object", - "id": "permissions-object", - "params": [ - { - "type": "string", - "description": "

    The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

    ", - "enum": [ - "read", - "write" - ], - "name": "actions", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

    ", - "enum": [ - "read", - "write" - ], - "name": "administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for checks on code.

    ", - "enum": [ - "read", - "write" - ], - "name": "checks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "contents", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for custom roles management.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_custom_roles", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for deployments and deployment statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "deployments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for managing repository environments.

    ", - "enum": [ - "read", - "write" - ], - "name": "environments", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

    ", - "enum": [ - "read", - "write" - ], - "name": "issues", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

    ", - "enum": [ - "read", - "write" - ], - "name": "metadata", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.

    ", - "enum": [ - "read", - "write" - ], - "name": "pages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.

    ", - "enum": [ - "read", - "write" - ], - "name": "pull_requests", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for a repository.

    ", - "enum": [ - "read", - "write" - ], - "name": "repository_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository projects, columns, and cards.

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "repository_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage secret scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "secret_scanning_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage repository secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage security events like code scanning alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "security_events", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage just a single file.

    ", - "enum": [ - "read", - "write" - ], - "name": "single_file", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for commit statuses.

    ", - "enum": [ - "read", - "write" - ], - "name": "statuses", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage Dependabot alerts.

    ", - "enum": [ - "read", - "write" - ], - "name": "vulnerability_alerts", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to update GitHub Actions workflow files.

    ", - "enum": [ - "write" - ], - "name": "workflows", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization teams and members.

    ", - "enum": [ - "read", - "write" - ], - "name": "members", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage access to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_administration", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage the post-receive hooks for an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_hooks", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for viewing an organization's plan.

    ", - "enum": [ - "read" - ], - "name": "organization_plan", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization projects and projects beta (where available).

    ", - "enum": [ - "read", - "write", - "admin" - ], - "name": "organization_projects", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token for organization packages published to GitHub Packages.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_packages", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage organization secrets.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_secrets", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_self_hosted_runners", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to view and manage users blocked by the organization.

    ", - "enum": [ - "read", - "write" - ], - "name": "organization_user_blocking", - "in": "body" - }, - { - "type": "string", - "description": "

    The level of permission to grant the access token to manage team discussions and related comments.

    ", - "enum": [ - "read", - "write" - ], - "name": "team_discussions", - "in": "body" - } ] } ] @@ -80071,14 +79540,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -82705,14 +82166,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -83638,14 +83091,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -84569,14 +84014,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -87187,14 +86624,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -89466,9 +88895,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", + "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "isRequired": true } ], @@ -89531,10 +88960,10 @@ ], "bodyParameters": [ { - "description": "

    The access_token of the OAuth application.

    ", "type": "string", "name": "access_token", "in": "body", + "description": "

    The access_token of the OAuth application.

    ", "isRequired": true } ], @@ -89897,14 +89326,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -90402,10 +89823,10 @@ ], "bodyParameters": [ { - "description": "

    The access_token of the OAuth application.

    ", "type": "string", "name": "access_token", "in": "body", + "description": "

    The access_token of the OAuth application.

    ", "isRequired": true } ], @@ -90768,14 +90189,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -91270,9 +90683,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "name": "access_token", "in": "body", + "description": "

    The OAuth access token used to authenticate to the GitHub API.

    ", "isRequired": true } ], @@ -91699,14 +91112,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -92266,53 +91671,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": false, @@ -95046,7 +94425,2775 @@ }, "response": { "statusCode": "200", - "description": "

    Response

    " + "contentType": "application/json", + "description": "

    Response

    ", + "example": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [], + "checks": [] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + }, + "schema": { + "title": "Branch With Protection", + "description": "Branch With Protection", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "commit": { + "title": "Commit", + "description": "Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } + }, + "required": [ + "sha", + "url" + ] + } + }, + "stats": { + "type": "object", + "properties": { + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + }, + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "string" + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "html", + "self" + ] + }, + "protected": { + "type": "boolean" + }, + "protection": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enforcement_level": { + "type": "string" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string" + }, + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts", + "checks" + ] + }, + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" + ] + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } + }, + "bypass_pull_request_allowances": { + "type": "object", + "description": "Allow specific users, teams, or apps to bypass pull request requirements.", + "properties": { + "users": { + "description": "The list of users allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "require_code_owner_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "required_approving_review_count": { + "type": "integer", + "minimum": 0, + "maximum": 6, + "examples": [ + 2 + ] + } + }, + "required": [ + "dismiss_stale_reviews", + "require_code_owner_reviews" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + } + } + }, + "protection_url": { + "type": "string", + "format": "uri" + }, + "pattern": { + "type": "string", + "examples": [ + "\"mas*\"" + ] + }, + "required_approving_review_count": { + "type": "integer", + "examples": [ + 1 + ] + } + }, + "required": [ + "name", + "commit", + "_links", + "protection", + "protected", + "protection_url" + ] + } } } ], @@ -95097,9 +97244,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the branch which should be updated to match upstream.

    ", "name": "branch", "in": "body", + "description": "

    The name of the branch which should be updated to match upstream.

    ", "isRequired": true } ], @@ -95199,24 +97346,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the base branch that the head will be merged into.

    ", "name": "base", "in": "body", + "description": "

    The name of the base branch that the head will be merged into.

    ", "isRequired": true }, { "type": "string", - "description": "

    The head to merge. This can be a branch name or a commit SHA1.

    ", "name": "head", "in": "body", + "description": "

    The head to merge. This can be a branch name or a commit SHA1.

    ", "isRequired": true }, { "type": "string", - "description": "

    Commit message to use for the merge commit. If omitted, a default message will be used.

    ", "name": "commit_message", "in": "body", - "isRequired": false + "description": "

    Commit message to use for the merge commit. If omitted, a default message will be used.

    " } ], "enabledForGitHubApps": true, @@ -98288,171 +100434,38 @@ "bodyParameters": [ { "type": "object or null", - "description": "

    Require status checks to pass before merging. Set to null to disable.

    ", - "properties": { - "strict": { - "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", - "name": "strict", - "in": "body", - "rawType": "boolean", - "rawDescription": "Require branches to be up to date before merging.", - "isRequired": true, - "childParamsGroups": [] - }, - "contexts": { - "type": "array of strings", - "deprecated": true, - "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "isRequired": true, - "childParamsGroups": [] - }, - "checks": { - "type": "array of objects", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", - "items": { - "type": "object", - "required": [ - "context" - ], - "properties": { - "context": { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the required check", - "isRequired": true, - "childParamsGroups": [] - }, - "app_id": { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "isRequired": false, - "childParamsGroups": [] - } - } - }, - "name": "checks", - "in": "body", - "rawType": "array", - "rawDescription": "The list of status checks to require in order to merge into this branch.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ - { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "strict", - "contexts" - ], "name": "required_status_checks", "in": "body", + "description": "

    Require status checks to pass before merging. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "required_status_checks", - "parentType": "object", - "id": "required_status_checks-object", - "params": [ - { - "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", - "name": "strict", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "deprecated": true, - "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", - "name": "contexts", - "in": "body", - "isRequired": true - }, - { - "type": "array of objects", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", - "name": "checks", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ - { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "boolean", + "name": "strict", + "description": "

    Require branches to be up to date before merging.

    ", + "isRequired": true }, { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ + "type": "array of strings", + "name": "contexts", + "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", + "isRequired": true + }, + { + "type": "array of objects", + "name": "checks", + "description": "

    The list of status checks to require in order to merge into this branch.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The name of the required check

    ", "name": "context", - "in": "body", + "description": "

    The name of the required check

    ", "isRequired": true }, { "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", "name": "app_id", - "in": "body", - "isRequired": false + "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    " } ] } @@ -98460,407 +100473,74 @@ }, { "type": "boolean or null", - "description": "

    Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "name": "enforce_admins", "in": "body", + "description": "

    Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "isRequired": true }, { "type": "object or null", - "description": "

    Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", - "properties": { - "dismissal_restrictions": { - "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, - "name": "dismissal_restrictions", - "in": "body", - "rawType": "object", - "rawDescription": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", - "childParamsGroups": [ - { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] - } - ] - }, - "dismiss_stale_reviews": { - "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", - "name": "dismiss_stale_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "childParamsGroups": [] - }, - "require_code_owner_reviews": { - "type": "boolean", - "description": "

    Blocks merging pull requests until code owners review them.

    ", - "name": "require_code_owner_reviews", - "in": "body", - "rawType": "boolean", - "rawDescription": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", - "childParamsGroups": [] - }, - "required_approving_review_count": { - "type": "integer", - "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    ", - "name": "required_approving_review_count", - "in": "body", - "rawType": "integer", - "rawDescription": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.", - "childParamsGroups": [] - }, - "bypass_pull_request_allowances": { - "type": "object", - "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - } - }, - "name": "bypass_pull_request_allowances", - "in": "body", - "rawType": "object", - "rawDescription": "Allow specific users, teams, or apps to bypass pull request requirements.", - "childParamsGroups": [ - { - "parentName": "bypass_pull_request_allowances", - "parentType": "object", - "id": "bypass_pull_request_allowances-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "name": "apps", - "in": "body" - } - ] - } - ] - } - }, "name": "required_pull_request_reviews", "in": "body", + "description": "

    Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "required_pull_request_reviews", - "parentType": "object", - "id": "required_pull_request_reviews-object", - "params": [ + "type": "object", + "name": "dismissal_restrictions", + "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", + "childParamsGroups": [ { - "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, - "name": "dismissal_restrictions", - "in": "body", - "childParamsGroups": [ - { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with dismissal access

    " }, { - "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", - "name": "dismiss_stale_reviews", - "in": "body" + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with dismissal access

    " }, { - "type": "boolean", - "description": "

    Blocks merging pull requests until code owners review them.

    ", - "name": "require_code_owner_reviews", - "in": "body" - }, - { - "type": "integer", - "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    ", - "name": "required_approving_review_count", - "in": "body" - }, - { - "type": "object", - "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - } - }, - "name": "bypass_pull_request_allowances", - "in": "body", - "childParamsGroups": [ - { - "parentName": "bypass_pull_request_allowances", - "parentType": "object", - "id": "bypass_pull_request_allowances-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "name": "apps", - "in": "body" - } - ] - } - ] + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with dismissal access

    " } ] }, { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] + "type": "boolean", + "name": "dismiss_stale_reviews", + "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    " }, { - "parentName": "bypass_pull_request_allowances", - "parentType": "object", - "id": "bypass_pull_request_allowances-object", - "params": [ + "type": "boolean", + "name": "require_code_owner_reviews", + "description": "

    Blocks merging pull requests until code owners review them.

    " + }, + { + "type": "integer", + "name": "required_approving_review_count", + "description": "

    Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    " + }, + { + "type": "object", + "name": "bypass_pull_request_allowances", + "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", + "childParamsGroups": [ { "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", "name": "users", - "in": "body" + "description": "

    The list of user logins allowed to bypass pull request requirements.

    " }, { "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", "name": "teams", - "in": "body" + "description": "

    The list of team slugs allowed to bypass pull request requirements.

    " }, { "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", "name": "apps", - "in": "body" + "description": "

    The list of app slugs allowed to bypass pull request requirements.

    " } ] } @@ -98868,120 +100548,59 @@ }, { "type": "object or null", - "description": "

    Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with push access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with push access", - "isRequired": true, - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with push access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with push access", - "isRequired": true, - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with push access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with push access", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "users", - "teams" - ], "name": "restrictions", "in": "body", + "description": "

    Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "restrictions", - "parentType": "object", - "id": "restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with push access

    ", - "name": "users", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with push access

    ", - "name": "teams", - "in": "body", - "isRequired": true - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with push access

    ", - "name": "apps", - "in": "body", - "isRequired": false - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with push access

    ", + "isRequired": true + }, + { + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with push access

    ", + "isRequired": true + }, + { + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with push access

    " } ] }, { "type": "boolean", - "description": "

    Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

    ", "name": "required_linear_history", "in": "body", - "isRequired": false + "description": "

    Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

    " }, { "type": "boolean or null", - "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "name": "allow_force_pushes", "in": "body", - "isRequired": false + "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    " }, { "type": "boolean", - "description": "

    Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

    ", "name": "allow_deletions", "in": "body", - "isRequired": false + "description": "

    Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

    ", "name": "block_creations", "in": "body", - "isRequired": false + "description": "

    If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

    " }, { "type": "boolean", - "description": "

    Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

    ", "name": "required_conversation_resolution", "in": "body", - "isRequired": false + "description": "

    Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

    " } ], "enabledForGitHubApps": true, @@ -99046,7 +100665,2001 @@ }, "response": { "statusCode": "200", - "description": "

    Response

    " + "contentType": "application/json", + "description": "

    Response

    ", + "example": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [], + "teams": [], + "apps": [] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [], + "teams": [], + "apps": [] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + }, + "schema": { + "title": "Protected Branch", + "description": "Branch protections protect branches", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "required_status_checks": { + "title": "Status Check Policy", + "description": "Status Check Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] + }, + "strict": { + "type": "boolean", + "examples": [ + true + ] + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + ] + } + }, + "required": [ + "url", + "contexts_url", + "strict", + "contexts", + "checks" + ] + }, + "required_pull_request_reviews": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "dismiss_stale_reviews": { + "type": "boolean" + }, + "require_code_owner_reviews": { + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "users", + "teams" + ] + }, + "bypass_pull_request_allowances": { + "type": "object", + "properties": { + "users": { + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + }, + "required": [ + "users", + "teams" + ] + } + }, + "required": [ + "url" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "enforce_admins": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "url", + "enabled" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + } + }, + "required": [ + "url" + ] + } } } ], @@ -101057,166 +104670,65 @@ "bodyParameters": [ { "type": "object", - "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s with dismissal access", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s with dismissal access", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s with dismissal access", - "childParamsGroups": [] - } - }, "name": "dismissal_restrictions", "in": "body", - "isRequired": false, + "description": "

    Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

    ", "childParamsGroups": [ { - "parentName": "dismissal_restrictions", - "parentType": "object", - "id": "dismissal_restrictions-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins with dismissal access

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs with dismissal access

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs with dismissal access

    ", - "name": "apps", - "in": "body" - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins with dismissal access

    " + }, + { + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs with dismissal access

    " + }, + { + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs with dismissal access

    " } ] }, { "type": "boolean", - "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    ", "name": "dismiss_stale_reviews", "in": "body", - "isRequired": false + "description": "

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

    " }, { "type": "boolean", - "description": "

    Blocks merging pull requests until code owners have reviewed.

    ", "name": "require_code_owner_reviews", "in": "body", - "isRequired": false + "description": "

    Blocks merging pull requests until code owners have reviewed.

    " }, { "type": "integer", - "description": "

    Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    ", "name": "required_approving_review_count", "in": "body", - "isRequired": false + "description": "

    Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

    " }, { "type": "object", - "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", - "properties": { - "users": { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "The list of user `login`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "teams": { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "The list of team `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - }, - "apps": { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "The list of app `slug`s allowed to bypass pull request requirements.", - "childParamsGroups": [] - } - }, "name": "bypass_pull_request_allowances", "in": "body", - "isRequired": false, + "description": "

    Allow specific users, teams, or apps to bypass pull request requirements.

    ", "childParamsGroups": [ { - "parentName": "bypass_pull_request_allowances", - "parentType": "object", - "id": "bypass_pull_request_allowances-object", - "params": [ - { - "type": "array of strings", - "description": "

    The list of user logins allowed to bypass pull request requirements.

    ", - "name": "users", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of team slugs allowed to bypass pull request requirements.

    ", - "name": "teams", - "in": "body" - }, - { - "type": "array of strings", - "description": "

    The list of app slugs allowed to bypass pull request requirements.

    ", - "name": "apps", - "in": "body" - } - ] + "type": "array of strings", + "name": "users", + "description": "

    The list of user logins allowed to bypass pull request requirements.

    " + }, + { + "type": "array of strings", + "name": "teams", + "description": "

    The list of team slugs allowed to bypass pull request requirements.

    " + }, + { + "type": "array of strings", + "name": "apps", + "description": "

    The list of app slugs allowed to bypass pull request requirements.

    " } ] } @@ -103355,46 +106867,32 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    Require branches to be up to date before merging.

    ", "name": "strict", "in": "body", - "isRequired": false + "description": "

    Require branches to be up to date before merging.

    " }, { "type": "array of strings", - "deprecated": true, - "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    ", "name": "contexts", "in": "body", - "isRequired": false + "description": "

    Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

    " }, { "type": "array of objects", - "description": "

    The list of status checks to require in order to merge into this branch.

    ", "name": "checks", "in": "body", - "isRequired": false, + "description": "

    The list of status checks to require in order to merge into this branch.

    ", "childParamsGroups": [ { - "parentName": "checks", - "parentType": "items", - "id": "checks-items", - "params": [ - { - "type": "string", - "description": "

    The name of the required check

    ", - "name": "context", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    ", - "name": "app_id", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "context", + "description": "

    The name of the required check

    ", + "isRequired": true + }, + { + "type": "integer", + "name": "app_id", + "description": "

    The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

    " } ] } @@ -103704,9 +107202,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -103716,8 +107214,14 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding status checks to a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -103802,9 +107306,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -103814,8 +107318,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example updating status checks for a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -103895,9 +107404,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    contexts parameter

    ", "name": "contexts", "in": "body", + "description": "

    The name of the status checks

    ", "isRequired": true } ], @@ -103907,8 +107416,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing status checks from a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -104957,9 +108471,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -105408,9 +108922,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -105859,9 +109373,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    apps parameter

    ", "name": "apps", "in": "body", + "description": "

    apps parameter

    ", "isRequired": true } ], @@ -106600,9 +110114,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -106612,8 +110126,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -106899,9 +110418,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -106911,8 +110430,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -107198,9 +110722,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    teams parameter

    ", "name": "teams", "in": "body", + "description": "

    The slug values for teams

    ", "isRequired": true } ], @@ -107210,8 +110734,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -107754,9 +111283,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -107766,8 +111295,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -108020,9 +111554,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -108032,8 +111566,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -108286,9 +111825,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    users parameter

    ", "name": "users", "in": "body", + "description": "

    The username for users

    ", "isRequired": true } ], @@ -108298,8 +111837,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -108546,55 +112090,52 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the check. For example, \"code-coverage\".

    ", "name": "name", "in": "body", + "description": "

    The name of the check. For example, \"code-coverage\".

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the commit.

    ", "name": "head_sha", "in": "body", + "description": "

    The SHA of the commit.

    ", "isRequired": true }, { "type": "string", - "description": "

    The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

    ", "name": "details_url", "in": "body", - "isRequired": false + "description": "

    The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

    " }, { "type": "string", - "description": "

    A reference for the run on the integrator's system.

    ", "name": "external_id", "in": "body", - "isRequired": false + "description": "

    A reference for the run on the integrator's system.

    " }, { "type": "string", + "name": "status", + "in": "body", "description": "

    The current status.

    ", "enum": [ "queued", "in_progress", "completed" ], - "default": "queued", - "name": "status", - "in": "body", - "isRequired": false + "default": "queued" }, { "type": "string", - "format": "date-time", - "description": "

    The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "string", + "name": "conclusion", + "in": "body", "description": "

    Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.

    ", "enum": [ "action_required", @@ -108605,588 +112146,120 @@ "skipped", "stale", "timed_out" - ], - "name": "conclusion", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "format": "date-time", - "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "completed_at", "in": "body", - "isRequired": false + "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "object", - "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", - "properties": { - "title": { - "type": "string", - "description": "

    The title of the check run.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the check run.", - "isRequired": true, - "childParamsGroups": [] - }, - "summary": { - "type": "string", - "maxLength": 65535, - "description": "

    The summary of the check run. This parameter supports Markdown.

    ", - "name": "summary", - "in": "body", - "rawType": "string", - "rawDescription": "The summary of the check run. This parameter supports Markdown.", - "isRequired": true, - "childParamsGroups": [] - }, - "text": { - "type": "string", - "maxLength": 65535, - "description": "

    The details of the check run. This parameter supports Markdown.

    ", - "name": "text", - "in": "body", - "rawType": "string", - "rawDescription": "The details of the check run. This parameter supports Markdown.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotations": { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", - "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, - "name": "annotations", - "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/github-ae@latest/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/github-ae@latest/rest/reference/checks#annotations-object) description for details about how to use this parameter.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - "images": { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, - "name": "images", - "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/github-ae@latest/rest/reference/checks#images-object) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "title", - "summary" - ], "name": "output", "in": "body", - "isRequired": false, + "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", "childParamsGroups": [ { - "parentName": "output", - "parentType": "object", - "id": "output-object", - "params": [ - { - "type": "string", - "description": "

    The title of the check run.

    ", - "name": "title", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 65535, - "description": "

    The summary of the check run. This parameter supports Markdown.

    ", - "name": "summary", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 65535, - "description": "

    The details of the check run. This parameter supports Markdown.

    ", - "name": "text", - "in": "body", - "isRequired": false - }, - { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", - "maxItems": 50, - "name": "annotations", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "name": "images", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "string", + "name": "title", + "description": "

    The title of the check run.

    ", + "isRequired": true }, { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ + "type": "string", + "name": "summary", + "description": "

    The summary of the check run. This parameter supports Markdown.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "text", + "description": "

    The details of the check run. This parameter supports Markdown.

    " + }, + { + "type": "array of objects", + "name": "annotations", + "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"About status checks\". See the annotations object description for details about how to use this parameter.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "name": "path", - "in": "body", + "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start line of the annotation.

    ", "name": "start_line", - "in": "body", + "description": "

    The start line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The end line of the annotation.

    ", "name": "end_line", - "in": "body", + "description": "

    The end line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "start_column", - "in": "body", - "isRequired": false + "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "end_column", - "in": "body", - "isRequired": false + "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "string", + "name": "annotation_level", "description": "

    The level of the annotation.

    ", + "isRequired": true, "enum": [ "notice", "warning", "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "name": "message", - "in": "body", + "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "isRequired": true }, { "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", "name": "title", - "in": "body", - "isRequired": false + "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    " }, { "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", "name": "raw_details", - "in": "body", - "isRequired": false + "description": "

    Details about this annotation. The maximum size is 64 KB.

    " } ] }, { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ + "type": "array of objects", + "name": "images", + "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The alternative text for the image.

    ", "name": "alt", - "in": "body", + "description": "

    The alternative text for the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full URL of the image.

    ", "name": "image_url", - "in": "body", + "description": "

    The full URL of the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short image description.

    ", "name": "caption", - "in": "body", - "isRequired": false + "description": "

    A short image description.

    " } ] } @@ -109194,42 +112267,27 @@ }, { "type": "array of objects", - "description": "

    Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", - "maxItems": 3, "name": "actions", "in": "body", - "isRequired": false, + "description": "

    Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", "childParamsGroups": [ { - "parentName": "actions", - "parentType": "items", - "id": "actions-items", - "params": [ - { - "type": "string", - "maxLength": 20, - "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", - "name": "label", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 40, - "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", - "name": "description", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 20, - "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", - "name": "identifier", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "label", + "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "identifier", + "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", + "isRequired": true } ] } @@ -112881,47 +115939,43 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the check. For example, \"code-coverage\".

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the check. For example, \"code-coverage\".

    " }, { "type": "string", - "description": "

    The URL of the integrator's site that has the full details of the check.

    ", "name": "details_url", "in": "body", - "isRequired": false + "description": "

    The URL of the integrator's site that has the full details of the check.

    " }, { "type": "string", - "description": "

    A reference for the run on the integrator's system.

    ", "name": "external_id", "in": "body", - "isRequired": false + "description": "

    A reference for the run on the integrator's system.

    " }, { "type": "string", - "format": "date-time", - "description": "

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "string", + "name": "status", + "in": "body", "description": "

    The current status.

    ", "enum": [ "queued", "in_progress", "completed" - ], - "name": "status", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "conclusion", + "in": "body", "description": "

    Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.

    ", "enum": [ "action_required", @@ -112932,587 +115986,119 @@ "skipped", "stale", "timed_out" - ], - "name": "conclusion", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "format": "date-time", - "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "completed_at", "in": "body", - "isRequired": false + "description": "

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { "type": "object", - "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", - "properties": { - "title": { - "type": "string", - "description": "

    Required.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "**Required**.", - "isRequired": false, - "childParamsGroups": [] - }, - "summary": { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "summary", - "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": true, - "childParamsGroups": [] - }, - "text": { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "text", - "in": "body", - "rawType": "string", - "rawDescription": "Can contain Markdown.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotations": { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", - "maxItems": 50, - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_line": { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The start line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "end_line": { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "rawType": "integer", - "rawDescription": "The end line of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "start_column": { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "end_column": { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "rawType": "integer", - "rawDescription": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "isRequired": false, - "childParamsGroups": [] - }, - "annotation_level": { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "rawType": "string", - "rawDescription": "The level of the annotation.", - "isRequired": true, - "childParamsGroups": [] - }, - "message": { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "isRequired": true, - "childParamsGroups": [] - }, - "title": { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title that represents the annotation. The maximum size is 255 characters.", - "isRequired": false, - "childParamsGroups": [] - }, - "raw_details": { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "rawType": "string", - "rawDescription": "Details about this annotation. The maximum size is 64 KB.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "path", - "start_line", - "end_line", - "annotation_level", - "message" - ] - }, - "name": "annotations", - "in": "body", - "rawType": "array", - "rawDescription": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/github-ae@latest/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/github-ae@latest/rest/reference/checks#annotations-object-1) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - "images": { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "items": { - "type": "object", - "properties": { - "alt": { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "rawType": "string", - "rawDescription": "The alternative text for the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "image_url": { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "rawType": "string", - "rawDescription": "The full URL of the image.", - "isRequired": true, - "childParamsGroups": [] - }, - "caption": { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "rawType": "string", - "rawDescription": "A short image description.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "alt", - "image_url" - ] - }, - "name": "images", - "in": "body", - "rawType": "array", - "rawDescription": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/github-ae@latest/rest/reference/checks#annotations-object-1) description for details.", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - }, - "required": [ - "summary" - ], "name": "output", "in": "body", - "isRequired": false, + "description": "

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

    ", "childParamsGroups": [ { - "parentName": "output", - "parentType": "object", - "id": "output-object", - "params": [ - { - "type": "string", - "description": "

    Required.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "summary", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    Can contain Markdown.

    ", - "maxLength": 65535, - "name": "text", - "in": "body", - "isRequired": false - }, - { - "type": "array of objects", - "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", - "maxItems": 50, - "name": "annotations", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ - { - "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start line of the annotation.

    ", - "name": "start_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The end line of the annotation.

    ", - "name": "end_line", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "start_column", - "in": "body", - "isRequired": false - }, - { - "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", - "name": "end_column", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    The level of the annotation.

    ", - "enum": [ - "notice", - "warning", - "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", - "name": "message", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", - "name": "title", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", - "name": "raw_details", - "in": "body", - "isRequired": false - } - ] - } - ] - }, - { - "type": "array of objects", - "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", - "name": "images", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ - { - "type": "string", - "description": "

    The alternative text for the image.

    ", - "name": "alt", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The full URL of the image.

    ", - "name": "image_url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    A short image description.

    ", - "name": "caption", - "in": "body", - "isRequired": false - } - ] - } - ] - } - ] + "type": "string", + "name": "title", + "description": "

    Required.

    " }, { - "parentName": "annotations", - "parentType": "items", - "id": "annotations-items", - "params": [ + "type": "string", + "name": "summary", + "description": "

    Can contain Markdown.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "text", + "description": "

    Can contain Markdown.

    " + }, + { + "type": "array of objects", + "name": "annotations", + "description": "

    Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"About status checks\". See the annotations object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "name": "path", - "in": "body", + "description": "

    The path of the file to add an annotation to. For example, assets/css/main.css.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start line of the annotation.

    ", "name": "start_line", - "in": "body", + "description": "

    The start line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The end line of the annotation.

    ", "name": "end_line", - "in": "body", + "description": "

    The end line of the annotation.

    ", "isRequired": true }, { "type": "integer", - "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "start_column", - "in": "body", - "isRequired": false + "description": "

    The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "integer", - "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    ", "name": "end_column", - "in": "body", - "isRequired": false + "description": "

    The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.

    " }, { "type": "string", + "name": "annotation_level", "description": "

    The level of the annotation.

    ", + "isRequired": true, "enum": [ "notice", "warning", "failure" - ], - "name": "annotation_level", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "name": "message", - "in": "body", + "description": "

    A short description of the feedback for these lines of code. The maximum size is 64 KB.

    ", "isRequired": true }, { "type": "string", - "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    ", "name": "title", - "in": "body", - "isRequired": false + "description": "

    The title that represents the annotation. The maximum size is 255 characters.

    " }, { "type": "string", - "description": "

    Details about this annotation. The maximum size is 64 KB.

    ", "name": "raw_details", - "in": "body", - "isRequired": false + "description": "

    Details about this annotation. The maximum size is 64 KB.

    " } ] }, { - "parentName": "images", - "parentType": "items", - "id": "images-items", - "params": [ + "type": "array of objects", + "name": "images", + "description": "

    Adds images to the output displayed in the GitHub pull request UI. See the images object description for details.

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    The alternative text for the image.

    ", "name": "alt", - "in": "body", + "description": "

    The alternative text for the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full URL of the image.

    ", "name": "image_url", - "in": "body", + "description": "

    The full URL of the image.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short image description.

    ", "name": "caption", - "in": "body", - "isRequired": false + "description": "

    A short image description.

    " } ] } @@ -113520,42 +116106,27 @@ }, { "type": "array of objects", - "description": "

    Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", - "maxItems": 3, "name": "actions", "in": "body", - "isRequired": false, + "description": "

    Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

    ", "childParamsGroups": [ { - "parentName": "actions", - "parentType": "items", - "id": "actions-items", - "params": [ - { - "type": "string", - "maxLength": 20, - "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", - "name": "label", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 40, - "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", - "name": "description", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "maxLength": 20, - "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", - "name": "identifier", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "label", + "description": "

    The text to be displayed on a button in the web UI. The maximum size is 20 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "description", + "description": "

    A short explanation of what this action would do. The maximum size is 40 characters.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "identifier", + "description": "

    A reference for the action on the integrator's system. The maximum size is 20 characters.

    ", + "isRequired": true } ] } @@ -117662,9 +120233,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The sha of the head commit.

    ", "name": "head_sha", "in": "body", + "description": "

    The sha of the head commit.

    ", "isRequired": true } ], @@ -123880,32 +126451,22 @@ "bodyParameters": [ { "type": "array of objects", - "description": "

    Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

    ", "name": "auto_trigger_checks", "in": "body", - "isRequired": false, + "description": "

    Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

    ", "childParamsGroups": [ { - "parentName": "auto_trigger_checks", - "parentType": "items", - "id": "auto_trigger_checks-items", - "params": [ - { - "type": "integer", - "description": "

    The id of the GitHub App.

    ", - "name": "app_id", - "in": "body", - "isRequired": true - }, - { - "type": "boolean", - "description": "

    Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

    ", - "default": true, - "name": "setting", - "in": "body", - "isRequired": true - } - ] + "type": "integer", + "name": "app_id", + "description": "

    The id of the GitHub App.

    ", + "isRequired": true + }, + { + "type": "boolean", + "name": "setting", + "description": "

    Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

    ", + "isRequired": true, + "default": true } ] } @@ -133853,28 +136414,27 @@ ], "bodyParameters": [ { - "description": "

    Sets the state of the code scanning alert. You must provide dismissed_reason when you set the state to dismissed.

    ", "type": "string", + "name": "state", + "in": "body", + "description": "

    Sets the state of the code scanning alert. You must provide dismissed_reason when you set the state to dismissed.

    ", + "isRequired": true, "enum": [ "open", "dismissed" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", + "name": "dismissed_reason", + "in": "body", "description": "

    Required when the state is dismissed. The reason for dismissing or closing the alert.

    ", "enum": [ null, "false positive", "won't fix", "used in tests" - ], - "name": "dismissed_reason", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -134744,6 +137304,33 @@ "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53" ] } + }, + { + "name": "direction", + "description": "

    The direction to sort the results by.

    ", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "

    The property by which to sort the results.

    ", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created" + ], + "default": "created" + } } ], "bodyParameters": [], @@ -135386,54 +137973,43 @@ ], "bodyParameters": [ { - "description": "

    The SHA of the commit to which the analysis you are uploading relates.

    ", "type": "string", - "minLength": 40, - "maxLength": 40, - "pattern": "^[0-9a-fA-F]+$", "name": "commit_sha", "in": "body", + "description": "

    The SHA of the commit to which the analysis you are uploading relates.

    ", "isRequired": true }, { "type": "string", - "description": "

    The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", "name": "ref", "in": "body", + "description": "

    The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

    ", "isRequired": true }, { - "description": "

    A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

    ", "type": "string", "name": "sarif", "in": "body", + "description": "

    A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

    ", "isRequired": true }, { - "description": "

    The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

    ", "type": "string", - "format": "uri", - "examples": [ - "file:///github/workspace/" - ], "name": "checkout_uri", "in": "body", - "isRequired": false + "description": "

    The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

    " }, { - "description": "

    The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "format": "date-time", "type": "string", "name": "started_at", "in": "body", - "isRequired": false + "description": "

    The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " }, { - "description": "

    The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

    ", "type": "string", "name": "tool_name", "in": "body", - "isRequired": false + "description": "

    The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

    " } ], "enabledForGitHubApps": true, @@ -136262,11 +138838,10 @@ "bodyParameters": [ { "type": "string", - "description": "

    The permission to grant the collaborator. Only valid on organization-owned repositories.

    ", - "default": "push", "name": "permission", "in": "body", - "isRequired": false + "description": "

    The permission to grant the collaborator. Only valid on organization-owned repositories.

    ", + "default": "push" } ], "enabledForGitHubApps": true, @@ -142101,6 +144676,8 @@ "bodyParameters": [ { "type": "string", + "name": "permissions", + "in": "body", "description": "

    The permissions that the associated user will have on the repository. Valid values are read, write, maintain, triage, and admin.

    ", "enum": [ "read", @@ -142108,10 +144685,7 @@ "maintain", "triage", "admin" - ], - "name": "permissions", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -142120,8 +144694,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example request body", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permissions": "write" + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -158554,9 +161131,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment

    ", "isRequired": true } ], @@ -159470,31 +162047,28 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true }, { "type": "string", - "description": "

    Relative path of the file to comment on.

    ", "name": "path", "in": "body", - "isRequired": false + "description": "

    Relative path of the file to comment on.

    " }, { "type": "integer", - "description": "

    Line index in the diff to comment on.

    ", "name": "position", "in": "body", - "isRequired": false + "description": "

    Line index in the diff to comment on.

    " }, { "type": "integer", - "description": "

    Deprecated. Use position parameter instead. Line number in the file to comment on.

    ", "name": "line", "in": "body", - "isRequired": false + "description": "

    Deprecated. Use position parameter instead. Line number in the file to comment on.

    " } ], "enabledForGitHubApps": true, @@ -162696,38 +165270,35 @@ "bodyParameters": [ { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the status.

    ", + "isRequired": true, "enum": [ "error", "failure", "pending", "success" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", - "description": "

    The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
    \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
    \nhttp://ci.example.com/user/repo/build/sha

    ", "name": "target_url", "in": "body", - "isRequired": false + "description": "

    The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
    \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
    \nhttp://ci.example.com/user/repo/build/sha

    " }, { "type": "string or null", - "description": "

    A short description of the status.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the status.

    " }, { "type": "string", - "description": "

    A string label to differentiate this status from the status of other systems. This field is case-insensitive.

    ", - "default": "default", "name": "context", "in": "body", - "isRequired": false + "description": "

    A string label to differentiate this status from the status of other systems. This field is case-insensitive.

    ", + "default": "default" } ], "enabledForGitHubApps": true, @@ -163173,24 +165744,22 @@ "bodyParameters": [ { "type": "string", - "description": "

    A name for the key.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    A name for the key.

    " }, { "type": "string", - "description": "

    The contents of the key.

    ", "name": "key", "in": "body", + "description": "

    The contents of the key.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

    \n

    Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

    ", "name": "read_only", "in": "body", - "isRequired": false + "description": "

    If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

    \n

    Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

    " } ], "enabledForGitHubApps": true, @@ -164291,82 +166860,61 @@ "bodyParameters": [ { "type": "string", - "description": "

    The ref to deploy. This can be a branch, tag, or SHA.

    ", "name": "ref", "in": "body", + "description": "

    The ref to deploy. This can be a branch, tag, or SHA.

    ", "isRequired": true }, { "type": "string", - "description": "

    Specifies a task to execute (e.g., deploy or deploy:migrations).

    ", - "default": "deploy", "name": "task", "in": "body", - "isRequired": false + "description": "

    Specifies a task to execute (e.g., deploy or deploy:migrations).

    ", + "default": "deploy" }, { "type": "boolean", - "description": "

    Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

    ", - "default": true, "name": "auto_merge", "in": "body", - "isRequired": false + "description": "

    Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

    ", + "default": true }, { "type": "array of strings", - "description": "

    The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

    ", "name": "required_contexts", "in": "body", - "isRequired": false + "description": "

    The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

    " }, { - "oneOf": [ - { - "type": "object", - "additionalProperties": true - }, - { - "type": "string", - "description": "JSON payload with extra information about the deployment.", - "default": "" - } - ], + "type": "object or string", "name": "payload", "in": "body", - "type": "object or string", - "description": "

    JSON payload with extra information about the deployment.

    ", - "isRequired": false + "description": "

    JSON payload with extra information about the deployment.

    " }, { "type": "string", - "description": "

    Name for the target deployment environment (e.g., production, staging, qa).

    ", - "default": "production", "name": "environment", "in": "body", - "isRequired": false + "description": "

    Name for the target deployment environment (e.g., production, staging, qa).

    ", + "default": "production" }, { "type": "string or null", - "description": "

    Short description of the deployment.

    ", - "default": "", "name": "description", "in": "body", - "isRequired": false + "description": "

    Short description of the deployment.

    " }, { "type": "boolean", - "description": "

    Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false

    ", - "default": false, "name": "transient_environment", "in": "body", - "isRequired": false + "description": "

    Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false

    " }, { "type": "boolean", - "description": "

    Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

    ", "name": "production_environment", "in": "body", - "isRequired": false + "description": "

    Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

    " } ], "enabledForGitHubApps": true, @@ -166095,13 +168643,10 @@ ], "bodyParameters": [ { - "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "type": "string", - "examples": [ - "release/*" - ], "name": "name", "in": "body", + "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "isRequired": true } ], @@ -166386,13 +168931,10 @@ ], "bodyParameters": [ { - "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "type": "string", - "examples": [ - "release/*" - ], "name": "name", "in": "body", + "description": "

    The name pattern that branches must match in order to deploy to the environment.

    \n

    Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.\nFor more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

    ", "isRequired": true } ], @@ -168020,105 +170562,49 @@ "bodyParameters": [ { "type": "integer", - "description": "

    The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).

    ", - "examples": [ - 30 - ], "name": "wait_timer", "in": "body", - "isRequired": false + "description": "

    The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).

    " }, { "type": "array of objects or null", - "description": "

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", "name": "reviewers", "in": "body", - "isRequired": false, + "description": "

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", "childParamsGroups": [ { - "parentName": "reviewers", - "parentType": "items", - "id": "reviewers-items", - "params": [ - { - "type": "string", - "description": "

    The type of reviewer.

    ", - "enum": [ - "User", - "Team" - ], - "examples": [ - "User" - ], - "name": "type", - "in": "body" - }, - { - "type": "integer", - "description": "

    The id of the user or team who can review the deployment

    ", - "examples": [ - 4532992 - ], - "name": "id", - "in": "body" - } + "type": "string", + "name": "type", + "description": "

    The type of reviewer.

    ", + "enum": [ + "User", + "Team" ] + }, + { + "type": "integer", + "name": "id", + "description": "

    The id of the user or team who can review the deployment

    " } ] }, { "type": "object or null", - "description": "

    The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

    ", - "properties": { - "protected_branches": { - "type": "boolean", - "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", - "name": "protected_branches", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", - "isRequired": true, - "childParamsGroups": [] - }, - "custom_branch_policies": { - "type": "boolean", - "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", - "name": "custom_branch_policies", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "protected_branches", - "custom_branch_policies" - ], "name": "deployment_branch_policy", "in": "body", - "isRequired": false, + "description": "

    The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

    ", "childParamsGroups": [ { - "parentName": "deployment_branch_policy", - "parentType": "object", - "id": "deployment_branch_policy-object", - "params": [ - { - "type": "boolean", - "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", - "name": "protected_branches", - "in": "body", - "isRequired": true - }, - { - "type": "boolean", - "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", - "name": "custom_branch_policies", - "in": "body", - "isRequired": true - } - ] + "type": "boolean", + "name": "protected_branches", + "description": "

    Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

    ", + "isRequired": true + }, + { + "type": "boolean", + "name": "custom_branch_policies", + "description": "

    Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

    ", + "isRequired": true } ] } @@ -169676,7 +172162,10 @@ "bodyParameters": [ { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the status. When you set a transient deployment to inactive, the deployment will be shown as destroyed in GitHub.

    ", + "isRequired": true, "enum": [ "error", "failure", @@ -169685,61 +172174,48 @@ "queued", "pending", "success" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string", - "description": "

    The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.

    ", - "default": "", "name": "target_url", "in": "body", - "isRequired": false + "description": "

    The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.

    " }, { "type": "string", - "description": "

    The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: \"\"

    ", - "default": "", "name": "log_url", "in": "body", - "isRequired": false + "description": "

    The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: \"\"

    " }, { "type": "string", - "description": "

    A short description of the status. The maximum description length is 140 characters.

    ", - "default": "", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the status. The maximum description length is 140 characters.

    " }, { "type": "string", + "name": "environment", + "in": "body", "description": "

    Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa.

    ", "enum": [ "production", "staging", "qa" - ], - "name": "environment", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "description": "

    Sets the URL for accessing your environment. Default: \"\"

    ", - "default": "", "name": "environment_url", "in": "body", - "isRequired": false + "description": "

    Sets the URL for accessing your environment. Default: \"\"

    " }, { "type": "boolean", - "description": "

    Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true

    ", "name": "auto_inactive", "in": "body", - "isRequired": false + "description": "

    Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true

    " } ], "enabledForGitHubApps": true, @@ -173819,24 +176295,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

    ", - "examples": [ - "Very **important** announcement about _nothing_." - ], "name": "announcement", "in": "body", + "description": "

    The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

    ", "isRequired": true }, { "type": "string or null", - "format": "date-time", - "description": "

    The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

    ", - "examples": [ - "\"2021-01-01T00:00:00.000-07:00\"" - ], "name": "expires_at", "in": "body", - "isRequired": false + "description": "

    The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

    " } ], "enabledForGitHubApps": false, @@ -174470,114 +176938,53 @@ "bodyParameters": [ { "type": "string", - "description": "

    Must be passed as \"web\".

    ", "name": "name", "in": "body", + "description": "

    Must be passed as \"web\".

    ", "isRequired": true }, { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", + "description": "

    Key/value pairs to provide settings for this webhook.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    " + }, + { + "type": "string", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ] }, { "type": "array of strings", - "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    ", "name": "events", "in": "body", - "isRequired": false + "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    " }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": false, @@ -174828,107 +177235,45 @@ "bodyParameters": [ { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers) header.", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    ", - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "name": "insecure_ssl", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.

    " + }, + { + "type": "string", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ] }, { "type": "array of strings", - "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    ", "name": "events", "in": "body", - "isRequired": false + "description": "

    The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

    " }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": false, @@ -175217,24 +177562,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The organization's username.

    ", "name": "login", "in": "body", + "description": "

    The organization's username.

    ", "isRequired": true }, { "type": "string", - "description": "

    The login of the user who will manage this organization.

    ", "name": "admin", "in": "body", + "description": "

    The login of the user who will manage this organization.

    ", "isRequired": true }, { "type": "string", - "description": "

    The organization's display name.

    ", "name": "profile_name", "in": "body", - "isRequired": false + "description": "

    The organization's display name.

    " } ], "enabledForGitHubApps": false, @@ -175401,9 +177745,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The organization's new name.

    ", "name": "login", "in": "body", + "description": "

    The organization's new name.

    ", "isRequired": true } ], @@ -175636,16 +177980,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new pre-receive environment's name.

    ", "name": "name", "in": "body", + "description": "

    The new pre-receive environment's name.

    ", "isRequired": true }, { "type": "string", - "description": "

    URL from which to download a tarball of this environment.

    ", "name": "image_url", "in": "body", + "description": "

    URL from which to download a tarball of this environment.

    ", "isRequired": true } ], @@ -175881,17 +178225,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    This pre-receive environment's new name.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    This pre-receive environment's new name.

    " }, { "type": "string", - "description": "

    URL from which to download a tarball of this environment.

    ", "name": "image_url", "in": "body", - "isRequired": false + "description": "

    URL from which to download a tarball of this environment.

    " } ], "enabledForGitHubApps": false, @@ -176450,16 +178792,16 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    The SCIM schema URIs.

    ", "name": "schemas", "in": "body", + "description": "

    The SCIM schema URIs.

    ", "isRequired": true }, { "type": "string", - "description": "

    The name of the SCIM group. This must match the GitHub organization that the group maps to.

    ", "name": "displayName", "in": "body", + "description": "

    The name of the SCIM group. This must match the GitHub organization that the group maps to.

    ", "isRequired": true }, { @@ -176467,21 +178809,12 @@ "name": "members", "in": "body", "description": "", - "isRequired": false, "childParamsGroups": [ { - "parentName": "members", - "parentType": "items", - "id": "members-items", - "params": [ - { - "type": "string", - "description": "

    The SCIM user ID for a user.

    ", - "name": "value", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "value", + "description": "

    The SCIM user ID for a user.

    ", + "isRequired": true } ] } @@ -176797,16 +179130,16 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    The SCIM schema URIs.

    ", "name": "schemas", "in": "body", + "description": "

    The SCIM schema URIs.

    ", "isRequired": true }, { "type": "string", - "description": "

    The name of the SCIM group. This must match the GitHub organization that the group maps to.

    ", "name": "displayName", "in": "body", + "description": "

    The name of the SCIM group. This must match the GitHub organization that the group maps to.

    ", "isRequired": true }, { @@ -176814,21 +179147,12 @@ "name": "members", "in": "body", "description": "", - "isRequired": false, "childParamsGroups": [ { - "parentName": "members", - "parentType": "items", - "id": "members-items", - "params": [ - { - "type": "string", - "description": "

    The SCIM user ID for a user.

    ", - "name": "value", - "in": "body", - "isRequired": true - } - ] + "type": "string", + "name": "value", + "description": "

    The SCIM user ID for a user.

    ", + "isRequired": true } ] } @@ -176993,54 +179317,41 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    The SCIM schema URIs.

    ", "name": "schemas", "in": "body", + "description": "

    The SCIM schema URIs.

    ", "isRequired": true }, { "type": "array of objects", - "description": "

    Array of SCIM operations.

    ", - "minItems": 1, "name": "Operations", "in": "body", + "description": "

    Array of SCIM operations.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "Operations", - "parentType": "items", - "id": "operations-items", - "params": [ - { - "type": "string", - "enum": [ - "add", - "Add", - "remove", - "Remove", - "replace", - "Replace" - ], - "name": "op", - "in": "body", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "path", - "in": "body", - "description": "", - "isRequired": false - }, - { - "description": "

    Can be any value - string, number, array or object.

    ", - "name": "value", - "in": "body", - "type": "", - "isRequired": false - } + "type": "string", + "name": "op", + "description": "", + "isRequired": true, + "enum": [ + "add", + "Add", + "remove", + "Remove", + "replace", + "Replace" ] + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "", + "name": "value", + "description": "

    Can be any value - string, number, array or object.

    " } ] } @@ -177807,14 +180118,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -178391,10 +180694,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    A list of scopes.

    ", "name": "scopes", "in": "body", - "isRequired": false + "description": "

    A list of scopes.

    " } ], "enabledForGitHubApps": false, @@ -178732,14 +181034,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -179527,14 +181821,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -180069,10 +182355,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    ", "name": "reason", "in": "body", - "isRequired": false + "description": "

    The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    " } ], "enabledForGitHubApps": false, @@ -180123,10 +182408,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    ", "name": "reason", "in": "body", - "isRequired": false + "description": "

    The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.

    " } ], "enabledForGitHubApps": false, @@ -180733,76 +183017,27 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Description of the gist

    ", "type": "string", - "examples": [ - "Example Ruby script" - ], "name": "description", "in": "body", - "isRequired": false + "description": "

    Description of the gist

    " }, { - "description": "

    Names and content for the files that make up the gist

    ", "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "content": { - "description": "

    Content of the file

    ", - "readOnly": false, - "type": "string", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "Content of the file", - "isRequired": true, - "childParamsGroups": [] - } - }, - "required": [ - "content" - ], - "rawType": "object", - "name": "key" - }, - "examples": [ - { - "hello.rb": { - "content": "puts \"Hello, World!\"" - } - } - ], "name": "files", "in": "body", + "description": "

    Names and content for the files that make up the gist

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "files", - "parentType": "object", - "id": "files-object", - "params": [ + "type": "object", + "name": "key", + "description": "

    A user-defined key to represent an item in files.

    ", + "childParamsGroups": [ { - "description": "

    A user-defined key to represent an item in files.

    ", - "type": "string", - "name": "key", - "in": "body", - "rawType": "string", - "rawDescription": "A key to represent an item in files." - } - ] - }, - { - "parentName": "key", - "parentType": "object", - "id": "key-object", - "params": [ - { - "description": "

    Content of the file

    ", - "readOnly": false, "type": "string", "name": "content", - "in": "body", + "description": "

    Content of the file

    ", "isRequired": true } ] @@ -180810,32 +183045,10 @@ ] }, { - "oneOf": [ - { - "description": "Flag indicating whether the gist is public", - "type": "boolean", - "default": false, - "examples": [ - true - ] - }, - { - "type": "string", - "default": "false", - "enum": [ - "true", - "false" - ], - "examples": [ - "true" - ] - } - ], + "type": "boolean or string", "name": "public", "in": "body", - "type": "boolean or string", - "description": "

    Flag indicating whether the gist is public

    ", - "isRequired": false + "description": "

    Flag indicating whether the gist is public

    " } ], "enabledForGitHubApps": false, @@ -184482,108 +186695,31 @@ ], "bodyParameters": [ { - "description": "

    Description of the gist

    ", "type": "string", - "examples": [ - "Example Ruby script" - ], "name": "description", "in": "body", - "isRequired": false + "description": "

    Description of the gist

    " }, { - "description": "

    Names of files to be updated

    ", "type": "object", - "additionalProperties": { - "type": [ - "object", - "null" - ], - "properties": { - "content": { - "description": "

    The new content of the file

    ", - "type": "string", - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The new content of the file", - "childParamsGroups": [] - }, - "filename": { - "description": "

    The new filename for the file

    ", - "type": "string or null", - "name": "filename", - "in": "body", - "rawType": [ - "string", - "null" - ], - "rawDescription": "The new filename for the file", - "childParamsGroups": [] - } - }, - "anyOf": [ - { - "required": [ - "content" - ] - }, - { - "required": [ - "filename" - ] - }, - { - "type": "object", - "maxProperties": 0 - } - ], - "rawType": "object", - "name": "key" - }, - "examples": [ - { - "hello.rb": { - "content": "blah", - "filename": "goodbye.rb" - } - } - ], "name": "files", "in": "body", - "isRequired": false, + "description": "

    Names of files to be updated

    ", "childParamsGroups": [ { - "parentName": "files", - "parentType": "object", - "id": "files-object", - "params": [ + "type": "object", + "name": "key", + "description": "

    A user-defined key to represent an item in files.

    ", + "childParamsGroups": [ { - "description": "

    A user-defined key to represent an item in files.

    ", - "type": "string", - "name": "key", - "in": "body", - "rawType": "string", - "rawDescription": "A key to represent an item in files." - } - ] - }, - { - "parentName": "key", - "parentType": "object", - "id": "key-object", - "params": [ - { - "description": "

    The new content of the file

    ", "type": "string", "name": "content", - "in": "body" + "description": "

    The new content of the file

    " }, { - "description": "

    The new filename for the file

    ", "type": "string or null", "name": "filename", - "in": "body" + "description": "

    The new filename for the file

    " } ] } @@ -190439,14 +192575,10 @@ ], "bodyParameters": [ { - "description": "

    The comment text.

    ", "type": "string", - "maxLength": 65535, - "examples": [ - "Body of the attachment" - ], "name": "body", "in": "body", + "description": "

    The comment text.

    ", "isRequired": true } ], @@ -191136,14 +193268,10 @@ ], "bodyParameters": [ { - "description": "

    The comment text.

    ", "type": "string", - "maxLength": 65535, - "examples": [ - "Body of the attachment" - ], "name": "body", "in": "body", + "description": "

    The comment text.

    ", "isRequired": true } ], @@ -191557,18 +193685,17 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new blob's content.

    ", "name": "content", "in": "body", + "description": "

    The new blob's content.

    ", "isRequired": true }, { "type": "string", - "description": "

    The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.

    ", - "default": "utf-8", "name": "encoding", "in": "body", - "isRequired": false + "description": "

    The encoding used for content. Currently, \"utf-8\" and \"base64\" are supported.

    ", + "default": "utf-8" } ], "enabledForGitHubApps": true, @@ -191799,171 +193926,77 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message

    ", "name": "message", "in": "body", + "description": "

    The commit message

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the tree object this commit points to

    ", "name": "tree", "in": "body", + "description": "

    The SHA of the tree object this commit points to

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

    ", "name": "parents", "in": "body", - "isRequired": false + "description": "

    The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

    " }, { "type": "object", - "description": "

    Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "author", "in": "body", - "isRequired": false, + "description": "

    Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] }, { "type": "object", - "description": "

    Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "childParamsGroups": [] - } - }, "name": "committer", "in": "body", - "isRequired": false, + "description": "

    Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - }, - { - "type": "string", - "format": "date-time", - "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "date", + "description": "

    Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] }, { "type": "string", - "description": "

    The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

    ", "name": "signature", "in": "body", - "isRequired": false + "description": "

    The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

    " } ], "enabledForGitHubApps": true, @@ -192832,27 +194865,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

    ", "name": "ref", "in": "body", + "description": "

    The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA1 value for this reference.

    ", "name": "sha", "in": "body", + "description": "

    The SHA1 value for this reference.

    ", "isRequired": true }, { "type": "string", - "examples": [ - "\"refs/heads/newbranch\"" - ], "name": "key", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -192992,18 +195021,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The SHA1 value to set this reference to

    ", "name": "sha", "in": "body", + "description": "

    The SHA1 value to set this reference to

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

    ", - "default": false, "name": "force", "in": "body", - "isRequired": false + "description": "

    Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

    " } ], "enabledForGitHubApps": true, @@ -193205,109 +195232,59 @@ "bodyParameters": [ { "type": "string", - "description": "

    The tag's name. This is typically a version (e.g., \"v0.0.1\").

    ", "name": "tag", "in": "body", + "description": "

    The tag's name. This is typically a version (e.g., \"v0.0.1\").

    ", "isRequired": true }, { "type": "string", - "description": "

    The tag message.

    ", "name": "message", "in": "body", + "description": "

    The tag message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the git object this is tagging.

    ", "name": "object", "in": "body", + "description": "

    The SHA of the git object this is tagging.

    ", "isRequired": true }, { "type": "string", + "name": "type", + "in": "body", "description": "

    The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.

    ", + "isRequired": true, "enum": [ "commit", "tree", "blob" - ], - "name": "type", - "in": "body", - "isRequired": true + ] }, { "type": "object", - "description": "

    An object with information about the individual creating the tag.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author of the tag

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author of the tag", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author of the tag

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author of the tag", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "format": "date-time", - "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "rawType": "string", - "rawDescription": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "tagger", "in": "body", - "isRequired": false, + "description": "

    An object with information about the individual creating the tag.

    ", "childParamsGroups": [ { - "parentName": "tagger", - "parentType": "object", - "id": "tagger-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author of the tag

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author of the tag

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "format": "date-time", - "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", - "name": "date", - "in": "body", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author of the tag

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author of the tag

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "

    When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ] } @@ -193742,68 +195719,55 @@ "bodyParameters": [ { "type": "array of objects", - "description": "

    Objects (of path, mode, type, and sha) specifying a tree structure.

    ", "name": "tree", "in": "body", + "description": "

    Objects (of path, mode, type, and sha) specifying a tree structure.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "tree", - "parentType": "items", - "id": "tree-items", - "params": [ - { - "type": "string", - "description": "

    The file referenced in the tree.

    ", - "name": "path", - "in": "body" - }, - { - "type": "string", - "description": "

    The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

    ", - "enum": [ - "100644", - "100755", - "040000", - "160000", - "120000" - ], - "name": "mode", - "in": "body" - }, - { - "type": "string", - "description": "

    Either blob, tree, or commit.

    ", - "enum": [ - "blob", - "tree", - "commit" - ], - "name": "type", - "in": "body" - }, - { - "type": "string or null", - "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", - "name": "sha", - "in": "body" - }, - { - "type": "string", - "description": "

    The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", - "name": "content", - "in": "body" - } + "type": "string", + "name": "path", + "description": "

    The file referenced in the tree.

    " + }, + { + "type": "string", + "name": "mode", + "description": "

    The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.

    ", + "enum": [ + "100644", + "100755", + "040000", + "160000", + "120000" ] + }, + { + "type": "string", + "name": "type", + "description": "

    Either blob, tree, or commit.

    ", + "enum": [ + "blob", + "tree", + "commit" + ] + }, + { + "type": "string or null", + "name": "sha", + "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    " + }, + { + "type": "string", + "name": "content", + "description": "

    The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or tree.sha.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    " } ] }, { "type": "string", - "description": "

    The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

    ", "name": "base_tree", "in": "body", - "isRequired": false + "description": "

    The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

    " } ], "enabledForGitHubApps": true, @@ -201654,7 +203618,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ], "schema": { @@ -204715,63 +206680,41 @@ ], "bodyParameters": [ { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "

    The title of the issue.

    ", + "type": "string or integer", "name": "title", "in": "body", - "type": "string or integer", + "description": "

    The title of the issue.

    ", "isRequired": true }, { "type": "string", - "description": "

    The contents of the issue.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the issue.

    " }, { "type": "string or null", - "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "name": "assignee", "in": "body", - "isRequired": false + "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    " }, { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._" - } - ], - "type": "string or integer or null", + "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "isRequired": false + "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    " }, { - "type": "array of strings or array of objects", - "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", + "type": "array", "name": "labels", "in": "body", - "isRequired": false + "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    " }, { "type": "array of strings", - "description": "

    Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    " } ], "enabledForGitHubApps": true, @@ -204957,7 +206900,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -208202,7 +210146,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -211272,74 +213217,56 @@ ], "bodyParameters": [ { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ], - "description": "

    The title of the issue.

    ", - "type": "string or integer or null", + "type": "null or string or integer or string or integer", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the issue.

    " }, { "type": "string or null", - "description": "

    The contents of the issue.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the issue.

    " }, { "type": "string or null", - "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", "in": "body", - "isRequired": false + "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    State of the issue. Either open or closed.

    ", "enum": [ "open", "closed" - ], - "name": "state", - "in": "body", - "isRequired": false + ] }, { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer", - "description": "The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._" - } - ], - "type": "string or integer or null", + "type": "string or null", + "name": "state_reason", + "in": "body", + "description": "

    The reason for the current state

    " + }, + { + "type": "null or string or integer or string or integer", "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "isRequired": false + "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    " }, { - "type": "array of strings or array of objects", - "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", + "type": "array", "name": "labels", "in": "body", - "isRequired": false + "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    " }, { "type": "array of strings", - "description": "

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    " } ], "enabledForGitHubApps": true, @@ -211527,7 +213454,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -214606,16 +216534,15 @@ "bodyParameters": [ { "type": "string", + "name": "lock_reason", + "in": "body", "description": "

    The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
    \n* off-topic
    \n* too heated
    \n* resolved
    \n* spam

    ", "enum": [ "off-topic", "too heated", "resolved", "spam" - ], - "name": "lock_reason", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -218522,10 +220449,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

    " } ], "enabledForGitHubApps": true, @@ -218707,7 +220633,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -221762,10 +223689,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

    ", "name": "assignees", "in": "body", - "isRequired": false + "description": "

    Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

    " } ], "enabledForGitHubApps": true, @@ -221947,7 +223873,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -226536,9 +228463,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true } ], @@ -228128,9 +230055,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The contents of the comment.

    ", "name": "body", "in": "body", + "description": "

    The contents of the comment.

    ", "isRequired": true } ], @@ -229080,7 +231007,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ], @@ -233948,7 +235876,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } }, "schema": { @@ -248900,10 +250829,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

    ", "name": "labels", - "in": "body" + "in": "body", + "description": "

    The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"

    " } ], "enabledForGitHubApps": true, @@ -249078,10 +251006,9 @@ "bodyParameters": [ { "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

    ", "name": "labels", - "in": "body" + "in": "body", + "description": "

    The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

    " } ], "enabledForGitHubApps": true, @@ -249647,24 +251574,22 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "name": "name", "in": "body", + "description": "

    The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "isRequired": true }, { "type": "string", - "description": "

    The hexadecimal color code for the label, without the leading #.

    ", "name": "color", "in": "body", - "isRequired": false + "description": "

    The hexadecimal color code for the label, without the leading #.

    " }, { "type": "string", - "description": "

    A short description of the label. Must be 100 characters or fewer.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the label. Must be 100 characters or fewer.

    " } ], "enabledForGitHubApps": true, @@ -249968,24 +251893,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    ", "name": "new_name", "in": "body", - "isRequired": false + "description": "

    The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji \":strawberry:\". For a full list of available emoji and codes, see \"Emoji cheat sheet.\"

    " }, { "type": "string", - "description": "

    The hexadecimal color code for the label, without the leading #.

    ", "name": "color", "in": "body", - "isRequired": false + "description": "

    The hexadecimal color code for the label, without the leading #.

    " }, { "type": "string", - "description": "

    A short description of the label. Must be 100 characters or fewer.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the label. Must be 100 characters or fewer.

    " } ], "enabledForGitHubApps": true, @@ -250838,37 +252760,33 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the milestone.

    ", "name": "title", "in": "body", + "description": "

    The title of the milestone.

    ", "isRequired": true }, { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the milestone. Either open or closed.

    ", "enum": [ "open", "closed" ], - "default": "open", - "name": "state", - "in": "body", - "isRequired": false + "default": "open" }, { "type": "string", - "description": "

    A description of the milestone.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A description of the milestone.

    " }, { "type": "string", - "format": "date-time", - "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "due_on", "in": "body", - "isRequired": false + "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ], "enabledForGitHubApps": true, @@ -251711,37 +253629,32 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the milestone.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the milestone.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    The state of the milestone. Either open or closed.

    ", "enum": [ "open", "closed" ], - "default": "open", - "name": "state", - "in": "body", - "isRequired": false + "default": "open" }, { "type": "string", - "description": "

    A description of the milestone.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A description of the milestone.

    " }, { "type": "string", - "format": "date-time", - "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    ", "name": "due_on", "in": "body", - "isRequired": false + "description": "

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    " } ], "enabledForGitHubApps": true, @@ -268618,33 +270531,28 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The Markdown text to render in HTML.

    ", "type": "string", "name": "text", "in": "body", + "description": "

    The Markdown text to render in HTML.

    ", "isRequired": true }, { + "type": "string", + "name": "mode", + "in": "body", "description": "

    The rendering mode. Can be either markdown or gfm.

    ", "enum": [ "markdown", "gfm" ], - "default": "markdown", - "type": "string", - "examples": [ - "markdown" - ], - "name": "mode", - "in": "body", - "isRequired": false + "default": "markdown" }, { - "description": "

    The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

    ", "type": "string", "name": "context", "in": "body", - "isRequired": false + "description": "

    The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.

    " } ], "enabledForGitHubApps": true, @@ -271945,88 +273853,58 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    A list of arrays indicating which repositories should be migrated.

    ", "name": "repositories", "in": "body", + "description": "

    A list of arrays indicating which repositories should be migrated.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Indicates whether repositories should be locked (to prevent manipulation) while migrating data.

    ", - "default": false, - "examples": [ - true - ], "name": "lock_repositories", "in": "body", - "isRequired": false + "description": "

    Indicates whether repositories should be locked (to prevent manipulation) while migrating data.

    " }, { "type": "boolean", - "description": "

    Indicates whether metadata should be excluded and only git source should be included for the migration.

    ", - "default": false, "name": "exclude_metadata", "in": "body", - "isRequired": false + "description": "

    Indicates whether metadata should be excluded and only git source should be included for the migration.

    " }, { "type": "boolean", - "description": "

    Indicates whether the repository git data should be excluded from the migration.

    ", - "default": false, "name": "exclude_git_data", "in": "body", - "isRequired": false + "description": "

    Indicates whether the repository git data should be excluded from the migration.

    " }, { "type": "boolean", - "description": "

    Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).

    ", - "default": false, - "examples": [ - true - ], "name": "exclude_attachments", "in": "body", - "isRequired": false + "description": "

    Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).

    " }, { "type": "boolean", - "description": "

    Indicates whether releases should be excluded from the migration (to reduce migration archive file size).

    ", - "default": false, - "examples": [ - true - ], "name": "exclude_releases", "in": "body", - "isRequired": false + "description": "

    Indicates whether releases should be excluded from the migration (to reduce migration archive file size).

    " }, { "type": "boolean", - "description": "

    Indicates whether projects owned by the organization or users should be excluded. from the migration.

    ", - "default": false, - "examples": [ - true - ], "name": "exclude_owner_projects", "in": "body", - "isRequired": false + "description": "

    Indicates whether projects owned by the organization or users should be excluded. from the migration.

    " }, { "type": "boolean", - "description": "

    Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

    ", - "default": false, - "examples": [ - true - ], "name": "org_metadata_only", "in": "body", - "isRequired": false + "description": "

    Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

    " }, { "type": "array of strings", - "description": "

    Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: \"repositories\".

    ", "name": "exclude", "in": "body", - "isRequired": false + "description": "

    Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: \"repositories\".

    " } ], "enabledForGitHubApps": false, @@ -277651,92 +279529,52 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Lock the repositories being migrated at the start of the migration

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "lock_repositories", "in": "body", - "isRequired": false + "description": "

    Lock the repositories being migrated at the start of the migration

    " }, { - "description": "

    Indicates whether metadata should be excluded and only git source should be included for the migration.

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_metadata", "in": "body", - "isRequired": false + "description": "

    Indicates whether metadata should be excluded and only git source should be included for the migration.

    " }, { - "description": "

    Indicates whether the repository git data should be excluded from the migration.

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_git_data", "in": "body", - "isRequired": false + "description": "

    Indicates whether the repository git data should be excluded from the migration.

    " }, { - "description": "

    Do not include attachments in the migration

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_attachments", "in": "body", - "isRequired": false + "description": "

    Do not include attachments in the migration

    " }, { - "description": "

    Do not include releases in the migration

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_releases", "in": "body", - "isRequired": false + "description": "

    Do not include releases in the migration

    " }, { - "description": "

    Indicates whether projects owned by the organization or users should be excluded.

    ", - "readOnly": false, "type": "boolean", - "examples": [ - true - ], "name": "exclude_owner_projects", "in": "body", - "isRequired": false + "description": "

    Indicates whether projects owned by the organization or users should be excluded.

    " }, { "type": "boolean", - "description": "

    Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

    ", - "default": false, - "examples": [ - true - ], "name": "org_metadata_only", "in": "body", - "isRequired": false + "description": "

    Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).

    " }, { - "description": "

    Exclude attributes from the API response to improve performance

    ", - "readOnly": false, "type": "array of strings", - "examples": [ - "repositories" - ], "name": "exclude", "in": "body", - "isRequired": false + "description": "

    Exclude attributes from the API response to improve performance

    " }, { "type": "array of strings", @@ -282619,69 +284457,62 @@ "bodyParameters": [ { "type": "string", - "description": "

    Billing email address. This address is not publicized.

    ", "name": "billing_email", "in": "body", - "isRequired": false + "description": "

    Billing email address. This address is not publicized.

    " }, { "type": "string", - "description": "

    The company name.

    ", "name": "company", "in": "body", - "isRequired": false + "description": "

    The company name.

    " }, { "type": "string", - "description": "

    The publicly visible email address.

    ", "name": "email", "in": "body", - "isRequired": false + "description": "

    The publicly visible email address.

    " }, { "type": "string", - "description": "

    The Twitter username of the company.

    ", "name": "twitter_username", "in": "body", - "isRequired": false + "description": "

    The Twitter username of the company.

    " }, { "type": "string", - "description": "

    The location.

    ", "name": "location", "in": "body", - "isRequired": false + "description": "

    The location.

    " }, { "type": "string", - "description": "

    The shorthand name of the company.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The shorthand name of the company.

    " }, { "type": "string", - "description": "

    The description of the company.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the company.

    " }, { "type": "boolean", - "description": "

    Whether an organization can use organization projects.

    ", "name": "has_organization_projects", "in": "body", - "isRequired": false + "description": "

    Whether an organization can use organization projects.

    " }, { "type": "boolean", - "description": "

    Whether repositories that belong to the organization can use repository projects.

    ", "name": "has_repository_projects", "in": "body", - "isRequired": false + "description": "

    Whether repositories that belong to the organization can use repository projects.

    " }, { "type": "string", + "name": "default_repository_permission", + "in": "body", "description": "

    Default permission level members have for organization repositories.

    ", "enum": [ "read", @@ -282689,101 +284520,82 @@ "admin", "none" ], - "default": "read", - "name": "default_repository_permission", - "in": "body", - "isRequired": false + "default": "read" }, { "type": "boolean", - "description": "

    Whether of non-admin organization members can create repositories. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

    ", - "default": true, "name": "members_can_create_repositories", "in": "body", - "isRequired": false + "description": "

    Whether of non-admin organization members can create repositories. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

    ", + "default": true }, { "type": "boolean", - "description": "

    Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_internal_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_private_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "boolean", - "description": "

    Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    ", "name": "members_can_create_public_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

    " }, { "type": "string", + "name": "members_allowed_repository_creation_type", + "in": "body", "description": "

    Specifies which types of repositories non-admin organization members can create. private is only available to repositories that are part of an organization on GitHub Enterprise Cloud.\nNote: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See the parameter deprecation notice in the operation description for details.

    ", "enum": [ "all", "private", "none" - ], - "name": "members_allowed_repository_creation_type", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.

    ", - "default": true, "name": "members_can_create_pages", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.

    ", + "default": true }, { "type": "boolean", - "description": "

    Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.

    ", - "default": true, "name": "members_can_create_public_pages", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.

    ", + "default": true }, { "type": "boolean", - "description": "

    Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.

    ", - "default": true, "name": "members_can_create_private_pages", "in": "body", - "isRequired": false + "description": "

    Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.

    ", + "default": true }, { "type": "boolean", - "description": "

    Whether organization members can fork private organization repositories.

    ", - "default": false, "name": "members_can_fork_private_repositories", "in": "body", - "isRequired": false + "description": "

    Whether organization members can fork private organization repositories.

    " }, { "type": "boolean", - "description": "

    Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.

    ", - "default": false, "name": "web_commit_signoff_required", "in": "body", - "isRequired": false + "description": "

    Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.

    " }, { "type": "string", - "examples": [ - "\"http://github.blog\"" - ], "name": "blog", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -284130,14 +285942,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -285859,15 +287663,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role to give the user in the organization. Can be one of:
    \n* admin - The user will become an owner of the organization.
    \n* member - The user will become a non-owner member of the organization.

    ", "enum": [ "admin", "member" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -287284,13 +289087,13 @@ "bodyParameters": [ { "type": "string", - "description": "

    The state that the membership should be in. Only \"active\" will be accepted.

    ", - "enum": [ - "active" - ], "name": "state", "in": "body", - "isRequired": true + "description": "

    The state that the membership should be in. Only \"active\" will be accepted.

    ", + "isRequired": true, + "enum": [ + "active" + ] } ], "enabledForGitHubApps": false, @@ -288002,11 +289805,9 @@ "bodyParameters": [ { "type": "boolean", - "description": "

    When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

    ", - "default": false, "name": "async", "in": "body", - "isRequired": false + "description": "

    When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

    " } ], "enabledForGitHubApps": true, @@ -288364,203 +290165,66 @@ "bodyParameters": [ { "type": "string", - "description": "

    Must be passed as \"web\".

    ", "name": "name", "in": "body", + "description": "

    Must be passed as \"web\".

    ", "isRequired": true }, { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - }, - "username": { - "type": "string", - "examples": [ - "\"kdaigle\"" - ], - "name": "username", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "password": { - "type": "string", - "examples": [ - "\"password\"" - ], - "name": "password", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "isRequired": true, "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"kdaigle\"" - ], - "name": "username", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"password\"" - ], - "name": "password", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "username", + "description": "" + }, + { + "type": "string", + "name": "password", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, @@ -288967,162 +290631,54 @@ "bodyParameters": [ { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true }, { "type": "string", - "examples": [ - "\"web\"" - ], "name": "name", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -289494,53 +291050,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": true, @@ -290560,77 +292090,35 @@ "bodyParameters": [ { "type": "string", + "name": "build_type", + "in": "body", "description": "

    The process in which the Page will be built. Possible values are \"legacy\" and \"workflow\".

    ", "enum": [ "legacy", "workflow" - ], - "name": "build_type", - "in": "body", - "isRequired": false + ] }, { "type": "object", + "name": "source", + "in": "body", "description": "

    The source branch and directory used to publish your Pages site.

    ", - "properties": { - "branch": { + "childParamsGroups": [ + { "type": "string", - "description": "

    The repository branch used to publish your site's source files.

    ", "name": "branch", - "in": "body", - "rawType": "string", - "rawDescription": "The repository branch used to publish your site's source files.", - "isRequired": true, - "childParamsGroups": [] + "description": "

    The repository branch used to publish your site's source files.

    ", + "isRequired": true }, - "path": { + { "type": "string", + "name": "path", "description": "

    The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: /

    ", "enum": [ "/", "/docs" ], - "default": "/", - "name": "path", - "in": "body", - "rawType": "string", - "rawDescription": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "branch" - ], - "name": "source", - "in": "body", - "isRequired": false, - "childParamsGroups": [ - { - "parentName": "source", - "parentType": "object", - "id": "source-object", - "params": [ - { - "type": "string", - "description": "

    The repository branch used to publish your site's source files.

    ", - "name": "branch", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: /

    ", - "enum": [ - "/", - "/docs" - ], - "default": "/", - "name": "path", - "in": "body", - "isRequired": false - } - ] + "default": "/" } ] } @@ -290914,75 +292402,37 @@ "bodyParameters": [ { "type": "string or null", - "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    ", "name": "cname", "in": "body", - "isRequired": false + "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    " }, { "type": "boolean", - "description": "

    Specify whether HTTPS should be enforced for the repository.

    ", "name": "https_enforced", "in": "body", - "isRequired": false + "description": "

    Specify whether HTTPS should be enforced for the repository.

    " }, { "type": "boolean", - "description": "

    Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

    ", "name": "public", "in": "body", - "isRequired": false + "description": "

    Configures access controls for the GitHub Pages site. If public is set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to internal visibility. This feature is only available to repositories in an organization on an Enterprise plan.

    " }, { "type": "string", + "name": "build_type", + "in": "body", "description": "

    The process by which the GitHub Pages site will be built. workflow means that the site is built by a custom GitHub Actions workflow. legacy means that the site is built by GitHub when changes are pushed to a specific branch.

    ", "enum": [ "legacy", "workflow" - ], - "name": "build_type", - "in": "body", - "isRequired": false + ] }, { - "anyOf": [ - { - "type": "string", - "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", - "enum": [ - "gh-pages", - "master", - "master /docs" - ] - }, - { - "type": "object", - "description": "Update the source for the repository. Must include the branch name and path.", - "properties": { - "branch": { - "type": "string", - "description": "The repository branch used to publish your site's source files." - }, - "path": { - "type": "string", - "description": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.", - "enum": [ - "/", - "/docs" - ] - } - }, - "required": [ - "branch", - "path" - ] - } - ], + "type": "", "name": "source", "in": "body", - "type": "", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -292564,17 +294014,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the project.

    ", "name": "name", "in": "body", + "description": "

    The name of the project.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the project.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The description of the project.

    " } ], "enabledForGitHubApps": true, @@ -293351,54 +294800,40 @@ ], "bodyParameters": [ { - "description": "

    Name of the project

    ", "type": "string", - "examples": [ - "Week One Sprint" - ], "name": "name", "in": "body", - "isRequired": false + "description": "

    Name of the project

    " }, { - "description": "

    Body of the project

    ", "type": "string or null", - "examples": [ - "This project represents the sprint of the first week in January" - ], "name": "body", "in": "body", - "isRequired": false + "description": "

    Body of the project

    " }, { - "description": "

    State of the project; either 'open' or 'closed'

    ", "type": "string", - "examples": [ - "open" - ], "name": "state", "in": "body", - "isRequired": false + "description": "

    State of the project; either 'open' or 'closed'

    " }, { - "description": "

    The baseline permission that all organization members have on this project

    ", "type": "string", + "name": "organization_permission", + "in": "body", + "description": "

    The baseline permission that all organization members have on this project

    ", "enum": [ "read", "write", "admin", "none" - ], - "name": "organization_permission", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether or not this project can be seen by everyone.

    ", "type": "boolean", "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether or not this project can be seen by everyone.

    " } ], "enabledForGitHubApps": true, @@ -294311,17 +295746,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the project.

    ", "name": "name", "in": "body", + "description": "

    The name of the project.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the project.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The description of the project.

    " } ], "enabledForGitHubApps": true, @@ -294709,24 +296143,17 @@ "parameters": [], "bodyParameters": [ { - "description": "

    Name of the project

    ", "type": "string", - "examples": [ - "Week One Sprint" - ], "name": "name", "in": "body", + "description": "

    Name of the project

    ", "isRequired": true }, { - "description": "

    Body of the project

    ", "type": "string or null", - "examples": [ - "This project represents the sprint of the first week in January" - ], "name": "body", "in": "body", - "isRequired": false + "description": "

    Body of the project

    " } ], "enabledForGitHubApps": true, @@ -295886,24 +297313,16 @@ ], "bodyParameters": [ { - "description": "

    The project card's note

    ", "type": "string or null", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", - "isRequired": false + "description": "

    The project card's note

    " }, { - "description": "

    Whether or not the card is archived

    ", "type": "boolean", - "examples": [ - false - ], "name": "archived", "in": "body", - "isRequired": false + "description": "

    Whether or not the card is archived

    " } ], "enabledForGitHubApps": true, @@ -296333,25 +297752,17 @@ ], "bodyParameters": [ { - "description": "

    The position of the card in a column. Can be one of: top, bottom, or after:<card_id> to place after the specified card.

    ", "type": "string", - "pattern": "^(?:top|bottom|after:\\d+)$", - "examples": [ - "bottom" - ], "name": "position", "in": "body", + "description": "

    The position of the card in a column. Can be one of: top, bottom, or after:<card_id> to place after the specified card.

    ", "isRequired": true }, { - "description": "

    The unique identifier of the column the card should be moved to

    ", "type": "integer", - "examples": [ - 42 - ], "name": "column_id", "in": "body", - "isRequired": false + "description": "

    The unique identifier of the column the card should be moved to

    " } ], "enabledForGitHubApps": true, @@ -296823,33 +298234,24 @@ ], "bodyParameters": [ { - "description": "

    The project card's note

    ", "type": "string or null", - "examples": [ - "Update all gems" - ], "name": "note", "in": "body", + "description": "

    The project card's note

    ", "isRequired": true }, { - "description": "

    The unique identifier of the content associated with the card

    ", "type": "integer", - "examples": [ - 42 - ], "name": "content_id", "in": "body", + "description": "

    The unique identifier of the content associated with the card

    ", "isRequired": true }, { - "description": "

    The piece of content associated with the card

    ", "type": "string", - "examples": [ - "PullRequest" - ], "name": "content_type", "in": "body", + "description": "

    The piece of content associated with the card

    ", "isRequired": true } ], @@ -297515,20 +298917,16 @@ ], "bodyParameters": [ { + "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant the collaborator.

    ", "enum": [ "read", "write", "admin" ], - "default": "write", - "type": "string", - "examples": [ - "write" - ], - "name": "permission", - "in": "body", - "isRequired": false + "default": "write" } ], "enabledForGitHubApps": true, @@ -298104,13 +299502,10 @@ ], "bodyParameters": [ { - "description": "

    Name of the project column

    ", "type": "string", - "examples": [ - "Remaining tasks" - ], "name": "name", "in": "body", + "description": "

    Name of the project column

    ", "isRequired": true } ], @@ -298316,14 +299711,10 @@ ], "bodyParameters": [ { - "description": "

    The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

    ", "type": "string", - "pattern": "^(?:first|last|after:\\d+)$", - "examples": [ - "last" - ], "name": "position", "in": "body", + "description": "

    The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

    ", "isRequired": true } ], @@ -298563,13 +299954,10 @@ ], "bodyParameters": [ { - "description": "

    Name of the project column

    ", "type": "string", - "examples": [ - "Remaining tasks" - ], "name": "name", "in": "body", + "description": "

    Name of the project column

    ", "isRequired": true } ], @@ -304311,55 +305699,47 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the new pull request. Required unless issue is specified.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the new pull request. Required unless issue is specified.

    " }, { "type": "string", - "description": "

    The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

    ", "name": "head", "in": "body", + "description": "

    The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

    ", "isRequired": true }, { "type": "string", - "description": "

    The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

    ", "name": "base", "in": "body", + "description": "

    The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    The contents of the pull request.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the pull request.

    " }, { "type": "boolean", - "description": "

    Indicates whether maintainers can modify the pull request.

    ", "name": "maintainer_can_modify", "in": "body", - "isRequired": false + "description": "

    Indicates whether maintainers can modify the pull request.

    " }, { "type": "boolean", - "description": "

    Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

    ", "name": "draft", "in": "body", - "isRequired": false + "description": "

    Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

    " }, { "type": "integer", - "description": "

    An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified.

    ", - "examples": [ - 1 - ], "name": "issue", "in": "body", - "isRequired": false + "description": "

    An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified.

    " } ], "enabledForGitHubApps": true, @@ -312008,42 +313388,37 @@ "bodyParameters": [ { "type": "string", - "description": "

    The title of the pull request.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The title of the pull request.

    " }, { "type": "string", - "description": "

    The contents of the pull request.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The contents of the pull request.

    " }, { "type": "string", + "name": "state", + "in": "body", "description": "

    State of this Pull Request. Either open or closed.

    ", "enum": [ "open", "closed" - ], - "name": "state", - "in": "body", - "isRequired": false + ] }, { "type": "string", - "description": "

    The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

    ", "name": "base", "in": "body", - "isRequired": false + "description": "

    The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

    " }, { "type": "boolean", - "description": "

    Indicates whether maintainers can modify the pull request.

    ", "name": "maintainer_can_modify", "in": "body", - "isRequired": false + "description": "

    Indicates whether maintainers can modify the pull request.

    " } ], "enabledForGitHubApps": true, @@ -316993,36 +318368,32 @@ "bodyParameters": [ { "type": "string", - "description": "

    Title for the automatic commit message.

    ", "name": "commit_title", "in": "body", - "isRequired": false + "description": "

    Title for the automatic commit message.

    " }, { "type": "string", - "description": "

    Extra detail to append to automatic commit message.

    ", "name": "commit_message", "in": "body", - "isRequired": false + "description": "

    Extra detail to append to automatic commit message.

    " }, { "type": "string", - "description": "

    SHA that pull request head must match to allow merge.

    ", "name": "sha", "in": "body", - "isRequired": false + "description": "

    SHA that pull request head must match to allow merge.

    " }, { "type": "string", + "name": "merge_method", + "in": "body", "description": "

    Merge method to use. Possible values are merge, squash or rebase. Default is merge.

    ", "enum": [ "merge", "squash", "rebase" - ], - "name": "merge_method", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -317140,10 +318511,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

    ", "name": "expected_head_sha", "in": "body", - "isRequired": false + "description": "

    The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

    " } ], "enabledForGitHubApps": false, @@ -318532,9 +319902,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the reply to the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the reply to the review comment.

    ", "isRequired": true } ], @@ -319907,82 +321277,70 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the review comment.

    ", "isRequired": true }, { "type": "string", - "description": "

    The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

    ", "name": "commit_id", "in": "body", + "description": "

    The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

    ", "isRequired": true }, { "type": "string", - "description": "

    The relative path to the file that necessitates a comment.

    ", "name": "path", "in": "body", + "description": "

    The relative path to the file that necessitates a comment.

    ", "isRequired": true }, { "type": "integer", - "description": "

    This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    ", - "deprecated": true, - "x-github": { - "deprecationDate": "2022-11-01" - }, "name": "position", "in": "body", - "isRequired": false + "description": "

    This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

    " }, { "type": "string", + "name": "side", + "in": "body", "description": "

    In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

    ", "enum": [ "LEFT", "RIGHT" - ], - "name": "side", - "in": "body", - "isRequired": false + ] }, { "type": "integer", - "description": "

    The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

    ", "name": "line", "in": "body", + "description": "

    The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

    ", "isRequired": true }, { "type": "integer", - "description": "

    Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

    ", "name": "start_line", "in": "body", - "isRequired": false + "description": "

    Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

    " }, { "type": "string", + "name": "start_side", + "in": "body", "description": "

    Required when using multi-line comments unless using in_reply_to. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

    ", "enum": [ "LEFT", "RIGHT", "side" - ], - "name": "start_side", - "in": "body", - "isRequired": false + ] }, { "type": "integer", - "description": "

    The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

    ", - "examples": [ - 2 - ], "name": "in_reply_to", "in": "body", - "isRequired": false + "description": "

    The ID of the review comment to reply to. To find the ID of a review comment with \"List review comments on a pull request\". When specified, all parameters other than body in the request body are ignored.

    " } ], "enabledForGitHubApps": true, @@ -320631,9 +321989,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The text of the review comment.

    ", "name": "body", "in": "body", + "description": "

    The text of the review comment.

    ", "isRequired": true } ], @@ -321751,17 +323109,15 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of user logins that will be requested.

    ", "name": "reviewers", "in": "body", - "isRequired": false + "description": "

    An array of user logins that will be requested.

    " }, { "type": "array of strings", - "description": "

    An array of team slugs that will be requested.

    ", "name": "team_reviewers", "in": "body", - "isRequired": false + "description": "

    An array of team slugs that will be requested.

    " } ], "enabledForGitHubApps": true, @@ -327318,17 +328674,16 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of user logins that will be removed.

    ", "name": "reviewers", "in": "body", + "description": "

    An array of user logins that will be removed.

    ", "isRequired": true }, { "type": "array of strings", - "description": "

    An array of team slugs that will be removed.

    ", "name": "team_reviewers", "in": "body", - "isRequired": false + "description": "

    An array of team slugs that will be removed.

    " } ], "enabledForGitHubApps": true, @@ -333264,104 +334619,69 @@ "bodyParameters": [ { "type": "string", - "description": "

    The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

    ", "name": "commit_id", "in": "body", - "isRequired": false + "description": "

    The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

    " }, { "type": "string", - "description": "

    Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

    " }, { "type": "string", + "name": "event", + "in": "body", "description": "

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

    ", "enum": [ "APPROVE", "REQUEST_CHANGES", "COMMENT" - ], - "name": "event", - "in": "body", - "isRequired": false + ] }, { "type": "array of objects", - "description": "

    Use the following table to specify the location, destination, and contents of the draft review comment.

    ", "name": "comments", "in": "body", - "isRequired": false, + "description": "

    Use the following table to specify the location, destination, and contents of the draft review comment.

    ", "childParamsGroups": [ { - "parentName": "comments", - "parentType": "items", - "id": "comments-items", - "params": [ - { - "type": "string", - "description": "

    The relative path to the file that necessitates a review comment.

    ", - "name": "path", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "description": "

    The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

    ", - "name": "position", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    Text of the review comment.

    ", - "name": "body", - "in": "body", - "isRequired": true - }, - { - "type": "integer", - "examples": [ - 28 - ], - "name": "line", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "RIGHT" - ], - "name": "side", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "integer", - "examples": [ - 26 - ], - "name": "start_line", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "LEFT" - ], - "name": "start_side", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "path", + "description": "

    The relative path to the file that necessitates a review comment.

    ", + "isRequired": true + }, + { + "type": "integer", + "name": "position", + "description": "

    The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

    " + }, + { + "type": "string", + "name": "body", + "description": "

    Text of the review comment.

    ", + "isRequired": true + }, + { + "type": "integer", + "name": "line", + "description": "" + }, + { + "type": "string", + "name": "side", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + }, + { + "type": "string", + "name": "start_side", + "description": "" } ] } @@ -334208,9 +335528,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The body text of the pull request review.

    ", "name": "body", "in": "body", + "description": "

    The body text of the pull request review.

    ", "isRequired": true } ], @@ -335681,23 +337001,19 @@ "bodyParameters": [ { "type": "string", - "description": "

    The message for the pull request review dismissal

    ", "name": "message", "in": "body", + "description": "

    The message for the pull request review dismissal

    ", "isRequired": true }, { "type": "string", - "enum": [ - "DISMISS" - ], - "examples": [ - "\"DISMISS\"" - ], "name": "event", "in": "body", "description": "", - "isRequired": false + "enum": [ + "DISMISS" + ] } ], "enabledForGitHubApps": true, @@ -336123,22 +337439,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The body text of the pull request review

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The body text of the pull request review

    " }, { "type": "string", + "name": "event", + "in": "body", "description": "

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.

    ", + "isRequired": true, "enum": [ "APPROVE", "REQUEST_CHANGES", "COMMENT" - ], - "name": "event", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -337256,7 +338571,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -337266,10 +338584,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -338302,7 +339617,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the team discussion.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -338312,10 +339630,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -339340,7 +340655,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the commit comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -339350,10 +340668,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -340386,7 +341701,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the issue comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -340396,10 +341714,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -341432,7 +342747,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the issue.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -341442,10 +342760,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": false, @@ -342474,7 +343789,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the pull request review comment.

    ", + "isRequired": true, "enum": [ "+1", "-1", @@ -342484,10 +343802,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -343518,7 +344833,10 @@ "bodyParameters": [ { "type": "string", + "name": "content", + "in": "body", "description": "

    The reaction type to add to the release.

    ", + "isRequired": true, "enum": [ "+1", "laugh", @@ -343526,10 +344844,7 @@ "hooray", "rocket", "eyes" - ], - "name": "content", - "in": "body", - "isRequired": true + ] } ], "enabledForGitHubApps": true, @@ -344934,47 +346249,40 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the tag.

    ", "name": "tag_name", "in": "body", + "description": "

    The name of the tag.

    ", "isRequired": true }, { "type": "string", - "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    ", "name": "target_commitish", "in": "body", - "isRequired": false + "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    " }, { "type": "string", - "description": "

    The name of the release.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the release.

    " }, { "type": "string", - "description": "

    Text describing the contents of the tag.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Text describing the contents of the tag.

    " }, { "type": "boolean", - "description": "

    true to create a draft (unpublished) release, false to create a published one.

    ", - "default": false, "name": "draft", "in": "body", - "isRequired": false + "description": "

    true to create a draft (unpublished) release, false to create a published one.

    " }, { "type": "boolean", - "description": "

    true to identify the release as a prerelease. false to identify the release as a full release.

    ", - "default": false, "name": "prerelease", "in": "body", - "isRequired": false + "description": "

    true to identify the release as a prerelease. false to identify the release as a full release.

    " } ], "enabledForGitHubApps": true, @@ -347878,45 +349186,39 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the tag.

    ", "name": "tag_name", "in": "body", - "isRequired": false + "description": "

    The name of the tag.

    " }, { "type": "string", - "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    ", "name": "target_commitish", "in": "body", - "isRequired": false + "description": "

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

    " }, { "type": "string", - "description": "

    The name of the release.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the release.

    " }, { "type": "string", - "description": "

    Text describing the contents of the tag.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    Text describing the contents of the tag.

    " }, { "type": "boolean", - "description": "

    true makes the release a draft, and false publishes the release.

    ", "name": "draft", "in": "body", - "isRequired": false + "description": "

    true makes the release a draft, and false publishes the release.

    " }, { "type": "boolean", - "description": "

    true to identify the release as a prerelease, false to identify the release as a full release.

    ", "name": "prerelease", "in": "body", - "isRequired": false + "description": "

    true to identify the release as a prerelease, false to identify the release as a full release.

    " } ], "enabledForGitHubApps": true, @@ -349069,27 +350371,21 @@ "bodyParameters": [ { "type": "string", - "description": "

    The file name of the asset.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The file name of the asset.

    " }, { "type": "string", - "description": "

    An alternate short description of the asset. Used in place of the filename.

    ", "name": "label", "in": "body", - "isRequired": false + "description": "

    An alternate short description of the asset. Used in place of the filename.

    " }, { "type": "string", - "examples": [ - "\"uploaded\"" - ], "name": "state", "in": "body", - "description": "", - "isRequired": false + "description": "" } ], "enabledForGitHubApps": true, @@ -352567,199 +353863,171 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the repository.

    ", "name": "name", "in": "body", + "description": "

    The name of the repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short description of the repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { "type": "string", - "description": "

    A URL with more information about the repository.

    ", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { "type": "boolean", - "description": "

    Whether the repository is private.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether the repository is private.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.

    ", "enum": [ "public", "private", "internal" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Either true to enable issues for this repository or false to disable them.

    ", - "default": true, "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Either true to enable issues for this repository or false to disable them.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", - "default": true, "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", - "default": true, "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    ", - "default": false, "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    " }, { "type": "integer", - "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    ", "name": "team_id", "in": "body", - "isRequired": false + "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    " }, { "type": "boolean", - "description": "

    Pass true to create an initial commit with empty README.

    ", - "default": false, "name": "auto_init", "in": "body", - "isRequired": false + "description": "

    Pass true to create an initial commit with empty README.

    " }, { "type": "string", - "description": "

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

    ", "name": "gitignore_template", "in": "body", - "isRequired": false + "description": "

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

    " }, { "type": "string", - "description": "

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

    ", "name": "license_template", "in": "body", - "isRequired": false + "description": "

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", - "default": true, "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", - "default": true, "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", - "default": true, "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    ", - "default": false, "name": "allow_auto_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    " }, { "type": "boolean", - "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    ", - "default": false, "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    ", - "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -360183,295 +361451,78 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the repository.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the repository.

    " }, { "type": "string", - "description": "

    A short description of the repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { "type": "string", - "description": "

    A URL with more information about the repository.

    ", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { "type": "boolean", - "description": "

    Either true to make the repository private or false to make it public. Default: false.
    \nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Either true to make the repository private or false to make it public. Default: false.
    \nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

    " }, { "type": "string", + "name": "visibility", + "in": "body", "description": "

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal.\"

    ", "enum": [ "public", "private", "internal" - ], - "name": "visibility", - "in": "body", - "isRequired": false + ] }, { "type": "object or null", - "description": "

    Specify which security and analysis features to enable or disable for the repository.

    \n

    To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

    \n

    For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.

    \n

    You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

    ", - "properties": { - "advanced_security": { - "type": "object", - "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "advanced_security", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", - "childParamsGroups": [ - { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - "secret_scanning": { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", - "childParamsGroups": [ - { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - "secret_scanning_push_protection": { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning_push_protection", - "in": "body", - "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", - "childParamsGroups": [ - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - } - }, "name": "security_and_analysis", "in": "body", - "isRequired": false, + "description": "

    Specify which security and analysis features to enable or disable for the repository.

    \n

    To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

    \n

    For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.

    \n

    You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

    ", "childParamsGroups": [ { - "parentName": "security_and_analysis", - "parentType": "object", - "id": "security_and_analysis-object", - "params": [ + "type": "object", + "name": "advanced_security", + "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", + "childParamsGroups": [ { - "type": "object", - "description": "

    Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "advanced_security", - "in": "body", - "childParamsGroups": [ - { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning", - "in": "body", - "childParamsGroups": [ - { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] - }, - { - "type": "object", - "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", - "properties": { - "status": { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `enabled` or `disabled`.", - "childParamsGroups": [] - } - }, - "name": "secret_scanning_push_protection", - "in": "body", - "childParamsGroups": [ - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" - } - ] - } - ] + "type": "string", + "name": "status", + "description": "

    Can be enabled or disabled.

    " } ] }, { - "parentName": "advanced_security", - "parentType": "object", - "id": "advanced_security-object", - "params": [ + "type": "object", + "name": "secret_scanning", + "description": "

    Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    Can be enabled or disabled.

    ", "name": "status", - "in": "body" + "description": "

    Can be enabled or disabled.

    " } ] }, { - "parentName": "secret_scanning", - "parentType": "object", - "id": "secret_scanning-object", - "params": [ + "type": "object", + "name": "secret_scanning_push_protection", + "description": "

    Use the status property to enable or disable secret scanning push protection for this repository. For more information, see \"Protecting pushes with secret scanning.\"

    ", + "childParamsGroups": [ { "type": "string", - "description": "

    Can be enabled or disabled.

    ", "name": "status", - "in": "body" - } - ] - }, - { - "parentName": "secret_scanning_push_protection", - "parentType": "object", - "id": "secret_scanning_push_protection-object", - "params": [ - { - "type": "string", - "description": "

    Can be enabled or disabled.

    ", - "name": "status", - "in": "body" + "description": "

    Can be enabled or disabled.

    " } ] } @@ -360479,168 +361530,141 @@ }, { "type": "boolean", - "description": "

    Either true to enable issues for this repository or false to disable them.

    ", - "default": true, "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Either true to enable issues for this repository or false to disable them.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", - "default": true, "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", - "default": true, "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Either true to enable the wiki for this repository or false to disable it.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    ", - "default": false, "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Either true to make this repo available as a template repository or false to prevent it.

    " }, { "type": "string", - "description": "

    Updates the default branch for this repository.

    ", "name": "default_branch", "in": "body", - "isRequired": false + "description": "

    Updates the default branch for this repository.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", - "default": true, "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", - "default": true, "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", - "default": true, "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

    ", + "default": true }, { "type": "boolean", - "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    ", - "default": false, "name": "allow_auto_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow auto-merge on pull requests, or false to disallow auto-merge.

    " }, { "type": "boolean", - "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    ", - "default": false, "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

    " }, { "type": "boolean", - "description": "

    Either true to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.

    ", - "default": false, "name": "allow_update_branch", "in": "body", - "isRequired": false + "description": "

    Either true to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.

    " }, { "type": "boolean", - "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    ", - "default": false, "name": "use_squash_pr_title_as_default", "in": "body", - "isRequired": false + "description": "

    Either true to allow squash-merge commits to use pull request title, or false to use commit message.

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    true to archive this repository. Note: You cannot unarchive repositories through the API.

    ", - "default": false, "name": "archived", "in": "body", - "isRequired": false + "description": "

    true to archive this repository. Note: You cannot unarchive repositories through the API.

    " }, { "type": "boolean", - "description": "

    Either true to allow private forks, or false to prevent private forks.

    ", - "default": false, "name": "allow_forking", "in": "body", - "isRequired": false + "description": "

    Either true to allow private forks, or false to prevent private forks.

    " }, { "type": "boolean", - "description": "

    Either true to require contributors to sign off on web-based commits, or false to not require contributors to sign off on web-based commits.

    ", - "default": false, "name": "web_commit_signoff_required", "in": "body", - "isRequired": false + "description": "

    Either true to require contributors to sign off on web-based commits, or false to not require contributors to sign off on web-based commits.

    " } ], "enabledForGitHubApps": true, @@ -366946,21 +367970,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    A custom webhook event name. Must be 100 characters or fewer.

    ", - "minLength": 1, - "maxLength": 100, "name": "event_type", "in": "body", + "description": "

    A custom webhook event name. Must be 100 characters or fewer.

    ", "isRequired": true }, { "type": "object", - "description": "

    JSON payload with extra information about the webhook event that your action or workflow may use.

    ", - "additionalProperties": true, - "maxProperties": 10, "name": "client_payload", "in": "body", - "isRequired": false + "description": "

    JSON payload with extra information about the webhook event that your action or workflow may use.

    " } ], "enabledForGitHubApps": true, @@ -367637,9 +368656,9 @@ "bodyParameters": [ { "type": "array of strings", - "description": "

    An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

    ", "name": "names", "in": "body", + "description": "

    An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

    ", "isRequired": true } ], @@ -367742,17 +368761,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The username or organization name the repository will be transferred to.

    ", "name": "new_owner", "in": "body", + "description": "

    The username or organization name the repository will be transferred to.

    ", "isRequired": true }, { "type": "array of integers", - "description": "

    ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

    ", "name": "team_ids", "in": "body", - "isRequired": false + "description": "

    ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

    " } ], "enabledForGitHubApps": true, @@ -370175,40 +371193,34 @@ "bodyParameters": [ { "type": "string", - "description": "

    The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

    ", "name": "owner", "in": "body", - "isRequired": false + "description": "

    The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

    " }, { "type": "string", - "description": "

    The name of the new repository.

    ", "name": "name", "in": "body", + "description": "

    The name of the new repository.

    ", "isRequired": true }, { "type": "string", - "description": "

    A short description of the new repository.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the new repository.

    " }, { "type": "boolean", - "description": "

    Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.

    ", - "default": false, "name": "include_all_branches", "in": "body", - "isRequired": false + "description": "

    Set to true to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: false.

    " }, { "type": "boolean", - "description": "

    Either true to create a new private repository or false to create a new public one.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Either true to create a new private repository or false to create a new public one.

    " } ], "enabledForGitHubApps": false, @@ -373418,227 +374430,162 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The name of the repository.

    ", "type": "string", - "examples": [ - "Team Environment" - ], "name": "name", "in": "body", + "description": "

    The name of the repository.

    ", "isRequired": true }, { - "description": "

    A short description of the repository.

    ", "type": "string", "name": "description", "in": "body", - "isRequired": false + "description": "

    A short description of the repository.

    " }, { - "description": "

    A URL with more information about the repository.

    ", "type": "string", "name": "homepage", "in": "body", - "isRequired": false + "description": "

    A URL with more information about the repository.

    " }, { - "description": "

    Whether the repository is private.

    ", - "default": false, "type": "boolean", "name": "private", "in": "body", - "isRequired": false + "description": "

    Whether the repository is private.

    " }, { - "description": "

    Whether issues are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_issues", "in": "body", - "isRequired": false + "description": "

    Whether issues are enabled.

    ", + "default": true }, { - "description": "

    Whether projects are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_projects", "in": "body", - "isRequired": false + "description": "

    Whether projects are enabled.

    ", + "default": true }, { - "description": "

    Whether the wiki is enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_wiki", "in": "body", - "isRequired": false + "description": "

    Whether the wiki is enabled.

    ", + "default": true }, { - "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    ", "type": "integer", "name": "team_id", "in": "body", - "isRequired": false + "description": "

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

    " }, { - "description": "

    Whether the repository is initialized with a minimal README.

    ", - "default": false, "type": "boolean", "name": "auto_init", "in": "body", - "isRequired": false + "description": "

    Whether the repository is initialized with a minimal README.

    " }, { - "description": "

    The desired language or platform to apply to the .gitignore.

    ", "type": "string", - "examples": [ - "Haskell" - ], "name": "gitignore_template", "in": "body", - "isRequired": false + "description": "

    The desired language or platform to apply to the .gitignore.

    " }, { - "description": "

    The license keyword of the open source license for this repository.

    ", "type": "string", - "examples": [ - "mit" - ], "name": "license_template", "in": "body", - "isRequired": false + "description": "

    The license keyword of the open source license for this repository.

    " }, { - "description": "

    Whether to allow squash merges for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_squash_merge", "in": "body", - "isRequired": false + "description": "

    Whether to allow squash merges for pull requests.

    ", + "default": true }, { - "description": "

    Whether to allow merge commits for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_merge_commit", "in": "body", - "isRequired": false + "description": "

    Whether to allow merge commits for pull requests.

    ", + "default": true }, { - "description": "

    Whether to allow rebase merges for pull requests.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "allow_rebase_merge", "in": "body", - "isRequired": false + "description": "

    Whether to allow rebase merges for pull requests.

    ", + "default": true }, { - "description": "

    Whether to allow Auto-merge to be used on pull requests.

    ", - "default": false, "type": "boolean", - "examples": [ - false - ], "name": "allow_auto_merge", "in": "body", - "isRequired": false + "description": "

    Whether to allow Auto-merge to be used on pull requests.

    " }, { - "description": "

    Whether to delete head branches when pull requests are merged

    ", - "default": false, "type": "boolean", - "examples": [ - false - ], "name": "delete_branch_on_merge", "in": "body", - "isRequired": false + "description": "

    Whether to delete head branches when pull requests are merged

    " }, { "type": "string", + "name": "squash_merge_commit_title", + "in": "body", + "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" - ], - "description": "

    The default value for a squash merge commit title:

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
      • \n
    ", - "name": "squash_merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "squash_merge_commit_message", + "in": "body", + "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "COMMIT_MESSAGES", "BLANK" - ], - "description": "

    The default value for a squash merge commit message:

    \n
      \n
    • PR_BODY - default to the pull request's body.
      • \n
    • COMMIT_MESSAGES - default to the branch's commit messages.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "squash_merge_commit_message", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_title", + "in": "body", + "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", "enum": [ "PR_TITLE", "MERGE_MESSAGE" - ], - "description": "

    The default value for a merge commit title.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
      • \n
    ", - "name": "merge_commit_title", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "merge_commit_message", + "in": "body", + "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", "enum": [ "PR_BODY", "PR_TITLE", "BLANK" - ], - "description": "

    The default value for a merge commit message.

    \n
      \n
    • PR_TITLE - default to the pull request's title.
      • \n
    • PR_BODY - default to the pull request's body.
      • \n
    • BLANK - default to a blank commit message.
      • \n
    ", - "name": "merge_commit_message", - "in": "body", - "isRequired": false + ] }, { - "description": "

    Whether downloads are enabled.

    ", - "default": true, "type": "boolean", - "examples": [ - true - ], "name": "has_downloads", "in": "body", - "isRequired": false + "description": "

    Whether downloads are enabled.

    ", + "default": true }, { - "description": "

    Whether this repository acts as a template that can be used to generate new repositories.

    ", - "default": false, "type": "boolean", - "examples": [ - true - ], "name": "is_template", "in": "body", - "isRequired": false + "description": "

    Whether this repository acts as a template that can be used to generate new repositories.

    " } ], "enabledForGitHubApps": false, @@ -377678,16 +378625,16 @@ "bodyParameters": [ { "type": "string", - "description": "

    The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.

    ", "name": "key_prefix", "in": "body", + "description": "

    The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.

    ", "isRequired": true }, { "type": "string", - "description": "

    The URL must contain <num> for the reference number.

    ", "name": "url_template", "in": "body", + "description": "

    The URL must contain <num> for the reference number.

    ", "isRequired": true } ], @@ -379756,7 +380703,7 @@ } ], "previews": [], - "descriptionHTML": "

    Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

    \n

    Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

    \n

    Note:

    \n
      \n
    • To get a repository's contents recursively, you can recursively get the tree.
      • \n
    • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
      • \n
    • This API supports files up to 1 megabyte in size.
      • \n
    \n

    If the content is a directory

    \n

    The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

    \n

    If the content is a symlink

    \n

    If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

    \n

    If the content is a submodule

    \n

    The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

    \n

    If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

    ", + "descriptionHTML": "

    Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

    \n

    Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

    \n

    Notes:

    \n
      \n
    • To get a repository's contents recursively, you can recursively get the tree.
      • \n
    • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
      • \n
    • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
      • \n
    • This API supports files up to 1 megabyte in size.
      • \n
    \n

    If the content is a directory

    \n

    The response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

    \n

    If the content is a symlink

    \n

    If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

    \n

    If the content is a submodule

    \n

    The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

    \n

    If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

    ", "statusCodes": [ { "httpStatusCode": "200", @@ -379816,185 +380763,77 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message.

    ", "name": "message", "in": "body", + "description": "

    The commit message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The new file content, using Base64 encoding.

    ", "name": "content", "in": "body", + "description": "

    The new file content, using Base64 encoding.

    ", "isRequired": true }, { "type": "string", - "description": "

    Required if you are updating a file. The blob SHA of the file being replaced.

    ", "name": "sha", "in": "body", - "isRequired": false + "description": "

    Required if you are updating a file. The blob SHA of the file being replaced.

    " }, { "type": "string", - "description": "

    The branch name. Default: the repository’s default branch (usually master)

    ", "name": "branch", "in": "body", - "isRequired": false + "description": "

    The branch name. Default: the repository’s default branch (usually master)

    " }, { "type": "object", - "description": "

    The person that committed the file. Default: the authenticated user.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "examples": [ - "\"2013-01-05T13:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "committer", "in": "body", - "isRequired": false, + "description": "

    The person that committed the file. Default: the authenticated user.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "examples": [ - "\"2013-01-05T13:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "" } ] }, { "type": "object", - "description": "

    The author of the file. Default: The committer or the authenticated user if you omit committer.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "isRequired": true, - "childParamsGroups": [] - }, - "date": { - "type": "string", - "examples": [ - "\"2013-01-15T17:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "name", - "email" - ], "name": "author", "in": "body", - "isRequired": false, + "description": "

    The author of the file. Default: The committer or the authenticated user if you omit committer.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", - "name": "name", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", - "name": "email", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "examples": [ - "\"2013-01-15T17:13:22+05:00\"" - ], - "name": "date", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author or committer of the commit. You'll receive a 422 status code if name is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author or committer of the commit. You'll receive a 422 status code if email is omitted.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "date", + "description": "" } ] } @@ -380542,118 +381381,57 @@ "bodyParameters": [ { "type": "string", - "description": "

    The commit message.

    ", "name": "message", "in": "body", + "description": "

    The commit message.

    ", "isRequired": true }, { "type": "string", - "description": "

    The blob SHA of the file being replaced.

    ", "name": "sha", "in": "body", + "description": "

    The blob SHA of the file being replaced.

    ", "isRequired": true }, { "type": "string", - "description": "

    The branch name. Default: the repository’s default branch (usually master)

    ", "name": "branch", "in": "body", - "isRequired": false + "description": "

    The branch name. Default: the repository’s default branch (usually master)

    " }, { "type": "object", - "description": "

    object containing information about the committer.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - } - }, "name": "committer", "in": "body", - "isRequired": false, + "description": "

    object containing information about the committer.

    ", "childParamsGroups": [ { - "parentName": "committer", - "parentType": "object", - "id": "committer-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " } ] }, { "type": "object", - "description": "

    object containing information about the author.

    ", - "properties": { - "name": { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the author (or committer) of the commit", - "childParamsGroups": [] - }, - "email": { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body", - "rawType": "string", - "rawDescription": "The email of the author (or committer) of the commit", - "childParamsGroups": [] - } - }, "name": "author", "in": "body", - "isRequired": false, + "description": "

    object containing information about the author.

    ", "childParamsGroups": [ { - "parentName": "author", - "parentType": "object", - "id": "author-object", - "params": [ - { - "type": "string", - "description": "

    The name of the author (or committer) of the commit

    ", - "name": "name", - "in": "body" - }, - { - "type": "string", - "description": "

    The email of the author (or committer) of the commit

    ", - "name": "email", - "in": "body" - } - ] + "type": "string", + "name": "name", + "description": "

    The name of the author (or committer) of the commit

    " + }, + { + "type": "string", + "name": "email", + "description": "

    The email of the author (or committer) of the commit

    " } ] } @@ -383824,10 +384602,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    Optional parameter to specify the organization name if forking into an organization.

    ", "name": "organization", "in": "body", - "isRequired": false + "description": "

    Optional parameter to specify the organization name if forking into an organization.

    " } ], "enabledForGitHubApps": true, @@ -395177,7 +395954,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] }, @@ -400698,18 +401476,20 @@ ], "bodyParameters": [ { - "description": "

    Sets the state of the secret scanning alert. Can be either open or resolved. You must provide resolution when you set the state to resolved.

    ", "type": "string", + "name": "state", + "in": "body", + "description": "

    Sets the state of the secret scanning alert. Can be either open or resolved. You must provide resolution when you set the state to resolved.

    ", + "isRequired": true, "enum": [ "open", "resolved" - ], - "name": "state", - "in": "body", - "isRequired": true + ] }, { "type": "string or null", + "name": "resolution", + "in": "body", "description": "

    Required when the state is resolved. The reason for resolving the alert.

    ", "enum": [ null, @@ -400717,10 +401497,7 @@ "wont_fix", "revoked", "used_in_tests" - ], - "name": "resolution", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -401358,61 +402135,55 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", + "description": "

    The name of the team.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "array of strings", - "description": "

    List GitHub IDs for organization members who will become team maintainers.

    ", "name": "maintainers", "in": "body", - "isRequired": false + "description": "

    List GitHub IDs for organization members who will become team maintainers.

    " }, { "type": "array of strings", - "description": "

    The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

    ", "name": "repo_names", "in": "body", - "isRequired": false + "description": "

    The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nDefault: secret
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.
    \nDefault for child team: closed

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " } ], "enabledForGitHubApps": true, @@ -401709,8 +402480,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -402441,8 +403212,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -402883,48 +403654,43 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    The name of the team.

    " }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push", "admin" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer or null", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " } ], "enabledForGitHubApps": true, @@ -403221,8 +403987,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -404454,15 +405220,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"

    ", "enum": [ "read", "write", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -409531,11 +410296,10 @@ "bodyParameters": [ { "type": "string", - "description": "

    The permission to grant the team on this repository. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", - "default": "push", "name": "permission", "in": "body", - "isRequired": false + "description": "

    The permission to grant the team on this repository. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", + "default": "push" } ], "enabledForGitHubApps": true, @@ -410257,8 +411021,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -410690,48 +411454,44 @@ "bodyParameters": [ { "type": "string", - "description": "

    The name of the team.

    ", "name": "name", "in": "body", + "description": "

    The name of the team.

    ", "isRequired": true }, { "type": "string", - "description": "

    The description of the team.

    ", "name": "description", "in": "body", - "isRequired": false + "description": "

    The description of the team.

    " }, { "type": "string", + "name": "privacy", + "in": "body", "description": "

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
    \nFor a non-nested team:
    \n* secret - only visible to organization owners and members of this team.
    \n* closed - visible to all members of this organization.
    \nFor a parent or child team:
    \n* closed - visible to all members of this organization.

    ", "enum": [ "secret", "closed" - ], - "name": "privacy", - "in": "body", - "isRequired": false + ] }, { "type": "string", + "name": "permission", + "in": "body", "description": "

    Deprecated. The permission that new repositories will be added to the team with when none is specified.

    ", "enum": [ "pull", "push", "admin" ], - "default": "pull", - "name": "permission", - "in": "body", - "isRequired": false + "default": "pull" }, { "type": "integer or null", - "description": "

    The ID of a team to set as the parent team.

    ", "name": "parent_team_id", "in": "body", - "isRequired": false + "description": "

    The ID of a team to set as the parent team.

    " } ], "enabledForGitHubApps": true, @@ -411027,8 +411787,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -411716,8 +412476,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -412938,15 +413698,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"

    ", "enum": [ "read", "write", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -417992,15 +418751,14 @@ "bodyParameters": [ { "type": "string", + "name": "permission", + "in": "body", "description": "

    The permission to grant the team on this repository. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    ", "enum": [ "pull", "push", "admin" - ], - "name": "permission", - "in": "body", - "isRequired": false + ] } ], "enabledForGitHubApps": true, @@ -418728,8 +419486,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -419652,9 +420410,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -420531,9 +421289,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -421485,9 +422243,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -422344,9 +423102,9 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion comment's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion comment's body text.

    ", "isRequired": true } ], @@ -423342,25 +424100,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", + "description": "

    The discussion post's title.

    ", "isRequired": true }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion post's body text.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    " } ], "enabledForGitHubApps": true, @@ -424305,17 +425061,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The discussion post's title.

    " }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The discussion post's body text.

    " } ], "enabledForGitHubApps": true, @@ -425324,25 +426078,23 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", + "description": "

    The discussion post's title.

    ", "isRequired": true }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", + "description": "

    The discussion post's body text.

    ", "isRequired": true }, { "type": "boolean", - "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    ", - "default": false, "name": "private", "in": "body", - "isRequired": false + "description": "

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

    " } ], "enabledForGitHubApps": true, @@ -426267,17 +427019,15 @@ "bodyParameters": [ { "type": "string", - "description": "

    The discussion post's title.

    ", "name": "title", "in": "body", - "isRequired": false + "description": "

    The discussion post's title.

    " }, { "type": "string", - "description": "

    The discussion post's body text.

    ", "name": "body", "in": "body", - "isRequired": false + "description": "

    The discussion post's body text.

    " } ], "enabledForGitHubApps": true, @@ -427153,12 +427903,9 @@ "bodyParameters": [ { "type": "integer", - "description": "

    External Group Id

    ", - "examples": [ - 1 - ], "name": "group_id", "in": "body", + "description": "

    External Group Id

    ", "isRequired": true } ], @@ -427833,15 +428580,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role that this user should have in the team.

    ", "enum": [ "member", "maintainer" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -428580,15 +429326,14 @@ "bodyParameters": [ { "type": "string", + "name": "role", + "in": "body", "description": "

    The role that this user should have in the team.

    ", "enum": [ "member", "maintainer" ], - "default": "member", - "name": "role", - "in": "body", - "isRequired": false + "default": "member" } ], "enabledForGitHubApps": true, @@ -430047,78 +430792,52 @@ "parameters": [], "bodyParameters": [ { - "description": "

    The new name of the user.

    ", "type": "string", - "examples": [ - "Omar Jahandar" - ], "name": "name", "in": "body", - "isRequired": false + "description": "

    The new name of the user.

    " }, { - "description": "

    The publicly visible email address of the user.

    ", "type": "string", - "examples": [ - "omar@example.com" - ], "name": "email", "in": "body", - "isRequired": false + "description": "

    The publicly visible email address of the user.

    " }, { - "description": "

    The new blog URL of the user.

    ", "type": "string", - "examples": [ - "blog.example.com" - ], "name": "blog", "in": "body", - "isRequired": false + "description": "

    The new blog URL of the user.

    " }, { - "description": "

    The new Twitter username of the user.

    ", "type": "string or null", - "examples": [ - "therealomarj" - ], "name": "twitter_username", "in": "body", - "isRequired": false + "description": "

    The new Twitter username of the user.

    " }, { - "description": "

    The new company of the user.

    ", "type": "string", - "examples": [ - "Acme corporation" - ], "name": "company", "in": "body", - "isRequired": false + "description": "

    The new company of the user.

    " }, { - "description": "

    The new location of the user.

    ", "type": "string", - "examples": [ - "Berlin, Germany" - ], "name": "location", "in": "body", - "isRequired": false + "description": "

    The new location of the user.

    " }, { - "description": "

    The new hiring availability of the user.

    ", "type": "boolean", "name": "hireable", "in": "body", - "isRequired": false + "description": "

    The new hiring availability of the user.

    " }, { - "description": "

    The new short biography of the user.

    ", "type": "string", "name": "bio", "in": "body", - "isRequired": false + "description": "

    The new short biography of the user.

    " } ], "enabledForGitHubApps": false, @@ -433751,10 +434470,10 @@ "parameters": [], "bodyParameters": [ { - "description": "

    A GPG key in ASCII-armored format.

    ", "type": "string", "name": "armored_public_key", "in": "body", + "description": "

    A GPG key in ASCII-armored format.

    ", "isRequired": true } ], @@ -434770,21 +435489,16 @@ "parameters": [], "bodyParameters": [ { - "description": "

    A descriptive name for the new key.

    ", "type": "string", - "examples": [ - "Personal MacBook Air" - ], "name": "title", "in": "body", - "isRequired": false + "description": "

    A descriptive name for the new key.

    " }, { - "description": "

    The public SSH key to add to your GitHub account.

    ", "type": "string", - "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ", "name": "key", "in": "body", + "description": "

    The public SSH key to add to your GitHub account.

    ", "isRequired": true } ], @@ -435298,53 +436012,27 @@ "bodyParameters": [ { "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], "name": "url", "in": "body", - "isRequired": false + "description": "

    The URL to which the payloads will be delivered.

    " }, { "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], "name": "content_type", "in": "body", - "isRequired": false + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " }, { "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], "name": "secret", "in": "body", - "isRequired": false + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " }, { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], + "type": "string or number", "name": "insecure_ssl", "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " } ], "enabledForGitHubApps": true, @@ -436378,188 +437066,63 @@ "bodyParameters": [ { "type": "string", - "description": "

    Use web to create a webhook. Default: web. This parameter only accepts the value web.

    ", "name": "name", "in": "body", - "isRequired": false + "description": "

    Use web to create a webhook. Default: web. This parameter only accepts the value web.

    " }, { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "childParamsGroups": [] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ], - "name": "token", - "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ], - "name": "digest", - "in": "body", - "rawType": "string", - "description": "", - "childParamsGroups": [] - } - }, "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body" - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body" - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body" - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " - }, - { - "type": "string", - "examples": [ - "\"abc\"" - ], - "name": "token", - "in": "body", - "description": "" - }, - { - "type": "string", - "examples": [ - "\"sha256\"" - ], - "name": "digest", - "in": "body", - "description": "" - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    " + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "token", + "description": "" + }, + { + "type": "string", + "name": "digest", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, @@ -437185,210 +437748,70 @@ "bodyParameters": [ { "type": "object", - "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", - "properties": { - "url": { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "isRequired": true, - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "isRequired": false, - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "isRequired": false, - "childParamsGroups": [] - }, - "insecure_ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false, - "childParamsGroups": [] - }, - "address": { - "type": "string", - "examples": [ - "\"bar@example.com\"" - ], - "name": "address", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - }, - "room": { - "type": "string", - "examples": [ - "\"The Serious Room\"" - ], - "name": "room", - "in": "body", - "rawType": "string", - "description": "", - "isRequired": false, - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], "name": "config", "in": "body", - "isRequired": false, + "description": "

    Key/value pairs to provide settings for this webhook. These are defined below.

    ", "childParamsGroups": [ { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

    The URL to which the payloads will be delivered.

    ", - "format": "uri", - "examples": [ - "https://example.com/webhook" - ], - "name": "url", - "in": "body", - "isRequired": true - }, - { - "type": "string", - "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    ", - "examples": [ - "\"json\"" - ], - "name": "content_type", - "in": "body", - "isRequired": false - }, - { - "type": "string", - "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    ", - "examples": [ - "\"********\"" - ], - "name": "secret", - "in": "body", - "isRequired": false - }, - { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "examples": [ - "\"0\"" - ] - }, - { - "type": "number" - } - ], - "name": "insecure_ssl", - "in": "body", - "type": "string or number", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"bar@example.com\"" - ], - "name": "address", - "in": "body", - "description": "", - "isRequired": false - }, - { - "type": "string", - "examples": [ - "\"The Serious Room\"" - ], - "name": "room", - "in": "body", - "description": "", - "isRequired": false - } - ] + "type": "string", + "name": "url", + "description": "

    The URL to which the payloads will be delivered.

    ", + "isRequired": true + }, + { + "type": "string", + "name": "content_type", + "description": "

    The media type used to serialize the payloads. Supported values include json and form. The default is form.

    " + }, + { + "type": "string", + "name": "secret", + "description": "

    If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

    " + }, + { + "type": "string or number", + "name": "insecure_ssl", + "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    " + }, + { + "type": "string", + "name": "address", + "description": "" + }, + { + "type": "string", + "name": "room", + "description": "" } ] }, { "type": "array of strings", + "name": "events", + "in": "body", "description": "

    Determines what events the hook is triggered for. This replaces the entire array of events.

    ", "default": [ "push" - ], - "name": "events", - "in": "body", - "isRequired": false + ] }, { "type": "array of strings", - "description": "

    Determines a list of events to be added to the list of events that the Hook triggers for.

    ", "name": "add_events", "in": "body", - "isRequired": false + "description": "

    Determines a list of events to be added to the list of events that the Hook triggers for.

    " }, { "type": "array of strings", - "description": "

    Determines a list of events to be removed from the list of events that the Hook triggers for.

    ", "name": "remove_events", "in": "body", - "isRequired": false + "description": "

    Determines a list of events to be removed from the list of events that the Hook triggers for.

    " }, { "type": "boolean", - "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", - "default": true, "name": "active", "in": "body", - "isRequired": false + "description": "

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    ", + "default": true } ], "enabledForGitHubApps": true, diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index e5836d6b92..2885224575 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -2854,14 +2854,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -3006,6 +2998,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -3791,14 +3791,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -3943,6 +3935,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -4514,14 +4514,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -4666,6 +4658,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -4807,14 +4807,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -4959,6 +4951,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -7458,14 +7458,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -7610,6 +7602,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -8432,14 +8432,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -8584,6 +8576,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -9278,14 +9278,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -9430,6 +9422,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -9826,14 +9826,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -9978,6 +9970,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -59363,7 +59363,7 @@ "/organizations/{organization_id}/custom_roles": { "get": { "summary": "List custom repository roles in an organization", - "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".", + "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".", "tags": [ "orgs" ], @@ -79970,6 +79970,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -91569,14 +91579,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -91721,6 +91723,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -92520,14 +92530,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -92672,6 +92674,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -101789,6 +101799,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -127359,8 +127379,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -128181,8 +128201,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -128980,8 +129000,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -202802,6 +202822,115 @@ "protected", "protection_url" ] + }, + "examples": { + "default": { + "value": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [ + + ], + "checks": [ + + ] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + } + } } } } @@ -207309,6 +207438,85 @@ "required": [ "url" ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + } + } } } } @@ -212195,7 +212403,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -212212,12 +212420,23 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding status checks to a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + } + } } } } @@ -212432,7 +212651,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -212449,12 +212668,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example updating status checks for a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -212641,7 +212870,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -212658,12 +212887,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing status checks from a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -215785,7 +216024,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -215802,12 +216041,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -216179,7 +216428,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -216190,18 +216439,28 @@ ], "example": { "teams": [ - "my-team" + "justice-league" ] } }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -216572,7 +216831,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -216589,12 +216848,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -217241,7 +217510,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -217263,6 +217532,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example adding a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -217601,7 +217880,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -217623,6 +217902,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -217960,7 +218249,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -217982,6 +218271,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example removing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -241659,6 +241958,7 @@ "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "state": "open", "fixed_at": null, "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", @@ -241880,6 +242180,33 @@ "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53" ] } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created" + ], + "default": "created" + } } ], "responses": { @@ -242466,7 +242793,7 @@ }, "delete": { "summary": "Delete a code scanning analysis from a repository", - "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `analysis_key`\n* `environment`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", + "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `category`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", "operationId": "code-scanning/delete-analysis", "tags": [ "code-scanning" @@ -246173,6 +246500,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -249582,6 +249919,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -252634,6 +252981,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -279775,7 +280132,7 @@ "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", - "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Note**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/rest/reference/git#get-a-tree).\n\n#### Size limits\nIf the requested file's size is:\n* 1 MB or smaller: All features of this endpoint are supported.\n* Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n * Greater than 100 MB: This endpoint is not supported.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", + "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Notes**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/rest/reference/git#get-a-tree).\n * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n#### Size limits\nIf the requested file's size is:\n* 1 MB or smaller: All features of this endpoint are supported.\n* Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n * Greater than 100 MB: This endpoint is not supported.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", "tags": [ "repos" ], @@ -297805,6 +298162,10 @@ "name": { "type": "string", "description": "When forking from an existing repository, a new name for the fork." + }, + "default_branch_only": { + "type": "boolean", + "description": "When forking from an existing repository, fork with only the default branch." } } } @@ -312912,14 +313273,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -313064,6 +313417,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -313678,6 +314039,15 @@ "required": [ "limit" ] + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "limit": "collaborators_only", + "expiry": "one_day" + } + } } } } @@ -316661,6 +317031,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "permissions": "write" + } + } } } } @@ -322855,7 +323233,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -326386,7 +326765,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -335118,7 +335498,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ] @@ -340133,7 +340514,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -343509,7 +343891,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -343690,6 +344073,16 @@ "closed" ] }, + "state_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason for the current state", + "examples": [ + "not_planned" + ] + }, "milestone": { "oneOf": [ { @@ -347008,7 +347401,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -350534,7 +350928,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -353857,7 +354252,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -419661,6 +420057,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -422713,6 +423119,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -479143,7 +479559,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -481678,8 +482095,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -482474,8 +482891,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -483153,8 +483570,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -502567,6 +502984,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -506159,6 +506586,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -509211,6 +509648,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -515978,6 +516425,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -519202,6 +519659,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -523228,6 +523695,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -526540,6 +527017,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -530621,14 +531108,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -530773,6 +531252,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -569691,8 +570178,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -585360,14 +585847,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -585512,6 +585991,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index aef31684f7..1c4a1cfacb 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -4438,14 +4438,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -5691,14 +5683,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -6489,14 +6473,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -9493,14 +9469,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -10438,14 +10406,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -11169,14 +11129,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -11470,14 +11422,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -14948,14 +14892,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -15930,14 +15866,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -16784,14 +16712,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -17340,14 +17260,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -18396,14 +18308,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -19290,14 +19194,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -20676,14 +20572,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -21668,14 +21556,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -22733,14 +22613,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -23539,14 +23411,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -24582,14 +24446,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -25388,14 +25244,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -26305,14 +26153,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -27247,14 +27087,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -88566,14 +88398,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -89525,14 +89349,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -102181,8 +101997,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -102987,8 +102803,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -103770,8 +103586,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -163212,6 +163028,115 @@ "protected", "protection_url" ] + }, + "examples": { + "default": { + "value": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [ + + ], + "checks": [ + + ] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + } + } } } } @@ -166250,6 +166175,85 @@ "required": [ "url" ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + } + } } } } @@ -169667,7 +169671,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -169684,12 +169688,23 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding status checks to a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + } + } } } } @@ -169904,7 +169919,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -169921,12 +169936,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example updating status checks for a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -170113,7 +170138,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -170130,12 +170155,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing status checks from a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -173257,7 +173292,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -173274,12 +173309,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -173651,7 +173696,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -173662,18 +173707,28 @@ ], "example": { "teams": [ - "my-team" + "justice-league" ] } }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -174044,7 +174099,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -174061,12 +174116,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -174713,7 +174778,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -174735,6 +174800,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example adding a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -175073,7 +175148,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -175095,6 +175170,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -175432,7 +175517,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -175454,6 +175539,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example removing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -223980,7 +224075,7 @@ "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", - "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Note**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.2/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/enterprise-server@3.2/rest/reference/git#get-a-tree).\n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", + "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Notes**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.2/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/enterprise-server@3.2/rest/reference/git#get-a-tree).\n * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. \n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", "tags": [ "repos" ], @@ -253675,14 +253770,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -257038,6 +257125,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "permissions": "write" + } + } } } } @@ -263036,7 +263131,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -266484,7 +266580,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -275155,7 +275252,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ] @@ -280084,7 +280182,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -283374,7 +283473,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -283560,6 +283660,16 @@ "closed" ] }, + "state_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason for the current state", + "examples": [ + "not_planned" + ] + }, "milestone": { "oneOf": [ { @@ -286786,7 +286896,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -290220,7 +290331,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -293451,7 +293563,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -402325,7 +402438,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -406390,8 +406504,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -407170,8 +407284,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -407833,8 +407947,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -426063,14 +426177,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -448151,8 +448257,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -463505,14 +463611,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index 737547e51b..b5c9714ad4 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -4292,14 +4292,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -5545,14 +5537,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -6343,14 +6327,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -9347,14 +9323,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -10292,14 +10260,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -11023,14 +10983,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -11324,14 +11276,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -14813,14 +14757,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -15795,14 +15731,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -16649,14 +16577,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -17205,14 +17125,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -18261,14 +18173,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -19155,14 +19059,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -20541,14 +20437,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -21533,14 +21421,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -22598,14 +22478,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -23404,14 +23276,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -24447,14 +24311,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -25253,14 +25109,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -26170,14 +26018,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -27112,14 +26952,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -89352,14 +89184,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -90311,14 +90135,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -104077,8 +103893,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -104883,8 +104699,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -105666,8 +105482,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -165228,6 +165044,115 @@ "protected", "protection_url" ] + }, + "examples": { + "default": { + "value": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [ + + ], + "checks": [ + + ] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + } + } } } } @@ -168260,6 +168185,85 @@ "required": [ "url" ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + } + } } } } @@ -171641,7 +171645,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -171658,12 +171662,23 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding status checks to a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + } + } } } } @@ -171878,7 +171893,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -171895,12 +171910,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example updating status checks for a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -172087,7 +172112,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -172104,12 +172129,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing status checks from a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -175231,7 +175266,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -175248,12 +175283,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -175625,7 +175670,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -175636,18 +175681,28 @@ ], "example": { "teams": [ - "my-team" + "justice-league" ] } }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -176018,7 +176073,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -176035,12 +176090,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -176687,7 +176752,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -176709,6 +176774,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example adding a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -177047,7 +177122,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -177069,6 +177144,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -177406,7 +177491,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -177428,6 +177513,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example removing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -226124,7 +226219,7 @@ "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", - "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Note**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.3/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/enterprise-server@3.3/rest/reference/git#get-a-tree).\n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", + "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Notes**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.3/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/enterprise-server@3.3/rest/reference/git#get-a-tree).\n * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. \n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", "tags": [ "repos" ], @@ -255835,14 +255930,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -259209,6 +259296,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "permissions": "write" + } + } } } } @@ -265229,7 +265324,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -268679,7 +268775,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -277330,7 +277427,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ] @@ -282264,7 +282362,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -285559,7 +285658,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -285740,6 +285840,16 @@ "closed" ] }, + "state_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason for the current state", + "examples": [ + "not_planned" + ] + }, "milestone": { "oneOf": [ { @@ -288977,7 +289087,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -292422,7 +292533,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -295664,7 +295776,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -405062,7 +405175,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -409095,8 +409209,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -409875,8 +409989,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -410538,8 +410652,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -428707,14 +428821,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -450855,8 +450961,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -466242,14 +466348,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json index 13c3fdc384..d729e6eeb6 100644 --- a/lib/rest/static/dereferenced/ghes-3.4.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.4.deref.json @@ -4292,14 +4292,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -5537,14 +5529,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -6327,14 +6311,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -9323,14 +9299,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -10260,14 +10228,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -10983,14 +10943,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -11276,14 +11228,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -14705,14 +14649,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -15679,14 +15615,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -16525,14 +16453,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -17073,14 +16993,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -18584,14 +18496,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -19568,14 +19472,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -20625,14 +20521,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -21423,14 +21311,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -22458,14 +22338,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -23256,14 +23128,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -24165,14 +24029,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -25099,14 +24955,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -68989,7 +68837,7 @@ "/organizations/{organization_id}/custom_roles": { "get": { "summary": "List custom repository roles in an organization", - "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.4/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".", + "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.4/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".", "tags": [ "orgs" ], @@ -93533,14 +93381,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -94484,14 +94324,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -114260,8 +114092,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -115075,8 +114907,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -115867,8 +115699,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -177816,6 +177648,115 @@ "protected", "protection_url" ] + }, + "examples": { + "default": { + "value": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [ + + ], + "checks": [ + + ] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + } + } } } } @@ -182323,6 +182264,85 @@ "required": [ "url" ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + } + } } } } @@ -187209,7 +187229,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -187226,12 +187246,23 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding status checks to a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + } + } } } } @@ -187446,7 +187477,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -187463,12 +187494,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example updating status checks for a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -187655,7 +187696,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -187672,12 +187713,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing status checks from a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -190799,7 +190850,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -190816,12 +190867,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -191193,7 +191254,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -191204,18 +191265,28 @@ ], "example": { "teams": [ - "my-team" + "justice-league" ] } }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -191586,7 +191657,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -191603,12 +191674,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -192255,7 +192336,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -192277,6 +192358,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example adding a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -192615,7 +192706,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -192637,6 +192728,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -192974,7 +193075,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -192996,6 +193097,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example removing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -216263,6 +216374,7 @@ "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "state": "open", "fixed_at": null, "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", @@ -217070,7 +217182,7 @@ }, "delete": { "summary": "Delete a code scanning analysis from a repository", - "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `analysis_key`\n* `environment`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", + "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `category`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", "operationId": "code-scanning/delete-analysis", "tags": [ "code-scanning" @@ -242200,7 +242312,7 @@ "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", - "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/enterprise-server@3.4/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/enterprise-server@3.4/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Note**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.4/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/enterprise-server@3.4/rest/reference/git#get-a-tree).\n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", + "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/enterprise-server@3.4/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/enterprise-server@3.4/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Notes**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.4/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/enterprise-server@3.4/rest/reference/git#get-a-tree).\n * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. \n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", "tags": [ "repos" ], @@ -272376,14 +272488,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -275742,6 +275846,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "permissions": "write" + } + } } } } @@ -281762,7 +281874,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -285212,7 +285325,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -293863,7 +293977,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ] @@ -298797,7 +298912,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -302092,7 +302208,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -302273,6 +302390,16 @@ "closed" ] }, + "state_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason for the current state", + "examples": [ + "not_planned" + ] + }, "milestone": { "oneOf": [ { @@ -305510,7 +305637,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -308955,7 +309083,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -312197,7 +312326,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -421794,7 +421924,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -425827,8 +425958,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -426616,8 +426747,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -427288,8 +427419,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -445466,14 +445597,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -474013,8 +474136,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -489409,14 +489532,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", diff --git a/lib/rest/static/dereferenced/ghes-3.5.deref.json b/lib/rest/static/dereferenced/ghes-3.5.deref.json index 8f04071743..e1f9fa5b10 100644 --- a/lib/rest/static/dereferenced/ghes-3.5.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.5.deref.json @@ -4292,14 +4292,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -5537,14 +5529,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -6327,14 +6311,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -9323,14 +9299,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -10260,14 +10228,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -10983,14 +10943,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -11276,14 +11228,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -14705,14 +14649,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -15679,14 +15615,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -16525,14 +16453,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -17073,14 +16993,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -18584,14 +18496,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -19568,14 +19472,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -20625,14 +20521,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -21423,14 +21311,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -22458,14 +22338,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -23256,14 +23128,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -24165,14 +24029,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -25099,14 +24955,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -69371,7 +69219,7 @@ "/organizations/{organization_id}/custom_roles": { "get": { "summary": "List custom repository roles in an organization", - "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.5/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".", + "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.5/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".", "tags": [ "orgs" ], @@ -95886,14 +95734,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -96837,14 +96677,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -116623,8 +116455,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -117438,8 +117270,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -118230,8 +118062,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -187709,6 +187541,115 @@ "protected", "protection_url" ] + }, + "examples": { + "default": { + "value": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [ + + ], + "checks": [ + + ] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + } + } } } } @@ -192216,6 +192157,85 @@ "required": [ "url" ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + } + } } } } @@ -197102,7 +197122,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -197119,12 +197139,23 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding status checks to a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + } + } } } } @@ -197339,7 +197370,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -197356,12 +197387,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example updating status checks for a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -197548,7 +197589,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -197565,12 +197606,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing status checks from a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -200692,7 +200743,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -200709,12 +200760,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -201086,7 +201147,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -201097,18 +201158,28 @@ ], "example": { "teams": [ - "my-team" + "justice-league" ] } }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -201479,7 +201550,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -201496,12 +201567,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -202148,7 +202229,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -202170,6 +202251,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example adding a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -202508,7 +202599,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -202530,6 +202621,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -202867,7 +202968,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -202889,6 +202990,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example removing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -226180,6 +226291,7 @@ "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "state": "open", "fixed_at": null, "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", @@ -226987,7 +227099,7 @@ }, "delete": { "summary": "Delete a code scanning analysis from a repository", - "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `analysis_key`\n* `environment`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", + "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `category`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", "operationId": "code-scanning/delete-analysis", "tags": [ "code-scanning" @@ -252325,7 +252437,7 @@ "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", - "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/enterprise-server@3.5/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/enterprise-server@3.5/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Note**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.5/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/enterprise-server@3.5/rest/reference/git#get-a-tree).\n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", + "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/enterprise-server@3.5/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/enterprise-server@3.5/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Notes**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.5/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/enterprise-server@3.5/rest/reference/git#get-a-tree).\n * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. \n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", "tags": [ "repos" ], @@ -282507,14 +282619,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -285879,6 +285983,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "permissions": "write" + } + } } } } @@ -291905,7 +292017,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -295355,7 +295468,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -304006,7 +304120,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ] @@ -308940,7 +309055,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -312235,7 +312351,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -312416,6 +312533,16 @@ "closed" ] }, + "state_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason for the current state", + "examples": [ + "not_planned" + ] + }, "milestone": { "oneOf": [ { @@ -315653,7 +315780,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -319098,7 +319226,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -322340,7 +322469,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -432413,7 +432543,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -436446,8 +436577,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -437235,8 +437366,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -437907,8 +438038,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -456099,14 +456230,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -484664,8 +484787,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -500060,14 +500183,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", diff --git a/lib/rest/static/dereferenced/ghes-3.6.deref.json b/lib/rest/static/dereferenced/ghes-3.6.deref.json index 76e197e7f6..f2404ccc60 100644 --- a/lib/rest/static/dereferenced/ghes-3.6.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.6.deref.json @@ -4292,14 +4292,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -5537,14 +5529,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -6327,14 +6311,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -9323,14 +9299,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -10260,14 +10228,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -10983,14 +10943,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -11276,14 +11228,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -14786,14 +14730,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -15760,14 +15696,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -16606,14 +16534,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -17154,14 +17074,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -18665,14 +18577,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -19649,14 +19553,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -20706,14 +20602,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -21504,14 +21392,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -22539,14 +22419,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -23337,14 +23209,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -24246,14 +24110,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -25180,14 +25036,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -70494,7 +70342,7 @@ "/organizations/{organization_id}/custom_roles": { "get": { "summary": "List custom repository roles in an organization", - "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.6/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".", + "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.6/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".", "tags": [ "orgs" ], @@ -97631,14 +97479,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -98582,14 +98422,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -119096,8 +118928,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -119917,8 +119749,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -120715,8 +120547,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -192223,6 +192055,115 @@ "protected", "protection_url" ] + }, + "examples": { + "default": { + "value": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [ + + ], + "checks": [ + + ] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + } + } } } } @@ -196730,6 +196671,85 @@ "required": [ "url" ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + } + } } } } @@ -201616,7 +201636,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -201633,12 +201653,23 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding status checks to a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + } + } } } } @@ -201853,7 +201884,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -201870,12 +201901,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example updating status checks for a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -202062,7 +202103,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -202079,12 +202120,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing status checks from a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -205206,7 +205257,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -205223,12 +205274,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -205600,7 +205661,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -205611,18 +205672,28 @@ ], "example": { "teams": [ - "my-team" + "justice-league" ] } }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -205993,7 +206064,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -206010,12 +206081,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -206662,7 +206743,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -206684,6 +206765,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example adding a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -207022,7 +207113,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -207044,6 +207135,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -207381,7 +207482,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -207403,6 +207504,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example removing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -231080,6 +231191,7 @@ "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "state": "open", "fixed_at": null, "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", @@ -231887,7 +231999,7 @@ }, "delete": { "summary": "Delete a code scanning analysis from a repository", - "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `analysis_key`\n* `environment`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", + "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `category`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", "operationId": "code-scanning/delete-analysis", "tags": [ "code-scanning" @@ -257648,7 +257760,7 @@ "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", - "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/enterprise-server@3.6/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/enterprise-server@3.6/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Note**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.6/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/enterprise-server@3.6/rest/reference/git#get-a-tree).\n\n#### Size limits\nIf the requested file's size is:\n* 1 MB or smaller: All features of this endpoint are supported.\n* Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/enterprise-server@3.6/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n * Greater than 100 MB: This endpoint is not supported.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", + "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/enterprise-server@3.6/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/enterprise-server@3.6/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Notes**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.6/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/enterprise-server@3.6/rest/reference/git#get-a-tree).\n * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n#### Size limits\nIf the requested file's size is:\n* 1 MB or smaller: All features of this endpoint are supported.\n* Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/enterprise-server@3.6/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n * Greater than 100 MB: This endpoint is not supported.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", "tags": [ "repos" ], @@ -288594,14 +288706,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -292053,6 +292157,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "permissions": "write" + } + } } } } @@ -298247,7 +298359,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -301778,7 +301891,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -310510,7 +310624,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ] @@ -315525,7 +315640,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -318901,7 +319017,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -319082,6 +319199,16 @@ "closed" ] }, + "state_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason for the current state", + "examples": [ + "not_planned" + ] + }, "milestone": { "oneOf": [ { @@ -322400,7 +322527,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -325926,7 +326054,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -329249,7 +329378,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -441115,7 +441245,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -445154,8 +445285,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -445949,8 +446080,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -446627,8 +446758,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -465074,14 +465205,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -494548,8 +494671,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -510216,14 +510339,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 03b28814c4..f51c2bc6bc 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -2762,14 +2762,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -3668,14 +3660,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -4458,14 +4442,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -7453,14 +7429,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -8390,14 +8358,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -9113,14 +9073,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -9406,14 +9358,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -11981,14 +11925,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -12955,14 +12891,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -14027,14 +13955,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -61875,14 +61795,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -62826,14 +62738,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -80524,8 +80428,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -81346,8 +81250,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -82145,8 +82049,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -149396,6 +149300,115 @@ "protected", "protection_url" ] + }, + "examples": { + "default": { + "value": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [ + + ], + "checks": [ + + ] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + } + } } } } @@ -153903,6 +153916,85 @@ "required": [ "url" ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + } + } } } } @@ -158789,7 +158881,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -158806,12 +158898,23 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding status checks to a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + } + } } } } @@ -159026,7 +159129,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -159043,12 +159146,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example updating status checks for a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -159235,7 +159348,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -159252,12 +159365,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing status checks from a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -162379,7 +162502,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -162396,12 +162519,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -162773,7 +162906,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -162784,18 +162917,28 @@ ], "example": { "teams": [ - "my-team" + "justice-league" ] } }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -163166,7 +163309,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -163183,12 +163326,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -163835,7 +163988,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -163857,6 +164010,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example adding a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -164195,7 +164358,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -164217,6 +164380,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -164554,7 +164727,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -164576,6 +164749,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example removing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -185051,6 +185234,33 @@ "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53" ] } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created" + ], + "default": "created" + } } ], "responses": { @@ -211055,7 +211265,7 @@ "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", - "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Note**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/github-ae@latest/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/github-ae@latest/rest/reference/git#get-a-tree).\n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", + "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Notes**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/github-ae@latest/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/github-ae@latest/rest/reference/git#get-a-tree).\n * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. \n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", "tags": [ "repos" ], @@ -240816,14 +241026,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -244199,6 +244401,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "permissions": "write" + } + } } } } @@ -250241,7 +250451,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -253696,7 +253907,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -262367,7 +262579,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ] @@ -267306,7 +267519,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -270606,7 +270820,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -270787,6 +271002,16 @@ "closed" ] }, + "state_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason for the current state", + "examples": [ + "not_planned" + ] + }, "milestone": { "oneOf": [ { @@ -274029,7 +274254,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -277479,7 +277705,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -280726,7 +280953,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -387727,7 +387955,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -390262,8 +390491,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -391058,8 +391287,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -391737,8 +391966,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -407823,14 +408052,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -436267,8 +436488,8 @@ ] }, "organization": { - "title": "Organization Full", - "description": "Organization Full", + "title": "Team Organization", + "description": "Team Organization", "type": "object", "properties": { "login": { @@ -447751,14 +447972,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", diff --git a/lib/search/indexes/github-docs-3.2-cn-records.json.br b/lib/search/indexes/github-docs-3.2-cn-records.json.br index 2cd4d7db82..eb63c2aa3b 100644 --- a/lib/search/indexes/github-docs-3.2-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.2-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a803672d8fdaf4837ab98ce2662ac8bb0ab0b0cc8683657032622529e0c03bb6 -size 795283 +oid sha256:92ba1b09ca4c893cf4ee16d01c1a574aae6bdc1c64bf77cbc817d4de54d654e7 +size 795254 diff --git a/lib/search/indexes/github-docs-3.2-cn.json.br b/lib/search/indexes/github-docs-3.2-cn.json.br index b094b1fd73..364b6c863f 100644 --- a/lib/search/indexes/github-docs-3.2-cn.json.br +++ b/lib/search/indexes/github-docs-3.2-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6a18baa7cbcf583b8a7a4bc9bfde520a7ac909bf22eea9ff631ea7b71ee0842d -size 1643339 +oid sha256:ddd91331d86e14ac836de094ab1b73aa5127a04df2c6b3ec282bc77bf3de5a04 +size 1646539 diff --git a/lib/search/indexes/github-docs-3.2-en-records.json.br b/lib/search/indexes/github-docs-3.2-en-records.json.br index 657bcf2a93..9a6d91f7da 100644 --- a/lib/search/indexes/github-docs-3.2-en-records.json.br +++ b/lib/search/indexes/github-docs-3.2-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e033b4118775273183e1d518e8aae53f0fa7c4dd77eb9dd1c49a85f391d291fa -size 1091643 +oid sha256:697731c0cfcb02c10945dd3b678b2b4dd24dd48c52c15fb4d001931268bfe3e8 +size 1094650 diff --git a/lib/search/indexes/github-docs-3.2-en.json.br b/lib/search/indexes/github-docs-3.2-en.json.br index e4e7ea9641..b2dda0b56d 100644 --- a/lib/search/indexes/github-docs-3.2-en.json.br +++ b/lib/search/indexes/github-docs-3.2-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:457b7f5ffb1404c8c06764b942800beef3a951814e0e54d6a04e4a80c6ddf75f -size 4426671 +oid sha256:26ae5e758affeba6ef1dc3df3320933c2c475845768ce0fdcd2ed18a99a43a33 +size 4441447 diff --git a/lib/search/indexes/github-docs-3.2-es-records.json.br b/lib/search/indexes/github-docs-3.2-es-records.json.br index ea0ec324ac..fb2b3f7c24 100644 --- a/lib/search/indexes/github-docs-3.2-es-records.json.br +++ b/lib/search/indexes/github-docs-3.2-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e07ad5433001cb675298dcbdd741eb8278d96f0c9b041ad278299f61fb48de35 -size 734018 +oid sha256:d28096ff0da3088ebfa45733bcc4764e9a7961a07154b747a34e30847b6e4047 +size 734117 diff --git a/lib/search/indexes/github-docs-3.2-es.json.br b/lib/search/indexes/github-docs-3.2-es.json.br index 50a40e1b95..0c459fb202 100644 --- a/lib/search/indexes/github-docs-3.2-es.json.br +++ b/lib/search/indexes/github-docs-3.2-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5561007b930b897118aa0be9dea313df5b8331b55497cae0d6edb9ab9056ba83 -size 3126775 +oid sha256:f432bb14bd55588fbfedda658d6bd3a886308f11dd2861380c017b6fd57238e0 +size 3128125 diff --git a/lib/search/indexes/github-docs-3.2-ja-records.json.br b/lib/search/indexes/github-docs-3.2-ja-records.json.br index 3a3e9759a9..5efabd2046 100644 --- a/lib/search/indexes/github-docs-3.2-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.2-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:249d4109380d07cd3ee197136e32b44ee7b891221b7b18af32153599683d558b -size 808670 +oid sha256:16772389f441d0104670e1e870952a2e100e2faee09a05c9b03f9f3204cb32a8 +size 810873 diff --git a/lib/search/indexes/github-docs-3.2-ja.json.br b/lib/search/indexes/github-docs-3.2-ja.json.br index e813cd08ac..b032b723e6 100644 --- a/lib/search/indexes/github-docs-3.2-ja.json.br +++ b/lib/search/indexes/github-docs-3.2-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2d33e7e8ef97bda5045d15c2250ffee1892a8b227566522a21c314813fb16057 -size 4448498 +oid sha256:382a5138f90fe97e60bc60af67d663fbc239116365a0eda79614a527f5e6af64 +size 4455469 diff --git a/lib/search/indexes/github-docs-3.2-pt-records.json.br b/lib/search/indexes/github-docs-3.2-pt-records.json.br index 8c566c3248..4f6b1d44af 100644 --- a/lib/search/indexes/github-docs-3.2-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.2-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:dd02c5fe45eb7d90fa95fafb74ef9667cebf95be0b21fd1a270c6e7e3000b4a4 -size 722979 +oid sha256:cc7be9d25efe635587b2be346fde8195053c24313f901f7f9ebff5b627576c15 +size 722974 diff --git a/lib/search/indexes/github-docs-3.2-pt.json.br b/lib/search/indexes/github-docs-3.2-pt.json.br index 54c11dec91..83fcaead7c 100644 --- a/lib/search/indexes/github-docs-3.2-pt.json.br +++ b/lib/search/indexes/github-docs-3.2-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:fe0feb43f86865d2b0a3bb6265b260e162e02f68476d4cd282df00b637a09e08 -size 3023291 +oid sha256:f6812661b413964eff528647c4d961dba401b97b093a3b22934af14abc6b1b3a +size 3022870 diff --git a/lib/search/indexes/github-docs-3.3-cn-records.json.br b/lib/search/indexes/github-docs-3.3-cn-records.json.br index 334fe31979..06e67cdb26 100644 --- a/lib/search/indexes/github-docs-3.3-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.3-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:05997e9019a77ac58f65c91beb756f95e01644c30df7785640bbec3d5650fcad -size 820547 +oid sha256:f57c52078d0ec7b67cc7970a61e130ce95fcd072ae8bb2a410d41d1427843203 +size 820737 diff --git a/lib/search/indexes/github-docs-3.3-cn.json.br b/lib/search/indexes/github-docs-3.3-cn.json.br index 1bfe3103ef..d29255e70a 100644 --- a/lib/search/indexes/github-docs-3.3-cn.json.br +++ b/lib/search/indexes/github-docs-3.3-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:72796767bd66101d2aedb4dcd8a5644582661e5fa25da0c17772d969bd5bbb83 -size 1690306 +oid sha256:bc519bbd1ba955db3ea4f4287e5920386a8f4b12d0da1860a00832e2ae06a30d +size 1694265 diff --git a/lib/search/indexes/github-docs-3.3-en-records.json.br b/lib/search/indexes/github-docs-3.3-en-records.json.br index c195b4dca5..2b116bd01c 100644 --- a/lib/search/indexes/github-docs-3.3-en-records.json.br +++ b/lib/search/indexes/github-docs-3.3-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:34970561d76d47d9fda0b6ff6d416a703a5e3344eca3a5b67f036299eea5dfa5 -size 1126759 +oid sha256:5cadf9741159bb823a821622614b21320ae681d3799f5d624cf09c5f47159d3d +size 1129826 diff --git a/lib/search/indexes/github-docs-3.3-en.json.br b/lib/search/indexes/github-docs-3.3-en.json.br index a1777d04ad..8582ce4759 100644 --- a/lib/search/indexes/github-docs-3.3-en.json.br +++ b/lib/search/indexes/github-docs-3.3-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:368b520118ed5823935934051482f2eb578b93a738a30d474a3c648f1489acc6 -size 4530611 +oid sha256:4c4709e3d0517975c6d46a17038b26434a2bb910ca7ff88bfd420ac11832f7c3 +size 4544538 diff --git a/lib/search/indexes/github-docs-3.3-es-records.json.br b/lib/search/indexes/github-docs-3.3-es-records.json.br index 8376877e9e..3ddacc83fb 100644 --- a/lib/search/indexes/github-docs-3.3-es-records.json.br +++ b/lib/search/indexes/github-docs-3.3-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c16cbc40bf563ca325805ebced2ea94628f3f2f8ec43d8eee2e1d2478c528fb9 -size 755254 +oid sha256:d9241795548b11c04b67323c6a6281fb9c8b59174bb9cafd85cb4311999fae64 +size 755252 diff --git a/lib/search/indexes/github-docs-3.3-es.json.br b/lib/search/indexes/github-docs-3.3-es.json.br index d27e5a955d..ea486a473f 100644 --- a/lib/search/indexes/github-docs-3.3-es.json.br +++ b/lib/search/indexes/github-docs-3.3-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c8dcbf06511726bb0ea608f335d86d0995014fabff6d35d43fbd0731eda400b7 -size 3211553 +oid sha256:644409674ff50d4a1b371a50b8fc1625507786395239ec00b402b4ecebaee384 +size 3211426 diff --git a/lib/search/indexes/github-docs-3.3-ja-records.json.br b/lib/search/indexes/github-docs-3.3-ja-records.json.br index ce2ac18ec1..d29c7d452e 100644 --- a/lib/search/indexes/github-docs-3.3-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.3-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c803bf84ad67f7df7a7e6a1523220cc54c45404144a8e0804cf38e9023a5cb37 -size 834203 +oid sha256:cd529ede5cb428dc7c079cd0d2820601e8cf5892c8238ad139f67a3d41013bac +size 836146 diff --git a/lib/search/indexes/github-docs-3.3-ja.json.br b/lib/search/indexes/github-docs-3.3-ja.json.br index 339c8e5e8c..699a5782a1 100644 --- a/lib/search/indexes/github-docs-3.3-ja.json.br +++ b/lib/search/indexes/github-docs-3.3-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:cb593b8f21986fb574d17818cdd81bfbdae761676ae3f5c4b3f93a22745d8076 -size 4582543 +oid sha256:b1fd4a8819202199c8cee2e2328422d98afab4853cf9430d964d216f6b988f6e +size 4589364 diff --git a/lib/search/indexes/github-docs-3.3-pt-records.json.br b/lib/search/indexes/github-docs-3.3-pt-records.json.br index 083d9c044f..36ee413a8e 100644 --- a/lib/search/indexes/github-docs-3.3-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.3-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:698d8080be857ddae166e8b4de61057314f63190081d2b9be40899b361ceefa3 -size 744362 +oid sha256:67922aa395b4778fa5c35e195eb27419956e56e57082d41d0c1f480f93903627 +size 744681 diff --git a/lib/search/indexes/github-docs-3.3-pt.json.br b/lib/search/indexes/github-docs-3.3-pt.json.br index 4e12778878..ffb666f0b8 100644 --- a/lib/search/indexes/github-docs-3.3-pt.json.br +++ b/lib/search/indexes/github-docs-3.3-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:27bd2d38dd4aadc354271ba1b8892f795dd7f48abb7eb443fc8abd530c3b0c00 -size 3107728 +oid sha256:2fc7907916b7ab532e330a32a74a5bcf18af6e77b15217db6379450ea9d35ff7 +size 3108515 diff --git a/lib/search/indexes/github-docs-3.4-cn-records.json.br b/lib/search/indexes/github-docs-3.4-cn-records.json.br index f692ceac3b..6b6f708e32 100644 --- a/lib/search/indexes/github-docs-3.4-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.4-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:19d88b49d7b99dceea6be14eb78b29ed0342db008c17fcb89dee24c038eb357d -size 823304 +oid sha256:bd0aeeb4376d159ebc4c0999d6fd25b25868d6f993a26116851536e4f0646ee3 +size 823505 diff --git a/lib/search/indexes/github-docs-3.4-cn.json.br b/lib/search/indexes/github-docs-3.4-cn.json.br index c545b06897..e8eb60f748 100644 --- a/lib/search/indexes/github-docs-3.4-cn.json.br +++ b/lib/search/indexes/github-docs-3.4-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5dcfaae9860dddb2899b0d3aac9e9cf81426b807f073ffd2451cd46feebf933c -size 1705495 +oid sha256:cd044ca01f90bb25ce24ce93e8c0553b053ddccdcba9c31828da0c147610fa29 +size 1710636 diff --git a/lib/search/indexes/github-docs-3.4-en-records.json.br b/lib/search/indexes/github-docs-3.4-en-records.json.br index e0a583f06f..c369a50b21 100644 --- a/lib/search/indexes/github-docs-3.4-en-records.json.br +++ b/lib/search/indexes/github-docs-3.4-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3ebc0aa9df88da1e9803c11f7da0f8831871a8b554fe9cf57fbc109e7f570b23 -size 1137908 +oid sha256:a81fddfcb1dd7c9ecb86c84f78b299fe648ecb4e50f68925b3f6bb75702d26c4 +size 1142016 diff --git a/lib/search/indexes/github-docs-3.4-en.json.br b/lib/search/indexes/github-docs-3.4-en.json.br index e2ea70b1e0..a2033ede92 100644 --- a/lib/search/indexes/github-docs-3.4-en.json.br +++ b/lib/search/indexes/github-docs-3.4-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a0e2343dda42d50e06b91405b94cea67340db4322001c02c342e7bd0f5abfca3 -size 4587074 +oid sha256:37f1dc3d6a1fd7918661bdc716f4da4909e38cfb0e4b5cfe1469672f126979db +size 4602386 diff --git a/lib/search/indexes/github-docs-3.4-es-records.json.br b/lib/search/indexes/github-docs-3.4-es-records.json.br index d93b7c12c4..742368501f 100644 --- a/lib/search/indexes/github-docs-3.4-es-records.json.br +++ b/lib/search/indexes/github-docs-3.4-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b9d84b6b9e1e8c59d52d6867cac5c9dd40a00e44b78e54d9868b8c81c54512b3 -size 760000 +oid sha256:a19c2fea94a62148c080aaa895854e3274fcc9a8bd0bdc4da881fd07ce720734 +size 760133 diff --git a/lib/search/indexes/github-docs-3.4-es.json.br b/lib/search/indexes/github-docs-3.4-es.json.br index 7a6b619924..d7209ce4ee 100644 --- a/lib/search/indexes/github-docs-3.4-es.json.br +++ b/lib/search/indexes/github-docs-3.4-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3116f3b62acf9df4a66755ffe290357c121334f7905c51019730761bbd8fa5e9 -size 3234572 +oid sha256:558e9ed6f3bd2a89ed925d65eb238ae7cc70aad30dbc167e9a28e6c3a1a143ab +size 3235748 diff --git a/lib/search/indexes/github-docs-3.4-ja-records.json.br b/lib/search/indexes/github-docs-3.4-ja-records.json.br index 8fd5272e41..718897675b 100644 --- a/lib/search/indexes/github-docs-3.4-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.4-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:60149b22e2fdf7633ae0b652a2e6523fb35ff5d460861dcef3e3287d29abd634 -size 837596 +oid sha256:64b5d2cf04a85201693ec12927c2a2b7a5311f4789d6f5d5fe4722b527435bd0 +size 839584 diff --git a/lib/search/indexes/github-docs-3.4-ja.json.br b/lib/search/indexes/github-docs-3.4-ja.json.br index 405c7131bd..f1b5d29a07 100644 --- a/lib/search/indexes/github-docs-3.4-ja.json.br +++ b/lib/search/indexes/github-docs-3.4-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:30ca015b5f2479727a59dcbe0f94c30d801d2dd9950f069cadb1c040533d3dcd -size 4617754 +oid sha256:828350d5b0a9b5040967c030875ec2fba11fa499c0b8623928da96017479102d +size 4624289 diff --git a/lib/search/indexes/github-docs-3.4-pt-records.json.br b/lib/search/indexes/github-docs-3.4-pt-records.json.br index b1bf3d3cd6..1d8aa20946 100644 --- a/lib/search/indexes/github-docs-3.4-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.4-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:732657ec699e3198563a1973910fbc5215edf7ed63d71dda91606dc711d0ee4f -size 748708 +oid sha256:1753ddd2f6ddb40ca7366f0d394819f9e61dccb98c72bce3abf0f3872c7ca9b3 +size 748833 diff --git a/lib/search/indexes/github-docs-3.4-pt.json.br b/lib/search/indexes/github-docs-3.4-pt.json.br index 97d1542b44..ea737ed280 100644 --- a/lib/search/indexes/github-docs-3.4-pt.json.br +++ b/lib/search/indexes/github-docs-3.4-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1a0fc85be6152946e4ed07e00cb1ed6b30eb7c11cfc228707d4836dcf1d87e75 -size 3132663 +oid sha256:cc0cdadef12c208ffbc2c458e35a3fb21546cff3006b6a3494ea385777ec2337 +size 3134018 diff --git a/lib/search/indexes/github-docs-3.5-cn-records.json.br b/lib/search/indexes/github-docs-3.5-cn-records.json.br index 5bbc19443e..ee763ef946 100644 --- a/lib/search/indexes/github-docs-3.5-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.5-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:07d889271fc3439b9825e424c971ac23dcbd0e9a5663f330b2d8a0b550f93e5e -size 853794 +oid sha256:08153116c15b7b18aae99a2082364f8a453a3a0f5d3c2e10becf1a0b3f28bf15 +size 855040 diff --git a/lib/search/indexes/github-docs-3.5-cn.json.br b/lib/search/indexes/github-docs-3.5-cn.json.br index debd37e534..56782de7a3 100644 --- a/lib/search/indexes/github-docs-3.5-cn.json.br +++ b/lib/search/indexes/github-docs-3.5-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3086adb8e7aac423927b8a7c5a95da921277354de43a4801a1f12526f19a8e2b -size 1768640 +oid sha256:77f959bc01c64000fe4dcb8e61d8517dda1897e5328bb3f9dc3e497cc0a843cd +size 1779201 diff --git a/lib/search/indexes/github-docs-3.5-en-records.json.br b/lib/search/indexes/github-docs-3.5-en-records.json.br index 104e5acb8d..89f0172817 100644 --- a/lib/search/indexes/github-docs-3.5-en-records.json.br +++ b/lib/search/indexes/github-docs-3.5-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1dfc06f96c39efa92d0285837885870f4c82219af11790041f72113a3faeeac5 -size 1176649 +oid sha256:c8f46a1da08566c1448dd753e2fa1055724f6c168610098d357b6531d39fd9fe +size 1181982 diff --git a/lib/search/indexes/github-docs-3.5-en.json.br b/lib/search/indexes/github-docs-3.5-en.json.br index 05ba9d4d69..76e9db8113 100644 --- a/lib/search/indexes/github-docs-3.5-en.json.br +++ b/lib/search/indexes/github-docs-3.5-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a6d28d0e6030135ef0909d422d1dca29c3e7416f5b4a31c75cd66f8a5170c754 -size 4750005 +oid sha256:c5d5448851876b0c38490ccc8c4dc9818bf7e416cae5037d40cc00c794ebe57d +size 4769114 diff --git a/lib/search/indexes/github-docs-3.5-es-records.json.br b/lib/search/indexes/github-docs-3.5-es-records.json.br index 64934159f4..b0fe8b0b24 100644 --- a/lib/search/indexes/github-docs-3.5-es-records.json.br +++ b/lib/search/indexes/github-docs-3.5-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:709e4df4f4b85cdd035effa2634e1e8b2aaeb251a4722135a711b95c53085aea -size 784211 +oid sha256:932c2138c14932e89cf6185c16251132c605ebf7f8b7216ff974df08dfa9997a +size 784878 diff --git a/lib/search/indexes/github-docs-3.5-es.json.br b/lib/search/indexes/github-docs-3.5-es.json.br index bbc7fef7b5..281758ac07 100644 --- a/lib/search/indexes/github-docs-3.5-es.json.br +++ b/lib/search/indexes/github-docs-3.5-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2a3f9eadb22ab3afb7f726dd59f9e75b23feccdb581c44a4469387cf6e93d482 -size 3354468 +oid sha256:f47b17c1b07ee2c2773365be7513d3d3c67ef35a6111a918dc8f4d7e690fc99c +size 3355866 diff --git a/lib/search/indexes/github-docs-3.5-ja-records.json.br b/lib/search/indexes/github-docs-3.5-ja-records.json.br index 356a4bd5c6..a030726bec 100644 --- a/lib/search/indexes/github-docs-3.5-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.5-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:328a0610045d7909b68666ca41810596ac27fbb9e20dbabf60135fd627b02939 -size 864537 +oid sha256:414e7f313ed6aea775bc21f7a1c93c93c06cda873e9dbdd8cc79b471df2ba204 +size 869051 diff --git a/lib/search/indexes/github-docs-3.5-ja.json.br b/lib/search/indexes/github-docs-3.5-ja.json.br index 05c0759379..8db43fe11a 100644 --- a/lib/search/indexes/github-docs-3.5-ja.json.br +++ b/lib/search/indexes/github-docs-3.5-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:63c1bcc46618e56c62f4555ad6aa88f5aaf7e9cae3395c900a87114583df4211 -size 4782088 +oid sha256:ebd9439c49cbb61abfaa9473d4165fbb030161494d36f88cd6ca0e1178a9e3a7 +size 4801012 diff --git a/lib/search/indexes/github-docs-3.5-pt-records.json.br b/lib/search/indexes/github-docs-3.5-pt-records.json.br index 33502dd469..a6ba45ee05 100644 --- a/lib/search/indexes/github-docs-3.5-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.5-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:02eba0d84cdc8c2499486d635a895370672c2fd67d3d2a6920e7deb92ec502ef -size 772616 +oid sha256:c0d7b1ac55756824f1e4585278430a37f621f2ca04172fcd884d5950eae2e4ad +size 773233 diff --git a/lib/search/indexes/github-docs-3.5-pt.json.br b/lib/search/indexes/github-docs-3.5-pt.json.br index b1702ef2bc..695fe321cb 100644 --- a/lib/search/indexes/github-docs-3.5-pt.json.br +++ b/lib/search/indexes/github-docs-3.5-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c8db35673f0c0f521ecfe54c63acda0cb011e81754a9dfa2d1c198c79e538520 -size 3245433 +oid sha256:ef9d9bb5907dcd53a3910fb2bb778da3f6720d59d9d29a891493a53cd0a66c4c +size 3249091 diff --git a/lib/search/indexes/github-docs-3.6-cn-records.json.br b/lib/search/indexes/github-docs-3.6-cn-records.json.br index 74ad9de8ba..c84d71bf08 100644 --- a/lib/search/indexes/github-docs-3.6-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.6-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:f5dbf8c719896b3404f46f5bec31a2de4f149daa34fe45471b4e3425fd3ea0dd -size 876666 +oid sha256:616313fdc3654089f5420b550ce219d4bfed6b6995989efd621a8111ea5ee4b9 +size 876545 diff --git a/lib/search/indexes/github-docs-3.6-cn.json.br b/lib/search/indexes/github-docs-3.6-cn.json.br index 43a43a5ca0..6803c05779 100644 --- a/lib/search/indexes/github-docs-3.6-cn.json.br +++ b/lib/search/indexes/github-docs-3.6-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e809c0ed8a944e90b56321284c2c6ed2640e61d334570dc17e8a871bc76ed0b2 -size 1815472 +oid sha256:ebe6184e712a35430f87a8704ae9a9926d8021523c0b9891918d84465e983aea +size 1826700 diff --git a/lib/search/indexes/github-docs-3.6-en-records.json.br b/lib/search/indexes/github-docs-3.6-en-records.json.br index 3dbb133958..4b60af2222 100644 --- a/lib/search/indexes/github-docs-3.6-en-records.json.br +++ b/lib/search/indexes/github-docs-3.6-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:88dddef6bb210b90e4d5d9ec56c3de868ffaa635af4f82226f51b13086d93839 -size 1205276 +oid sha256:f01aef2f467c23fd6c952524b50415dc3cc176c7c19e016da2dc50845598c3ce +size 1209827 diff --git a/lib/search/indexes/github-docs-3.6-en.json.br b/lib/search/indexes/github-docs-3.6-en.json.br index ca55ae93e4..f408a4a6f9 100644 --- a/lib/search/indexes/github-docs-3.6-en.json.br +++ b/lib/search/indexes/github-docs-3.6-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c5a80ecae8c04bf55185a2c2656b7144ba987e7b7c8f0cb66b517083935178b9 -size 4864312 +oid sha256:363e8da2f352d3de54009501eb6e76355eeaf6dc3da64d341fdac376dca5f217 +size 4881357 diff --git a/lib/search/indexes/github-docs-3.6-es-records.json.br b/lib/search/indexes/github-docs-3.6-es-records.json.br index 478a009c5a..d025c52d9c 100644 --- a/lib/search/indexes/github-docs-3.6-es-records.json.br +++ b/lib/search/indexes/github-docs-3.6-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2f9c29d5682968f5d1f24b913d9ec9ee6ebb23a410ef40034428319fd4bf8463 -size 804491 +oid sha256:50f3c1fc2c6c89f34404d65e0248ede87bbac255b0641006a5e2440bc40e9e85 +size 805074 diff --git a/lib/search/indexes/github-docs-3.6-es.json.br b/lib/search/indexes/github-docs-3.6-es.json.br index 1f193b2dbc..59c7b89539 100644 --- a/lib/search/indexes/github-docs-3.6-es.json.br +++ b/lib/search/indexes/github-docs-3.6-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:dc816f0c57b1fb4a9e2361fdf969b7eb76ea0202d3e779d131d0f57f6e64e621 -size 3448570 +oid sha256:8783178b6f79cf2aae606cc894f19ea8115dca5b5c9b1b407234eb64a9734339 +size 3447942 diff --git a/lib/search/indexes/github-docs-3.6-ja-records.json.br b/lib/search/indexes/github-docs-3.6-ja-records.json.br index f35d1fed9d..2443c817ab 100644 --- a/lib/search/indexes/github-docs-3.6-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.6-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:579302c2715d97bfe8b4efe2000d8ae2ae9359a08c23c0883101d5b50b439707 -size 887155 +oid sha256:298265b518231c7c606d58ae79439c238d0a9a25ec860b9f8637e21a4e95f207 +size 890725 diff --git a/lib/search/indexes/github-docs-3.6-ja.json.br b/lib/search/indexes/github-docs-3.6-ja.json.br index 77837d20bf..8425da79e4 100644 --- a/lib/search/indexes/github-docs-3.6-ja.json.br +++ b/lib/search/indexes/github-docs-3.6-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:f2994e6724ae2625d3e60f96abb88ecbc9b7bfb8c33d13b46b4f8f425a1d1606 -size 4913296 +oid sha256:3b21a7f1cc4233cf48e6b0fa2a8269f1825518520e5b7f4701e054923bb9922b +size 4927845 diff --git a/lib/search/indexes/github-docs-3.6-pt-records.json.br b/lib/search/indexes/github-docs-3.6-pt-records.json.br index 99301e3291..c02becfcb6 100644 --- a/lib/search/indexes/github-docs-3.6-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.6-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:17af0f89f75f4067d0159c72718e2d9e12b26c50b2299e2b1d0a67b2a90d4301 -size 792862 +oid sha256:b19e876cccef04928787fb6b4701cf70e1c1f4ffe89e45e2c086c0c7f5bde4ba +size 793372 diff --git a/lib/search/indexes/github-docs-3.6-pt.json.br b/lib/search/indexes/github-docs-3.6-pt.json.br index cd3d0c202b..46b7aef73d 100644 --- a/lib/search/indexes/github-docs-3.6-pt.json.br +++ b/lib/search/indexes/github-docs-3.6-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:67a447da7af1a55b4263bc707389c9b20b622329513029eb3b34568d4030d7e8 -size 3338901 +oid sha256:416f363a59884e173df4a0ad93933747131726077b167bea040c0fb9a8ae7437 +size 3340421 diff --git a/lib/search/indexes/github-docs-dotcom-cn-records.json.br b/lib/search/indexes/github-docs-dotcom-cn-records.json.br index 5c26bf3542..4c418b895d 100644 --- a/lib/search/indexes/github-docs-dotcom-cn-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6df49528f7af6c720f54fff321e0d83db791d01f8393e59bd02f17c5b42537f4 -size 1038719 +oid sha256:68234273a2df4017f432ff96e3951c7b74de1c6929df7047a08da077c4a129d4 +size 1039060 diff --git a/lib/search/indexes/github-docs-dotcom-cn.json.br b/lib/search/indexes/github-docs-dotcom-cn.json.br index f6d4b0110f..c12f194581 100644 --- a/lib/search/indexes/github-docs-dotcom-cn.json.br +++ b/lib/search/indexes/github-docs-dotcom-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7c3bd484371924a240c43a48f35ed4902d47eb5376b569f56c6120c6ac30a76b -size 1865265 +oid sha256:ad01a15a2412184e455fb6191a3985643e1641e126b1b9054ed94507ad7b6097 +size 1887014 diff --git a/lib/search/indexes/github-docs-dotcom-en-records.json.br b/lib/search/indexes/github-docs-dotcom-en-records.json.br index ac1a78b8e4..988fc74d5d 100644 --- a/lib/search/indexes/github-docs-dotcom-en-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:17ff406ec71c93f588d493bd3f3c9bf1c3fb599ab89872ac4e0c4a829a168799 -size 1448782 +oid sha256:e60ac3e3eba733478727d9dcba623e9fc80eecc1802dd45eca05583b0af7ab95 +size 1457879 diff --git a/lib/search/indexes/github-docs-dotcom-en.json.br b/lib/search/indexes/github-docs-dotcom-en.json.br index a27642a1df..173d34ba52 100644 --- a/lib/search/indexes/github-docs-dotcom-en.json.br +++ b/lib/search/indexes/github-docs-dotcom-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5e7b51021e3c51339cad8f24b84065fe11a4b4f438afb0103fe8723c3e7424f9 -size 5586320 +oid sha256:51b20a5257ed071b7751d2590aadd1b2c88fc9f0c8e0195024e95f73c8d851db +size 5620320 diff --git a/lib/search/indexes/github-docs-dotcom-es-records.json.br b/lib/search/indexes/github-docs-dotcom-es-records.json.br index 04d7c1fbf1..fd96084c01 100644 --- a/lib/search/indexes/github-docs-dotcom-es-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a3c6115b27f86ae5a298ab062dcb5235f283203fd38d02c94e3266fb443a6aae -size 936215 +oid sha256:2c5fb75d36ca9cc73cc55babbf0eaf414f6c664c7de1c6e233569ae505810595 +size 937353 diff --git a/lib/search/indexes/github-docs-dotcom-es.json.br b/lib/search/indexes/github-docs-dotcom-es.json.br index 9fee8f19cc..58307f3639 100644 --- a/lib/search/indexes/github-docs-dotcom-es.json.br +++ b/lib/search/indexes/github-docs-dotcom-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c3930c14ce3ba743daf58e2a7889fab282bfde643f85dc72c2570e19dbb81189 -size 3884178 +oid sha256:fba4817e5916297d51d15a9d75d39367146c1e7ff76bbc3a1f0a3bf9ec0a379b +size 3893397 diff --git a/lib/search/indexes/github-docs-dotcom-ja-records.json.br b/lib/search/indexes/github-docs-dotcom-ja-records.json.br index 66a4cd63a4..2a57356125 100644 --- a/lib/search/indexes/github-docs-dotcom-ja-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4dd943992a522b8788fd96d80f410548f454d59d1d80c2cbfe72e17bfeeb5cdf -size 1044418 +oid sha256:f5d9fd3b883dfdaa53e634facad4f5d1f600183b948954454d587bc50a12dc54 +size 1047502 diff --git a/lib/search/indexes/github-docs-dotcom-ja.json.br b/lib/search/indexes/github-docs-dotcom-ja.json.br index c99b97e42b..c4e50b49e1 100644 --- a/lib/search/indexes/github-docs-dotcom-ja.json.br +++ b/lib/search/indexes/github-docs-dotcom-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:16baba1ec443a8d6ccce4f1db0ecb5c0c334629ce9520e7968ae4e47f253490a -size 5612306 +oid sha256:bfeafa55658907da398e4c174631e46fd59db5d20ec038864094e26abe4e7d1e +size 5633723 diff --git a/lib/search/indexes/github-docs-dotcom-pt-records.json.br b/lib/search/indexes/github-docs-dotcom-pt-records.json.br index 4f64aca1a3..b5651aefe9 100644 --- a/lib/search/indexes/github-docs-dotcom-pt-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e3ad2f9e0ad85e5013919885fab96c2786db6380277c3a00aa76ab73b828f8d8 -size 924804 +oid sha256:2c62b3d674a0931924b86aae5b76659da52e362208d2c532e65f983ba2bd435b +size 926221 diff --git a/lib/search/indexes/github-docs-dotcom-pt.json.br b/lib/search/indexes/github-docs-dotcom-pt.json.br index e9ec895ca5..77e3072d01 100644 --- a/lib/search/indexes/github-docs-dotcom-pt.json.br +++ b/lib/search/indexes/github-docs-dotcom-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:01a5389cd4b309dceb6650887601d4154906adbb48cfb940e8ebb6d42be32618 -size 3787788 +oid sha256:ed150f4b11ea96f4dba0534f86f714e2f6f55fbacbb6e13321e27983e041bcfa +size 3791322 diff --git a/lib/search/indexes/github-docs-ghae-cn-records.json.br b/lib/search/indexes/github-docs-ghae-cn-records.json.br index 4306598151..202ceae306 100644 --- a/lib/search/indexes/github-docs-ghae-cn-records.json.br +++ b/lib/search/indexes/github-docs-ghae-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6b76eb4fbe95ea5d9dbd35ade41f804aed0418fb9e58695469e0fec196dae453 -size 660062 +oid sha256:38470a980e1f61e3c141ec4f9ae75d5abb42d8c0163820e656c33d55affb3c8d +size 660755 diff --git a/lib/search/indexes/github-docs-ghae-cn.json.br b/lib/search/indexes/github-docs-ghae-cn.json.br index c3ae7e33d1..bac49c75d3 100644 --- a/lib/search/indexes/github-docs-ghae-cn.json.br +++ b/lib/search/indexes/github-docs-ghae-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:f9bac98dc49c45c977312011d783ca5274ebce217f307739ecff4a6a309c5179 -size 1315937 +oid sha256:e59f691b3444cc53b1df48dcab3e98b9477d41b8ad9abec9b00d4bce7193e4fb +size 1322293 diff --git a/lib/search/indexes/github-docs-ghae-en-records.json.br b/lib/search/indexes/github-docs-ghae-en-records.json.br index bb38145b15..bd898e4112 100644 --- a/lib/search/indexes/github-docs-ghae-en-records.json.br +++ b/lib/search/indexes/github-docs-ghae-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:65f8087ad2607b7d76caac50bf5cd95e8df92f9ceb407a82056a9f4b43a0346d -size 939221 +oid sha256:a4b79f67520fafbe5368fc166076d267a4d340b7158f0e7e61f05bf8dfd447b6 +size 939046 diff --git a/lib/search/indexes/github-docs-ghae-en.json.br b/lib/search/indexes/github-docs-ghae-en.json.br index 64e5a5df10..2e723b7567 100644 --- a/lib/search/indexes/github-docs-ghae-en.json.br +++ b/lib/search/indexes/github-docs-ghae-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:020bfb78dd7fe7deee12e2f160c446f2aebcbf521ca822b010102b3f577ef700 -size 3705644 +oid sha256:31f81ac18199f51499dc98423a11041947a987de3c833b0b5ce0556e519d0cda +size 3726211 diff --git a/lib/search/indexes/github-docs-ghae-es-records.json.br b/lib/search/indexes/github-docs-ghae-es-records.json.br index ba1be0cc88..a54828eaac 100644 --- a/lib/search/indexes/github-docs-ghae-es-records.json.br +++ b/lib/search/indexes/github-docs-ghae-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a90a2317e41364b733acc3f9413babbab642085d015bd50253bce64d37a2c166 -size 613463 +oid sha256:6a9bb8002e986c0a0338d314a63419fe4f5f8a8810b9addc072258066af751c8 +size 614479 diff --git a/lib/search/indexes/github-docs-ghae-es.json.br b/lib/search/indexes/github-docs-ghae-es.json.br index 2a6a7bb09d..845cacd721 100644 --- a/lib/search/indexes/github-docs-ghae-es.json.br +++ b/lib/search/indexes/github-docs-ghae-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6fae84c7a2b11d58aafc0488238bcaf4077652d6a131d9b4808329e80b05b83c -size 2532878 +oid sha256:2cf033d367998b234d62cf6558494a9e0eedb0ee98e08f5508196fcae61773e8 +size 2537100 diff --git a/lib/search/indexes/github-docs-ghae-ja-records.json.br b/lib/search/indexes/github-docs-ghae-ja-records.json.br index d9a0fcbd94..07a13f0335 100644 --- a/lib/search/indexes/github-docs-ghae-ja-records.json.br +++ b/lib/search/indexes/github-docs-ghae-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d5f39e7ebdd65bc5af199bdca6ecd80328953d923acea014c3cae66229d3641b -size 673040 +oid sha256:389dfe0c02916aed1fb82d3759ae018a72a5e1973aee11aab7b9fec3694f89de +size 674141 diff --git a/lib/search/indexes/github-docs-ghae-ja.json.br b/lib/search/indexes/github-docs-ghae-ja.json.br index 824ae2d32a..bf292c0852 100644 --- a/lib/search/indexes/github-docs-ghae-ja.json.br +++ b/lib/search/indexes/github-docs-ghae-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:268c83bb05bad0ff7985fd36f480a3b94fb61de3435101e57c7b986b297daaac -size 3599940 +oid sha256:76cf757be67bc212a521946c0f859065bd503b92c42b11ff51991c432aaa35ad +size 3609521 diff --git a/lib/search/indexes/github-docs-ghae-pt-records.json.br b/lib/search/indexes/github-docs-ghae-pt-records.json.br index 6155de2d06..4b99ea5163 100644 --- a/lib/search/indexes/github-docs-ghae-pt-records.json.br +++ b/lib/search/indexes/github-docs-ghae-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:37eb22821e2857398313e1adc0bbfae90129d729487bffb3c36b0c432a01d079 -size 604901 +oid sha256:e6fdb8e44f18ec9a0909c4070032b9a9427ba96577e3004fbbf45e927ac91a4d +size 605793 diff --git a/lib/search/indexes/github-docs-ghae-pt.json.br b/lib/search/indexes/github-docs-ghae-pt.json.br index b25188f7ac..b882bb1af7 100644 --- a/lib/search/indexes/github-docs-ghae-pt.json.br +++ b/lib/search/indexes/github-docs-ghae-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:0b57508a6560f6e008fa39f4bc22e0ab22117f3515e4fca972f5f0e3ff2933fd -size 2432291 +oid sha256:d0f1caa66b122e546f16297c24726551e1623f5dfd15ecd50474044967553faa +size 2433891 diff --git a/lib/search/indexes/github-docs-ghec-cn-records.json.br b/lib/search/indexes/github-docs-ghec-cn-records.json.br index 01d3d67fcf..690ace125b 100644 --- a/lib/search/indexes/github-docs-ghec-cn-records.json.br +++ b/lib/search/indexes/github-docs-ghec-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1095a9713e4b56dc94cca86ad3850355114919befdaac14bc8c4f3a34c94d02c -size 1010190 +oid sha256:e06598d19f1cd6eb7dddd47dc7b42f3aa4faa3b93af6fe42b631f13257eb9d2c +size 1011569 diff --git a/lib/search/indexes/github-docs-ghec-cn.json.br b/lib/search/indexes/github-docs-ghec-cn.json.br index ce80227365..02bf1f57b1 100644 --- a/lib/search/indexes/github-docs-ghec-cn.json.br +++ b/lib/search/indexes/github-docs-ghec-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:943437ae4665978c57844057919b2ee01f65d8768b0fb2cf2a54e31ba58a8b60 -size 1992316 +oid sha256:40e4987a4e8baf0683430108413879228ad0c28b30381cafbb616fed240ffd74 +size 2020031 diff --git a/lib/search/indexes/github-docs-ghec-en-records.json.br b/lib/search/indexes/github-docs-ghec-en-records.json.br index 281c02c0de..d26096e0e6 100644 --- a/lib/search/indexes/github-docs-ghec-en-records.json.br +++ b/lib/search/indexes/github-docs-ghec-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3f86fc1fa43ca779237d94c73866e999fe570b1775498630cc95c90095254e4f -size 1377121 +oid sha256:9e532d57505f325923a1e59a71e20c69c25115ed35d99a515d327ad7dac393ba +size 1388952 diff --git a/lib/search/indexes/github-docs-ghec-en.json.br b/lib/search/indexes/github-docs-ghec-en.json.br index f899ae9b28..defdeedd77 100644 --- a/lib/search/indexes/github-docs-ghec-en.json.br +++ b/lib/search/indexes/github-docs-ghec-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:51cfd62cf76f6cb3f59ac3c0d258200296e90879d5d503c53937a21ec7b17d77 -size 5593740 +oid sha256:d1f07c7d82219d91105ab2db676ba439d36ce9a7ae62ebffdaa0653ad9abe80f +size 5638821 diff --git a/lib/search/indexes/github-docs-ghec-es-records.json.br b/lib/search/indexes/github-docs-ghec-es-records.json.br index 0029e521b9..20223e94da 100644 --- a/lib/search/indexes/github-docs-ghec-es-records.json.br +++ b/lib/search/indexes/github-docs-ghec-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:27b3e014c0a0bc9b776c451c500111df669b3abf635bbbd88fbeebc53be860bb -size 934387 +oid sha256:df0c75425173901d7dd95e2e7c13ca318952d61dcf73d032180e74c4ed2ddf55 +size 936009 diff --git a/lib/search/indexes/github-docs-ghec-es.json.br b/lib/search/indexes/github-docs-ghec-es.json.br index d2701ec91b..8b2f77d2d2 100644 --- a/lib/search/indexes/github-docs-ghec-es.json.br +++ b/lib/search/indexes/github-docs-ghec-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5204a9e95f31df3915cf9452671e9eb7fff6f400f123c272056d26b23d89c938 -size 4022438 +oid sha256:bdc84daea64883ea0c24a5b96b6a65705d3faa759f0328e9e65a456781b09ddc +size 4033213 diff --git a/lib/search/indexes/github-docs-ghec-ja-records.json.br b/lib/search/indexes/github-docs-ghec-ja-records.json.br index 2f54632d0b..0c8f0c7f6e 100644 --- a/lib/search/indexes/github-docs-ghec-ja-records.json.br +++ b/lib/search/indexes/github-docs-ghec-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4490ef019d6eb7ff71e850f9e70d88d8cd18b75d27b1cb1462d6765c17628fbb -size 1020799 +oid sha256:b724e065e9965baf447028096d2b14a18e4bbdfa132d4adca6990b3ca49a6fd3 +size 1026150 diff --git a/lib/search/indexes/github-docs-ghec-ja.json.br b/lib/search/indexes/github-docs-ghec-ja.json.br index b37528c434..c35603e05a 100644 --- a/lib/search/indexes/github-docs-ghec-ja.json.br +++ b/lib/search/indexes/github-docs-ghec-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b16c76f783da0a7791c7f0b5e6ce5b650dec64a42b71558afee1a956637470e4 -size 5701088 +oid sha256:4613a3880ade14eab71d5ca6250f976cc788c29e7e94d2be38b7fd82b6877517 +size 5733786 diff --git a/lib/search/indexes/github-docs-ghec-pt-records.json.br b/lib/search/indexes/github-docs-ghec-pt-records.json.br index 749874d070..4a195290d7 100644 --- a/lib/search/indexes/github-docs-ghec-pt-records.json.br +++ b/lib/search/indexes/github-docs-ghec-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1215b84a66180d4a46c6e3f7c2c65bf1ecb0a54633cf218154965368aced3700 -size 921372 +oid sha256:26b6c3db1f002a84e029389befe13ff992234f8c9e35e1e43ec386509d187329 +size 923487 diff --git a/lib/search/indexes/github-docs-ghec-pt.json.br b/lib/search/indexes/github-docs-ghec-pt.json.br index f693fb45bf..75698c76ba 100644 --- a/lib/search/indexes/github-docs-ghec-pt.json.br +++ b/lib/search/indexes/github-docs-ghec-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:09c2c25cdb5f6b78d014f1f1d0f2142e7741e6e22e9a4860b930ac2eada5df53 -size 3914161 +oid sha256:7679451fbd0cf68af7fa6b57744748feddf94439bd1d63e6c2c9c608ba818076 +size 3922369 diff --git a/middleware/anchor-redirect.js b/middleware/anchor-redirect.js index 92300fd624..0bc4b2c2d6 100644 --- a/middleware/anchor-redirect.js +++ b/middleware/anchor-redirect.js @@ -1,5 +1,7 @@ import express from 'express' + import { readCompressedJsonFileFallbackLazily } from '../lib/read-json-file.js' +import { defaultCacheControl } from './cache-control.js' const clientSideRestAPIRedirects = readCompressedJsonFileFallbackLazily( './lib/redirects/static/client-side-rest-api-redirects.json' @@ -15,6 +17,9 @@ router.get('/', function redirects(req, res, next) { if (!req.query.hash) { return res.status(400).send("Missing 'hash' query string") } + + defaultCacheControl(res) + const redirectFrom = `${req.query.path}#${req.query.hash}` res.status(200).send({ to: clientSideRestAPIRedirects()[redirectFrom] } || null) }) diff --git a/middleware/api/es-search.js b/middleware/api/es-search.js index a5e983c814..e42d006843 100644 --- a/middleware/api/es-search.js +++ b/middleware/api/es-search.js @@ -1,6 +1,9 @@ import { Client } from '@elastic/elasticsearch' -const ELASTICSEARCH_URL = process.env.ELASTICSEARCH_URL || 'http://localhost:9200' +// The reason this is exported is so the middleware endpoints can +// find out if the environment variable has been set (and is truthy) +// before attempting to call the main function in this file. +export const ELASTICSEARCH_URL = process.env.ELASTICSEARCH_URL const isDevMode = process.env.NODE_ENV !== 'production' diff --git a/middleware/api/search.js b/middleware/api/search.js index 65456bbbb2..84b09d0245 100644 --- a/middleware/api/search.js +++ b/middleware/api/search.js @@ -3,9 +3,9 @@ import express from 'express' import searchVersions from '../../lib/search/versions.js' import languages from '../../lib/languages.js' import { allVersions } from '../../lib/all-versions.js' -import { cacheControlFactory } from '../cache-control.js' +import { defaultCacheControl } from '../cache-control.js' import catchMiddlewareError from '../catch-middleware-error.js' -import { getSearchResults } from './es-search.js' +import { getSearchResults, ELASTICSEARCH_URL } from './es-search.js' // Used by the legacy search const versions = new Set(Object.values(searchVersions)) @@ -13,8 +13,6 @@ const languagesSet = new Set(Object.keys(languages)) const router = express.Router() -const cacheControl = cacheControlFactory(60 * 60 * 24) - const DEFAULT_SIZE = 10 const MAX_SIZE = 50 // How much you return has a strong impact on performance const DEFAULT_PAGE = 1 @@ -45,14 +43,48 @@ const legacyEnterpriseServerVersions = Object.fromEntries( }) ) +function getIndexPrefix() { + // This logic is mirrored in the scripts we use before running tests + // In particular, see the `index-test-fixtures` npm script. + // That's expected to be run before CI and local jest testing. + // The reason we have a deliberately different index name (by prefix) + // for testing compared to regular operation is to make it convenient + // for engineers working on local manual testing *and* automated + // testing without have to re-index different content (e.g. fixtures + // vs real content) on the same index name. + if (process.env.NODE_ENV === 'test') return 'tests_' + + return '' +} + function convertLegacyVersionName(version) { // In the olden days we used to use `?version=3.5&...` but we decided // that's ambiguous and it should be `ghes-3.5` instead. return legacyEnterpriseServerVersions[version] || version } +function notConfiguredMiddleware(req, res, next) { + if (!ELASTICSEARCH_URL) { + if (process.env.NODE_ENV === 'production') { + // Temporarily, this is OKish. The Docs Engineering team is + // currently working on setting up an Elasticsearch cloud + // instance that we can use. We don't currently have that, + // but this code is running in production. We just don't want + // to unnecessarily throw errors when it's actually a known thing. + return res.status(500).send('ELASTICSEARCH_URL not been set up yet') + } + throw new Error( + 'process.env.ELASTICSEARCH_URL is not set. ' + + "If you're working on this locally, add `ELASTICSEARCH_URL=http://localhost:9200` in your .env file" + ) + } + + return next() +} + router.get( '/legacy', + notConfiguredMiddleware, catchMiddlewareError(async function legacySearch(req, res, next) { const { query, version, language, filters, limit: limit_ } = req.query if (filters) { @@ -69,7 +101,10 @@ router.get( return res.status(200).json([]) } - const indexName = `github-docs-${convertLegacyVersionName(version)}-${language}` + const indexName = `${getIndexPrefix()}github-docs-${convertLegacyVersionName( + version + )}-${language}` + const hits = [] try { const searchResults = await getSearchResults({ @@ -117,7 +152,7 @@ router.get( } }) if (process.env.NODE_ENV !== 'development') { - cacheControl(res) + defaultCacheControl(res) } res.setHeader('x-search-legacy', 'yes') @@ -187,7 +222,7 @@ const validationMiddleware = (req, res, next) => { const version = versionAliases[search.version] || allVersions[search.version].miscVersionName - search.indexName = `github-docs-${version}-${search.language}` // github-docs-ghes-3.5-en + search.indexName = `${getIndexPrefix()}github-docs-${version}-${search.language}` // github-docs-ghes-3.5-en req.search = search return next() @@ -196,6 +231,7 @@ const validationMiddleware = (req, res, next) => { router.get( '/v1', validationMiddleware, + notConfiguredMiddleware, catchMiddlewareError(async function search(req, res, next) { const { indexName, query, page, size, debug, sort } = req.search const { meta, hits } = await getSearchResults({ indexName, query, page, size, debug, sort }) @@ -206,7 +242,7 @@ router.get( // So the only distinguishing key is the request URL. // Because of that, it's safe to allow the reverse proxy (a.k.a the CDN) // cache and hold on to this. - cacheControl(res) + defaultCacheControl(res) } // The v1 version of the output matches perfectly what comes out diff --git a/middleware/archived-enterprise-versions-assets.js b/middleware/archived-enterprise-versions-assets.js index 2b36d17c5e..d905ecdc3d 100644 --- a/middleware/archived-enterprise-versions-assets.js +++ b/middleware/archived-enterprise-versions-assets.js @@ -4,9 +4,10 @@ import got from 'got' import patterns from '../lib/patterns.js' import isArchivedVersion from '../lib/is-archived-version.js' +import { setFastlySurrogateKey, SURROGATE_ENUMS } from './set-fastly-surrogate-key.js' import { cacheControlFactory } from './cache-control.js' -const cacheControl = cacheControlFactory(60 * 60 * 24) +const cacheControl = cacheControlFactory(60 * 60 * 24 * 365) // This module handles requests for the CSS and JS assets for // deprecated GitHub Enterprise versions by routing them to static content in @@ -58,8 +59,12 @@ export default async function archivedEnterpriseVersionsAssets(req, res, next) { res.set('content-length', r.headers['content-length']) res.set('x-is-archived', 'true') res.set('x-robots-tag', 'noindex') - // Allow the browser and Fastly to cache these + + // This cache configuration should match what we do for archived + // enterprise version URLs that are not assets. cacheControl(res) + setFastlySurrogateKey(res, SURROGATE_ENUMS.MANUAL) + return res.send(r.body) } catch (err) { // Primarly for the developers working on tests that mock diff --git a/middleware/archived-enterprise-versions.js b/middleware/archived-enterprise-versions.js index 6471f458db..e14d8bb70d 100644 --- a/middleware/archived-enterprise-versions.js +++ b/middleware/archived-enterprise-versions.js @@ -69,8 +69,11 @@ const cacheAggressively = (res) => { const retryConfiguration = { limit: 3 } // According to our Datadog metrics, the *average* time for the // the 'archive_enterprise_proxy' metric is ~70ms (excluding spikes) -// which much less than 500ms. -const timeoutConfiguration = { response: 500 } +// which much less than 1500ms. +// We have observed errors of timeout, in production, when it was +// set to 500ms. Let's try to be very conservative here to avoid +// unnecessary error reporting. +const timeoutConfiguration = { response: 1500 } async function getRemoteJSON(url, config) { if (_getRemoteJSONCache.has(url)) { diff --git a/middleware/cache-control.js b/middleware/cache-control.js index e9100c1c29..8b2aa91183 100644 --- a/middleware/cache-control.js +++ b/middleware/cache-control.js @@ -38,3 +38,20 @@ export function cacheControlFactory( res.set(key, directives) } } + +// 24 hours for CDN, we soft-purge this with each deploy +const defaultCDNCacheControl = cacheControlFactory(60 * 60 * 24, { + key: 'surrogate-control', +}) + +// Shorter because between deployments and their (sort) purges, +// we don't want the browser to overly cache because with them we +// can't control purging. +const defaultBrowserCacheControl = cacheControlFactory(60) + +// A general default configuration that is useful to almost all responses +// that can be cached. +export function defaultCacheControl(res) { + defaultCDNCacheControl(res) + defaultBrowserCacheControl(res) +} diff --git a/middleware/contextualizers/breadcrumbs.js b/middleware/contextualizers/breadcrumbs.js index a707cd0a9b..ef4195c4c9 100644 --- a/middleware/contextualizers/breadcrumbs.js +++ b/middleware/contextualizers/breadcrumbs.js @@ -17,6 +17,8 @@ export default async function breadcrumbs(req, res, next) { return next() } +const earlyAccessExceptions = ['insights', 'enterprise-importer'] + async function getBreadcrumbs(req, isEarlyAccess = false) { const crumbs = [] const { currentPath, currentVersion } = req.context @@ -30,11 +32,11 @@ async function getBreadcrumbs(req, isEarlyAccess = false) { // top-level like "/github" cutoff++ - // The only exception to this rule is for the - // /{version}/early-access/insights/... URLs because they're a + // There are a few exceptions to this rule for the + // /{version}/early-access//... URLs because they're a // bit different. - // If there are more known exceptions, extend this conditional. - if (!split.includes('insights')) { + // If there are more known exceptions, add them to the array above. + if (!earlyAccessExceptions.some((product) => split.includes(product))) { cutoff++ } diff --git a/middleware/contextualizers/generic-toc.js b/middleware/contextualizers/generic-toc.js index 595e04f1b8..fb64cbfd26 100644 --- a/middleware/contextualizers/generic-toc.js +++ b/middleware/contextualizers/generic-toc.js @@ -24,8 +24,12 @@ export default async function genericToc(req, res, next) { mapTopic: 'flat', } + // Frontmatter can optionally be set on an Early Access product to show hidden child items. + // If so, this is a special case where we want to override the flat tocType and use a nested type. + const earlyAccessToc = req.context.page.earlyAccessToc + // Find the current TOC type based on the current document type. - const currentTocType = tocTypes[req.context.page.documentType] + const currentTocType = earlyAccessToc ? 'nested' : tocTypes[req.context.page.documentType] // Find the part of the site tree that corresponds to the current path. const treePage = findPageInSiteTree( @@ -34,7 +38,7 @@ export default async function genericToc(req, res, next) { req.pagePath ) - // Only include hidden child items on a TOC page if it's an Early Access category or + // By default, only include hidden child items on a TOC page if it's an Early Access category or // map topic page, not a product or 'articles' fake cagegory page (e.g., /early-access/github/articles). // This is because we don't want entire EA product TOCs to be publicly browseable, but anything at the category // or below level is fair game because that content is scoped to specific features. @@ -43,7 +47,8 @@ export default async function genericToc(req, res, next) { const isEarlyAccess = req.context.currentPath.includes('/early-access/') const isArticlesCategory = req.context.currentPath.endsWith('/articles') - req.context.showHiddenTocItems = isCategoryOrMapTopic && isEarlyAccess && !isArticlesCategory + req.context.showHiddenTocItems = + earlyAccessToc || (isCategoryOrMapTopic && isEarlyAccess && !isArticlesCategory) // Conditionally run getTocItems() recursively. let isRecursive diff --git a/middleware/render-page.js b/middleware/render-page.js index 6f219eaf24..9edce60fba 100644 --- a/middleware/render-page.js +++ b/middleware/render-page.js @@ -1,5 +1,6 @@ import { get } from 'lodash-es' +import FailBot from '../lib/failbot.js' import patterns from '../lib/patterns.js' import getMiniTocItems from '../lib/get-mini-toc-items.js' import Page from '../lib/page.js' @@ -7,12 +8,7 @@ import statsd from '../lib/statsd.js' import { allVersions } from '../lib/all-versions.js' import { isConnectionDropped } from './halt-on-dropped-connection.js' import { nextApp, nextHandleRequest } from './next.js' -import { cacheControlFactory } from './cache-control.js' - -const browserCacheControl = cacheControlFactory(60) // 1 minute for browsers -const cdnCacheControl = cacheControlFactory(60 * 60 * 24, { - key: 'surrogate-control', -}) // 24 hours for CDN, we purge this with each deploy +import { defaultCacheControl } from './cache-control.js' async function buildRenderedPage(req) { const { context } = req @@ -40,10 +36,15 @@ async function buildMiniTocItems(req) { export default async function renderPage(req, res, next) { const { context } = req + + // This is a contextualizing the request so that when this `req` is + // ultimately passed into the `Error.getInitialProps` function, + // which NextJS executes at runtime on errors, so that we can + // from there send the error to Failbot. + req.FailBot = FailBot + const { page } = context const path = req.pagePath || req.path - browserCacheControl(res) - cdnCacheControl(res) // render a 404 page if (!page) { @@ -122,5 +123,7 @@ export default async function renderPage(req, res, next) { } } + defaultCacheControl(res) + return nextHandleRequest(req, res) } diff --git a/next.config.js b/next.config.js index e427ea4c61..50aa6fcec0 100644 --- a/next.config.js +++ b/next.config.js @@ -1,6 +1,9 @@ import fs from 'fs' -import frontmatter from 'gray-matter' import path from 'path' + +import frontmatter from 'gray-matter' +import { languageKeys } from './lib/languages.js' + const homepage = path.posix.join(process.cwd(), 'content/index.md') const { data } = frontmatter(fs.readFileSync(homepage, 'utf8')) const productIds = data.children @@ -15,8 +18,7 @@ export default { ignoreDuringBuilds: true, }, i18n: { - // locales: Object.values(languages).map(({ code }) => code), - locales: ['en', 'cn', 'ja', 'es', 'pt'], + locales: languageKeys, defaultLocale: 'en', }, sassOptions: { diff --git a/package-lock.json b/package-lock.json index fc75eabe25..3a7fef6278 100644 --- a/package-lock.json +++ b/package-lock.json @@ -53,7 +53,7 @@ "mdast-util-to-string": "^3.1.0", "morgan": "^1.10.0", "msgpack5rpc": "^1.1.0", - "next": "12.2.5", + "next": "12.2.4", "parse5": "7.0.0", "port-used": "^2.0.8", "react": "^17.0.2", @@ -97,7 +97,7 @@ "@babel/preset-env": "^7.18.2", "@graphql-inspector/core": "^3.1.2", "@graphql-tools/load": "^7.5.14", - "@jest/globals": "^28.1.1", + "@jest/globals": "29.0.0", "@octokit/graphql": "4.8.0", "@octokit/rest": "^18.12.0", "@types/github-slugger": "^1.3.0", @@ -134,13 +134,13 @@ "http-status-code": "^2.1.0", "husky": "^8.0.1", "japanese-characters": "^1.1.0", - "jest": "28.1.3", + "jest": "29.0.0", "jest-environment-puppeteer": "^5.0.4", "jest-fail-on-console": "^2.4.2", "jest-github-actions-reporter": "^1.0.3", "jest-slow-test-reporter": "^1.0.0", "kill-port": "2.0.0", - "linkinator": "^3.1.0", + "linkinator": "4.0.2", "lint-staged": "^13.0.1", "make-promises-safe": "^5.1.0", "minimatch": "^5.1.0", @@ -535,9 +535,9 @@ } }, "node_modules/@babel/helper-plugin-utils": { - "version": "7.17.12", - "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.17.12.tgz", - "integrity": "sha512-JDkf04mqtN3y4iAbO1hv9U2ARpPyPL1zqyWs/2WG1pgSq9llHFjStX5jdxb84himgJm+8Ng+x0oiWF/nw/XQKA==", + "version": "7.18.9", + "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.18.9.tgz", + "integrity": "sha512-aBXPT3bmtLryXaoJLyYPXPlSD4p1ld9aYeR+sJNOZjJJGiOpb+fKfh3NkcCu7J54nUJwCERPBExCCpyCOHnu/w==", "dev": true, "engines": { "node": ">=6.9.0" @@ -1118,6 +1118,21 @@ "@babel/core": "^7.0.0-0" } }, + "node_modules/@babel/plugin-syntax-jsx": { + "version": "7.18.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.18.6.tgz", + "integrity": "sha512-6mmljtAedFGTWu2p/8WIORGwy+61PLgOMPOdazc7YoJ9ZCWUyFy3A6CpPkRKLKD1ToAesxX8KGEViAiLo9N+7Q==", + "dev": true, + "dependencies": { + "@babel/helper-plugin-utils": "^7.18.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, "node_modules/@babel/plugin-syntax-logical-assignment-operators": { "version": "7.10.4", "dev": true, @@ -1214,12 +1229,12 @@ } }, "node_modules/@babel/plugin-syntax-typescript": { - "version": "7.17.12", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.17.12.tgz", - "integrity": "sha512-TYY0SXFiO31YXtNg3HtFwNJHjLsAyIIhAhNWkQ5whPPS7HWUFlg9z0Ta4qAQNjQbP1wsSt/oKkmZ/4/WWdMUpw==", + "version": "7.18.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.18.6.tgz", + "integrity": "sha512-mAWAuq4rvOepWCBid55JuRNvpTNf2UGVgoz4JV0fXEKolsVZDzsa4NqCef758WZJj/GDu0gVGItjKFiClTAmZA==", "dev": true, "dependencies": { - "@babel/helper-plugin-utils": "^7.17.12" + "@babel/helper-plugin-utils": "^7.18.6" }, "engines": { "node": ">=6.9.0" @@ -2363,29 +2378,29 @@ } }, "node_modules/@jest/console": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/console/-/console-28.1.3.tgz", - "integrity": "sha512-QPAkP5EwKdK/bxIr6C1I4Vs0rm2nHiANzj/Z5X2JQkrZo6IqvC4ldZ9K95tF0HdidhA8Bo6egxSzUFPYKcEXLw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/console/-/console-29.0.0.tgz", + "integrity": "sha512-rHsKEqT2Kx73PqO9qIOdwg0Grd6Y3COyqNpi5SKRI0qXgmlqXkOczQMfIb8I0Gdnc9/kaMj6cTnBGLyBA03Xrg==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", - "jest-message-util": "^28.1.3", - "jest-util": "^28.1.3", + "jest-message-util": "^29.0.0", + "jest-util": "^29.0.0", "slash": "^3.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/console/node_modules/@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -2393,13 +2408,13 @@ "chalk": "^4.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/console/node_modules/@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "dependencies": { "@types/yargs-parser": "*" @@ -2422,32 +2437,32 @@ } }, "node_modules/@jest/console/node_modules/jest-message-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", - "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.0.0.tgz", + "integrity": "sha512-4U0RdNV0TBTgVGzEchjryEpq4sqLO3gUQT7TEIbO5+q0K5MuiofOPcXk4GLpWviWByMRJjliQNMuzJ4YGT+oGQ==", "dev": true, "dependencies": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/console/node_modules/jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -2455,22 +2470,21 @@ "picomatch": "^2.2.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/console/node_modules/pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/console/node_modules/pretty-format/node_modules/ansi-styles": { @@ -2501,43 +2515,42 @@ } }, "node_modules/@jest/core": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/core/-/core-28.1.3.tgz", - "integrity": "sha512-CIKBrlaKOzA7YG19BEqCw3SLIsEwjZkeJzf5bdooVnW4bH5cktqe3JX+G2YV1aK5vP8N9na1IGWFzYaTp6k6NA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/core/-/core-29.0.0.tgz", + "integrity": "sha512-9qljprspjQwbmnq3Wv9d/M6/ejMdWs1uAAljQAX9QsjJ1SlSByXw1mRA9UpR2BP9TxLLwEembbm0ykrT//2STg==", "dev": true, "dependencies": { - "@jest/console": "^28.1.3", - "@jest/reporters": "^28.1.3", - "@jest/test-result": "^28.1.3", - "@jest/transform": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/console": "^29.0.0", + "@jest/reporters": "^29.0.0", + "@jest/test-result": "^29.0.0", + "@jest/transform": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", "ansi-escapes": "^4.2.1", "chalk": "^4.0.0", "ci-info": "^3.2.0", "exit": "^0.1.2", "graceful-fs": "^4.2.9", - "jest-changed-files": "^28.1.3", - "jest-config": "^28.1.3", - "jest-haste-map": "^28.1.3", - "jest-message-util": "^28.1.3", - "jest-regex-util": "^28.0.2", - "jest-resolve": "^28.1.3", - "jest-resolve-dependencies": "^28.1.3", - "jest-runner": "^28.1.3", - "jest-runtime": "^28.1.3", - "jest-snapshot": "^28.1.3", - "jest-util": "^28.1.3", - "jest-validate": "^28.1.3", - "jest-watcher": "^28.1.3", + "jest-changed-files": "^29.0.0", + "jest-config": "^29.0.0", + "jest-haste-map": "^29.0.0", + "jest-message-util": "^29.0.0", + "jest-regex-util": "^29.0.0", + "jest-resolve": "^29.0.0", + "jest-resolve-dependencies": "^29.0.0", + "jest-runner": "^29.0.0", + "jest-runtime": "^29.0.0", + "jest-snapshot": "^29.0.0", + "jest-util": "^29.0.0", + "jest-validate": "^29.0.0", + "jest-watcher": "^29.0.0", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", - "rimraf": "^3.0.0", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "strip-ansi": "^6.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" }, "peerDependencies": { "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" @@ -2549,12 +2562,12 @@ } }, "node_modules/@jest/core/node_modules/@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -2562,13 +2575,13 @@ "chalk": "^4.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/core/node_modules/@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "dependencies": { "@types/yargs-parser": "*" @@ -2591,32 +2604,32 @@ } }, "node_modules/@jest/core/node_modules/jest-message-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", - "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.0.0.tgz", + "integrity": "sha512-4U0RdNV0TBTgVGzEchjryEpq4sqLO3gUQT7TEIbO5+q0K5MuiofOPcXk4GLpWviWByMRJjliQNMuzJ4YGT+oGQ==", "dev": true, "dependencies": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/core/node_modules/jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -2624,22 +2637,21 @@ "picomatch": "^2.2.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/core/node_modules/pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/core/node_modules/pretty-format/node_modules/ansi-styles": { @@ -2696,28 +2708,28 @@ } }, "node_modules/@jest/expect": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/expect/-/expect-28.1.3.tgz", - "integrity": "sha512-lzc8CpUbSoE4dqT0U+g1qODQjBRHPpCPXissXD4mS9+sWQdmmpeJ9zSH1rS1HEkrsMN0fb7nKrJ9giAR1d3wBw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/expect/-/expect-29.0.0.tgz", + "integrity": "sha512-X2S5NpZOeXXDGBLvU/4K1nAD5iIz6/9Gs041wToI0FiX3glh/aEGGsVv3+SxKddYIb6Ei+ZbqzJmfRzQ7nwPlQ==", "dev": true, "dependencies": { - "expect": "^28.1.3", - "jest-snapshot": "^28.1.3" + "expect": "^29.0.0", + "jest-snapshot": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/expect-utils": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/expect-utils/-/expect-utils-28.1.3.tgz", - "integrity": "sha512-wvbi9LUrHJLn3NlDW6wF2hvIMtd4JUl2QNVrjq+IBSHirgfrR3o9RnVtxzdEGO2n9JyIWwHnLfby5KzqBGg2YA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/expect-utils/-/expect-utils-29.0.0.tgz", + "integrity": "sha512-odQ+cjUpui6++a9Ua/oWn7CG0Af+EZe9weWZbfUQHTg7C3K9PCb0AnD4X7nyAe4WjfeZmVVyG5SJELMQaUbCtg==", "dev": true, "dependencies": { - "jest-get-type": "^28.0.2" + "jest-get-type": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/fake-timers": { @@ -2737,58 +2749,59 @@ } }, "node_modules/@jest/globals": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/globals/-/globals-28.1.3.tgz", - "integrity": "sha512-XFU4P4phyryCXu1pbcqMO0GSQcYe1IsalYCDzRNyhetyeyxMcIxa11qPNDpVNLeretItNqEmYYQn1UYz/5x1NA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/globals/-/globals-29.0.0.tgz", + "integrity": "sha512-ZHQMh6BZtabbikh9wkuPpVQmPHEpc4EgOaY/UJNM6hHHA5HRmiP5rH54M8267nkGscuqM5KpWP+zAZ4XEOXZag==", "dev": true, "dependencies": { - "@jest/environment": "^28.1.3", - "@jest/expect": "^28.1.3", - "@jest/types": "^28.1.3" + "@jest/environment": "^29.0.0", + "@jest/expect": "^29.0.0", + "@jest/types": "^29.0.0", + "jest-mock": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/globals/node_modules/@jest/environment": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-28.1.3.tgz", - "integrity": "sha512-1bf40cMFTEkKyEf585R9Iz1WayDjHoHqvts0XFYEqyKM3cFWDpeMoqKKTAF9LSYQModPUlh8FKptoM2YcMWAXA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-29.0.0.tgz", + "integrity": "sha512-ZHLvUENMAnwXowtyhmPRS0QLCXM4TS0ZfuiSR4QfRsJVN5lG4KdBDvI9kHJe/21vrgzPVOkvI7IBnkyPFCbV7g==", "dev": true, "dependencies": { - "@jest/fake-timers": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/fake-timers": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", - "jest-mock": "^28.1.3" + "jest-mock": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/globals/node_modules/@jest/fake-timers": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-28.1.3.tgz", - "integrity": "sha512-D/wOkL2POHv52h+ok5Oj/1gOG9HSywdoPtFsRCUmlCILXNn5eIWmcnd3DIiWlJnpGvQtmajqBP95Ei0EimxfLw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-29.0.0.tgz", + "integrity": "sha512-4tqH5fT9H0+Ms3Z1HLZ/JfpzJluep2Zo3uuj0KPyu6IIyYSHCDfkXuiBQNWUGvumZDLQ2Si03cC7Gq0r73VgVg==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@sinonjs/fake-timers": "^9.1.2", "@types/node": "*", - "jest-message-util": "^28.1.3", - "jest-mock": "^28.1.3", - "jest-util": "^28.1.3" + "jest-message-util": "^29.0.0", + "jest-mock": "^29.0.0", + "jest-util": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/globals/node_modules/@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -2796,7 +2809,7 @@ "chalk": "^4.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/globals/node_modules/@sinonjs/fake-timers": { @@ -2809,9 +2822,9 @@ } }, "node_modules/@jest/globals/node_modules/@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "dependencies": { "@types/yargs-parser": "*" @@ -2834,45 +2847,45 @@ } }, "node_modules/@jest/globals/node_modules/jest-message-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", - "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.0.0.tgz", + "integrity": "sha512-4U0RdNV0TBTgVGzEchjryEpq4sqLO3gUQT7TEIbO5+q0K5MuiofOPcXk4GLpWviWByMRJjliQNMuzJ4YGT+oGQ==", "dev": true, "dependencies": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/globals/node_modules/jest-mock": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-28.1.3.tgz", - "integrity": "sha512-o3J2jr6dMMWYVH4Lh/NKmDXdosrsJgi4AviS8oXLujcjpCMBb1FMsblDnOXKZKfSiHLxYub1eS0IHuRXsio9eA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-29.0.0.tgz", + "integrity": "sha512-0AWznVt415KMCxcJPaE2+tWaruw0w8aRrKH1Y/NZUx3+Pd9f20jQjUR82iHqGSuYS4EOHL9uI8SjAhJk+ET91g==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/globals/node_modules/jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -2880,22 +2893,21 @@ "picomatch": "^2.2.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/globals/node_modules/pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/globals/node_modules/pretty-format/node_modules/ansi-styles": { @@ -2926,17 +2938,17 @@ } }, "node_modules/@jest/reporters": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/reporters/-/reporters-28.1.3.tgz", - "integrity": "sha512-JuAy7wkxQZVNU/V6g9xKzCGC5LVXx9FDcABKsSXp5MiKPEE2144a/vXTEDoyzjUpZKfVwp08Wqg5A4WfTMAzjg==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/reporters/-/reporters-29.0.0.tgz", + "integrity": "sha512-6ZFLlHQwncULTucAKWeGJLGPvzjgC/0gFmxJi/LgU9G1v498r/RcWQiZBPqhJcSvpWGTCaqjvUGmPCLtrUpubw==", "dev": true, "dependencies": { "@bcoe/v8-coverage": "^0.2.3", - "@jest/console": "^28.1.3", - "@jest/test-result": "^28.1.3", - "@jest/transform": "^28.1.3", - "@jest/types": "^28.1.3", - "@jridgewell/trace-mapping": "^0.3.13", + "@jest/console": "^29.0.0", + "@jest/test-result": "^29.0.0", + "@jest/transform": "^29.0.0", + "@jest/types": "^29.0.0", + "@jridgewell/trace-mapping": "^0.3.15", "@types/node": "*", "chalk": "^4.0.0", "collect-v8-coverage": "^1.0.0", @@ -2948,9 +2960,9 @@ "istanbul-lib-report": "^3.0.0", "istanbul-lib-source-maps": "^4.0.0", "istanbul-reports": "^3.1.3", - "jest-message-util": "^28.1.3", - "jest-util": "^28.1.3", - "jest-worker": "^28.1.3", + "jest-message-util": "^29.0.0", + "jest-util": "^29.0.0", + "jest-worker": "^29.0.0", "slash": "^3.0.0", "string-length": "^4.0.1", "strip-ansi": "^6.0.0", @@ -2958,7 +2970,7 @@ "v8-to-istanbul": "^9.0.1" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" }, "peerDependencies": { "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" @@ -2970,12 +2982,12 @@ } }, "node_modules/@jest/reporters/node_modules/@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -2983,13 +2995,13 @@ "chalk": "^4.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/reporters/node_modules/@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "dependencies": { "@types/yargs-parser": "*" @@ -3042,32 +3054,32 @@ } }, "node_modules/@jest/reporters/node_modules/jest-message-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", - "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.0.0.tgz", + "integrity": "sha512-4U0RdNV0TBTgVGzEchjryEpq4sqLO3gUQT7TEIbO5+q0K5MuiofOPcXk4GLpWviWByMRJjliQNMuzJ4YGT+oGQ==", "dev": true, "dependencies": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/reporters/node_modules/jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -3075,13 +3087,13 @@ "picomatch": "^2.2.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/reporters/node_modules/jest-worker": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-28.1.3.tgz", - "integrity": "sha512-CqRA220YV/6jCo8VWvAt1KKx6eek1VIHMPeLEbpcfSfkEeWyBNppynM/o6q+Wmw+sOhos2ml34wZbSX3G13//g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-29.0.0.tgz", + "integrity": "sha512-2t9Panx3F9N1wAvRuZT7xLEptRFc1C5G90DOHniIGz1JIgF9uhd5u8jNBsc7wN63lhnaiLeVLnNx21wT7OVFEQ==", "dev": true, "dependencies": { "@types/node": "*", @@ -3089,7 +3101,7 @@ "supports-color": "^8.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/reporters/node_modules/jest-worker/node_modules/supports-color": { @@ -3120,18 +3132,17 @@ } }, "node_modules/@jest/reporters/node_modules/pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/reporters/node_modules/pretty-format/node_modules/ansi-styles": { @@ -3174,53 +3185,53 @@ } }, "node_modules/@jest/schemas": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-28.1.3.tgz", - "integrity": "sha512-/l/VWsdt/aBXgjshLWOFyFt3IVdYypu5y2Wn2rOO1un6nkqIn8SLXzgIMYXFyYsRWDyF5EthmKJMIdJvk08grg==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-29.0.0.tgz", + "integrity": "sha512-3Ab5HgYIIAnS0HjqJHQYZS+zXc4tUmTmBH3z83ajI6afXp8X3ZtdLX+nXx+I7LNkJD7uN9LAVhgnjDgZa2z0kA==", "dev": true, "dependencies": { "@sinclair/typebox": "^0.24.1" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/source-map": { - "version": "28.1.2", - "resolved": "https://registry.npmjs.org/@jest/source-map/-/source-map-28.1.2.tgz", - "integrity": "sha512-cV8Lx3BeStJb8ipPHnqVw/IM2VCMWO3crWZzYodSIkxXnRcXJipCdx1JCK0K5MsJJouZQTH73mzf4vgxRaH9ww==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/source-map/-/source-map-29.0.0.tgz", + "integrity": "sha512-nOr+0EM8GiHf34mq2GcJyz/gYFyLQ2INDhAylrZJ9mMWoW21mLBfZa0BUVPPMxVYrLjeiRe2Z7kWXOGnS0TFhQ==", "dev": true, "dependencies": { - "@jridgewell/trace-mapping": "^0.3.13", + "@jridgewell/trace-mapping": "^0.3.15", "callsites": "^3.0.0", "graceful-fs": "^4.2.9" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/test-result": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/test-result/-/test-result-28.1.3.tgz", - "integrity": "sha512-kZAkxnSE+FqE8YjW8gNuoVkkC9I7S1qmenl8sGcDOLropASP+BkcGKwhXoyqQuGOGeYY0y/ixjrd/iERpEXHNg==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/test-result/-/test-result-29.0.0.tgz", + "integrity": "sha512-mv76j8ILaqOuZAWBGR1/ZSRinN5Q/eEji7kMcvADjd+gQGfn/Py+91nUrVakJT69idC66bvQ7yF24frQpzFKUg==", "dev": true, "dependencies": { - "@jest/console": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/console": "^29.0.0", + "@jest/types": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "collect-v8-coverage": "^1.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/test-result/node_modules/@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -3228,13 +3239,13 @@ "chalk": "^4.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/test-result/node_modules/@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "dependencies": { "@types/yargs-parser": "*" @@ -3257,18 +3268,18 @@ } }, "node_modules/@jest/test-sequencer": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/test-sequencer/-/test-sequencer-28.1.3.tgz", - "integrity": "sha512-NIMPEqqa59MWnDi1kvXXpYbqsfQmSJsIbnd85mdVGkiDfQ9WQQTXOLsvISUfonmnBT+w85WEgneCigEEdHDFxw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/test-sequencer/-/test-sequencer-29.0.0.tgz", + "integrity": "sha512-uL6yX//SUME1c/ucbY365obdsrPjvSoNBwB80WTe+drYL4jf7A87vA2+w4hYwXJEIGQspv5skg3iB/sJSys7ew==", "dev": true, "dependencies": { - "@jest/test-result": "^28.1.3", + "@jest/test-result": "^29.0.0", "graceful-fs": "^4.2.9", - "jest-haste-map": "^28.1.3", + "jest-haste-map": "^29.0.0", "slash": "^3.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/test-sequencer/node_modules/slash": { @@ -3281,38 +3292,38 @@ } }, "node_modules/@jest/transform": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/transform/-/transform-28.1.3.tgz", - "integrity": "sha512-u5dT5di+oFI6hfcLOHGTAfmUxFRrjK+vnaP0kkVow9Md/M7V/MxqQMOz/VV25UZO8pzeA9PjfTpOu6BDuwSPQA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/transform/-/transform-29.0.0.tgz", + "integrity": "sha512-hwyBt8UR5o8GGaphmRqNQwVCctiOR8ncugCp/RlInEZvQ+ysKkS5TFfe5RgeQ0KtKdWByQqn5yA574LLOp3OWw==", "dev": true, "dependencies": { "@babel/core": "^7.11.6", - "@jest/types": "^28.1.3", - "@jridgewell/trace-mapping": "^0.3.13", + "@jest/types": "^29.0.0", + "@jridgewell/trace-mapping": "^0.3.15", "babel-plugin-istanbul": "^6.1.1", "chalk": "^4.0.0", "convert-source-map": "^1.4.0", - "fast-json-stable-stringify": "^2.0.0", + "fast-json-stable-stringify": "^2.1.0", "graceful-fs": "^4.2.9", - "jest-haste-map": "^28.1.3", - "jest-regex-util": "^28.0.2", - "jest-util": "^28.1.3", + "jest-haste-map": "^29.0.0", + "jest-regex-util": "^29.0.0", + "jest-util": "^29.0.0", "micromatch": "^4.0.4", "pirates": "^4.0.4", "slash": "^3.0.0", "write-file-atomic": "^4.0.1" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/transform/node_modules/@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -3320,13 +3331,13 @@ "chalk": "^4.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/transform/node_modules/@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "dependencies": { "@types/yargs-parser": "*" @@ -3349,12 +3360,12 @@ } }, "node_modules/@jest/transform/node_modules/jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -3362,7 +3373,7 @@ "picomatch": "^2.2.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/@jest/transform/node_modules/slash": { @@ -3375,16 +3386,16 @@ } }, "node_modules/@jest/transform/node_modules/write-file-atomic": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-4.0.1.tgz", - "integrity": "sha512-nSKUxgAbyioruk6hU87QzVbY279oYT6uiwgDoujth2ju4mJ+TZau7SQBhtbTmUyuNYTuXnSyRn66FV0+eCgcrQ==", + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-4.0.2.tgz", + "integrity": "sha512-7KxauUdBmSdWnmpaGFg+ppNjKF8uNLry8LyzjauQDOVONfFLNKrKvQOxZ/VuTIcS/gge/YNahf5RIIQWTSarlg==", "dev": true, "dependencies": { "imurmurhash": "^0.1.4", "signal-exit": "^3.0.7" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || >=16" + "node": "^12.13.0 || ^14.15.0 || >=16.0.0" } }, "node_modules/@jest/types": { @@ -3478,23 +3489,23 @@ "integrity": "sha512-GryiOJmNcWbovBxTfZSF71V/mXbgcV3MewDe3kIMCLyIh5e7SKAeUZs+rMnJ8jkMolZ/4/VsdBmMrw3l+VdZ3w==" }, "node_modules/@jridgewell/trace-mapping": { - "version": "0.3.13", - "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.13.tgz", - "integrity": "sha512-o1xbKhp9qnIAoHJSWd6KlCZfqslL4valSF81H8ImioOAxluWYWOpWkpyktY2vnt4tbrX9XYaxovq6cgowaJp2w==", + "version": "0.3.15", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.15.tgz", + "integrity": "sha512-oWZNOULl+UbhsgB51uuZzglikfIKSUBO/M9W2OfEjn7cmqoAiCgmv9lyACTUacZwBz0ITnJ2NqjU8Tx0DHL88g==", "dependencies": { "@jridgewell/resolve-uri": "^3.0.3", "@jridgewell/sourcemap-codec": "^1.4.10" } }, "node_modules/@next/env": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/env/-/env-12.2.5.tgz", - "integrity": "sha512-vLPLV3cpPGjUPT3PjgRj7e3nio9t6USkuew3JE/jMeon/9Mvp1WyR18v3iwnCuX7eUAm1HmAbJHHLAbcu/EJcw==" + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/env/-/env-12.2.4.tgz", + "integrity": "sha512-/gApFXWk5CCLFQJL5IYJXxPQuG5tz5nPX4l27A9Zm/+wJxiwFrRSP54AopDxIv4JRp/rGwcgk/lZS/0Clw8jYA==" }, "node_modules/@next/swc-android-arm-eabi": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-android-arm-eabi/-/swc-android-arm-eabi-12.2.5.tgz", - "integrity": "sha512-cPWClKxGhgn2dLWnspW+7psl3MoLQUcNqJqOHk2BhNcou9ARDtC0IjQkKe5qcn9qg7I7U83Gp1yh2aesZfZJMA==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-android-arm-eabi/-/swc-android-arm-eabi-12.2.4.tgz", + "integrity": "sha512-P4YSFNpmXXSnn3P1qsOAqz+MX3On9fHrlc8ovb/CFJJoU+YLCR53iCEwfw39e0IZEgDA7ttgr108plF8mxaX0g==", "cpu": [ "arm" ], @@ -3507,9 +3518,9 @@ } }, "node_modules/@next/swc-android-arm64": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-android-arm64/-/swc-android-arm64-12.2.5.tgz", - "integrity": "sha512-vMj0efliXmC5b7p+wfcQCX0AfU8IypjkzT64GiKJD9PgiA3IILNiGJr1fw2lyUDHkjeWx/5HMlMEpLnTsQslwg==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-android-arm64/-/swc-android-arm64-12.2.4.tgz", + "integrity": "sha512-4o2n14E18O+8xHlf6dgJsWPXN9gmSmfIe2Z0EqKDIPBBkFt/2CyrH0+vwHnL2l7xkDHhOGfZYcYIWVUR5aNu0A==", "cpu": [ "arm64" ], @@ -3522,9 +3533,9 @@ } }, "node_modules/@next/swc-darwin-arm64": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-darwin-arm64/-/swc-darwin-arm64-12.2.5.tgz", - "integrity": "sha512-VOPWbO5EFr6snla/WcxUKtvzGVShfs302TEMOtzYyWni6f9zuOetijJvVh9CCTzInnXAZMtHyNhefijA4HMYLg==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-darwin-arm64/-/swc-darwin-arm64-12.2.4.tgz", + "integrity": "sha512-DcUO6MGBL9E3jj5o86MUnTOy4WawIJJhyCcFYO4f51sbl7+uPIYIx40eo98A6NwJEXazCqq1hLeqOaNTAIvDiQ==", "cpu": [ "arm64" ], @@ -3537,9 +3548,9 @@ } }, "node_modules/@next/swc-darwin-x64": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-darwin-x64/-/swc-darwin-x64-12.2.5.tgz", - "integrity": "sha512-5o8bTCgAmtYOgauO/Xd27vW52G2/m3i5PX7MUYePquxXAnX73AAtqA3WgPXBRitEB60plSKZgOTkcpqrsh546A==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-darwin-x64/-/swc-darwin-x64-12.2.4.tgz", + "integrity": "sha512-IUlFMqeLjdIzDorrGC2Dt+2Ae3DbKQbRzCzmDq4/CP1+jJGeDXo/2AHnlE+WYnwQAC4KtAz6pbVnd3KstZWsVA==", "cpu": [ "x64" ], @@ -3552,9 +3563,9 @@ } }, "node_modules/@next/swc-freebsd-x64": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-freebsd-x64/-/swc-freebsd-x64-12.2.5.tgz", - "integrity": "sha512-yYUbyup1JnznMtEBRkK4LT56N0lfK5qNTzr6/DEyDw5TbFVwnuy2hhLBzwCBkScFVjpFdfiC6SQAX3FrAZzuuw==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-freebsd-x64/-/swc-freebsd-x64-12.2.4.tgz", + "integrity": "sha512-475vwyWcjnyDVDWLgAATP0HI8W1rwByc+uXk1B6KkAVFhkoDgH387LW0uNqxavK+VxCzj3avQXX/58XDvxtSlg==", "cpu": [ "x64" ], @@ -3567,9 +3578,9 @@ } }, "node_modules/@next/swc-linux-arm-gnueabihf": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-linux-arm-gnueabihf/-/swc-linux-arm-gnueabihf-12.2.5.tgz", - "integrity": "sha512-2ZE2/G921Acks7UopJZVMgKLdm4vN4U0yuzvAMJ6KBavPzqESA2yHJlm85TV/K9gIjKhSk5BVtauIUntFRP8cg==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-linux-arm-gnueabihf/-/swc-linux-arm-gnueabihf-12.2.4.tgz", + "integrity": "sha512-qZW+L3iG3XSGtlOPmD5RRWXyk6ZNdscLV0BQjuDvP+exTg+uixqHXOHz0/GVATIJEBQOF0Kew7jAXVXEP+iRTQ==", "cpu": [ "arm" ], @@ -3582,9 +3593,9 @@ } }, "node_modules/@next/swc-linux-arm64-gnu": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-linux-arm64-gnu/-/swc-linux-arm64-gnu-12.2.5.tgz", - "integrity": "sha512-/I6+PWVlz2wkTdWqhlSYYJ1pWWgUVva6SgX353oqTh8njNQp1SdFQuWDqk8LnM6ulheVfSsgkDzxrDaAQZnzjQ==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-linux-arm64-gnu/-/swc-linux-arm64-gnu-12.2.4.tgz", + "integrity": "sha512-fEPRjItWYaKyyG9N+2HIA59OBHIhk7WC+Rh+LwXsh0pQe870Ykpek3KQs0umjsrEGe57NyMomq3f80/N8taDvA==", "cpu": [ "arm64" ], @@ -3597,9 +3608,9 @@ } }, "node_modules/@next/swc-linux-arm64-musl": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-linux-arm64-musl/-/swc-linux-arm64-musl-12.2.5.tgz", - "integrity": "sha512-LPQRelfX6asXyVr59p5sTpx5l+0yh2Vjp/R8Wi4X9pnqcayqT4CUJLiHqCvZuLin3IsFdisJL0rKHMoaZLRfmg==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-linux-arm64-musl/-/swc-linux-arm64-musl-12.2.4.tgz", + "integrity": "sha512-rnCTzXII0EBCcFn9P5s/Dho2kPUMSX/bP0iOAj8wEI/IxUEfEElbin89zJoNW30cycHu19xY8YP4K2+hzciPzQ==", "cpu": [ "arm64" ], @@ -3612,9 +3623,9 @@ } }, "node_modules/@next/swc-linux-x64-gnu": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-linux-x64-gnu/-/swc-linux-x64-gnu-12.2.5.tgz", - "integrity": "sha512-0szyAo8jMCClkjNK0hknjhmAngUppoRekW6OAezbEYwHXN/VNtsXbfzgYOqjKWxEx3OoAzrT3jLwAF0HdX2MEw==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-linux-x64-gnu/-/swc-linux-x64-gnu-12.2.4.tgz", + "integrity": "sha512-PhXX6NSuIuhHInxPY2VkG2Bl7VllsD3Cjx+pQcS1wTym7Zt7UoLvn05PkRrkiyIkvR+UXnqPUM3TYiSbnemXEw==", "cpu": [ "x64" ], @@ -3627,9 +3638,9 @@ } }, "node_modules/@next/swc-linux-x64-musl": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-linux-x64-musl/-/swc-linux-x64-musl-12.2.5.tgz", - "integrity": "sha512-zg/Y6oBar1yVnW6Il1I/08/2ukWtOG6s3acdJdEyIdsCzyQi4RLxbbhkD/EGQyhqBvd3QrC6ZXQEXighQUAZ0g==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-linux-x64-musl/-/swc-linux-x64-musl-12.2.4.tgz", + "integrity": "sha512-GmC/QROiUZpFirHRfPQqMyCXZ+5+ndbBZrMvL74HtQB/CKXB8K1VM+rvy9Gp/5OaU8Rxp48IcX79NOfI2LiXlA==", "cpu": [ "x64" ], @@ -3642,9 +3653,9 @@ } }, "node_modules/@next/swc-win32-arm64-msvc": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-win32-arm64-msvc/-/swc-win32-arm64-msvc-12.2.5.tgz", - "integrity": "sha512-3/90DRNSqeeSRMMEhj4gHHQlLhhKg5SCCoYfE3kBjGpE63EfnblYUqsszGGZ9ekpKL/R4/SGB40iCQr8tR5Jiw==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-win32-arm64-msvc/-/swc-win32-arm64-msvc-12.2.4.tgz", + "integrity": "sha512-9XKoCXbNZuaMRPtcKQz3+hgVpkMosaLlcxHFXT8/j4w61k7/qvEbrkMDS9WHNrD/xVcLycwhPRgXcns2K1BdBQ==", "cpu": [ "arm64" ], @@ -3657,9 +3668,9 @@ } }, "node_modules/@next/swc-win32-ia32-msvc": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-win32-ia32-msvc/-/swc-win32-ia32-msvc-12.2.5.tgz", - "integrity": "sha512-hGLc0ZRAwnaPL4ulwpp4D2RxmkHQLuI8CFOEEHdzZpS63/hMVzv81g8jzYA0UXbb9pus/iTc3VRbVbAM03SRrw==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-win32-ia32-msvc/-/swc-win32-ia32-msvc-12.2.4.tgz", + "integrity": "sha512-hEyRieZKH9iw4AzvXaQ+Fyb98k0G/o9QcRGxA1/O/O/elf1+Qvuwb15phT8GbVtIeNziy66XTPOhKKfdr8KyUg==", "cpu": [ "ia32" ], @@ -3672,9 +3683,9 @@ } }, "node_modules/@next/swc-win32-x64-msvc": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-win32-x64-msvc/-/swc-win32-x64-msvc-12.2.5.tgz", - "integrity": "sha512-7h5/ahY7NeaO2xygqVrSG/Y8Vs4cdjxIjowTZ5W6CKoTKn7tmnuxlUc2h74x06FKmbhAd9agOjr/AOKyxYYm9Q==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-win32-x64-msvc/-/swc-win32-x64-msvc-12.2.4.tgz", + "integrity": "sha512-5Pl1tdMJWLy4rvzU1ecx0nHWgDPqoYuvYoXE/5X0Clu9si/yOuBIj573F2kOTY7mu0LX2wgCJVSnyK0abHBxIw==", "cpu": [ "x64" ], @@ -3843,6 +3854,31 @@ "@octokit/openapi-types": "^11.2.0" } }, + "node_modules/@pnpm/network.ca-file": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@pnpm/network.ca-file/-/network.ca-file-1.0.1.tgz", + "integrity": "sha512-gkINruT2KUhZLTaiHxwCOh1O4NVnFT0wLjWFBHmTz9vpKag/C/noIMJXBxFe4F0mYpUVX2puLwAieLYFg2NvoA==", + "dev": true, + "dependencies": { + "graceful-fs": "4.2.10" + }, + "engines": { + "node": ">=12.22.0" + } + }, + "node_modules/@pnpm/npm-conf": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/@pnpm/npm-conf/-/npm-conf-1.0.5.tgz", + "integrity": "sha512-hD8ml183638O3R6/Txrh0L8VzGOrFXgRtRDG4qQC4tONdZ5Z1M+tlUUDUvrjYdmK6G+JTBTeaCLMna11cXzi8A==", + "dev": true, + "dependencies": { + "@pnpm/network.ca-file": "^1.0.1", + "config-chain": "^1.1.11" + }, + "engines": { + "node": ">=12" + } + }, "node_modules/@primer/behaviors": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/@primer/behaviors/-/behaviors-1.1.3.tgz", @@ -3953,9 +3989,9 @@ "license": "BSD-3-Clause" }, "node_modules/@sinclair/typebox": { - "version": "0.24.20", - "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.24.20.tgz", - "integrity": "sha512-kVaO5aEFZb33nPMTZBxiPEkY+slxiPtqC7QX8f9B3eGOMBvEfuMfxp9DSTTCsRJPumPKjrge4yagyssO4q6qzQ==", + "version": "0.24.28", + "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.24.28.tgz", + "integrity": "sha512-dgJd3HLOkLmz4Bw50eZx/zJwtBq65nms3N9VBYu5LTjJ883oBFkTyXRlCB/ZGGwqYpJJHA5zW2Ibhl5ngITfow==", "dev": true }, "node_modules/@sindresorhus/is": { @@ -4139,9 +4175,9 @@ } }, "node_modules/@types/babel__traverse": { - "version": "7.17.1", - "resolved": "https://registry.npmjs.org/@types/babel__traverse/-/babel__traverse-7.17.1.tgz", - "integrity": "sha512-kVzjari1s2YVi77D3w1yuvohV2idweYXMCDzqBiVNN63TcDWrIlTVOYpqVrvbbyOE/IyzBoTKF0fdnLPEORFxA==", + "version": "7.18.0", + "resolved": "https://registry.npmjs.org/@types/babel__traverse/-/babel__traverse-7.18.0.tgz", + "integrity": "sha512-v4Vwdko+pgymgS+A2UIaJru93zQd85vIGWObM5ekZNdXCKtDYqATlEYnWgfo86Q6I1Lh0oXnksDnMU1cwmlPDw==", "dev": true, "dependencies": { "@babel/types": "^7.3.0" @@ -4320,9 +4356,9 @@ "license": "MIT" }, "node_modules/@types/prettier": { - "version": "2.6.3", - "resolved": "https://registry.npmjs.org/@types/prettier/-/prettier-2.6.3.tgz", - "integrity": "sha512-ymZk3LEC/fsut+/Q5qejp6R9O1rMxz3XaRHDV6kX8MrGAhOSPqVARbDi+EZvInBpw+BnCX3TD240byVkOfQsHg==", + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/@types/prettier/-/prettier-2.7.0.tgz", + "integrity": "sha512-RI1L7N4JnW5gQw2spvL7Sllfuf1SaHdrZpCHiBlCXjIlufi1SMNnbu2teze3/QE67Fg2tBlH7W+mi4hVNk4p0A==", "dev": true }, "node_modules/@types/prop-types": { @@ -5004,8 +5040,9 @@ }, "node_modules/ansi-align": { "version": "3.0.1", + "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.1.tgz", + "integrity": "sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==", "dev": true, - "license": "ISC", "dependencies": { "string-width": "^4.1.0" } @@ -5363,21 +5400,21 @@ } }, "node_modules/babel-jest": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/babel-jest/-/babel-jest-28.1.3.tgz", - "integrity": "sha512-epUaPOEWMk3cWX0M/sPvCHHCe9fMFAa/9hXEgKP8nFfNl/jlGkE9ucq9NqkZGXLDduCJYS0UvSlPUwC0S+rH6Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/babel-jest/-/babel-jest-29.0.0.tgz", + "integrity": "sha512-EJM2dqxz9+uWJLLucZLPYAmRsHHt1IMkitAHGqjDlIP2IQXzkIMO3ATbBWk0lU6VwX4rNeVN04t/DDB8U5C2rg==", "dev": true, "dependencies": { - "@jest/transform": "^28.1.3", + "@jest/transform": "^29.0.0", "@types/babel__core": "^7.1.14", "babel-plugin-istanbul": "^6.1.1", - "babel-preset-jest": "^28.1.3", + "babel-preset-jest": "^29.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "slash": "^3.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" }, "peerDependencies": { "@babel/core": "^7.8.0" @@ -5469,9 +5506,9 @@ } }, "node_modules/babel-plugin-jest-hoist": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-28.1.3.tgz", - "integrity": "sha512-Ys3tUKAmfnkRUpPdpa98eYrAR0nV+sSFUZZEGuQ2EbFd1y4SOLtD5QDNHAq+bb9a+bbXvYQC4b+ID/THIMcU6Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-29.0.0.tgz", + "integrity": "sha512-B9oaXrlxXHFWeWqhDPg03iqQd2UN/mg/VdZOsLaqAVBkztru3ctTryAI4zisxLEEgmcUnLTKewqx0gGifoXD3A==", "dev": true, "dependencies": { "@babel/template": "^7.3.3", @@ -5480,7 +5517,7 @@ "@types/babel__traverse": "^7.0.6" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/babel-plugin-polyfill-corejs2": { @@ -5934,16 +5971,16 @@ } }, "node_modules/babel-preset-jest": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/babel-preset-jest/-/babel-preset-jest-28.1.3.tgz", - "integrity": "sha512-L+fupJvlWAHbQfn74coNX3zf60LXMJsezNvvx8eIh7iOR1luJ1poxYgQk1F8PYtNq/6QODDHCqsSnTFSWC491A==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/babel-preset-jest/-/babel-preset-jest-29.0.0.tgz", + "integrity": "sha512-B5Ke47Xcs8rDF3p1korT3LoilpADCwbG93ALqtvqu6Xpf4d8alKkrCBTExbNzdHJcIuEPpfYvEaFFRGee2kUgQ==", "dev": true, "dependencies": { - "babel-plugin-jest-hoist": "^28.1.3", + "babel-plugin-jest-hoist": "^29.0.0", "babel-preset-current-node-syntax": "^1.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" }, "peerDependencies": { "@babel/core": "^7.0.0" @@ -6228,63 +6265,97 @@ "license": "MIT" }, "node_modules/boxen": { - "version": "5.1.2", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/boxen/-/boxen-7.0.0.tgz", + "integrity": "sha512-j//dBVuyacJbvW+tvZ9HuH03fZ46QcaKvvhZickZqtB271DxJ7SNRSNxrV/dZX0085m7hISRZWbzWlJvx/rHSg==", "dev": true, - "license": "MIT", "dependencies": { - "ansi-align": "^3.0.0", - "camelcase": "^6.2.0", - "chalk": "^4.1.0", - "cli-boxes": "^2.2.1", - "string-width": "^4.2.2", - "type-fest": "^0.20.2", - "widest-line": "^3.1.0", - "wrap-ansi": "^7.0.0" + "ansi-align": "^3.0.1", + "camelcase": "^7.0.0", + "chalk": "^5.0.1", + "cli-boxes": "^3.0.0", + "string-width": "^5.1.2", + "type-fest": "^2.13.0", + "widest-line": "^4.0.1", + "wrap-ansi": "^8.0.1" }, "engines": { - "node": ">=10" + "node": ">=14.16" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/boxen/node_modules/ansi-styles": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.1.0.tgz", + "integrity": "sha512-VbqNsoz55SYGczauuup0MFUyXNQviSpFTj1RQtFzmQLk18qbVSpTFFGMT293rmDaQuKCT6InmbuEyUne4mTuxQ==", + "dev": true, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, "node_modules/boxen/node_modules/camelcase": { - "version": "6.2.0", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-7.0.0.tgz", + "integrity": "sha512-JToIvOmz6nhGsUhAYScbo2d6Py5wojjNfoxoc2mEVLUdJ70gJK2gnd+ABY1Tc3sVMyK7QDPtN0T/XdlCQWITyQ==", "dev": true, - "license": "MIT", "engines": { - "node": ">=10" + "node": ">=14.16" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/boxen/node_modules/chalk": { - "version": "4.1.2", + "node_modules/boxen/node_modules/string-width": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", + "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", "dev": true, - "license": "MIT", "dependencies": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" + "eastasianwidth": "^0.2.0", + "emoji-regex": "^9.2.2", + "strip-ansi": "^7.0.1" }, "engines": { - "node": ">=10" + "node": ">=12" }, "funding": { - "url": "https://github.com/chalk/chalk?sponsor=1" + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/boxen/node_modules/type-fest": { - "version": "0.20.2", + "version": "2.18.1", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-2.18.1.tgz", + "integrity": "sha512-UKCINsd4qiATXD6OIlnQw9t1ux/n2ld+Nl0kzPbCONhCaUIS/BhJbNw14w6584HCQWf3frBK8vmWnGZq/sbPHQ==", "dev": true, - "license": "(MIT OR CC0-1.0)", "engines": { - "node": ">=10" + "node": ">=12.20" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/boxen/node_modules/wrap-ansi": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.0.1.tgz", + "integrity": "sha512-QFF+ufAqhoYHvoHdajT/Po7KoXVBPXS2bgjIam5isfWJPfIOnQZ50JtUiVvCv/sjgacf3yRrt2ZKUZ/V4itN4g==", + "dev": true, + "dependencies": { + "ansi-styles": "^6.1.0", + "string-width": "^5.0.1", + "strip-ansi": "^7.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, "node_modules/brace-expansion": { "version": "2.0.1", "dev": true, @@ -6722,11 +6793,12 @@ } }, "node_modules/cli-boxes": { - "version": "2.2.1", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-3.0.0.tgz", + "integrity": "sha512-/lzGpEWL/8PfI0BmBOPRwp0c/wFNX1RdUML3jK/RcSBA9T8mZDdQpqYBKtCFTOfQbwPqWEOpjqW+Fnayc0969g==", "dev": true, - "license": "MIT", "engines": { - "node": ">=6" + "node": ">=10" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -6934,20 +7006,33 @@ "version": "0.0.1", "license": "MIT" }, - "node_modules/configstore": { - "version": "5.0.1", + "node_modules/config-chain": { + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/config-chain/-/config-chain-1.1.13.tgz", + "integrity": "sha512-qj+f8APARXHrM0hraqXYb2/bOVSV4PvJQlNZ/DVj0QrmNM2q2euizkeuVckQ57J+W0mRH6Hvi+k50M4Jul2VRQ==", "dev": true, - "license": "BSD-2-Clause", "dependencies": { - "dot-prop": "^5.2.0", - "graceful-fs": "^4.1.2", - "make-dir": "^3.0.0", - "unique-string": "^2.0.0", - "write-file-atomic": "^3.0.0", - "xdg-basedir": "^4.0.0" + "ini": "^1.3.4", + "proto-list": "~1.2.1" + } + }, + "node_modules/configstore": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/configstore/-/configstore-6.0.0.tgz", + "integrity": "sha512-cD31W1v3GqUlQvbBCGcXmd2Nj9SvLDOP1oQ0YFuLETufzSPaKp11rYBsSOm7rCsW3OnIRAFM3OxRhceaXNYHkA==", + "dev": true, + "dependencies": { + "dot-prop": "^6.0.1", + "graceful-fs": "^4.2.6", + "unique-string": "^3.0.0", + "write-file-atomic": "^3.0.3", + "xdg-basedir": "^5.0.1" }, "engines": { - "node": ">=8" + "node": ">=12" + }, + "funding": { + "url": "https://github.com/yeoman/configstore?sponsor=1" } }, "node_modules/connect-datadog": { @@ -7130,11 +7215,30 @@ } }, "node_modules/crypto-random-string": { - "version": "2.0.0", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/crypto-random-string/-/crypto-random-string-4.0.0.tgz", + "integrity": "sha512-x8dy3RnvYdlUcPOjkEHqozhiwzKNSq7GcPuXFbnyMOCHxX8V3OgIg/pYuabl2sbUPfIJaeAQB7PMOK8DFIdoRA==", "dev": true, - "license": "MIT", + "dependencies": { + "type-fest": "^1.0.1" + }, "engines": { - "node": ">=8" + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/crypto-random-string/node_modules/type-fest": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-1.4.0.tgz", + "integrity": "sha512-yGSza74xk0UG8k+pLh5oeoYirvIiWo5t0/o3zHHAO2tRDiZcxWP7fywNlXhqb6/r6sWvwi+RsyQMWhVLe4BVuA==", + "dev": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/csp-parse": { @@ -7304,8 +7408,9 @@ }, "node_modules/deep-extend": { "version": "0.6.0", + "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", + "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", "dev": true, - "license": "MIT", "engines": { "node": ">=4.0.0" } @@ -7396,12 +7501,12 @@ } }, "node_modules/diff-sequences": { - "version": "28.1.1", - "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-28.1.1.tgz", - "integrity": "sha512-FU0iFaH/E23a+a718l8Qa/19bF9p06kgE0KipMOMadwa3SjnaElKzPaUC0vnibs6/B/9ni97s61mcejk8W1fQw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-29.0.0.tgz", + "integrity": "sha512-7Qe/zd1wxSDL4D/X/FPjOMB+ZMDt71W94KYaq05I2l0oQqgXgs7s4ftYYmV38gBSrPz2vcygxfs1xn0FT+rKNA==", "dev": true, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/dir-glob": { @@ -7603,22 +7708,18 @@ } }, "node_modules/dot-prop": { - "version": "5.3.0", + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-6.0.1.tgz", + "integrity": "sha512-tE7ztYzXHIeyvc7N+hR3oi7FIbf/NIjVP9hmAt3yMXzrQ072/fpjGLx2GxNxGxUl5V73MEqYzioOMoVhGMJ5cA==", "dev": true, - "license": "MIT", "dependencies": { "is-obj": "^2.0.0" }, "engines": { - "node": ">=8" - } - }, - "node_modules/dot-prop/node_modules/is-obj": { - "version": "2.0.0", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/dotenv": { @@ -7639,6 +7740,12 @@ "dev": true, "license": "BSD-3-Clause" }, + "node_modules/eastasianwidth": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", + "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==", + "dev": true + }, "node_modules/ee-first": { "version": "1.1.1", "license": "MIT" @@ -7802,11 +7909,15 @@ } }, "node_modules/escape-goat": { - "version": "2.1.1", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-goat/-/escape-goat-4.0.0.tgz", + "integrity": "sha512-2Sd4ShcWxbx6OY1IHyla/CVNwvg7XwZVoXZHcSu9w9SReNP1EzzD5T8NWKIR38fIqEns9kDWKUQTXXAmlDrdPg==", "dev": true, - "license": "MIT", "engines": { - "node": ">=8" + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/escape-html": { @@ -8701,19 +8812,19 @@ } }, "node_modules/expect": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/expect/-/expect-28.1.3.tgz", - "integrity": "sha512-eEh0xn8HlsuOBxFgIss+2mX85VAS4Qy3OSkjV7rlBWljtA4oWH37glVGyOZSZvErDT/yBywZdPGwCXuTvSG85g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/expect/-/expect-29.0.0.tgz", + "integrity": "sha512-OKAHGwaBqZ6I7bas0cnrrvomEL2d0yp2XXYQhhnVHfaqDaKStUBxjWtlGu/uI2tBqwb9sBMvaS41DSJFsRRJHQ==", "dev": true, "dependencies": { - "@jest/expect-utils": "^28.1.3", - "jest-get-type": "^28.0.2", - "jest-matcher-utils": "^28.1.3", - "jest-message-util": "^28.1.3", - "jest-util": "^28.1.3" + "@jest/expect-utils": "^29.0.0", + "jest-get-type": "^29.0.0", + "jest-matcher-utils": "^29.0.0", + "jest-message-util": "^29.0.0", + "jest-util": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/expect-puppeteer": { @@ -8723,12 +8834,12 @@ "optional": true }, "node_modules/expect/node_modules/@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -8736,13 +8847,13 @@ "chalk": "^4.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/expect/node_modules/@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "dependencies": { "@types/yargs-parser": "*" @@ -8765,32 +8876,32 @@ } }, "node_modules/expect/node_modules/jest-message-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", - "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.0.0.tgz", + "integrity": "sha512-4U0RdNV0TBTgVGzEchjryEpq4sqLO3gUQT7TEIbO5+q0K5MuiofOPcXk4GLpWviWByMRJjliQNMuzJ4YGT+oGQ==", "dev": true, "dependencies": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/expect/node_modules/jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -8798,22 +8909,21 @@ "picomatch": "^2.2.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/expect/node_modules/pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/expect/node_modules/pretty-format/node_modules/ansi-styles": { @@ -9650,8 +9760,9 @@ }, "node_modules/global-dirs": { "version": "3.0.0", + "resolved": "https://registry.npmjs.org/global-dirs/-/global-dirs-3.0.0.tgz", + "integrity": "sha512-v8ho2DS5RiCjftj1nD9NmnfaOzTdud7RRnVd9kFNOjqZbISlx5DQ+OrTkywgd0dIt7oFCvKetZSHoHcP3sDdiA==", "dev": true, - "license": "MIT", "dependencies": { "ini": "2.0.0" }, @@ -9664,8 +9775,9 @@ }, "node_modules/global-dirs/node_modules/ini": { "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ini/-/ini-2.0.0.tgz", + "integrity": "sha512-7PnF4oN3CvZF23ADhA5wRaYEQpJ8qygSkbtTXWBeXWXmEVRXK+1ITciHWwHhsjv1TmW0MgacIv6hEi5pX5NQdA==", "dev": true, - "license": "ISC", "engines": { "node": ">=10" } @@ -9953,11 +10065,15 @@ } }, "node_modules/has-yarn": { - "version": "2.1.0", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-yarn/-/has-yarn-3.0.0.tgz", + "integrity": "sha512-IrsVwUHhEULx3R8f/aA8AHuEzAorplsab/v8HBzEiIukwq5i/EC+xmOW+HfP1OaDP+2JkgT1yILHN2O3UFIbcA==", "dev": true, - "license": "MIT", "engines": { - "node": ">=8" + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/hast-to-hyperscript": { @@ -10473,11 +10589,12 @@ } }, "node_modules/import-lazy": { - "version": "2.1.0", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz", + "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", "dev": true, - "license": "MIT", "engines": { - "node": ">=4" + "node": ">=8" } }, "node_modules/import-local": { @@ -10677,21 +10794,17 @@ } }, "node_modules/is-ci": { - "version": "2.0.0", + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/is-ci/-/is-ci-3.0.1.tgz", + "integrity": "sha512-ZYvCgrefwqoQ6yTyYUbQu64HsITZ3NfKX1lzaEYdkTDcfKzzCI/wthRRYKkdjHKFVgNiXKAKm65Zo1pk2as/QQ==", "dev": true, - "license": "MIT", "dependencies": { - "ci-info": "^2.0.0" + "ci-info": "^3.2.0" }, "bin": { "is-ci": "bin.js" } }, - "node_modules/is-ci/node_modules/ci-info": { - "version": "2.0.0", - "dev": true, - "license": "MIT" - }, "node_modules/is-core-module": { "version": "2.9.0", "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.9.0.tgz", @@ -10779,8 +10892,9 @@ }, "node_modules/is-installed-globally": { "version": "0.4.0", + "resolved": "https://registry.npmjs.org/is-installed-globally/-/is-installed-globally-0.4.0.tgz", + "integrity": "sha512-iwGqO3J21aaSkC7jWnHP/difazwS7SFeIqxv6wEtLU8Y5KlzFTjyqcSIT0d8s4+dDhKytsk9PJZ2BkS5eZwQRQ==", "dev": true, - "license": "MIT", "dependencies": { "global-dirs": "^3.0.0", "is-path-inside": "^3.0.2" @@ -10805,11 +10919,12 @@ } }, "node_modules/is-npm": { - "version": "5.0.0", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/is-npm/-/is-npm-6.0.0.tgz", + "integrity": "sha512-JEjxbSmtPSt1c8XTkVrlujcXdKV1/tvuQ7GwKcAlyiVLeYFQ2VHat8xfrDJsIkhCdF/tZ7CiIR3sy141c6+gPQ==", "dev": true, - "license": "MIT", "engines": { - "node": ">=10" + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -10838,10 +10953,20 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/is-obj": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-2.0.0.tgz", + "integrity": "sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/is-path-inside": { "version": "3.0.3", + "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.3.tgz", + "integrity": "sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==", "dev": true, - "license": "MIT", "engines": { "node": ">=8" } @@ -10930,8 +11055,9 @@ }, "node_modules/is-typedarray": { "version": "1.0.0", - "dev": true, - "license": "MIT" + "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", + "integrity": "sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA==", + "dev": true }, "node_modules/is-url": { "version": "1.2.4", @@ -10974,9 +11100,13 @@ } }, "node_modules/is-yarn-global": { - "version": "0.3.0", + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/is-yarn-global/-/is-yarn-global-0.4.0.tgz", + "integrity": "sha512-HneQBCrXGBy15QnaDfcn6OLoU8AQPAa0Qn0IeJR/QCo4E8dNZaGGwxpCwWyEBQC5QvFonP8d6t60iGpAHVAfNA==", "dev": true, - "license": "MIT" + "engines": { + "node": ">=12" + } }, "node_modules/is2": { "version": "2.0.4", @@ -11092,21 +11222,21 @@ "license": "MIT" }, "node_modules/jest": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest/-/jest-28.1.3.tgz", - "integrity": "sha512-N4GT5on8UkZgH0O5LUavMRV1EDEhNTL0KEfRmDIeZHSV7p2XgLoY9t9VDUgL6o+yfdgYHVxuz81G8oB9VG5uyA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest/-/jest-29.0.0.tgz", + "integrity": "sha512-9uz4Tclskb8WrfRXqu66FsFCFoyYctwWXpruKwnD95FZqkyoEAA1oGH53HUn7nQx7uEgZTKdNl/Yo6DqqU+XMg==", "dev": true, "dependencies": { - "@jest/core": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/core": "^29.0.0", + "@jest/types": "^29.0.0", "import-local": "^3.0.2", - "jest-cli": "^28.1.3" + "jest-cli": "^29.0.0" }, "bin": { "jest": "bin/jest.js" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" }, "peerDependencies": { "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" @@ -11118,87 +11248,87 @@ } }, "node_modules/jest-changed-files": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-changed-files/-/jest-changed-files-28.1.3.tgz", - "integrity": "sha512-esaOfUWJXk2nfZt9SPyC8gA1kNfdKLkQWyzsMlqq8msYSlNKfmZxfRgZn4Cd4MGVUF+7v6dBs0d5TOAKa7iIiA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-changed-files/-/jest-changed-files-29.0.0.tgz", + "integrity": "sha512-28/iDMDrUpGoCitTURuDqUzWQoWmOmOKOFST1mi2lwh62X4BFf6khgH3uSuo1e49X/UDjuApAj3w0wLOex4VPQ==", "dev": true, "dependencies": { "execa": "^5.0.0", "p-limit": "^3.1.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-circus": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-circus/-/jest-circus-28.1.3.tgz", - "integrity": "sha512-cZ+eS5zc79MBwt+IhQhiEp0OeBddpc1n8MBo1nMB8A7oPMKEO+Sre+wHaLJexQUj9Ya/8NOBY0RESUgYjB6fow==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-circus/-/jest-circus-29.0.0.tgz", + "integrity": "sha512-6EX70/+ZdzPLShBeokMVIpUaq5cQpOsO4OCDiV1drKUHht0hmUOWvY6LE4pBSFdepB0Sukw4Y0ajRqtvLBO9/A==", "dev": true, "dependencies": { - "@jest/environment": "^28.1.3", - "@jest/expect": "^28.1.3", - "@jest/test-result": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/environment": "^29.0.0", + "@jest/expect": "^29.0.0", + "@jest/test-result": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "co": "^4.6.0", "dedent": "^0.7.0", "is-generator-fn": "^2.0.0", - "jest-each": "^28.1.3", - "jest-matcher-utils": "^28.1.3", - "jest-message-util": "^28.1.3", - "jest-runtime": "^28.1.3", - "jest-snapshot": "^28.1.3", - "jest-util": "^28.1.3", + "jest-each": "^29.0.0", + "jest-matcher-utils": "^29.0.0", + "jest-message-util": "^29.0.0", + "jest-runtime": "^29.0.0", + "jest-snapshot": "^29.0.0", + "jest-util": "^29.0.0", "p-limit": "^3.1.0", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-circus/node_modules/@jest/environment": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-28.1.3.tgz", - "integrity": "sha512-1bf40cMFTEkKyEf585R9Iz1WayDjHoHqvts0XFYEqyKM3cFWDpeMoqKKTAF9LSYQModPUlh8FKptoM2YcMWAXA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-29.0.0.tgz", + "integrity": "sha512-ZHLvUENMAnwXowtyhmPRS0QLCXM4TS0ZfuiSR4QfRsJVN5lG4KdBDvI9kHJe/21vrgzPVOkvI7IBnkyPFCbV7g==", "dev": true, "dependencies": { - "@jest/fake-timers": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/fake-timers": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", - "jest-mock": "^28.1.3" + "jest-mock": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-circus/node_modules/@jest/fake-timers": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-28.1.3.tgz", - "integrity": "sha512-D/wOkL2POHv52h+ok5Oj/1gOG9HSywdoPtFsRCUmlCILXNn5eIWmcnd3DIiWlJnpGvQtmajqBP95Ei0EimxfLw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-29.0.0.tgz", + "integrity": "sha512-4tqH5fT9H0+Ms3Z1HLZ/JfpzJluep2Zo3uuj0KPyu6IIyYSHCDfkXuiBQNWUGvumZDLQ2Si03cC7Gq0r73VgVg==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@sinonjs/fake-timers": "^9.1.2", "@types/node": "*", - "jest-message-util": "^28.1.3", - "jest-mock": "^28.1.3", - "jest-util": "^28.1.3" + "jest-message-util": "^29.0.0", + "jest-mock": "^29.0.0", + "jest-util": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-circus/node_modules/@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -11206,7 +11336,7 @@ "chalk": "^4.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-circus/node_modules/@sinonjs/fake-timers": { @@ -11219,9 +11349,9 @@ } }, "node_modules/jest-circus/node_modules/@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "dependencies": { "@types/yargs-parser": "*" @@ -11244,45 +11374,45 @@ } }, "node_modules/jest-circus/node_modules/jest-message-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", - "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.0.0.tgz", + "integrity": "sha512-4U0RdNV0TBTgVGzEchjryEpq4sqLO3gUQT7TEIbO5+q0K5MuiofOPcXk4GLpWviWByMRJjliQNMuzJ4YGT+oGQ==", "dev": true, "dependencies": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-circus/node_modules/jest-mock": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-28.1.3.tgz", - "integrity": "sha512-o3J2jr6dMMWYVH4Lh/NKmDXdosrsJgi4AviS8oXLujcjpCMBb1FMsblDnOXKZKfSiHLxYub1eS0IHuRXsio9eA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-29.0.0.tgz", + "integrity": "sha512-0AWznVt415KMCxcJPaE2+tWaruw0w8aRrKH1Y/NZUx3+Pd9f20jQjUR82iHqGSuYS4EOHL9uI8SjAhJk+ET91g==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-circus/node_modules/jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -11290,22 +11420,21 @@ "picomatch": "^2.2.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-circus/node_modules/pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-circus/node_modules/pretty-format/node_modules/ansi-styles": { @@ -11336,21 +11465,21 @@ } }, "node_modules/jest-cli": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-cli/-/jest-cli-28.1.3.tgz", - "integrity": "sha512-roY3kvrv57Azn1yPgdTebPAXvdR2xfezaKKYzVxZ6It/5NCxzJym6tUI5P1zkdWhfUYkxEI9uZWcQdaFLo8mJQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-cli/-/jest-cli-29.0.0.tgz", + "integrity": "sha512-VZUPQjWJKL8QABFiBk1tHeJ3czBodjU9r22ceQmeL7X8/M73FYxTte0RkYPHI2SiLPWy99GZNWA+oOu9x0xKOA==", "dev": true, "dependencies": { - "@jest/core": "^28.1.3", - "@jest/test-result": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/core": "^29.0.0", + "@jest/test-result": "^29.0.0", + "@jest/types": "^29.0.0", "chalk": "^4.0.0", "exit": "^0.1.2", "graceful-fs": "^4.2.9", "import-local": "^3.0.2", - "jest-config": "^28.1.3", - "jest-util": "^28.1.3", - "jest-validate": "^28.1.3", + "jest-config": "^29.0.0", + "jest-util": "^29.0.0", + "jest-validate": "^29.0.0", "prompts": "^2.0.1", "yargs": "^17.3.1" }, @@ -11358,7 +11487,7 @@ "jest": "bin/jest.js" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" }, "peerDependencies": { "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" @@ -11370,12 +11499,12 @@ } }, "node_modules/jest-cli/node_modules/@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -11383,13 +11512,13 @@ "chalk": "^4.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-cli/node_modules/@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "dependencies": { "@types/yargs-parser": "*" @@ -11412,12 +11541,12 @@ } }, "node_modules/jest-cli/node_modules/jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -11425,40 +11554,40 @@ "picomatch": "^2.2.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-config": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-config/-/jest-config-28.1.3.tgz", - "integrity": "sha512-MG3INjByJ0J4AsNBm7T3hsuxKQqFIiRo/AUqb1q9LRKI5UU6Aar9JHbr9Ivn1TVwfUD9KirRoM/T6u8XlcQPHQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-config/-/jest-config-29.0.0.tgz", + "integrity": "sha512-RbcUgQBJDS0O8OThWUwm5UCfzo0zOymUX/cJzUNlYB1ZWqe3M8MFEcgwqgZSifYuYTi46xWu5cmkMiyRQAdnMw==", "dev": true, "dependencies": { "@babel/core": "^7.11.6", - "@jest/test-sequencer": "^28.1.3", - "@jest/types": "^28.1.3", - "babel-jest": "^28.1.3", + "@jest/test-sequencer": "^29.0.0", + "@jest/types": "^29.0.0", + "babel-jest": "^29.0.0", "chalk": "^4.0.0", "ci-info": "^3.2.0", "deepmerge": "^4.2.2", "glob": "^7.1.3", "graceful-fs": "^4.2.9", - "jest-circus": "^28.1.3", - "jest-environment-node": "^28.1.3", - "jest-get-type": "^28.0.2", - "jest-regex-util": "^28.0.2", - "jest-resolve": "^28.1.3", - "jest-runner": "^28.1.3", - "jest-util": "^28.1.3", - "jest-validate": "^28.1.3", + "jest-circus": "^29.0.0", + "jest-environment-node": "^29.0.0", + "jest-get-type": "^29.0.0", + "jest-regex-util": "^29.0.0", + "jest-resolve": "^29.0.0", + "jest-runner": "^29.0.0", + "jest-util": "^29.0.0", + "jest-validate": "^29.0.0", "micromatch": "^4.0.4", "parse-json": "^5.2.0", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "strip-json-comments": "^3.1.1" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" }, "peerDependencies": { "@types/node": "*", @@ -11474,44 +11603,44 @@ } }, "node_modules/jest-config/node_modules/@jest/environment": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-28.1.3.tgz", - "integrity": "sha512-1bf40cMFTEkKyEf585R9Iz1WayDjHoHqvts0XFYEqyKM3cFWDpeMoqKKTAF9LSYQModPUlh8FKptoM2YcMWAXA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-29.0.0.tgz", + "integrity": "sha512-ZHLvUENMAnwXowtyhmPRS0QLCXM4TS0ZfuiSR4QfRsJVN5lG4KdBDvI9kHJe/21vrgzPVOkvI7IBnkyPFCbV7g==", "dev": true, "dependencies": { - "@jest/fake-timers": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/fake-timers": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", - "jest-mock": "^28.1.3" + "jest-mock": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-config/node_modules/@jest/fake-timers": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-28.1.3.tgz", - "integrity": "sha512-D/wOkL2POHv52h+ok5Oj/1gOG9HSywdoPtFsRCUmlCILXNn5eIWmcnd3DIiWlJnpGvQtmajqBP95Ei0EimxfLw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-29.0.0.tgz", + "integrity": "sha512-4tqH5fT9H0+Ms3Z1HLZ/JfpzJluep2Zo3uuj0KPyu6IIyYSHCDfkXuiBQNWUGvumZDLQ2Si03cC7Gq0r73VgVg==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@sinonjs/fake-timers": "^9.1.2", "@types/node": "*", - "jest-message-util": "^28.1.3", - "jest-mock": "^28.1.3", - "jest-util": "^28.1.3" + "jest-message-util": "^29.0.0", + "jest-mock": "^29.0.0", + "jest-util": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-config/node_modules/@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -11519,7 +11648,7 @@ "chalk": "^4.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-config/node_modules/@sinonjs/fake-timers": { @@ -11532,9 +11661,9 @@ } }, "node_modules/jest-config/node_modules/@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "dependencies": { "@types/yargs-parser": "*" @@ -11587,62 +11716,62 @@ } }, "node_modules/jest-config/node_modules/jest-environment-node": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-28.1.3.tgz", - "integrity": "sha512-ugP6XOhEpjAEhGYvp5Xj989ns5cB1K6ZdjBYuS30umT4CQEETaxSiPcZ/E1kFktX4GkrcM4qu07IIlDYX1gp+A==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-29.0.0.tgz", + "integrity": "sha512-Cns21Vgu0z7LjtssL0SWkxmjclHdwXeECFAP3ONit5NPnGCbv+0Rqby8w9vK7NpFlUaFgMmLYYBsUjSmIhwpvg==", "dev": true, "dependencies": { - "@jest/environment": "^28.1.3", - "@jest/fake-timers": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/environment": "^29.0.0", + "@jest/fake-timers": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", - "jest-mock": "^28.1.3", - "jest-util": "^28.1.3" + "jest-mock": "^29.0.0", + "jest-util": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-config/node_modules/jest-message-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", - "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.0.0.tgz", + "integrity": "sha512-4U0RdNV0TBTgVGzEchjryEpq4sqLO3gUQT7TEIbO5+q0K5MuiofOPcXk4GLpWviWByMRJjliQNMuzJ4YGT+oGQ==", "dev": true, "dependencies": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-config/node_modules/jest-mock": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-28.1.3.tgz", - "integrity": "sha512-o3J2jr6dMMWYVH4Lh/NKmDXdosrsJgi4AviS8oXLujcjpCMBb1FMsblDnOXKZKfSiHLxYub1eS0IHuRXsio9eA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-29.0.0.tgz", + "integrity": "sha512-0AWznVt415KMCxcJPaE2+tWaruw0w8aRrKH1Y/NZUx3+Pd9f20jQjUR82iHqGSuYS4EOHL9uI8SjAhJk+ET91g==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-config/node_modules/jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -11650,7 +11779,7 @@ "picomatch": "^2.2.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-config/node_modules/minimatch": { @@ -11666,18 +11795,17 @@ } }, "node_modules/jest-config/node_modules/pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-config/node_modules/pretty-format/node_modules/ansi-styles": { @@ -11737,18 +11865,18 @@ } }, "node_modules/jest-diff": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-diff/-/jest-diff-28.1.3.tgz", - "integrity": "sha512-8RqP1B/OXzjjTWkqMX67iqgwBVJRgCyKD3L9nq+6ZqJMdvjE8RgHktqZ6jNrkdMT+dJuYNI3rhQpxaz7drJHfw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-diff/-/jest-diff-29.0.0.tgz", + "integrity": "sha512-erkuYf1dQBHow3XJmS+bH6t9TZ0GwrSdQGauN8sTqyZlFByOjRadmHgTTcAHINeeSwxzGHN2ob3PXVvZphD7XQ==", "dev": true, "dependencies": { "chalk": "^4.0.0", - "diff-sequences": "^28.1.1", - "jest-get-type": "^28.0.2", - "pretty-format": "^28.1.3" + "diff-sequences": "^29.0.0", + "jest-get-type": "^29.0.0", + "pretty-format": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-diff/node_modules/chalk": { @@ -11768,18 +11896,17 @@ } }, "node_modules/jest-diff/node_modules/pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-diff/node_modules/pretty-format/node_modules/ansi-styles": { @@ -11801,40 +11928,40 @@ "dev": true }, "node_modules/jest-docblock": { - "version": "28.1.1", - "resolved": "https://registry.npmjs.org/jest-docblock/-/jest-docblock-28.1.1.tgz", - "integrity": "sha512-3wayBVNiOYx0cwAbl9rwm5kKFP8yHH3d/fkEaL02NPTkDojPtheGB7HZSFY4wzX+DxyrvhXz0KSCVksmCknCuA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-docblock/-/jest-docblock-29.0.0.tgz", + "integrity": "sha512-s5Kpra/kLzbqu9dEjov30kj1n4tfu3e7Pl8v+f8jOkeWNqM6Ds8jRaJfZow3ducoQUrf2Z4rs2N5S3zXnb83gw==", "dev": true, "dependencies": { "detect-newline": "^3.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-each": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-each/-/jest-each-28.1.3.tgz", - "integrity": "sha512-arT1z4sg2yABU5uogObVPvSlSMQlDA48owx07BDPAiasW0yYpYHYOo4HHLz9q0BVzDVU4hILFjzJw0So9aCL/g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-each/-/jest-each-29.0.0.tgz", + "integrity": "sha512-ACKRvqdo7Bc0YrjQbrQtokpQ2NZxdXA63OklJht7a9UarCJXlZeWh51wEUe0ORqbnu15nAnX1YFQHmVpS1+ZXA==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "chalk": "^4.0.0", - "jest-get-type": "^28.0.2", - "jest-util": "^28.1.3", - "pretty-format": "^28.1.3" + "jest-get-type": "^29.0.0", + "jest-util": "^29.0.0", + "pretty-format": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-each/node_modules/@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -11842,13 +11969,13 @@ "chalk": "^4.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-each/node_modules/@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "dependencies": { "@types/yargs-parser": "*" @@ -11871,12 +11998,12 @@ } }, "node_modules/jest-each/node_modules/jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -11884,22 +12011,21 @@ "picomatch": "^2.2.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-each/node_modules/pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-each/node_modules/pretty-format/node_modules/ansi-styles": { @@ -11989,12 +12115,12 @@ } }, "node_modules/jest-get-type": { - "version": "28.0.2", - "resolved": "https://registry.npmjs.org/jest-get-type/-/jest-get-type-28.0.2.tgz", - "integrity": "sha512-ioj2w9/DxSYHfOm5lJKCdcAmPJzQXmbM/Url3rhlghrPvT3tt+7a/+oXc9azkKmLvoiXjtV83bEWqi+vs5nlPA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-get-type/-/jest-get-type-29.0.0.tgz", + "integrity": "sha512-83X19z/HuLKYXYHskZlBAShO7UfLFXu/vWajw9ZNJASN32li8yHMaVGAQqxFW1RCFOkB7cubaL6FaJVQqqJLSw==", "dev": true, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-github-actions-reporter": { @@ -12006,37 +12132,37 @@ } }, "node_modules/jest-haste-map": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-haste-map/-/jest-haste-map-28.1.3.tgz", - "integrity": "sha512-3S+RQWDXccXDKSWnkHa/dPwt+2qwA8CJzR61w3FoYCvoo3Pn8tvGcysmMF0Bj0EX5RYvAI2EIvC57OmotfdtKA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-haste-map/-/jest-haste-map-29.0.0.tgz", + "integrity": "sha512-mLyDt2WyNU0DZ64s7kRFkFJzrHEuXIxG+OKOs9/P5s1W7NzXE+P7SvLbxjz2Cg63cJjuglYRrD6fZcYf19T8Lw==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/graceful-fs": "^4.1.3", "@types/node": "*", "anymatch": "^3.0.3", "fb-watchman": "^2.0.0", "graceful-fs": "^4.2.9", - "jest-regex-util": "^28.0.2", - "jest-util": "^28.1.3", - "jest-worker": "^28.1.3", + "jest-regex-util": "^29.0.0", + "jest-util": "^29.0.0", + "jest-worker": "^29.0.0", "micromatch": "^4.0.4", "walker": "^1.0.8" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" }, "optionalDependencies": { "fsevents": "^2.3.2" } }, "node_modules/jest-haste-map/node_modules/@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -12044,13 +12170,13 @@ "chalk": "^4.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-haste-map/node_modules/@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "dependencies": { "@types/yargs-parser": "*" @@ -12073,12 +12199,12 @@ } }, "node_modules/jest-haste-map/node_modules/jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -12086,13 +12212,13 @@ "picomatch": "^2.2.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-haste-map/node_modules/jest-worker": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-28.1.3.tgz", - "integrity": "sha512-CqRA220YV/6jCo8VWvAt1KKx6eek1VIHMPeLEbpcfSfkEeWyBNppynM/o6q+Wmw+sOhos2ml34wZbSX3G13//g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-29.0.0.tgz", + "integrity": "sha512-2t9Panx3F9N1wAvRuZT7xLEptRFc1C5G90DOHniIGz1JIgF9uhd5u8jNBsc7wN63lhnaiLeVLnNx21wT7OVFEQ==", "dev": true, "dependencies": { "@types/node": "*", @@ -12100,7 +12226,7 @@ "supports-color": "^8.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-haste-map/node_modules/jest-worker/node_modules/supports-color": { @@ -12119,16 +12245,16 @@ } }, "node_modules/jest-leak-detector": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-leak-detector/-/jest-leak-detector-28.1.3.tgz", - "integrity": "sha512-WFVJhnQsiKtDEo5lG2mM0v40QWnBM+zMdHHyJs8AWZ7J0QZJS59MsyKeJHWhpBZBH32S48FOVvGyOFT1h0DlqA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-leak-detector/-/jest-leak-detector-29.0.0.tgz", + "integrity": "sha512-kBjNS0/z2+ZV/3N7R+ot5fKD2W1fHkoxC3kH/fkb2z24YSPfR9RGwiNX+YLRG9r0gWsxQx16boxzHT23G6rFBw==", "dev": true, "dependencies": { - "jest-get-type": "^28.0.2", - "pretty-format": "^28.1.3" + "jest-get-type": "^29.0.0", + "pretty-format": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-leak-detector/node_modules/ansi-styles": { @@ -12144,18 +12270,17 @@ } }, "node_modules/jest-leak-detector/node_modules/pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-leak-detector/node_modules/react-is": { @@ -12165,18 +12290,18 @@ "dev": true }, "node_modules/jest-matcher-utils": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-matcher-utils/-/jest-matcher-utils-28.1.3.tgz", - "integrity": "sha512-kQeJ7qHemKfbzKoGjHHrRKH6atgxMk8Enkk2iPQ3XwO6oE/KYD8lMYOziCkeSB9G4adPM4nR1DE8Tf5JeWH6Bw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-matcher-utils/-/jest-matcher-utils-29.0.0.tgz", + "integrity": "sha512-HtCxFHI8lQSbN1RppFjtl6DIrS+x4d3lOhpJljVxFEXob4lxlKon3FunW0XoGxNSvIoD00AfTFspnufpOqszrg==", "dev": true, "dependencies": { "chalk": "^4.0.0", - "jest-diff": "^28.1.3", - "jest-get-type": "^28.0.2", - "pretty-format": "^28.1.3" + "jest-diff": "^29.0.0", + "jest-get-type": "^29.0.0", + "pretty-format": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-matcher-utils/node_modules/chalk": { @@ -12196,18 +12321,17 @@ } }, "node_modules/jest-matcher-utils/node_modules/pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-matcher-utils/node_modules/pretty-format/node_modules/ansi-styles": { @@ -12313,54 +12437,54 @@ } }, "node_modules/jest-regex-util": { - "version": "28.0.2", - "resolved": "https://registry.npmjs.org/jest-regex-util/-/jest-regex-util-28.0.2.tgz", - "integrity": "sha512-4s0IgyNIy0y9FK+cjoVYoxamT7Zeo7MhzqRGx7YDYmaQn1wucY9rotiGkBzzcMXTtjrCAP/f7f+E0F7+fxPNdw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-regex-util/-/jest-regex-util-29.0.0.tgz", + "integrity": "sha512-BV7VW7Sy0fInHWN93MMPtlClweYv2qrSCwfeFWmpribGZtQPWNvRSq9XOVgOEjU1iBGRKXUZil0o2AH7Iy9Lug==", "dev": true, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-resolve": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-resolve/-/jest-resolve-28.1.3.tgz", - "integrity": "sha512-Z1W3tTjE6QaNI90qo/BJpfnvpxtaFTFw5CDgwpyE/Kz8U/06N1Hjf4ia9quUhCh39qIGWF1ZuxFiBiJQwSEYKQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-resolve/-/jest-resolve-29.0.0.tgz", + "integrity": "sha512-MN19maPUXzibBshYg/cSrDWqiJwEBur6gbQb2lwOL4+6k14wdNW8Xh0uNPPxUntb7cpTi07uql/bUO5TVwiJbA==", "dev": true, "dependencies": { "chalk": "^4.0.0", "graceful-fs": "^4.2.9", - "jest-haste-map": "^28.1.3", + "jest-haste-map": "^29.0.0", "jest-pnp-resolver": "^1.2.2", - "jest-util": "^28.1.3", - "jest-validate": "^28.1.3", + "jest-util": "^29.0.0", + "jest-validate": "^29.0.0", "resolve": "^1.20.0", "resolve.exports": "^1.1.0", "slash": "^3.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-resolve-dependencies": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-resolve-dependencies/-/jest-resolve-dependencies-28.1.3.tgz", - "integrity": "sha512-qa0QO2Q0XzQoNPouMbCc7Bvtsem8eQgVPNkwn9LnS+R2n8DaVDPL/U1gngC0LTl1RYXJU0uJa2BMC2DbTfFrHA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-resolve-dependencies/-/jest-resolve-dependencies-29.0.0.tgz", + "integrity": "sha512-1TYUMcLZcUqa2fdUQ3leYtiXWXfNmimPvnJ34YDLLf0nyJ/aEeqlHJM9Ji2jw9Qxdh7nUypanjUlUV87yRHBFQ==", "dev": true, "dependencies": { - "jest-regex-util": "^28.0.2", - "jest-snapshot": "^28.1.3" + "jest-regex-util": "^29.0.0", + "jest-snapshot": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-resolve/node_modules/@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -12368,13 +12492,13 @@ "chalk": "^4.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-resolve/node_modules/@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "dependencies": { "@types/yargs-parser": "*" @@ -12397,12 +12521,12 @@ } }, "node_modules/jest-resolve/node_modules/jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -12410,7 +12534,7 @@ "picomatch": "^2.2.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-resolve/node_modules/slash": { @@ -12423,76 +12547,76 @@ } }, "node_modules/jest-runner": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-runner/-/jest-runner-28.1.3.tgz", - "integrity": "sha512-GkMw4D/0USd62OVO0oEgjn23TM+YJa2U2Wu5zz9xsQB1MxWKDOlrnykPxnMsN0tnJllfLPinHTka61u0QhaxBA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-runner/-/jest-runner-29.0.0.tgz", + "integrity": "sha512-OpTpRIBOIn9RXuMMrpS+h9ZoK+nZHaOuNOceUiDbDoOJ6pmeGu0zst7VR22xXT3fOCwWqg5qe0fZ23G+ve5P0Q==", "dev": true, "dependencies": { - "@jest/console": "^28.1.3", - "@jest/environment": "^28.1.3", - "@jest/test-result": "^28.1.3", - "@jest/transform": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/console": "^29.0.0", + "@jest/environment": "^29.0.0", + "@jest/test-result": "^29.0.0", + "@jest/transform": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "emittery": "^0.10.2", "graceful-fs": "^4.2.9", - "jest-docblock": "^28.1.1", - "jest-environment-node": "^28.1.3", - "jest-haste-map": "^28.1.3", - "jest-leak-detector": "^28.1.3", - "jest-message-util": "^28.1.3", - "jest-resolve": "^28.1.3", - "jest-runtime": "^28.1.3", - "jest-util": "^28.1.3", - "jest-watcher": "^28.1.3", - "jest-worker": "^28.1.3", + "jest-docblock": "^29.0.0", + "jest-environment-node": "^29.0.0", + "jest-haste-map": "^29.0.0", + "jest-leak-detector": "^29.0.0", + "jest-message-util": "^29.0.0", + "jest-resolve": "^29.0.0", + "jest-runtime": "^29.0.0", + "jest-util": "^29.0.0", + "jest-watcher": "^29.0.0", + "jest-worker": "^29.0.0", "p-limit": "^3.1.0", "source-map-support": "0.5.13" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-runner/node_modules/@jest/environment": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-28.1.3.tgz", - "integrity": "sha512-1bf40cMFTEkKyEf585R9Iz1WayDjHoHqvts0XFYEqyKM3cFWDpeMoqKKTAF9LSYQModPUlh8FKptoM2YcMWAXA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-29.0.0.tgz", + "integrity": "sha512-ZHLvUENMAnwXowtyhmPRS0QLCXM4TS0ZfuiSR4QfRsJVN5lG4KdBDvI9kHJe/21vrgzPVOkvI7IBnkyPFCbV7g==", "dev": true, "dependencies": { - "@jest/fake-timers": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/fake-timers": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", - "jest-mock": "^28.1.3" + "jest-mock": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-runner/node_modules/@jest/fake-timers": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-28.1.3.tgz", - "integrity": "sha512-D/wOkL2POHv52h+ok5Oj/1gOG9HSywdoPtFsRCUmlCILXNn5eIWmcnd3DIiWlJnpGvQtmajqBP95Ei0EimxfLw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-29.0.0.tgz", + "integrity": "sha512-4tqH5fT9H0+Ms3Z1HLZ/JfpzJluep2Zo3uuj0KPyu6IIyYSHCDfkXuiBQNWUGvumZDLQ2Si03cC7Gq0r73VgVg==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@sinonjs/fake-timers": "^9.1.2", "@types/node": "*", - "jest-message-util": "^28.1.3", - "jest-mock": "^28.1.3", - "jest-util": "^28.1.3" + "jest-message-util": "^29.0.0", + "jest-mock": "^29.0.0", + "jest-util": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-runner/node_modules/@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -12500,7 +12624,7 @@ "chalk": "^4.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-runner/node_modules/@sinonjs/fake-timers": { @@ -12513,9 +12637,9 @@ } }, "node_modules/jest-runner/node_modules/@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "dependencies": { "@types/yargs-parser": "*" @@ -12538,62 +12662,62 @@ } }, "node_modules/jest-runner/node_modules/jest-environment-node": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-28.1.3.tgz", - "integrity": "sha512-ugP6XOhEpjAEhGYvp5Xj989ns5cB1K6ZdjBYuS30umT4CQEETaxSiPcZ/E1kFktX4GkrcM4qu07IIlDYX1gp+A==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-29.0.0.tgz", + "integrity": "sha512-Cns21Vgu0z7LjtssL0SWkxmjclHdwXeECFAP3ONit5NPnGCbv+0Rqby8w9vK7NpFlUaFgMmLYYBsUjSmIhwpvg==", "dev": true, "dependencies": { - "@jest/environment": "^28.1.3", - "@jest/fake-timers": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/environment": "^29.0.0", + "@jest/fake-timers": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", - "jest-mock": "^28.1.3", - "jest-util": "^28.1.3" + "jest-mock": "^29.0.0", + "jest-util": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-runner/node_modules/jest-message-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", - "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.0.0.tgz", + "integrity": "sha512-4U0RdNV0TBTgVGzEchjryEpq4sqLO3gUQT7TEIbO5+q0K5MuiofOPcXk4GLpWviWByMRJjliQNMuzJ4YGT+oGQ==", "dev": true, "dependencies": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-runner/node_modules/jest-mock": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-28.1.3.tgz", - "integrity": "sha512-o3J2jr6dMMWYVH4Lh/NKmDXdosrsJgi4AviS8oXLujcjpCMBb1FMsblDnOXKZKfSiHLxYub1eS0IHuRXsio9eA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-29.0.0.tgz", + "integrity": "sha512-0AWznVt415KMCxcJPaE2+tWaruw0w8aRrKH1Y/NZUx3+Pd9f20jQjUR82iHqGSuYS4EOHL9uI8SjAhJk+ET91g==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-runner/node_modules/jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -12601,13 +12725,13 @@ "picomatch": "^2.2.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-runner/node_modules/jest-worker": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-28.1.3.tgz", - "integrity": "sha512-CqRA220YV/6jCo8VWvAt1KKx6eek1VIHMPeLEbpcfSfkEeWyBNppynM/o6q+Wmw+sOhos2ml34wZbSX3G13//g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-29.0.0.tgz", + "integrity": "sha512-2t9Panx3F9N1wAvRuZT7xLEptRFc1C5G90DOHniIGz1JIgF9uhd5u8jNBsc7wN63lhnaiLeVLnNx21wT7OVFEQ==", "dev": true, "dependencies": { "@types/node": "*", @@ -12615,7 +12739,7 @@ "supports-color": "^8.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-runner/node_modules/jest-worker/node_modules/supports-color": { @@ -12634,18 +12758,17 @@ } }, "node_modules/jest-runner/node_modules/pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-runner/node_modules/pretty-format/node_modules/ansi-styles": { @@ -12686,77 +12809,77 @@ } }, "node_modules/jest-runtime": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-runtime/-/jest-runtime-28.1.3.tgz", - "integrity": "sha512-NU+881ScBQQLc1JHG5eJGU7Ui3kLKrmwCPPtYsJtBykixrM2OhVQlpMmFWJjMyDfdkGgBMNjXCGB/ebzsgNGQw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-runtime/-/jest-runtime-29.0.0.tgz", + "integrity": "sha512-dU0qFpTRWZY7Rur7yBgpz4g67mITSozBZ1jlhoG4ER/P/NiTFyZ/W8nMd5floeAMafmbrOc/5A9SlCu7SQCoBA==", "dev": true, "dependencies": { - "@jest/environment": "^28.1.3", - "@jest/fake-timers": "^28.1.3", - "@jest/globals": "^28.1.3", - "@jest/source-map": "^28.1.2", - "@jest/test-result": "^28.1.3", - "@jest/transform": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/environment": "^29.0.0", + "@jest/fake-timers": "^29.0.0", + "@jest/globals": "^29.0.0", + "@jest/source-map": "^29.0.0", + "@jest/test-result": "^29.0.0", + "@jest/transform": "^29.0.0", + "@jest/types": "^29.0.0", + "@types/node": "*", "chalk": "^4.0.0", "cjs-module-lexer": "^1.0.0", "collect-v8-coverage": "^1.0.0", - "execa": "^5.0.0", "glob": "^7.1.3", "graceful-fs": "^4.2.9", - "jest-haste-map": "^28.1.3", - "jest-message-util": "^28.1.3", - "jest-mock": "^28.1.3", - "jest-regex-util": "^28.0.2", - "jest-resolve": "^28.1.3", - "jest-snapshot": "^28.1.3", - "jest-util": "^28.1.3", + "jest-haste-map": "^29.0.0", + "jest-message-util": "^29.0.0", + "jest-mock": "^29.0.0", + "jest-regex-util": "^29.0.0", + "jest-resolve": "^29.0.0", + "jest-snapshot": "^29.0.0", + "jest-util": "^29.0.0", "slash": "^3.0.0", "strip-bom": "^4.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-runtime/node_modules/@jest/environment": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-28.1.3.tgz", - "integrity": "sha512-1bf40cMFTEkKyEf585R9Iz1WayDjHoHqvts0XFYEqyKM3cFWDpeMoqKKTAF9LSYQModPUlh8FKptoM2YcMWAXA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-29.0.0.tgz", + "integrity": "sha512-ZHLvUENMAnwXowtyhmPRS0QLCXM4TS0ZfuiSR4QfRsJVN5lG4KdBDvI9kHJe/21vrgzPVOkvI7IBnkyPFCbV7g==", "dev": true, "dependencies": { - "@jest/fake-timers": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/fake-timers": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", - "jest-mock": "^28.1.3" + "jest-mock": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-runtime/node_modules/@jest/fake-timers": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-28.1.3.tgz", - "integrity": "sha512-D/wOkL2POHv52h+ok5Oj/1gOG9HSywdoPtFsRCUmlCILXNn5eIWmcnd3DIiWlJnpGvQtmajqBP95Ei0EimxfLw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-29.0.0.tgz", + "integrity": "sha512-4tqH5fT9H0+Ms3Z1HLZ/JfpzJluep2Zo3uuj0KPyu6IIyYSHCDfkXuiBQNWUGvumZDLQ2Si03cC7Gq0r73VgVg==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@sinonjs/fake-timers": "^9.1.2", "@types/node": "*", - "jest-message-util": "^28.1.3", - "jest-mock": "^28.1.3", - "jest-util": "^28.1.3" + "jest-message-util": "^29.0.0", + "jest-mock": "^29.0.0", + "jest-util": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-runtime/node_modules/@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -12764,7 +12887,7 @@ "chalk": "^4.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-runtime/node_modules/@sinonjs/fake-timers": { @@ -12777,9 +12900,9 @@ } }, "node_modules/jest-runtime/node_modules/@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "dependencies": { "@types/yargs-parser": "*" @@ -12832,45 +12955,45 @@ } }, "node_modules/jest-runtime/node_modules/jest-message-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", - "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.0.0.tgz", + "integrity": "sha512-4U0RdNV0TBTgVGzEchjryEpq4sqLO3gUQT7TEIbO5+q0K5MuiofOPcXk4GLpWviWByMRJjliQNMuzJ4YGT+oGQ==", "dev": true, "dependencies": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-runtime/node_modules/jest-mock": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-28.1.3.tgz", - "integrity": "sha512-o3J2jr6dMMWYVH4Lh/NKmDXdosrsJgi4AviS8oXLujcjpCMBb1FMsblDnOXKZKfSiHLxYub1eS0IHuRXsio9eA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-29.0.0.tgz", + "integrity": "sha512-0AWznVt415KMCxcJPaE2+tWaruw0w8aRrKH1Y/NZUx3+Pd9f20jQjUR82iHqGSuYS4EOHL9uI8SjAhJk+ET91g==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-runtime/node_modules/jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -12878,7 +13001,7 @@ "picomatch": "^2.2.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-runtime/node_modules/minimatch": { @@ -12894,18 +13017,17 @@ } }, "node_modules/jest-runtime/node_modules/pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-runtime/node_modules/pretty-format/node_modules/ansi-styles": { @@ -12941,46 +13063,47 @@ "license": "MIT" }, "node_modules/jest-snapshot": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-snapshot/-/jest-snapshot-28.1.3.tgz", - "integrity": "sha512-4lzMgtiNlc3DU/8lZfmqxN3AYD6GGLbl+72rdBpXvcV+whX7mDrREzkPdp2RnmfIiWBg1YbuFSkXduF2JcafJg==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-snapshot/-/jest-snapshot-29.0.0.tgz", + "integrity": "sha512-rR3B8GInk/IibF0M/sQCukSM8xX8bPI3Q0kjoAw4HT9Mx0Q3bS0MmF74rsreBOnVJgzN0Iwrc7YY56Yp8KQ7kA==", "dev": true, "dependencies": { "@babel/core": "^7.11.6", "@babel/generator": "^7.7.2", + "@babel/plugin-syntax-jsx": "^7.7.2", "@babel/plugin-syntax-typescript": "^7.7.2", "@babel/traverse": "^7.7.2", "@babel/types": "^7.3.3", - "@jest/expect-utils": "^28.1.3", - "@jest/transform": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/expect-utils": "^29.0.0", + "@jest/transform": "^29.0.0", + "@jest/types": "^29.0.0", "@types/babel__traverse": "^7.0.6", "@types/prettier": "^2.1.5", "babel-preset-current-node-syntax": "^1.0.0", "chalk": "^4.0.0", - "expect": "^28.1.3", + "expect": "^29.0.0", "graceful-fs": "^4.2.9", - "jest-diff": "^28.1.3", - "jest-get-type": "^28.0.2", - "jest-haste-map": "^28.1.3", - "jest-matcher-utils": "^28.1.3", - "jest-message-util": "^28.1.3", - "jest-util": "^28.1.3", + "jest-diff": "^29.0.0", + "jest-get-type": "^29.0.0", + "jest-haste-map": "^29.0.0", + "jest-matcher-utils": "^29.0.0", + "jest-message-util": "^29.0.0", + "jest-util": "^29.0.0", "natural-compare": "^1.4.0", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "semver": "^7.3.5" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-snapshot/node_modules/@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -12988,13 +13111,13 @@ "chalk": "^4.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-snapshot/node_modules/@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "dependencies": { "@types/yargs-parser": "*" @@ -13017,32 +13140,32 @@ } }, "node_modules/jest-snapshot/node_modules/jest-message-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", - "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.0.0.tgz", + "integrity": "sha512-4U0RdNV0TBTgVGzEchjryEpq4sqLO3gUQT7TEIbO5+q0K5MuiofOPcXk4GLpWviWByMRJjliQNMuzJ4YGT+oGQ==", "dev": true, "dependencies": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-snapshot/node_modules/jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -13050,22 +13173,21 @@ "picomatch": "^2.2.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-snapshot/node_modules/pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-snapshot/node_modules/pretty-format/node_modules/ansi-styles": { @@ -13127,29 +13249,29 @@ } }, "node_modules/jest-validate": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-validate/-/jest-validate-28.1.3.tgz", - "integrity": "sha512-SZbOGBWEsaTxBGCOpsRWlXlvNkvTkY0XxRfh7zYmvd8uL5Qzyg0CHAXiXKROflh801quA6+/DsT4ODDthOC/OA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-validate/-/jest-validate-29.0.0.tgz", + "integrity": "sha512-UhgDKmahJnv5s5MK6a8kQ397YNS9euvL7gWTvUf7y0OO7vZeafUItlq3tguvfFVazQJ+kBGUm/XCJes7V61l8g==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "camelcase": "^6.2.0", "chalk": "^4.0.0", - "jest-get-type": "^28.0.2", + "jest-get-type": "^29.0.0", "leven": "^3.1.0", - "pretty-format": "^28.1.3" + "pretty-format": "^29.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-validate/node_modules/@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -13157,13 +13279,13 @@ "chalk": "^4.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-validate/node_modules/@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "dependencies": { "@types/yargs-parser": "*" @@ -13198,18 +13320,17 @@ } }, "node_modules/jest-validate/node_modules/pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-validate/node_modules/pretty-format/node_modules/ansi-styles": { @@ -13231,31 +13352,31 @@ "dev": true }, "node_modules/jest-watcher": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-watcher/-/jest-watcher-28.1.3.tgz", - "integrity": "sha512-t4qcqj9hze+jviFPUN3YAtAEeFnr/azITXQEMARf5cMwKY2SMBRnCQTXLixTl20OR6mLh9KLMrgVJgJISym+1g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-watcher/-/jest-watcher-29.0.0.tgz", + "integrity": "sha512-GoRq5QJt5/dv3keK7rIzg9R0e/HpTnjyMNYtCTTDZgGIj6QUDMpiJqt7Mwfyyaxwg5PS8gVyQvRQn6Lril4cuQ==", "dev": true, "dependencies": { - "@jest/test-result": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/test-result": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", "ansi-escapes": "^4.2.1", "chalk": "^4.0.0", "emittery": "^0.10.2", - "jest-util": "^28.1.3", + "jest-util": "^29.0.0", "string-length": "^4.0.1" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-watcher/node_modules/@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -13263,13 +13384,13 @@ "chalk": "^4.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-watcher/node_modules/@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "dependencies": { "@types/yargs-parser": "*" @@ -13292,12 +13413,12 @@ } }, "node_modules/jest-watcher/node_modules/jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "dependencies": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -13305,7 +13426,7 @@ "picomatch": "^2.2.3" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest-worker": { @@ -13340,12 +13461,12 @@ } }, "node_modules/jest/node_modules/@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "dependencies": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -13353,13 +13474,13 @@ "chalk": "^4.0.0" }, "engines": { - "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, "node_modules/jest/node_modules/@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "dependencies": { "@types/yargs-parser": "*" @@ -13459,14 +13580,6 @@ "node": ">=6" } }, - "node_modules/jsonexport": { - "version": "3.2.0", - "dev": true, - "license": "Apache-2.0", - "bin": { - "jsonexport": "bin/jsonexport.js" - } - }, "node_modules/jsonfile": { "version": "6.1.0", "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", @@ -13547,14 +13660,18 @@ } }, "node_modules/latest-version": { - "version": "5.1.0", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/latest-version/-/latest-version-7.0.0.tgz", + "integrity": "sha512-KvNT4XqAMzdcL6ka6Tl3i2lYeFDgXNCuIX+xNx6ZMVR1dFq+idXd9FLKNMOIx0t9mJ9/HudyX4oZWXZQ0UJHeg==", "dev": true, - "license": "MIT", "dependencies": { - "package-json": "^6.3.0" + "package-json": "^8.1.0" }, "engines": { - "node": ">=8" + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/lazy-ass": { @@ -13609,9 +13726,9 @@ "license": "MIT" }, "node_modules/linkinator": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/linkinator/-/linkinator-3.1.0.tgz", - "integrity": "sha512-ikQtLZ0JtY2JQXGZlzHID9Y87R4Zxe4TPAtFTem9T2UxQqXr0Ab8z9fse+apHEaD2l+WIX8f/P0IMODBMHhPWw==", + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/linkinator/-/linkinator-4.0.2.tgz", + "integrity": "sha512-PkwPiMx2NsRXaKQiOkTH8uMkkUrN3rh0gI6nFwjme2A7TVVYzlwGfmb00wbDEEdLrO49tDbajUEJGup64swmog==", "dev": true, "dependencies": { "chalk": "^5.0.0", @@ -13619,18 +13736,18 @@ "gaxios": "^5.0.0", "glob": "^8.0.1", "htmlparser2": "^8.0.1", - "jsonexport": "^3.2.0", "marked": "^4.0.3", "meow": "^10.1.1", "mime": "^3.0.0", "server-destroy": "^1.0.1", - "update-notifier": "^5.1.0" + "srcset": "^5.0.0", + "update-notifier": "^6.0.0" }, "bin": { "linkinator": "build/src/cli.js" }, "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + "node": ">=14" } }, "node_modules/linkinator/node_modules/mime": { @@ -15272,15 +15389,15 @@ "peer": true }, "node_modules/next": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/next/-/next-12.2.5.tgz", - "integrity": "sha512-tBdjqX5XC/oFs/6gxrZhjmiq90YWizUYU6qOWAfat7zJwrwapJ+BYgX2PmiacunXMaRpeVT4vz5MSPSLgNkrpA==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/next/-/next-12.2.4.tgz", + "integrity": "sha512-b1xlxEozmAWokAXzXsi5vlmU/IfJcFNIJA8dpU5UdkFbyDPio8wwb8mAQ/Y7rGtfTgG/t/u49BiyEA+xAgFvow==", "dependencies": { - "@next/env": "12.2.5", + "@next/env": "12.2.4", "@swc/helpers": "0.4.3", "caniuse-lite": "^1.0.30001332", "postcss": "8.4.14", - "styled-jsx": "5.0.4", + "styled-jsx": "5.0.2", "use-sync-external-store": "1.2.0" }, "bin": { @@ -15290,19 +15407,19 @@ "node": ">=12.22.0" }, "optionalDependencies": { - "@next/swc-android-arm-eabi": "12.2.5", - "@next/swc-android-arm64": "12.2.5", - "@next/swc-darwin-arm64": "12.2.5", - "@next/swc-darwin-x64": "12.2.5", - "@next/swc-freebsd-x64": "12.2.5", - "@next/swc-linux-arm-gnueabihf": "12.2.5", - "@next/swc-linux-arm64-gnu": "12.2.5", - "@next/swc-linux-arm64-musl": "12.2.5", - "@next/swc-linux-x64-gnu": "12.2.5", - "@next/swc-linux-x64-musl": "12.2.5", - "@next/swc-win32-arm64-msvc": "12.2.5", - "@next/swc-win32-ia32-msvc": "12.2.5", - "@next/swc-win32-x64-msvc": "12.2.5" + "@next/swc-android-arm-eabi": "12.2.4", + "@next/swc-android-arm64": "12.2.4", + "@next/swc-darwin-arm64": "12.2.4", + "@next/swc-darwin-x64": "12.2.4", + "@next/swc-freebsd-x64": "12.2.4", + "@next/swc-linux-arm-gnueabihf": "12.2.4", + "@next/swc-linux-arm64-gnu": "12.2.4", + "@next/swc-linux-arm64-musl": "12.2.4", + "@next/swc-linux-x64-gnu": "12.2.4", + "@next/swc-linux-x64-musl": "12.2.4", + "@next/swc-win32-arm64-msvc": "12.2.4", + "@next/swc-win32-ia32-msvc": "12.2.4", + "@next/swc-win32-x64-msvc": "12.2.4" }, "peerDependencies": { "fibers": ">= 3.1.0", @@ -15848,170 +15965,21 @@ } }, "node_modules/package-json": { - "version": "6.5.0", + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/package-json/-/package-json-8.1.0.tgz", + "integrity": "sha512-hySwcV8RAWeAfPsXb9/HGSPn8lwDnv6fabH+obUZKX169QknRkRhPxd1yMubpKDskLFATkl3jHpNtVtDPFA0Wg==", "dev": true, - "license": "MIT", "dependencies": { - "got": "^9.6.0", - "registry-auth-token": "^4.0.0", - "registry-url": "^5.0.0", - "semver": "^6.2.0" + "got": "^12.1.0", + "registry-auth-token": "^5.0.1", + "registry-url": "^6.0.0", + "semver": "^7.3.7" }, "engines": { - "node": ">=8" - } - }, - "node_modules/package-json/node_modules/@sindresorhus/is": { - "version": "0.14.0", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/package-json/node_modules/@szmarczak/http-timer": { - "version": "1.1.2", - "dev": true, - "license": "MIT", - "dependencies": { - "defer-to-connect": "^1.0.1" + "node": ">=14.16" }, - "engines": { - "node": ">=6" - } - }, - "node_modules/package-json/node_modules/cacheable-request": { - "version": "6.1.0", - "dev": true, - "license": "MIT", - "dependencies": { - "clone-response": "^1.0.2", - "get-stream": "^5.1.0", - "http-cache-semantics": "^4.0.0", - "keyv": "^3.0.0", - "lowercase-keys": "^2.0.0", - "normalize-url": "^4.1.0", - "responselike": "^1.0.2" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/package-json/node_modules/decompress-response": { - "version": "3.3.0", - "dev": true, - "license": "MIT", - "dependencies": { - "mimic-response": "^1.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/package-json/node_modules/defer-to-connect": { - "version": "1.1.3", - "dev": true, - "license": "MIT" - }, - "node_modules/package-json/node_modules/got": { - "version": "9.6.0", - "dev": true, - "license": "MIT", - "dependencies": { - "@sindresorhus/is": "^0.14.0", - "@szmarczak/http-timer": "^1.1.2", - "cacheable-request": "^6.0.0", - "decompress-response": "^3.3.0", - "duplexer3": "^0.1.4", - "get-stream": "^4.1.0", - "lowercase-keys": "^1.0.1", - "mimic-response": "^1.0.1", - "p-cancelable": "^1.0.0", - "to-readable-stream": "^1.0.0", - "url-parse-lax": "^3.0.0" - }, - "engines": { - "node": ">=8.6" - } - }, - "node_modules/package-json/node_modules/got/node_modules/get-stream": { - "version": "4.1.0", - "dev": true, - "license": "MIT", - "dependencies": { - "pump": "^3.0.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/package-json/node_modules/got/node_modules/lowercase-keys": { - "version": "1.0.1", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/package-json/node_modules/json-buffer": { - "version": "3.0.0", - "dev": true, - "license": "MIT" - }, - "node_modules/package-json/node_modules/keyv": { - "version": "3.1.0", - "dev": true, - "license": "MIT", - "dependencies": { - "json-buffer": "3.0.0" - } - }, - "node_modules/package-json/node_modules/normalize-url": { - "version": "4.5.1", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8" - } - }, - "node_modules/package-json/node_modules/p-cancelable": { - "version": "1.1.0", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, - "node_modules/package-json/node_modules/responselike": { - "version": "1.0.2", - "dev": true, - "license": "MIT", - "dependencies": { - "lowercase-keys": "^1.0.0" - } - }, - "node_modules/package-json/node_modules/responselike/node_modules/lowercase-keys": { - "version": "1.0.1", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/package-json/node_modules/semver": { - "version": "6.3.0", - "dev": true, - "license": "ISC", - "bin": { - "semver": "bin/semver.js" - } - }, - "node_modules/package-json/node_modules/to-readable-stream": { - "version": "1.0.0", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/param-case": { @@ -16455,6 +16423,12 @@ "url": "https://github.com/sponsors/wooorm" } }, + "node_modules/proto-list": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/proto-list/-/proto-list-1.2.4.tgz", + "integrity": "sha512-vtK/94akxsTMhe0/cbfpR+syPuszcuwhqVjJq26CuNDgFGj682oRBXOP5MJpv2r7JtE8MsiepGIqvvOTBwn2vA==", + "dev": true + }, "node_modules/proxy-addr": { "version": "2.0.7", "license": "MIT", @@ -16507,14 +16481,18 @@ } }, "node_modules/pupa": { - "version": "2.1.1", + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/pupa/-/pupa-3.1.0.tgz", + "integrity": "sha512-FLpr4flz5xZTSJxSeaheeMKN/EDzMdK7b8PTOC6a5PYFKTucWbdqjgqaEyH0shFiSJrVB1+Qqi4Tk19ccU6Aug==", "dev": true, - "license": "MIT", "dependencies": { - "escape-goat": "^2.0.0" + "escape-goat": "^4.0.0" }, "engines": { - "node": ">=8" + "node": ">=12.20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/puppeteer": { @@ -16663,8 +16641,9 @@ }, "node_modules/rc": { "version": "1.2.8", + "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", + "integrity": "sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==", "dev": true, - "license": "(BSD-2-Clause OR MIT OR Apache-2.0)", "dependencies": { "deep-extend": "^0.6.0", "ini": "~1.3.0", @@ -16677,8 +16656,9 @@ }, "node_modules/rc/node_modules/strip-json-comments": { "version": "2.0.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", + "integrity": "sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ==", "dev": true, - "license": "MIT", "engines": { "node": ">=0.10.0" } @@ -17148,25 +17128,30 @@ } }, "node_modules/registry-auth-token": { - "version": "4.2.1", + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/registry-auth-token/-/registry-auth-token-5.0.1.tgz", + "integrity": "sha512-UfxVOj8seK1yaIOiieV4FIP01vfBDLsY0H9sQzi9EbbUdJiuuBjJgLa1DpImXMNPnVkBD4eVxTEXcrZA6kfpJA==", "dev": true, - "license": "MIT", "dependencies": { - "rc": "^1.2.8" + "@pnpm/npm-conf": "^1.0.4" }, "engines": { - "node": ">=6.0.0" + "node": ">=14" } }, "node_modules/registry-url": { - "version": "5.1.0", + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/registry-url/-/registry-url-6.0.1.tgz", + "integrity": "sha512-+crtS5QjFRqFCoQmvGduwYWEBng99ZvmFvF+cUJkGYF1L1BfU8C6Zp9T7f5vPAwyLkUExpvK+ANVZmGU49qi4Q==", "dev": true, - "license": "MIT", "dependencies": { - "rc": "^1.2.8" + "rc": "1.2.8" }, "engines": { - "node": ">=8" + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/regjsgen": { @@ -18150,22 +18135,18 @@ } }, "node_modules/semver-diff": { - "version": "3.1.1", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/semver-diff/-/semver-diff-4.0.0.tgz", + "integrity": "sha512-0Ju4+6A8iOnpL/Thra7dZsSlOHYAHIeMxfhWQRI1/VLcT3WDBZKKtQt/QkBOsiIN9ZpuvHE6cGZ0x4glCMmfiA==", "dev": true, - "license": "MIT", "dependencies": { - "semver": "^6.3.0" + "semver": "^7.3.5" }, "engines": { - "node": ">=8" - } - }, - "node_modules/semver-diff/node_modules/semver": { - "version": "6.3.0", - "dev": true, - "license": "ISC", - "bin": { - "semver": "bin/semver.js" + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/send": { @@ -18629,7 +18610,7 @@ "version": "5.0.0", "resolved": "https://registry.npmjs.org/srcset/-/srcset-5.0.0.tgz", "integrity": "sha512-SqEZaAEhe0A6ETEa9O1IhSPC7MdvehZtCnTR0AftXk3QhY2UNgb+NApFOUPZILXk/YTDfFxMTNJOBpzrJsEdIA==", - "optional": true, + "devOptional": true, "engines": { "node": "^12.20.0 || ^14.13.1 || >=16.0.0" }, @@ -18977,9 +18958,9 @@ } }, "node_modules/styled-jsx": { - "version": "5.0.4", - "resolved": "https://registry.npmjs.org/styled-jsx/-/styled-jsx-5.0.4.tgz", - "integrity": "sha512-sDFWLbg4zR+UkNzfk5lPilyIgtpddfxXEULxhujorr5jtePTUqiPDc5BC0v1NRqTr/WaFBGQQUoYToGlF4B2KQ==", + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/styled-jsx/-/styled-jsx-5.0.2.tgz", + "integrity": "sha512-LqPQrbBh3egD57NBcHET4qcgshPks+yblyhPlH2GY8oaDgKs8SK4C3dBh3oSJjgzJ3G5t1SYEZGHkP+QEpX9EQ==", "engines": { "node": ">= 12.0.0" }, @@ -19504,8 +19485,9 @@ }, "node_modules/typedarray-to-buffer": { "version": "3.1.5", + "resolved": "https://registry.npmjs.org/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz", + "integrity": "sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==", "dev": true, - "license": "MIT", "dependencies": { "is-typedarray": "^1.0.0" } @@ -19642,14 +19624,18 @@ } }, "node_modules/unique-string": { - "version": "2.0.0", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/unique-string/-/unique-string-3.0.0.tgz", + "integrity": "sha512-VGXBUVwxKMBUznyffQweQABPRRW1vHZAbadFZud4pLFAqRGvv/96vafgjWFqzourzr8YonlQiPgH0YCJfawoGQ==", "dev": true, - "license": "MIT", "dependencies": { - "crypto-random-string": "^2.0.0" + "crypto-random-string": "^4.0.0" }, "engines": { - "node": ">=8" + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/unist-builder": { @@ -19831,47 +19817,33 @@ } }, "node_modules/update-notifier": { - "version": "5.1.0", + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/update-notifier/-/update-notifier-6.0.2.tgz", + "integrity": "sha512-EDxhTEVPZZRLWYcJ4ZXjGFN0oP7qYvbXWzEgRm/Yql4dHX5wDbvh89YHP6PK1lzZJYrMtXUuZZz8XGK+U6U1og==", "dev": true, - "license": "BSD-2-Clause", "dependencies": { - "boxen": "^5.0.0", - "chalk": "^4.1.0", - "configstore": "^5.0.1", - "has-yarn": "^2.1.0", - "import-lazy": "^2.1.0", - "is-ci": "^2.0.0", + "boxen": "^7.0.0", + "chalk": "^5.0.1", + "configstore": "^6.0.0", + "has-yarn": "^3.0.0", + "import-lazy": "^4.0.0", + "is-ci": "^3.0.1", "is-installed-globally": "^0.4.0", - "is-npm": "^5.0.0", - "is-yarn-global": "^0.3.0", - "latest-version": "^5.1.0", - "pupa": "^2.1.1", - "semver": "^7.3.4", - "semver-diff": "^3.1.1", - "xdg-basedir": "^4.0.0" + "is-npm": "^6.0.0", + "is-yarn-global": "^0.4.0", + "latest-version": "^7.0.0", + "pupa": "^3.1.0", + "semver": "^7.3.7", + "semver-diff": "^4.0.0", + "xdg-basedir": "^5.1.0" }, "engines": { - "node": ">=10" + "node": ">=14.16" }, "funding": { "url": "https://github.com/yeoman/update-notifier?sponsor=1" } }, - "node_modules/update-notifier/node_modules/chalk": { - "version": "4.1.2", - "dev": true, - "license": "MIT", - "dependencies": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/chalk?sponsor=1" - } - }, "node_modules/upper-case": { "version": "2.0.2", "dev": true, @@ -19895,25 +19867,6 @@ "punycode": "^2.1.0" } }, - "node_modules/url-parse-lax": { - "version": "3.0.0", - "dev": true, - "license": "MIT", - "dependencies": { - "prepend-http": "^2.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/url-parse-lax/node_modules/prepend-http": { - "version": "2.0.0", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=4" - } - }, "node_modules/url-template": { "version": "3.0.0", "license": "BSD-3-Clause", @@ -20543,14 +20496,35 @@ "license": "ISC" }, "node_modules/widest-line": { - "version": "3.1.0", + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-4.0.1.tgz", + "integrity": "sha512-o0cyEG0e8GPzT4iGHphIOh0cJOV8fivsXxddQasHPHfoZf1ZexrfeA21w2NaEN1RHE+fXlfISmOE8R9N3u3Qig==", "dev": true, - "license": "MIT", "dependencies": { - "string-width": "^4.0.0" + "string-width": "^5.0.1" }, "engines": { - "node": ">=8" + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/widest-line/node_modules/string-width": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", + "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", + "dev": true, + "dependencies": { + "eastasianwidth": "^0.2.0", + "emoji-regex": "^9.2.2", + "strip-ansi": "^7.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/word-wrap": { @@ -20594,8 +20568,9 @@ }, "node_modules/write-file-atomic": { "version": "3.0.3", + "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-3.0.3.tgz", + "integrity": "sha512-AvHcyZ5JnSfq3ioSyjrBkH9yW4m7Ayk8/9My/DD9onKeu/94fwrMocemO2QAJFAlnnDN+ZDS+ZjAR5ua1/PV/Q==", "dev": true, - "license": "ISC", "dependencies": { "imurmurhash": "^0.1.4", "is-typedarray": "^1.0.0", @@ -20625,11 +20600,15 @@ } }, "node_modules/xdg-basedir": { - "version": "4.0.0", + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-5.1.0.tgz", + "integrity": "sha512-GCPAHLvrIH13+c0SuacwvRYj2SxJXQ4kaVTT5xgL3kPrz56XxkF21IGhjSE1+W0aw7gpBWRGXLCPnPby6lSpmQ==", "dev": true, - "license": "MIT", "engines": { - "node": ">=8" + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/xml2js": { @@ -20706,9 +20685,9 @@ } }, "node_modules/yargs/node_modules/yargs-parser": { - "version": "21.0.1", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.0.1.tgz", - "integrity": "sha512-9BK1jFpLzJROCI5TzwZL/TU4gqjK5xiHV/RfWLOahrjAko/e4DJkRDZQXfvqAsiZzzYhgAzbgz6lg48jcm4GLg==", + "version": "21.1.1", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", + "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", "dev": true, "engines": { "node": ">=12" @@ -21013,9 +20992,9 @@ } }, "@babel/helper-plugin-utils": { - "version": "7.17.12", - "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.17.12.tgz", - "integrity": "sha512-JDkf04mqtN3y4iAbO1hv9U2ARpPyPL1zqyWs/2WG1pgSq9llHFjStX5jdxb84himgJm+8Ng+x0oiWF/nw/XQKA==", + "version": "7.18.9", + "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.18.9.tgz", + "integrity": "sha512-aBXPT3bmtLryXaoJLyYPXPlSD4p1ld9aYeR+sJNOZjJJGiOpb+fKfh3NkcCu7J54nUJwCERPBExCCpyCOHnu/w==", "dev": true }, "@babel/helper-remap-async-to-generator": { @@ -21391,6 +21370,15 @@ "@babel/helper-plugin-utils": "^7.8.0" } }, + "@babel/plugin-syntax-jsx": { + "version": "7.18.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.18.6.tgz", + "integrity": "sha512-6mmljtAedFGTWu2p/8WIORGwy+61PLgOMPOdazc7YoJ9ZCWUyFy3A6CpPkRKLKD1ToAesxX8KGEViAiLo9N+7Q==", + "dev": true, + "requires": { + "@babel/helper-plugin-utils": "^7.18.6" + } + }, "@babel/plugin-syntax-logical-assignment-operators": { "version": "7.10.4", "dev": true, @@ -21450,12 +21438,12 @@ } }, "@babel/plugin-syntax-typescript": { - "version": "7.17.12", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.17.12.tgz", - "integrity": "sha512-TYY0SXFiO31YXtNg3HtFwNJHjLsAyIIhAhNWkQ5whPPS7HWUFlg9z0Ta4qAQNjQbP1wsSt/oKkmZ/4/WWdMUpw==", + "version": "7.18.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.18.6.tgz", + "integrity": "sha512-mAWAuq4rvOepWCBid55JuRNvpTNf2UGVgoz4JV0fXEKolsVZDzsa4NqCef758WZJj/GDu0gVGItjKFiClTAmZA==", "dev": true, "requires": { - "@babel/helper-plugin-utils": "^7.17.12" + "@babel/helper-plugin-utils": "^7.18.6" } }, "@babel/plugin-transform-arrow-functions": { @@ -22262,26 +22250,26 @@ "dev": true }, "@jest/console": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/console/-/console-28.1.3.tgz", - "integrity": "sha512-QPAkP5EwKdK/bxIr6C1I4Vs0rm2nHiANzj/Z5X2JQkrZo6IqvC4ldZ9K95tF0HdidhA8Bo6egxSzUFPYKcEXLw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/console/-/console-29.0.0.tgz", + "integrity": "sha512-rHsKEqT2Kx73PqO9qIOdwg0Grd6Y3COyqNpi5SKRI0qXgmlqXkOczQMfIb8I0Gdnc9/kaMj6cTnBGLyBA03Xrg==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", - "jest-message-util": "^28.1.3", - "jest-util": "^28.1.3", + "jest-message-util": "^29.0.0", + "jest-util": "^29.0.0", "slash": "^3.0.0" }, "dependencies": { "@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -22290,9 +22278,9 @@ } }, "@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "requires": { "@types/yargs-parser": "*" @@ -22309,29 +22297,29 @@ } }, "jest-message-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", - "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.0.0.tgz", + "integrity": "sha512-4U0RdNV0TBTgVGzEchjryEpq4sqLO3gUQT7TEIbO5+q0K5MuiofOPcXk4GLpWviWByMRJjliQNMuzJ4YGT+oGQ==", "dev": true, "requires": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" } }, "jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -22340,13 +22328,12 @@ } }, "pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, @@ -22374,49 +22361,48 @@ } }, "@jest/core": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/core/-/core-28.1.3.tgz", - "integrity": "sha512-CIKBrlaKOzA7YG19BEqCw3SLIsEwjZkeJzf5bdooVnW4bH5cktqe3JX+G2YV1aK5vP8N9na1IGWFzYaTp6k6NA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/core/-/core-29.0.0.tgz", + "integrity": "sha512-9qljprspjQwbmnq3Wv9d/M6/ejMdWs1uAAljQAX9QsjJ1SlSByXw1mRA9UpR2BP9TxLLwEembbm0ykrT//2STg==", "dev": true, "requires": { - "@jest/console": "^28.1.3", - "@jest/reporters": "^28.1.3", - "@jest/test-result": "^28.1.3", - "@jest/transform": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/console": "^29.0.0", + "@jest/reporters": "^29.0.0", + "@jest/test-result": "^29.0.0", + "@jest/transform": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", "ansi-escapes": "^4.2.1", "chalk": "^4.0.0", "ci-info": "^3.2.0", "exit": "^0.1.2", "graceful-fs": "^4.2.9", - "jest-changed-files": "^28.1.3", - "jest-config": "^28.1.3", - "jest-haste-map": "^28.1.3", - "jest-message-util": "^28.1.3", - "jest-regex-util": "^28.0.2", - "jest-resolve": "^28.1.3", - "jest-resolve-dependencies": "^28.1.3", - "jest-runner": "^28.1.3", - "jest-runtime": "^28.1.3", - "jest-snapshot": "^28.1.3", - "jest-util": "^28.1.3", - "jest-validate": "^28.1.3", - "jest-watcher": "^28.1.3", + "jest-changed-files": "^29.0.0", + "jest-config": "^29.0.0", + "jest-haste-map": "^29.0.0", + "jest-message-util": "^29.0.0", + "jest-regex-util": "^29.0.0", + "jest-resolve": "^29.0.0", + "jest-resolve-dependencies": "^29.0.0", + "jest-runner": "^29.0.0", + "jest-runtime": "^29.0.0", + "jest-snapshot": "^29.0.0", + "jest-util": "^29.0.0", + "jest-validate": "^29.0.0", + "jest-watcher": "^29.0.0", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", - "rimraf": "^3.0.0", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "strip-ansi": "^6.0.0" }, "dependencies": { "@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -22425,9 +22411,9 @@ } }, "@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "requires": { "@types/yargs-parser": "*" @@ -22444,29 +22430,29 @@ } }, "jest-message-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", - "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.0.0.tgz", + "integrity": "sha512-4U0RdNV0TBTgVGzEchjryEpq4sqLO3gUQT7TEIbO5+q0K5MuiofOPcXk4GLpWviWByMRJjliQNMuzJ4YGT+oGQ==", "dev": true, "requires": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" } }, "jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -22475,13 +22461,12 @@ } }, "pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, @@ -22528,22 +22513,22 @@ } }, "@jest/expect": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/expect/-/expect-28.1.3.tgz", - "integrity": "sha512-lzc8CpUbSoE4dqT0U+g1qODQjBRHPpCPXissXD4mS9+sWQdmmpeJ9zSH1rS1HEkrsMN0fb7nKrJ9giAR1d3wBw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/expect/-/expect-29.0.0.tgz", + "integrity": "sha512-X2S5NpZOeXXDGBLvU/4K1nAD5iIz6/9Gs041wToI0FiX3glh/aEGGsVv3+SxKddYIb6Ei+ZbqzJmfRzQ7nwPlQ==", "dev": true, "requires": { - "expect": "^28.1.3", - "jest-snapshot": "^28.1.3" + "expect": "^29.0.0", + "jest-snapshot": "^29.0.0" } }, "@jest/expect-utils": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/expect-utils/-/expect-utils-28.1.3.tgz", - "integrity": "sha512-wvbi9LUrHJLn3NlDW6wF2hvIMtd4JUl2QNVrjq+IBSHirgfrR3o9RnVtxzdEGO2n9JyIWwHnLfby5KzqBGg2YA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/expect-utils/-/expect-utils-29.0.0.tgz", + "integrity": "sha512-odQ+cjUpui6++a9Ua/oWn7CG0Af+EZe9weWZbfUQHTg7C3K9PCb0AnD4X7nyAe4WjfeZmVVyG5SJELMQaUbCtg==", "dev": true, "requires": { - "jest-get-type": "^28.0.2" + "jest-get-type": "^29.0.0" } }, "@jest/fake-timers": { @@ -22559,49 +22544,50 @@ } }, "@jest/globals": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/globals/-/globals-28.1.3.tgz", - "integrity": "sha512-XFU4P4phyryCXu1pbcqMO0GSQcYe1IsalYCDzRNyhetyeyxMcIxa11qPNDpVNLeretItNqEmYYQn1UYz/5x1NA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/globals/-/globals-29.0.0.tgz", + "integrity": "sha512-ZHQMh6BZtabbikh9wkuPpVQmPHEpc4EgOaY/UJNM6hHHA5HRmiP5rH54M8267nkGscuqM5KpWP+zAZ4XEOXZag==", "dev": true, "requires": { - "@jest/environment": "^28.1.3", - "@jest/expect": "^28.1.3", - "@jest/types": "^28.1.3" + "@jest/environment": "^29.0.0", + "@jest/expect": "^29.0.0", + "@jest/types": "^29.0.0", + "jest-mock": "^29.0.0" }, "dependencies": { "@jest/environment": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-28.1.3.tgz", - "integrity": "sha512-1bf40cMFTEkKyEf585R9Iz1WayDjHoHqvts0XFYEqyKM3cFWDpeMoqKKTAF9LSYQModPUlh8FKptoM2YcMWAXA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-29.0.0.tgz", + "integrity": "sha512-ZHLvUENMAnwXowtyhmPRS0QLCXM4TS0ZfuiSR4QfRsJVN5lG4KdBDvI9kHJe/21vrgzPVOkvI7IBnkyPFCbV7g==", "dev": true, "requires": { - "@jest/fake-timers": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/fake-timers": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", - "jest-mock": "^28.1.3" + "jest-mock": "^29.0.0" } }, "@jest/fake-timers": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-28.1.3.tgz", - "integrity": "sha512-D/wOkL2POHv52h+ok5Oj/1gOG9HSywdoPtFsRCUmlCILXNn5eIWmcnd3DIiWlJnpGvQtmajqBP95Ei0EimxfLw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-29.0.0.tgz", + "integrity": "sha512-4tqH5fT9H0+Ms3Z1HLZ/JfpzJluep2Zo3uuj0KPyu6IIyYSHCDfkXuiBQNWUGvumZDLQ2Si03cC7Gq0r73VgVg==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@sinonjs/fake-timers": "^9.1.2", "@types/node": "*", - "jest-message-util": "^28.1.3", - "jest-mock": "^28.1.3", - "jest-util": "^28.1.3" + "jest-message-util": "^29.0.0", + "jest-mock": "^29.0.0", + "jest-util": "^29.0.0" } }, "@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -22619,9 +22605,9 @@ } }, "@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "requires": { "@types/yargs-parser": "*" @@ -22638,39 +22624,39 @@ } }, "jest-message-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", - "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.0.0.tgz", + "integrity": "sha512-4U0RdNV0TBTgVGzEchjryEpq4sqLO3gUQT7TEIbO5+q0K5MuiofOPcXk4GLpWviWByMRJjliQNMuzJ4YGT+oGQ==", "dev": true, "requires": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" } }, "jest-mock": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-28.1.3.tgz", - "integrity": "sha512-o3J2jr6dMMWYVH4Lh/NKmDXdosrsJgi4AviS8oXLujcjpCMBb1FMsblDnOXKZKfSiHLxYub1eS0IHuRXsio9eA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-29.0.0.tgz", + "integrity": "sha512-0AWznVt415KMCxcJPaE2+tWaruw0w8aRrKH1Y/NZUx3+Pd9f20jQjUR82iHqGSuYS4EOHL9uI8SjAhJk+ET91g==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*" } }, "jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -22679,13 +22665,12 @@ } }, "pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, @@ -22713,17 +22698,17 @@ } }, "@jest/reporters": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/reporters/-/reporters-28.1.3.tgz", - "integrity": "sha512-JuAy7wkxQZVNU/V6g9xKzCGC5LVXx9FDcABKsSXp5MiKPEE2144a/vXTEDoyzjUpZKfVwp08Wqg5A4WfTMAzjg==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/reporters/-/reporters-29.0.0.tgz", + "integrity": "sha512-6ZFLlHQwncULTucAKWeGJLGPvzjgC/0gFmxJi/LgU9G1v498r/RcWQiZBPqhJcSvpWGTCaqjvUGmPCLtrUpubw==", "dev": true, "requires": { "@bcoe/v8-coverage": "^0.2.3", - "@jest/console": "^28.1.3", - "@jest/test-result": "^28.1.3", - "@jest/transform": "^28.1.3", - "@jest/types": "^28.1.3", - "@jridgewell/trace-mapping": "^0.3.13", + "@jest/console": "^29.0.0", + "@jest/test-result": "^29.0.0", + "@jest/transform": "^29.0.0", + "@jest/types": "^29.0.0", + "@jridgewell/trace-mapping": "^0.3.15", "@types/node": "*", "chalk": "^4.0.0", "collect-v8-coverage": "^1.0.0", @@ -22735,9 +22720,9 @@ "istanbul-lib-report": "^3.0.0", "istanbul-lib-source-maps": "^4.0.0", "istanbul-reports": "^3.1.3", - "jest-message-util": "^28.1.3", - "jest-util": "^28.1.3", - "jest-worker": "^28.1.3", + "jest-message-util": "^29.0.0", + "jest-util": "^29.0.0", + "jest-worker": "^29.0.0", "slash": "^3.0.0", "string-length": "^4.0.1", "strip-ansi": "^6.0.0", @@ -22746,12 +22731,12 @@ }, "dependencies": { "@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -22760,9 +22745,9 @@ } }, "@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "requires": { "@types/yargs-parser": "*" @@ -22803,29 +22788,29 @@ } }, "jest-message-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", - "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.0.0.tgz", + "integrity": "sha512-4U0RdNV0TBTgVGzEchjryEpq4sqLO3gUQT7TEIbO5+q0K5MuiofOPcXk4GLpWviWByMRJjliQNMuzJ4YGT+oGQ==", "dev": true, "requires": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" } }, "jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -22834,9 +22819,9 @@ } }, "jest-worker": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-28.1.3.tgz", - "integrity": "sha512-CqRA220YV/6jCo8VWvAt1KKx6eek1VIHMPeLEbpcfSfkEeWyBNppynM/o6q+Wmw+sOhos2ml34wZbSX3G13//g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-29.0.0.tgz", + "integrity": "sha512-2t9Panx3F9N1wAvRuZT7xLEptRFc1C5G90DOHniIGz1JIgF9uhd5u8jNBsc7wN63lhnaiLeVLnNx21wT7OVFEQ==", "dev": true, "requires": { "@types/node": "*", @@ -22865,13 +22850,12 @@ } }, "pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, @@ -22908,44 +22892,44 @@ } }, "@jest/schemas": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-28.1.3.tgz", - "integrity": "sha512-/l/VWsdt/aBXgjshLWOFyFt3IVdYypu5y2Wn2rOO1un6nkqIn8SLXzgIMYXFyYsRWDyF5EthmKJMIdJvk08grg==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-29.0.0.tgz", + "integrity": "sha512-3Ab5HgYIIAnS0HjqJHQYZS+zXc4tUmTmBH3z83ajI6afXp8X3ZtdLX+nXx+I7LNkJD7uN9LAVhgnjDgZa2z0kA==", "dev": true, "requires": { "@sinclair/typebox": "^0.24.1" } }, "@jest/source-map": { - "version": "28.1.2", - "resolved": "https://registry.npmjs.org/@jest/source-map/-/source-map-28.1.2.tgz", - "integrity": "sha512-cV8Lx3BeStJb8ipPHnqVw/IM2VCMWO3crWZzYodSIkxXnRcXJipCdx1JCK0K5MsJJouZQTH73mzf4vgxRaH9ww==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/source-map/-/source-map-29.0.0.tgz", + "integrity": "sha512-nOr+0EM8GiHf34mq2GcJyz/gYFyLQ2INDhAylrZJ9mMWoW21mLBfZa0BUVPPMxVYrLjeiRe2Z7kWXOGnS0TFhQ==", "dev": true, "requires": { - "@jridgewell/trace-mapping": "^0.3.13", + "@jridgewell/trace-mapping": "^0.3.15", "callsites": "^3.0.0", "graceful-fs": "^4.2.9" } }, "@jest/test-result": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/test-result/-/test-result-28.1.3.tgz", - "integrity": "sha512-kZAkxnSE+FqE8YjW8gNuoVkkC9I7S1qmenl8sGcDOLropASP+BkcGKwhXoyqQuGOGeYY0y/ixjrd/iERpEXHNg==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/test-result/-/test-result-29.0.0.tgz", + "integrity": "sha512-mv76j8ILaqOuZAWBGR1/ZSRinN5Q/eEji7kMcvADjd+gQGfn/Py+91nUrVakJT69idC66bvQ7yF24frQpzFKUg==", "dev": true, "requires": { - "@jest/console": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/console": "^29.0.0", + "@jest/types": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "collect-v8-coverage": "^1.0.0" }, "dependencies": { "@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -22954,9 +22938,9 @@ } }, "@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "requires": { "@types/yargs-parser": "*" @@ -22975,14 +22959,14 @@ } }, "@jest/test-sequencer": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/test-sequencer/-/test-sequencer-28.1.3.tgz", - "integrity": "sha512-NIMPEqqa59MWnDi1kvXXpYbqsfQmSJsIbnd85mdVGkiDfQ9WQQTXOLsvISUfonmnBT+w85WEgneCigEEdHDFxw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/test-sequencer/-/test-sequencer-29.0.0.tgz", + "integrity": "sha512-uL6yX//SUME1c/ucbY365obdsrPjvSoNBwB80WTe+drYL4jf7A87vA2+w4hYwXJEIGQspv5skg3iB/sJSys7ew==", "dev": true, "requires": { - "@jest/test-result": "^28.1.3", + "@jest/test-result": "^29.0.0", "graceful-fs": "^4.2.9", - "jest-haste-map": "^28.1.3", + "jest-haste-map": "^29.0.0", "slash": "^3.0.0" }, "dependencies": { @@ -22995,22 +22979,22 @@ } }, "@jest/transform": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/transform/-/transform-28.1.3.tgz", - "integrity": "sha512-u5dT5di+oFI6hfcLOHGTAfmUxFRrjK+vnaP0kkVow9Md/M7V/MxqQMOz/VV25UZO8pzeA9PjfTpOu6BDuwSPQA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/transform/-/transform-29.0.0.tgz", + "integrity": "sha512-hwyBt8UR5o8GGaphmRqNQwVCctiOR8ncugCp/RlInEZvQ+ysKkS5TFfe5RgeQ0KtKdWByQqn5yA574LLOp3OWw==", "dev": true, "requires": { "@babel/core": "^7.11.6", - "@jest/types": "^28.1.3", - "@jridgewell/trace-mapping": "^0.3.13", + "@jest/types": "^29.0.0", + "@jridgewell/trace-mapping": "^0.3.15", "babel-plugin-istanbul": "^6.1.1", "chalk": "^4.0.0", "convert-source-map": "^1.4.0", - "fast-json-stable-stringify": "^2.0.0", + "fast-json-stable-stringify": "^2.1.0", "graceful-fs": "^4.2.9", - "jest-haste-map": "^28.1.3", - "jest-regex-util": "^28.0.2", - "jest-util": "^28.1.3", + "jest-haste-map": "^29.0.0", + "jest-regex-util": "^29.0.0", + "jest-util": "^29.0.0", "micromatch": "^4.0.4", "pirates": "^4.0.4", "slash": "^3.0.0", @@ -23018,12 +23002,12 @@ }, "dependencies": { "@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -23032,9 +23016,9 @@ } }, "@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "requires": { "@types/yargs-parser": "*" @@ -23051,12 +23035,12 @@ } }, "jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -23071,9 +23055,9 @@ "dev": true }, "write-file-atomic": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-4.0.1.tgz", - "integrity": "sha512-nSKUxgAbyioruk6hU87QzVbY279oYT6uiwgDoujth2ju4mJ+TZau7SQBhtbTmUyuNYTuXnSyRn66FV0+eCgcrQ==", + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-4.0.2.tgz", + "integrity": "sha512-7KxauUdBmSdWnmpaGFg+ppNjKF8uNLry8LyzjauQDOVONfFLNKrKvQOxZ/VuTIcS/gge/YNahf5RIIQWTSarlg==", "dev": true, "requires": { "imurmurhash": "^0.1.4", @@ -23154,95 +23138,95 @@ "integrity": "sha512-GryiOJmNcWbovBxTfZSF71V/mXbgcV3MewDe3kIMCLyIh5e7SKAeUZs+rMnJ8jkMolZ/4/VsdBmMrw3l+VdZ3w==" }, "@jridgewell/trace-mapping": { - "version": "0.3.13", - "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.13.tgz", - "integrity": "sha512-o1xbKhp9qnIAoHJSWd6KlCZfqslL4valSF81H8ImioOAxluWYWOpWkpyktY2vnt4tbrX9XYaxovq6cgowaJp2w==", + "version": "0.3.15", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.15.tgz", + "integrity": "sha512-oWZNOULl+UbhsgB51uuZzglikfIKSUBO/M9W2OfEjn7cmqoAiCgmv9lyACTUacZwBz0ITnJ2NqjU8Tx0DHL88g==", "requires": { "@jridgewell/resolve-uri": "^3.0.3", "@jridgewell/sourcemap-codec": "^1.4.10" } }, "@next/env": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/env/-/env-12.2.5.tgz", - "integrity": "sha512-vLPLV3cpPGjUPT3PjgRj7e3nio9t6USkuew3JE/jMeon/9Mvp1WyR18v3iwnCuX7eUAm1HmAbJHHLAbcu/EJcw==" + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/env/-/env-12.2.4.tgz", + "integrity": "sha512-/gApFXWk5CCLFQJL5IYJXxPQuG5tz5nPX4l27A9Zm/+wJxiwFrRSP54AopDxIv4JRp/rGwcgk/lZS/0Clw8jYA==" }, "@next/swc-android-arm-eabi": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-android-arm-eabi/-/swc-android-arm-eabi-12.2.5.tgz", - "integrity": "sha512-cPWClKxGhgn2dLWnspW+7psl3MoLQUcNqJqOHk2BhNcou9ARDtC0IjQkKe5qcn9qg7I7U83Gp1yh2aesZfZJMA==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-android-arm-eabi/-/swc-android-arm-eabi-12.2.4.tgz", + "integrity": "sha512-P4YSFNpmXXSnn3P1qsOAqz+MX3On9fHrlc8ovb/CFJJoU+YLCR53iCEwfw39e0IZEgDA7ttgr108plF8mxaX0g==", "optional": true }, "@next/swc-android-arm64": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-android-arm64/-/swc-android-arm64-12.2.5.tgz", - "integrity": "sha512-vMj0efliXmC5b7p+wfcQCX0AfU8IypjkzT64GiKJD9PgiA3IILNiGJr1fw2lyUDHkjeWx/5HMlMEpLnTsQslwg==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-android-arm64/-/swc-android-arm64-12.2.4.tgz", + "integrity": "sha512-4o2n14E18O+8xHlf6dgJsWPXN9gmSmfIe2Z0EqKDIPBBkFt/2CyrH0+vwHnL2l7xkDHhOGfZYcYIWVUR5aNu0A==", "optional": true }, "@next/swc-darwin-arm64": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-darwin-arm64/-/swc-darwin-arm64-12.2.5.tgz", - "integrity": "sha512-VOPWbO5EFr6snla/WcxUKtvzGVShfs302TEMOtzYyWni6f9zuOetijJvVh9CCTzInnXAZMtHyNhefijA4HMYLg==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-darwin-arm64/-/swc-darwin-arm64-12.2.4.tgz", + "integrity": "sha512-DcUO6MGBL9E3jj5o86MUnTOy4WawIJJhyCcFYO4f51sbl7+uPIYIx40eo98A6NwJEXazCqq1hLeqOaNTAIvDiQ==", "optional": true }, "@next/swc-darwin-x64": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-darwin-x64/-/swc-darwin-x64-12.2.5.tgz", - "integrity": "sha512-5o8bTCgAmtYOgauO/Xd27vW52G2/m3i5PX7MUYePquxXAnX73AAtqA3WgPXBRitEB60plSKZgOTkcpqrsh546A==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-darwin-x64/-/swc-darwin-x64-12.2.4.tgz", + "integrity": "sha512-IUlFMqeLjdIzDorrGC2Dt+2Ae3DbKQbRzCzmDq4/CP1+jJGeDXo/2AHnlE+WYnwQAC4KtAz6pbVnd3KstZWsVA==", "optional": true }, "@next/swc-freebsd-x64": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-freebsd-x64/-/swc-freebsd-x64-12.2.5.tgz", - "integrity": "sha512-yYUbyup1JnznMtEBRkK4LT56N0lfK5qNTzr6/DEyDw5TbFVwnuy2hhLBzwCBkScFVjpFdfiC6SQAX3FrAZzuuw==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-freebsd-x64/-/swc-freebsd-x64-12.2.4.tgz", + "integrity": "sha512-475vwyWcjnyDVDWLgAATP0HI8W1rwByc+uXk1B6KkAVFhkoDgH387LW0uNqxavK+VxCzj3avQXX/58XDvxtSlg==", "optional": true }, "@next/swc-linux-arm-gnueabihf": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-linux-arm-gnueabihf/-/swc-linux-arm-gnueabihf-12.2.5.tgz", - "integrity": "sha512-2ZE2/G921Acks7UopJZVMgKLdm4vN4U0yuzvAMJ6KBavPzqESA2yHJlm85TV/K9gIjKhSk5BVtauIUntFRP8cg==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-linux-arm-gnueabihf/-/swc-linux-arm-gnueabihf-12.2.4.tgz", + "integrity": "sha512-qZW+L3iG3XSGtlOPmD5RRWXyk6ZNdscLV0BQjuDvP+exTg+uixqHXOHz0/GVATIJEBQOF0Kew7jAXVXEP+iRTQ==", "optional": true }, "@next/swc-linux-arm64-gnu": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-linux-arm64-gnu/-/swc-linux-arm64-gnu-12.2.5.tgz", - "integrity": "sha512-/I6+PWVlz2wkTdWqhlSYYJ1pWWgUVva6SgX353oqTh8njNQp1SdFQuWDqk8LnM6ulheVfSsgkDzxrDaAQZnzjQ==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-linux-arm64-gnu/-/swc-linux-arm64-gnu-12.2.4.tgz", + "integrity": "sha512-fEPRjItWYaKyyG9N+2HIA59OBHIhk7WC+Rh+LwXsh0pQe870Ykpek3KQs0umjsrEGe57NyMomq3f80/N8taDvA==", "optional": true }, "@next/swc-linux-arm64-musl": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-linux-arm64-musl/-/swc-linux-arm64-musl-12.2.5.tgz", - "integrity": "sha512-LPQRelfX6asXyVr59p5sTpx5l+0yh2Vjp/R8Wi4X9pnqcayqT4CUJLiHqCvZuLin3IsFdisJL0rKHMoaZLRfmg==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-linux-arm64-musl/-/swc-linux-arm64-musl-12.2.4.tgz", + "integrity": "sha512-rnCTzXII0EBCcFn9P5s/Dho2kPUMSX/bP0iOAj8wEI/IxUEfEElbin89zJoNW30cycHu19xY8YP4K2+hzciPzQ==", "optional": true }, "@next/swc-linux-x64-gnu": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-linux-x64-gnu/-/swc-linux-x64-gnu-12.2.5.tgz", - "integrity": "sha512-0szyAo8jMCClkjNK0hknjhmAngUppoRekW6OAezbEYwHXN/VNtsXbfzgYOqjKWxEx3OoAzrT3jLwAF0HdX2MEw==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-linux-x64-gnu/-/swc-linux-x64-gnu-12.2.4.tgz", + "integrity": "sha512-PhXX6NSuIuhHInxPY2VkG2Bl7VllsD3Cjx+pQcS1wTym7Zt7UoLvn05PkRrkiyIkvR+UXnqPUM3TYiSbnemXEw==", "optional": true }, "@next/swc-linux-x64-musl": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-linux-x64-musl/-/swc-linux-x64-musl-12.2.5.tgz", - "integrity": "sha512-zg/Y6oBar1yVnW6Il1I/08/2ukWtOG6s3acdJdEyIdsCzyQi4RLxbbhkD/EGQyhqBvd3QrC6ZXQEXighQUAZ0g==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-linux-x64-musl/-/swc-linux-x64-musl-12.2.4.tgz", + "integrity": "sha512-GmC/QROiUZpFirHRfPQqMyCXZ+5+ndbBZrMvL74HtQB/CKXB8K1VM+rvy9Gp/5OaU8Rxp48IcX79NOfI2LiXlA==", "optional": true }, "@next/swc-win32-arm64-msvc": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-win32-arm64-msvc/-/swc-win32-arm64-msvc-12.2.5.tgz", - "integrity": "sha512-3/90DRNSqeeSRMMEhj4gHHQlLhhKg5SCCoYfE3kBjGpE63EfnblYUqsszGGZ9ekpKL/R4/SGB40iCQr8tR5Jiw==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-win32-arm64-msvc/-/swc-win32-arm64-msvc-12.2.4.tgz", + "integrity": "sha512-9XKoCXbNZuaMRPtcKQz3+hgVpkMosaLlcxHFXT8/j4w61k7/qvEbrkMDS9WHNrD/xVcLycwhPRgXcns2K1BdBQ==", "optional": true }, "@next/swc-win32-ia32-msvc": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-win32-ia32-msvc/-/swc-win32-ia32-msvc-12.2.5.tgz", - "integrity": "sha512-hGLc0ZRAwnaPL4ulwpp4D2RxmkHQLuI8CFOEEHdzZpS63/hMVzv81g8jzYA0UXbb9pus/iTc3VRbVbAM03SRrw==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-win32-ia32-msvc/-/swc-win32-ia32-msvc-12.2.4.tgz", + "integrity": "sha512-hEyRieZKH9iw4AzvXaQ+Fyb98k0G/o9QcRGxA1/O/O/elf1+Qvuwb15phT8GbVtIeNziy66XTPOhKKfdr8KyUg==", "optional": true }, "@next/swc-win32-x64-msvc": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/@next/swc-win32-x64-msvc/-/swc-win32-x64-msvc-12.2.5.tgz", - "integrity": "sha512-7h5/ahY7NeaO2xygqVrSG/Y8Vs4cdjxIjowTZ5W6CKoTKn7tmnuxlUc2h74x06FKmbhAd9agOjr/AOKyxYYm9Q==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/@next/swc-win32-x64-msvc/-/swc-win32-x64-msvc-12.2.4.tgz", + "integrity": "sha512-5Pl1tdMJWLy4rvzU1ecx0nHWgDPqoYuvYoXE/5X0Clu9si/yOuBIj573F2kOTY7mu0LX2wgCJVSnyK0abHBxIw==", "optional": true }, "@nodelib/fs.scandir": { @@ -23375,6 +23359,25 @@ "@octokit/openapi-types": "^11.2.0" } }, + "@pnpm/network.ca-file": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@pnpm/network.ca-file/-/network.ca-file-1.0.1.tgz", + "integrity": "sha512-gkINruT2KUhZLTaiHxwCOh1O4NVnFT0wLjWFBHmTz9vpKag/C/noIMJXBxFe4F0mYpUVX2puLwAieLYFg2NvoA==", + "dev": true, + "requires": { + "graceful-fs": "4.2.10" + } + }, + "@pnpm/npm-conf": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/@pnpm/npm-conf/-/npm-conf-1.0.5.tgz", + "integrity": "sha512-hD8ml183638O3R6/Txrh0L8VzGOrFXgRtRDG4qQC4tONdZ5Z1M+tlUUDUvrjYdmK6G+JTBTeaCLMna11cXzi8A==", + "dev": true, + "requires": { + "@pnpm/network.ca-file": "^1.0.1", + "config-chain": "^1.1.11" + } + }, "@primer/behaviors": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/@primer/behaviors/-/behaviors-1.1.3.tgz", @@ -23458,9 +23461,9 @@ "devOptional": true }, "@sinclair/typebox": { - "version": "0.24.20", - "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.24.20.tgz", - "integrity": "sha512-kVaO5aEFZb33nPMTZBxiPEkY+slxiPtqC7QX8f9B3eGOMBvEfuMfxp9DSTTCsRJPumPKjrge4yagyssO4q6qzQ==", + "version": "0.24.28", + "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.24.28.tgz", + "integrity": "sha512-dgJd3HLOkLmz4Bw50eZx/zJwtBq65nms3N9VBYu5LTjJ883oBFkTyXRlCB/ZGGwqYpJJHA5zW2Ibhl5ngITfow==", "dev": true }, "@sindresorhus/is": { @@ -23616,9 +23619,9 @@ } }, "@types/babel__traverse": { - "version": "7.17.1", - "resolved": "https://registry.npmjs.org/@types/babel__traverse/-/babel__traverse-7.17.1.tgz", - "integrity": "sha512-kVzjari1s2YVi77D3w1yuvohV2idweYXMCDzqBiVNN63TcDWrIlTVOYpqVrvbbyOE/IyzBoTKF0fdnLPEORFxA==", + "version": "7.18.0", + "resolved": "https://registry.npmjs.org/@types/babel__traverse/-/babel__traverse-7.18.0.tgz", + "integrity": "sha512-v4Vwdko+pgymgS+A2UIaJru93zQd85vIGWObM5ekZNdXCKtDYqATlEYnWgfo86Q6I1Lh0oXnksDnMU1cwmlPDw==", "dev": true, "requires": { "@babel/types": "^7.3.0" @@ -23777,9 +23780,9 @@ "version": "6.0.1" }, "@types/prettier": { - "version": "2.6.3", - "resolved": "https://registry.npmjs.org/@types/prettier/-/prettier-2.6.3.tgz", - "integrity": "sha512-ymZk3LEC/fsut+/Q5qejp6R9O1rMxz3XaRHDV6kX8MrGAhOSPqVARbDi+EZvInBpw+BnCX3TD240byVkOfQsHg==", + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/@types/prettier/-/prettier-2.7.0.tgz", + "integrity": "sha512-RI1L7N4JnW5gQw2spvL7Sllfuf1SaHdrZpCHiBlCXjIlufi1SMNnbu2teze3/QE67Fg2tBlH7W+mi4hVNk4p0A==", "dev": true }, "@types/prop-types": { @@ -24289,6 +24292,8 @@ }, "ansi-align": { "version": "3.0.1", + "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.1.tgz", + "integrity": "sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==", "dev": true, "requires": { "string-width": "^4.1.0" @@ -24550,15 +24555,15 @@ } }, "babel-jest": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/babel-jest/-/babel-jest-28.1.3.tgz", - "integrity": "sha512-epUaPOEWMk3cWX0M/sPvCHHCe9fMFAa/9hXEgKP8nFfNl/jlGkE9ucq9NqkZGXLDduCJYS0UvSlPUwC0S+rH6Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/babel-jest/-/babel-jest-29.0.0.tgz", + "integrity": "sha512-EJM2dqxz9+uWJLLucZLPYAmRsHHt1IMkitAHGqjDlIP2IQXzkIMO3ATbBWk0lU6VwX4rNeVN04t/DDB8U5C2rg==", "dev": true, "requires": { - "@jest/transform": "^28.1.3", + "@jest/transform": "^29.0.0", "@types/babel__core": "^7.1.14", "babel-plugin-istanbul": "^6.1.1", - "babel-preset-jest": "^28.1.3", + "babel-preset-jest": "^29.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "slash": "^3.0.0" @@ -24631,9 +24636,9 @@ } }, "babel-plugin-jest-hoist": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-28.1.3.tgz", - "integrity": "sha512-Ys3tUKAmfnkRUpPdpa98eYrAR0nV+sSFUZZEGuQ2EbFd1y4SOLtD5QDNHAq+bb9a+bbXvYQC4b+ID/THIMcU6Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-29.0.0.tgz", + "integrity": "sha512-B9oaXrlxXHFWeWqhDPg03iqQd2UN/mg/VdZOsLaqAVBkztru3ctTryAI4zisxLEEgmcUnLTKewqx0gGifoXD3A==", "dev": true, "requires": { "@babel/template": "^7.3.3", @@ -25030,12 +25035,12 @@ } }, "babel-preset-jest": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/babel-preset-jest/-/babel-preset-jest-28.1.3.tgz", - "integrity": "sha512-L+fupJvlWAHbQfn74coNX3zf60LXMJsezNvvx8eIh7iOR1luJ1poxYgQk1F8PYtNq/6QODDHCqsSnTFSWC491A==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/babel-preset-jest/-/babel-preset-jest-29.0.0.tgz", + "integrity": "sha512-B5Ke47Xcs8rDF3p1korT3LoilpADCwbG93ALqtvqu6Xpf4d8alKkrCBTExbNzdHJcIuEPpfYvEaFFRGee2kUgQ==", "dev": true, "requires": { - "babel-plugin-jest-hoist": "^28.1.3", + "babel-plugin-jest-hoist": "^29.0.0", "babel-preset-current-node-syntax": "^1.0.0" } }, @@ -25248,34 +25253,60 @@ "devOptional": true }, "boxen": { - "version": "5.1.2", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/boxen/-/boxen-7.0.0.tgz", + "integrity": "sha512-j//dBVuyacJbvW+tvZ9HuH03fZ46QcaKvvhZickZqtB271DxJ7SNRSNxrV/dZX0085m7hISRZWbzWlJvx/rHSg==", "dev": true, "requires": { - "ansi-align": "^3.0.0", - "camelcase": "^6.2.0", - "chalk": "^4.1.0", - "cli-boxes": "^2.2.1", - "string-width": "^4.2.2", - "type-fest": "^0.20.2", - "widest-line": "^3.1.0", - "wrap-ansi": "^7.0.0" + "ansi-align": "^3.0.1", + "camelcase": "^7.0.0", + "chalk": "^5.0.1", + "cli-boxes": "^3.0.0", + "string-width": "^5.1.2", + "type-fest": "^2.13.0", + "widest-line": "^4.0.1", + "wrap-ansi": "^8.0.1" }, "dependencies": { - "camelcase": { - "version": "6.2.0", + "ansi-styles": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.1.0.tgz", + "integrity": "sha512-VbqNsoz55SYGczauuup0MFUyXNQviSpFTj1RQtFzmQLk18qbVSpTFFGMT293rmDaQuKCT6InmbuEyUne4mTuxQ==", "dev": true }, - "chalk": { - "version": "4.1.2", + "camelcase": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-7.0.0.tgz", + "integrity": "sha512-JToIvOmz6nhGsUhAYScbo2d6Py5wojjNfoxoc2mEVLUdJ70gJK2gnd+ABY1Tc3sVMyK7QDPtN0T/XdlCQWITyQ==", + "dev": true + }, + "string-width": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", + "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", "dev": true, "requires": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" + "eastasianwidth": "^0.2.0", + "emoji-regex": "^9.2.2", + "strip-ansi": "^7.0.1" } }, "type-fest": { - "version": "0.20.2", + "version": "2.18.1", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-2.18.1.tgz", + "integrity": "sha512-UKCINsd4qiATXD6OIlnQw9t1ux/n2ld+Nl0kzPbCONhCaUIS/BhJbNw14w6584HCQWf3frBK8vmWnGZq/sbPHQ==", "dev": true + }, + "wrap-ansi": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.0.1.tgz", + "integrity": "sha512-QFF+ufAqhoYHvoHdajT/Po7KoXVBPXS2bgjIam5isfWJPfIOnQZ50JtUiVvCv/sjgacf3yRrt2ZKUZ/V4itN4g==", + "dev": true, + "requires": { + "ansi-styles": "^6.1.0", + "string-width": "^5.0.1", + "strip-ansi": "^7.0.1" + } } } }, @@ -25555,7 +25586,9 @@ "dev": true }, "cli-boxes": { - "version": "2.2.1", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-3.0.0.tgz", + "integrity": "sha512-/lzGpEWL/8PfI0BmBOPRwp0c/wFNX1RdUML3jK/RcSBA9T8mZDdQpqYBKtCFTOfQbwPqWEOpjqW+Fnayc0969g==", "dev": true }, "cli-cursor": { @@ -25700,16 +25733,27 @@ "concat-map": { "version": "0.0.1" }, - "configstore": { - "version": "5.0.1", + "config-chain": { + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/config-chain/-/config-chain-1.1.13.tgz", + "integrity": "sha512-qj+f8APARXHrM0hraqXYb2/bOVSV4PvJQlNZ/DVj0QrmNM2q2euizkeuVckQ57J+W0mRH6Hvi+k50M4Jul2VRQ==", "dev": true, "requires": { - "dot-prop": "^5.2.0", - "graceful-fs": "^4.1.2", - "make-dir": "^3.0.0", - "unique-string": "^2.0.0", - "write-file-atomic": "^3.0.0", - "xdg-basedir": "^4.0.0" + "ini": "^1.3.4", + "proto-list": "~1.2.1" + } + }, + "configstore": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/configstore/-/configstore-6.0.0.tgz", + "integrity": "sha512-cD31W1v3GqUlQvbBCGcXmd2Nj9SvLDOP1oQ0YFuLETufzSPaKp11rYBsSOm7rCsW3OnIRAFM3OxRhceaXNYHkA==", + "dev": true, + "requires": { + "dot-prop": "^6.0.1", + "graceful-fs": "^4.2.6", + "unique-string": "^3.0.0", + "write-file-atomic": "^3.0.3", + "xdg-basedir": "^5.0.1" } }, "connect-datadog": { @@ -25824,8 +25868,21 @@ } }, "crypto-random-string": { - "version": "2.0.0", - "dev": true + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/crypto-random-string/-/crypto-random-string-4.0.0.tgz", + "integrity": "sha512-x8dy3RnvYdlUcPOjkEHqozhiwzKNSq7GcPuXFbnyMOCHxX8V3OgIg/pYuabl2sbUPfIJaeAQB7PMOK8DFIdoRA==", + "dev": true, + "requires": { + "type-fest": "^1.0.1" + }, + "dependencies": { + "type-fest": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-1.4.0.tgz", + "integrity": "sha512-yGSza74xk0UG8k+pLh5oeoYirvIiWo5t0/o3zHHAO2tRDiZcxWP7fywNlXhqb6/r6sWvwi+RsyQMWhVLe4BVuA==", + "dev": true + } + } }, "csp-parse": { "version": "0.0.2", @@ -25935,6 +25992,8 @@ }, "deep-extend": { "version": "0.6.0", + "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", + "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", "dev": true }, "deep-is": { @@ -25988,9 +26047,9 @@ "version": "5.0.0" }, "diff-sequences": { - "version": "28.1.1", - "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-28.1.1.tgz", - "integrity": "sha512-FU0iFaH/E23a+a718l8Qa/19bF9p06kgE0KipMOMadwa3SjnaElKzPaUC0vnibs6/B/9ni97s61mcejk8W1fQw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-29.0.0.tgz", + "integrity": "sha512-7Qe/zd1wxSDL4D/X/FPjOMB+ZMDt71W94KYaq05I2l0oQqgXgs7s4ftYYmV38gBSrPz2vcygxfs1xn0FT+rKNA==", "dev": true }, "dir-glob": { @@ -26120,16 +26179,12 @@ } }, "dot-prop": { - "version": "5.3.0", + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-6.0.1.tgz", + "integrity": "sha512-tE7ztYzXHIeyvc7N+hR3oi7FIbf/NIjVP9hmAt3yMXzrQ072/fpjGLx2GxNxGxUl5V73MEqYzioOMoVhGMJ5cA==", "dev": true, "requires": { "is-obj": "^2.0.0" - }, - "dependencies": { - "is-obj": { - "version": "2.0.0", - "dev": true - } } }, "dotenv": { @@ -26145,6 +26200,12 @@ "version": "0.1.4", "dev": true }, + "eastasianwidth": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", + "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==", + "dev": true + }, "ee-first": { "version": "1.1.1" }, @@ -26267,7 +26328,9 @@ "dev": true }, "escape-goat": { - "version": "2.1.1", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-goat/-/escape-goat-4.0.0.tgz", + "integrity": "sha512-2Sd4ShcWxbx6OY1IHyla/CVNwvg7XwZVoXZHcSu9w9SReNP1EzzD5T8NWKIR38fIqEns9kDWKUQTXXAmlDrdPg==", "dev": true }, "escape-html": { @@ -26863,25 +26926,25 @@ } }, "expect": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/expect/-/expect-28.1.3.tgz", - "integrity": "sha512-eEh0xn8HlsuOBxFgIss+2mX85VAS4Qy3OSkjV7rlBWljtA4oWH37glVGyOZSZvErDT/yBywZdPGwCXuTvSG85g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/expect/-/expect-29.0.0.tgz", + "integrity": "sha512-OKAHGwaBqZ6I7bas0cnrrvomEL2d0yp2XXYQhhnVHfaqDaKStUBxjWtlGu/uI2tBqwb9sBMvaS41DSJFsRRJHQ==", "dev": true, "requires": { - "@jest/expect-utils": "^28.1.3", - "jest-get-type": "^28.0.2", - "jest-matcher-utils": "^28.1.3", - "jest-message-util": "^28.1.3", - "jest-util": "^28.1.3" + "@jest/expect-utils": "^29.0.0", + "jest-get-type": "^29.0.0", + "jest-matcher-utils": "^29.0.0", + "jest-message-util": "^29.0.0", + "jest-util": "^29.0.0" }, "dependencies": { "@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -26890,9 +26953,9 @@ } }, "@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "requires": { "@types/yargs-parser": "*" @@ -26909,29 +26972,29 @@ } }, "jest-message-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", - "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.0.0.tgz", + "integrity": "sha512-4U0RdNV0TBTgVGzEchjryEpq4sqLO3gUQT7TEIbO5+q0K5MuiofOPcXk4GLpWviWByMRJjliQNMuzJ4YGT+oGQ==", "dev": true, "requires": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" } }, "jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -26940,13 +27003,12 @@ } }, "pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, @@ -27530,6 +27592,8 @@ }, "global-dirs": { "version": "3.0.0", + "resolved": "https://registry.npmjs.org/global-dirs/-/global-dirs-3.0.0.tgz", + "integrity": "sha512-v8ho2DS5RiCjftj1nD9NmnfaOzTdud7RRnVd9kFNOjqZbISlx5DQ+OrTkywgd0dIt7oFCvKetZSHoHcP3sDdiA==", "dev": true, "requires": { "ini": "2.0.0" @@ -27537,6 +27601,8 @@ "dependencies": { "ini": { "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ini/-/ini-2.0.0.tgz", + "integrity": "sha512-7PnF4oN3CvZF23ADhA5wRaYEQpJ8qygSkbtTXWBeXWXmEVRXK+1ITciHWwHhsjv1TmW0MgacIv6hEi5pX5NQdA==", "dev": true } } @@ -27733,7 +27799,9 @@ } }, "has-yarn": { - "version": "2.1.0", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-yarn/-/has-yarn-3.0.0.tgz", + "integrity": "sha512-IrsVwUHhEULx3R8f/aA8AHuEzAorplsab/v8HBzEiIukwq5i/EC+xmOW+HfP1OaDP+2JkgT1yILHN2O3UFIbcA==", "dev": true }, "hast-to-hyperscript": { @@ -28074,7 +28142,9 @@ } }, "import-lazy": { - "version": "2.1.0", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz", + "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", "dev": true }, "import-local": { @@ -28188,16 +28258,12 @@ "dev": true }, "is-ci": { - "version": "2.0.0", + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/is-ci/-/is-ci-3.0.1.tgz", + "integrity": "sha512-ZYvCgrefwqoQ6yTyYUbQu64HsITZ3NfKX1lzaEYdkTDcfKzzCI/wthRRYKkdjHKFVgNiXKAKm65Zo1pk2as/QQ==", "dev": true, "requires": { - "ci-info": "^2.0.0" - }, - "dependencies": { - "ci-info": { - "version": "2.0.0", - "dev": true - } + "ci-info": "^3.2.0" } }, "is-core-module": { @@ -28248,6 +28314,8 @@ }, "is-installed-globally": { "version": "0.4.0", + "resolved": "https://registry.npmjs.org/is-installed-globally/-/is-installed-globally-0.4.0.tgz", + "integrity": "sha512-iwGqO3J21aaSkC7jWnHP/difazwS7SFeIqxv6wEtLU8Y5KlzFTjyqcSIT0d8s4+dDhKytsk9PJZ2BkS5eZwQRQ==", "dev": true, "requires": { "global-dirs": "^3.0.0", @@ -28261,7 +28329,9 @@ "dev": true }, "is-npm": { - "version": "5.0.0", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/is-npm/-/is-npm-6.0.0.tgz", + "integrity": "sha512-JEjxbSmtPSt1c8XTkVrlujcXdKV1/tvuQ7GwKcAlyiVLeYFQ2VHat8xfrDJsIkhCdF/tZ7CiIR3sy141c6+gPQ==", "dev": true }, "is-number": { @@ -28277,8 +28347,16 @@ "has-tostringtag": "^1.0.0" } }, + "is-obj": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-2.0.0.tgz", + "integrity": "sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w==", + "dev": true + }, "is-path-inside": { "version": "3.0.3", + "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.3.tgz", + "integrity": "sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==", "dev": true }, "is-plain-obj": { @@ -28326,6 +28404,8 @@ }, "is-typedarray": { "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", + "integrity": "sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA==", "dev": true }, "is-url": { @@ -28351,7 +28431,9 @@ "version": "1.0.4" }, "is-yarn-global": { - "version": "0.3.0", + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/is-yarn-global/-/is-yarn-global-0.4.0.tgz", + "integrity": "sha512-HneQBCrXGBy15QnaDfcn6OLoU8AQPAa0Qn0IeJR/QCo4E8dNZaGGwxpCwWyEBQC5QvFonP8d6t60iGpAHVAfNA==", "dev": true }, "is2": { @@ -28440,24 +28522,24 @@ "version": "2.1.0" }, "jest": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest/-/jest-28.1.3.tgz", - "integrity": "sha512-N4GT5on8UkZgH0O5LUavMRV1EDEhNTL0KEfRmDIeZHSV7p2XgLoY9t9VDUgL6o+yfdgYHVxuz81G8oB9VG5uyA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest/-/jest-29.0.0.tgz", + "integrity": "sha512-9uz4Tclskb8WrfRXqu66FsFCFoyYctwWXpruKwnD95FZqkyoEAA1oGH53HUn7nQx7uEgZTKdNl/Yo6DqqU+XMg==", "dev": true, "requires": { - "@jest/core": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/core": "^29.0.0", + "@jest/types": "^29.0.0", "import-local": "^3.0.2", - "jest-cli": "^28.1.3" + "jest-cli": "^29.0.0" }, "dependencies": { "@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -28466,9 +28548,9 @@ } }, "@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "requires": { "@types/yargs-parser": "*" @@ -28487,9 +28569,9 @@ } }, "jest-changed-files": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-changed-files/-/jest-changed-files-28.1.3.tgz", - "integrity": "sha512-esaOfUWJXk2nfZt9SPyC8gA1kNfdKLkQWyzsMlqq8msYSlNKfmZxfRgZn4Cd4MGVUF+7v6dBs0d5TOAKa7iIiA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-changed-files/-/jest-changed-files-29.0.0.tgz", + "integrity": "sha512-28/iDMDrUpGoCitTURuDqUzWQoWmOmOKOFST1mi2lwh62X4BFf6khgH3uSuo1e49X/UDjuApAj3w0wLOex4VPQ==", "dev": true, "requires": { "execa": "^5.0.0", @@ -28497,65 +28579,65 @@ } }, "jest-circus": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-circus/-/jest-circus-28.1.3.tgz", - "integrity": "sha512-cZ+eS5zc79MBwt+IhQhiEp0OeBddpc1n8MBo1nMB8A7oPMKEO+Sre+wHaLJexQUj9Ya/8NOBY0RESUgYjB6fow==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-circus/-/jest-circus-29.0.0.tgz", + "integrity": "sha512-6EX70/+ZdzPLShBeokMVIpUaq5cQpOsO4OCDiV1drKUHht0hmUOWvY6LE4pBSFdepB0Sukw4Y0ajRqtvLBO9/A==", "dev": true, "requires": { - "@jest/environment": "^28.1.3", - "@jest/expect": "^28.1.3", - "@jest/test-result": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/environment": "^29.0.0", + "@jest/expect": "^29.0.0", + "@jest/test-result": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "co": "^4.6.0", "dedent": "^0.7.0", "is-generator-fn": "^2.0.0", - "jest-each": "^28.1.3", - "jest-matcher-utils": "^28.1.3", - "jest-message-util": "^28.1.3", - "jest-runtime": "^28.1.3", - "jest-snapshot": "^28.1.3", - "jest-util": "^28.1.3", + "jest-each": "^29.0.0", + "jest-matcher-utils": "^29.0.0", + "jest-message-util": "^29.0.0", + "jest-runtime": "^29.0.0", + "jest-snapshot": "^29.0.0", + "jest-util": "^29.0.0", "p-limit": "^3.1.0", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" }, "dependencies": { "@jest/environment": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-28.1.3.tgz", - "integrity": "sha512-1bf40cMFTEkKyEf585R9Iz1WayDjHoHqvts0XFYEqyKM3cFWDpeMoqKKTAF9LSYQModPUlh8FKptoM2YcMWAXA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-29.0.0.tgz", + "integrity": "sha512-ZHLvUENMAnwXowtyhmPRS0QLCXM4TS0ZfuiSR4QfRsJVN5lG4KdBDvI9kHJe/21vrgzPVOkvI7IBnkyPFCbV7g==", "dev": true, "requires": { - "@jest/fake-timers": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/fake-timers": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", - "jest-mock": "^28.1.3" + "jest-mock": "^29.0.0" } }, "@jest/fake-timers": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-28.1.3.tgz", - "integrity": "sha512-D/wOkL2POHv52h+ok5Oj/1gOG9HSywdoPtFsRCUmlCILXNn5eIWmcnd3DIiWlJnpGvQtmajqBP95Ei0EimxfLw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-29.0.0.tgz", + "integrity": "sha512-4tqH5fT9H0+Ms3Z1HLZ/JfpzJluep2Zo3uuj0KPyu6IIyYSHCDfkXuiBQNWUGvumZDLQ2Si03cC7Gq0r73VgVg==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@sinonjs/fake-timers": "^9.1.2", "@types/node": "*", - "jest-message-util": "^28.1.3", - "jest-mock": "^28.1.3", - "jest-util": "^28.1.3" + "jest-message-util": "^29.0.0", + "jest-mock": "^29.0.0", + "jest-util": "^29.0.0" } }, "@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -28573,9 +28655,9 @@ } }, "@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "requires": { "@types/yargs-parser": "*" @@ -28592,39 +28674,39 @@ } }, "jest-message-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", - "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.0.0.tgz", + "integrity": "sha512-4U0RdNV0TBTgVGzEchjryEpq4sqLO3gUQT7TEIbO5+q0K5MuiofOPcXk4GLpWviWByMRJjliQNMuzJ4YGT+oGQ==", "dev": true, "requires": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" } }, "jest-mock": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-28.1.3.tgz", - "integrity": "sha512-o3J2jr6dMMWYVH4Lh/NKmDXdosrsJgi4AviS8oXLujcjpCMBb1FMsblDnOXKZKfSiHLxYub1eS0IHuRXsio9eA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-29.0.0.tgz", + "integrity": "sha512-0AWznVt415KMCxcJPaE2+tWaruw0w8aRrKH1Y/NZUx3+Pd9f20jQjUR82iHqGSuYS4EOHL9uI8SjAhJk+ET91g==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*" } }, "jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -28633,13 +28715,12 @@ } }, "pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, @@ -28667,32 +28748,32 @@ } }, "jest-cli": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-cli/-/jest-cli-28.1.3.tgz", - "integrity": "sha512-roY3kvrv57Azn1yPgdTebPAXvdR2xfezaKKYzVxZ6It/5NCxzJym6tUI5P1zkdWhfUYkxEI9uZWcQdaFLo8mJQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-cli/-/jest-cli-29.0.0.tgz", + "integrity": "sha512-VZUPQjWJKL8QABFiBk1tHeJ3czBodjU9r22ceQmeL7X8/M73FYxTte0RkYPHI2SiLPWy99GZNWA+oOu9x0xKOA==", "dev": true, "requires": { - "@jest/core": "^28.1.3", - "@jest/test-result": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/core": "^29.0.0", + "@jest/test-result": "^29.0.0", + "@jest/types": "^29.0.0", "chalk": "^4.0.0", "exit": "^0.1.2", "graceful-fs": "^4.2.9", "import-local": "^3.0.2", - "jest-config": "^28.1.3", - "jest-util": "^28.1.3", - "jest-validate": "^28.1.3", + "jest-config": "^29.0.0", + "jest-util": "^29.0.0", + "jest-validate": "^29.0.0", "prompts": "^2.0.1", "yargs": "^17.3.1" }, "dependencies": { "@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -28701,9 +28782,9 @@ } }, "@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "requires": { "@types/yargs-parser": "*" @@ -28720,12 +28801,12 @@ } }, "jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -28736,68 +28817,68 @@ } }, "jest-config": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-config/-/jest-config-28.1.3.tgz", - "integrity": "sha512-MG3INjByJ0J4AsNBm7T3hsuxKQqFIiRo/AUqb1q9LRKI5UU6Aar9JHbr9Ivn1TVwfUD9KirRoM/T6u8XlcQPHQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-config/-/jest-config-29.0.0.tgz", + "integrity": "sha512-RbcUgQBJDS0O8OThWUwm5UCfzo0zOymUX/cJzUNlYB1ZWqe3M8MFEcgwqgZSifYuYTi46xWu5cmkMiyRQAdnMw==", "dev": true, "requires": { "@babel/core": "^7.11.6", - "@jest/test-sequencer": "^28.1.3", - "@jest/types": "^28.1.3", - "babel-jest": "^28.1.3", + "@jest/test-sequencer": "^29.0.0", + "@jest/types": "^29.0.0", + "babel-jest": "^29.0.0", "chalk": "^4.0.0", "ci-info": "^3.2.0", "deepmerge": "^4.2.2", "glob": "^7.1.3", "graceful-fs": "^4.2.9", - "jest-circus": "^28.1.3", - "jest-environment-node": "^28.1.3", - "jest-get-type": "^28.0.2", - "jest-regex-util": "^28.0.2", - "jest-resolve": "^28.1.3", - "jest-runner": "^28.1.3", - "jest-util": "^28.1.3", - "jest-validate": "^28.1.3", + "jest-circus": "^29.0.0", + "jest-environment-node": "^29.0.0", + "jest-get-type": "^29.0.0", + "jest-regex-util": "^29.0.0", + "jest-resolve": "^29.0.0", + "jest-runner": "^29.0.0", + "jest-util": "^29.0.0", + "jest-validate": "^29.0.0", "micromatch": "^4.0.4", "parse-json": "^5.2.0", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "strip-json-comments": "^3.1.1" }, "dependencies": { "@jest/environment": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-28.1.3.tgz", - "integrity": "sha512-1bf40cMFTEkKyEf585R9Iz1WayDjHoHqvts0XFYEqyKM3cFWDpeMoqKKTAF9LSYQModPUlh8FKptoM2YcMWAXA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-29.0.0.tgz", + "integrity": "sha512-ZHLvUENMAnwXowtyhmPRS0QLCXM4TS0ZfuiSR4QfRsJVN5lG4KdBDvI9kHJe/21vrgzPVOkvI7IBnkyPFCbV7g==", "dev": true, "requires": { - "@jest/fake-timers": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/fake-timers": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", - "jest-mock": "^28.1.3" + "jest-mock": "^29.0.0" } }, "@jest/fake-timers": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-28.1.3.tgz", - "integrity": "sha512-D/wOkL2POHv52h+ok5Oj/1gOG9HSywdoPtFsRCUmlCILXNn5eIWmcnd3DIiWlJnpGvQtmajqBP95Ei0EimxfLw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-29.0.0.tgz", + "integrity": "sha512-4tqH5fT9H0+Ms3Z1HLZ/JfpzJluep2Zo3uuj0KPyu6IIyYSHCDfkXuiBQNWUGvumZDLQ2Si03cC7Gq0r73VgVg==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@sinonjs/fake-timers": "^9.1.2", "@types/node": "*", - "jest-message-util": "^28.1.3", - "jest-mock": "^28.1.3", - "jest-util": "^28.1.3" + "jest-message-util": "^29.0.0", + "jest-mock": "^29.0.0", + "jest-util": "^29.0.0" } }, "@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -28815,9 +28896,9 @@ } }, "@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "requires": { "@types/yargs-parser": "*" @@ -28858,53 +28939,53 @@ } }, "jest-environment-node": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-28.1.3.tgz", - "integrity": "sha512-ugP6XOhEpjAEhGYvp5Xj989ns5cB1K6ZdjBYuS30umT4CQEETaxSiPcZ/E1kFktX4GkrcM4qu07IIlDYX1gp+A==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-29.0.0.tgz", + "integrity": "sha512-Cns21Vgu0z7LjtssL0SWkxmjclHdwXeECFAP3ONit5NPnGCbv+0Rqby8w9vK7NpFlUaFgMmLYYBsUjSmIhwpvg==", "dev": true, "requires": { - "@jest/environment": "^28.1.3", - "@jest/fake-timers": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/environment": "^29.0.0", + "@jest/fake-timers": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", - "jest-mock": "^28.1.3", - "jest-util": "^28.1.3" + "jest-mock": "^29.0.0", + "jest-util": "^29.0.0" } }, "jest-message-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", - "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.0.0.tgz", + "integrity": "sha512-4U0RdNV0TBTgVGzEchjryEpq4sqLO3gUQT7TEIbO5+q0K5MuiofOPcXk4GLpWviWByMRJjliQNMuzJ4YGT+oGQ==", "dev": true, "requires": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" } }, "jest-mock": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-28.1.3.tgz", - "integrity": "sha512-o3J2jr6dMMWYVH4Lh/NKmDXdosrsJgi4AviS8oXLujcjpCMBb1FMsblDnOXKZKfSiHLxYub1eS0IHuRXsio9eA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-29.0.0.tgz", + "integrity": "sha512-0AWznVt415KMCxcJPaE2+tWaruw0w8aRrKH1Y/NZUx3+Pd9f20jQjUR82iHqGSuYS4EOHL9uI8SjAhJk+ET91g==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*" } }, "jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -28922,13 +29003,12 @@ } }, "pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, @@ -28979,15 +29059,15 @@ } }, "jest-diff": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-diff/-/jest-diff-28.1.3.tgz", - "integrity": "sha512-8RqP1B/OXzjjTWkqMX67iqgwBVJRgCyKD3L9nq+6ZqJMdvjE8RgHktqZ6jNrkdMT+dJuYNI3rhQpxaz7drJHfw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-diff/-/jest-diff-29.0.0.tgz", + "integrity": "sha512-erkuYf1dQBHow3XJmS+bH6t9TZ0GwrSdQGauN8sTqyZlFByOjRadmHgTTcAHINeeSwxzGHN2ob3PXVvZphD7XQ==", "dev": true, "requires": { "chalk": "^4.0.0", - "diff-sequences": "^28.1.1", - "jest-get-type": "^28.0.2", - "pretty-format": "^28.1.3" + "diff-sequences": "^29.0.0", + "jest-get-type": "^29.0.0", + "pretty-format": "^29.0.0" }, "dependencies": { "chalk": { @@ -29001,13 +29081,12 @@ } }, "pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, @@ -29029,34 +29108,34 @@ } }, "jest-docblock": { - "version": "28.1.1", - "resolved": "https://registry.npmjs.org/jest-docblock/-/jest-docblock-28.1.1.tgz", - "integrity": "sha512-3wayBVNiOYx0cwAbl9rwm5kKFP8yHH3d/fkEaL02NPTkDojPtheGB7HZSFY4wzX+DxyrvhXz0KSCVksmCknCuA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-docblock/-/jest-docblock-29.0.0.tgz", + "integrity": "sha512-s5Kpra/kLzbqu9dEjov30kj1n4tfu3e7Pl8v+f8jOkeWNqM6Ds8jRaJfZow3ducoQUrf2Z4rs2N5S3zXnb83gw==", "dev": true, "requires": { "detect-newline": "^3.0.0" } }, "jest-each": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-each/-/jest-each-28.1.3.tgz", - "integrity": "sha512-arT1z4sg2yABU5uogObVPvSlSMQlDA48owx07BDPAiasW0yYpYHYOo4HHLz9q0BVzDVU4hILFjzJw0So9aCL/g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-each/-/jest-each-29.0.0.tgz", + "integrity": "sha512-ACKRvqdo7Bc0YrjQbrQtokpQ2NZxdXA63OklJht7a9UarCJXlZeWh51wEUe0ORqbnu15nAnX1YFQHmVpS1+ZXA==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "chalk": "^4.0.0", - "jest-get-type": "^28.0.2", - "jest-util": "^28.1.3", - "pretty-format": "^28.1.3" + "jest-get-type": "^29.0.0", + "jest-util": "^29.0.0", + "pretty-format": "^29.0.0" }, "dependencies": { "@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -29065,9 +29144,9 @@ } }, "@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "requires": { "@types/yargs-parser": "*" @@ -29084,12 +29163,12 @@ } }, "jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -29098,13 +29177,12 @@ } }, "pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, @@ -29180,9 +29258,9 @@ } }, "jest-get-type": { - "version": "28.0.2", - "resolved": "https://registry.npmjs.org/jest-get-type/-/jest-get-type-28.0.2.tgz", - "integrity": "sha512-ioj2w9/DxSYHfOm5lJKCdcAmPJzQXmbM/Url3rhlghrPvT3tt+7a/+oXc9azkKmLvoiXjtV83bEWqi+vs5nlPA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-get-type/-/jest-get-type-29.0.0.tgz", + "integrity": "sha512-83X19z/HuLKYXYHskZlBAShO7UfLFXu/vWajw9ZNJASN32li8yHMaVGAQqxFW1RCFOkB7cubaL6FaJVQqqJLSw==", "dev": true }, "jest-github-actions-reporter": { @@ -29193,32 +29271,32 @@ } }, "jest-haste-map": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-haste-map/-/jest-haste-map-28.1.3.tgz", - "integrity": "sha512-3S+RQWDXccXDKSWnkHa/dPwt+2qwA8CJzR61w3FoYCvoo3Pn8tvGcysmMF0Bj0EX5RYvAI2EIvC57OmotfdtKA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-haste-map/-/jest-haste-map-29.0.0.tgz", + "integrity": "sha512-mLyDt2WyNU0DZ64s7kRFkFJzrHEuXIxG+OKOs9/P5s1W7NzXE+P7SvLbxjz2Cg63cJjuglYRrD6fZcYf19T8Lw==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/graceful-fs": "^4.1.3", "@types/node": "*", "anymatch": "^3.0.3", "fb-watchman": "^2.0.0", "fsevents": "^2.3.2", "graceful-fs": "^4.2.9", - "jest-regex-util": "^28.0.2", - "jest-util": "^28.1.3", - "jest-worker": "^28.1.3", + "jest-regex-util": "^29.0.0", + "jest-util": "^29.0.0", + "jest-worker": "^29.0.0", "micromatch": "^4.0.4", "walker": "^1.0.8" }, "dependencies": { "@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -29227,9 +29305,9 @@ } }, "@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "requires": { "@types/yargs-parser": "*" @@ -29246,12 +29324,12 @@ } }, "jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -29260,9 +29338,9 @@ } }, "jest-worker": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-28.1.3.tgz", - "integrity": "sha512-CqRA220YV/6jCo8VWvAt1KKx6eek1VIHMPeLEbpcfSfkEeWyBNppynM/o6q+Wmw+sOhos2ml34wZbSX3G13//g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-29.0.0.tgz", + "integrity": "sha512-2t9Panx3F9N1wAvRuZT7xLEptRFc1C5G90DOHniIGz1JIgF9uhd5u8jNBsc7wN63lhnaiLeVLnNx21wT7OVFEQ==", "dev": true, "requires": { "@types/node": "*", @@ -29284,13 +29362,13 @@ } }, "jest-leak-detector": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-leak-detector/-/jest-leak-detector-28.1.3.tgz", - "integrity": "sha512-WFVJhnQsiKtDEo5lG2mM0v40QWnBM+zMdHHyJs8AWZ7J0QZJS59MsyKeJHWhpBZBH32S48FOVvGyOFT1h0DlqA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-leak-detector/-/jest-leak-detector-29.0.0.tgz", + "integrity": "sha512-kBjNS0/z2+ZV/3N7R+ot5fKD2W1fHkoxC3kH/fkb2z24YSPfR9RGwiNX+YLRG9r0gWsxQx16boxzHT23G6rFBw==", "dev": true, "requires": { - "jest-get-type": "^28.0.2", - "pretty-format": "^28.1.3" + "jest-get-type": "^29.0.0", + "pretty-format": "^29.0.0" }, "dependencies": { "ansi-styles": { @@ -29300,13 +29378,12 @@ "dev": true }, "pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" } @@ -29320,15 +29397,15 @@ } }, "jest-matcher-utils": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-matcher-utils/-/jest-matcher-utils-28.1.3.tgz", - "integrity": "sha512-kQeJ7qHemKfbzKoGjHHrRKH6atgxMk8Enkk2iPQ3XwO6oE/KYD8lMYOziCkeSB9G4adPM4nR1DE8Tf5JeWH6Bw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-matcher-utils/-/jest-matcher-utils-29.0.0.tgz", + "integrity": "sha512-HtCxFHI8lQSbN1RppFjtl6DIrS+x4d3lOhpJljVxFEXob4lxlKon3FunW0XoGxNSvIoD00AfTFspnufpOqszrg==", "dev": true, "requires": { "chalk": "^4.0.0", - "jest-diff": "^28.1.3", - "jest-get-type": "^28.0.2", - "pretty-format": "^28.1.3" + "jest-diff": "^29.0.0", + "jest-get-type": "^29.0.0", + "pretty-format": "^29.0.0" }, "dependencies": { "chalk": { @@ -29342,13 +29419,12 @@ } }, "pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, @@ -29424,35 +29500,35 @@ } }, "jest-regex-util": { - "version": "28.0.2", - "resolved": "https://registry.npmjs.org/jest-regex-util/-/jest-regex-util-28.0.2.tgz", - "integrity": "sha512-4s0IgyNIy0y9FK+cjoVYoxamT7Zeo7MhzqRGx7YDYmaQn1wucY9rotiGkBzzcMXTtjrCAP/f7f+E0F7+fxPNdw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-regex-util/-/jest-regex-util-29.0.0.tgz", + "integrity": "sha512-BV7VW7Sy0fInHWN93MMPtlClweYv2qrSCwfeFWmpribGZtQPWNvRSq9XOVgOEjU1iBGRKXUZil0o2AH7Iy9Lug==", "dev": true }, "jest-resolve": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-resolve/-/jest-resolve-28.1.3.tgz", - "integrity": "sha512-Z1W3tTjE6QaNI90qo/BJpfnvpxtaFTFw5CDgwpyE/Kz8U/06N1Hjf4ia9quUhCh39qIGWF1ZuxFiBiJQwSEYKQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-resolve/-/jest-resolve-29.0.0.tgz", + "integrity": "sha512-MN19maPUXzibBshYg/cSrDWqiJwEBur6gbQb2lwOL4+6k14wdNW8Xh0uNPPxUntb7cpTi07uql/bUO5TVwiJbA==", "dev": true, "requires": { "chalk": "^4.0.0", "graceful-fs": "^4.2.9", - "jest-haste-map": "^28.1.3", + "jest-haste-map": "^29.0.0", "jest-pnp-resolver": "^1.2.2", - "jest-util": "^28.1.3", - "jest-validate": "^28.1.3", + "jest-util": "^29.0.0", + "jest-validate": "^29.0.0", "resolve": "^1.20.0", "resolve.exports": "^1.1.0", "slash": "^3.0.0" }, "dependencies": { "@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -29461,9 +29537,9 @@ } }, "@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "requires": { "@types/yargs-parser": "*" @@ -29480,12 +29556,12 @@ } }, "jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -29502,77 +29578,77 @@ } }, "jest-resolve-dependencies": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-resolve-dependencies/-/jest-resolve-dependencies-28.1.3.tgz", - "integrity": "sha512-qa0QO2Q0XzQoNPouMbCc7Bvtsem8eQgVPNkwn9LnS+R2n8DaVDPL/U1gngC0LTl1RYXJU0uJa2BMC2DbTfFrHA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-resolve-dependencies/-/jest-resolve-dependencies-29.0.0.tgz", + "integrity": "sha512-1TYUMcLZcUqa2fdUQ3leYtiXWXfNmimPvnJ34YDLLf0nyJ/aEeqlHJM9Ji2jw9Qxdh7nUypanjUlUV87yRHBFQ==", "dev": true, "requires": { - "jest-regex-util": "^28.0.2", - "jest-snapshot": "^28.1.3" + "jest-regex-util": "^29.0.0", + "jest-snapshot": "^29.0.0" } }, "jest-runner": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-runner/-/jest-runner-28.1.3.tgz", - "integrity": "sha512-GkMw4D/0USd62OVO0oEgjn23TM+YJa2U2Wu5zz9xsQB1MxWKDOlrnykPxnMsN0tnJllfLPinHTka61u0QhaxBA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-runner/-/jest-runner-29.0.0.tgz", + "integrity": "sha512-OpTpRIBOIn9RXuMMrpS+h9ZoK+nZHaOuNOceUiDbDoOJ6pmeGu0zst7VR22xXT3fOCwWqg5qe0fZ23G+ve5P0Q==", "dev": true, "requires": { - "@jest/console": "^28.1.3", - "@jest/environment": "^28.1.3", - "@jest/test-result": "^28.1.3", - "@jest/transform": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/console": "^29.0.0", + "@jest/environment": "^29.0.0", + "@jest/test-result": "^29.0.0", + "@jest/transform": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "emittery": "^0.10.2", "graceful-fs": "^4.2.9", - "jest-docblock": "^28.1.1", - "jest-environment-node": "^28.1.3", - "jest-haste-map": "^28.1.3", - "jest-leak-detector": "^28.1.3", - "jest-message-util": "^28.1.3", - "jest-resolve": "^28.1.3", - "jest-runtime": "^28.1.3", - "jest-util": "^28.1.3", - "jest-watcher": "^28.1.3", - "jest-worker": "^28.1.3", + "jest-docblock": "^29.0.0", + "jest-environment-node": "^29.0.0", + "jest-haste-map": "^29.0.0", + "jest-leak-detector": "^29.0.0", + "jest-message-util": "^29.0.0", + "jest-resolve": "^29.0.0", + "jest-runtime": "^29.0.0", + "jest-util": "^29.0.0", + "jest-watcher": "^29.0.0", + "jest-worker": "^29.0.0", "p-limit": "^3.1.0", "source-map-support": "0.5.13" }, "dependencies": { "@jest/environment": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-28.1.3.tgz", - "integrity": "sha512-1bf40cMFTEkKyEf585R9Iz1WayDjHoHqvts0XFYEqyKM3cFWDpeMoqKKTAF9LSYQModPUlh8FKptoM2YcMWAXA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-29.0.0.tgz", + "integrity": "sha512-ZHLvUENMAnwXowtyhmPRS0QLCXM4TS0ZfuiSR4QfRsJVN5lG4KdBDvI9kHJe/21vrgzPVOkvI7IBnkyPFCbV7g==", "dev": true, "requires": { - "@jest/fake-timers": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/fake-timers": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", - "jest-mock": "^28.1.3" + "jest-mock": "^29.0.0" } }, "@jest/fake-timers": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-28.1.3.tgz", - "integrity": "sha512-D/wOkL2POHv52h+ok5Oj/1gOG9HSywdoPtFsRCUmlCILXNn5eIWmcnd3DIiWlJnpGvQtmajqBP95Ei0EimxfLw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-29.0.0.tgz", + "integrity": "sha512-4tqH5fT9H0+Ms3Z1HLZ/JfpzJluep2Zo3uuj0KPyu6IIyYSHCDfkXuiBQNWUGvumZDLQ2Si03cC7Gq0r73VgVg==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@sinonjs/fake-timers": "^9.1.2", "@types/node": "*", - "jest-message-util": "^28.1.3", - "jest-mock": "^28.1.3", - "jest-util": "^28.1.3" + "jest-message-util": "^29.0.0", + "jest-mock": "^29.0.0", + "jest-util": "^29.0.0" } }, "@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -29590,9 +29666,9 @@ } }, "@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "requires": { "@types/yargs-parser": "*" @@ -29609,53 +29685,53 @@ } }, "jest-environment-node": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-28.1.3.tgz", - "integrity": "sha512-ugP6XOhEpjAEhGYvp5Xj989ns5cB1K6ZdjBYuS30umT4CQEETaxSiPcZ/E1kFktX4GkrcM4qu07IIlDYX1gp+A==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-29.0.0.tgz", + "integrity": "sha512-Cns21Vgu0z7LjtssL0SWkxmjclHdwXeECFAP3ONit5NPnGCbv+0Rqby8w9vK7NpFlUaFgMmLYYBsUjSmIhwpvg==", "dev": true, "requires": { - "@jest/environment": "^28.1.3", - "@jest/fake-timers": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/environment": "^29.0.0", + "@jest/fake-timers": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", - "jest-mock": "^28.1.3", - "jest-util": "^28.1.3" + "jest-mock": "^29.0.0", + "jest-util": "^29.0.0" } }, "jest-message-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", - "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.0.0.tgz", + "integrity": "sha512-4U0RdNV0TBTgVGzEchjryEpq4sqLO3gUQT7TEIbO5+q0K5MuiofOPcXk4GLpWviWByMRJjliQNMuzJ4YGT+oGQ==", "dev": true, "requires": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" } }, "jest-mock": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-28.1.3.tgz", - "integrity": "sha512-o3J2jr6dMMWYVH4Lh/NKmDXdosrsJgi4AviS8oXLujcjpCMBb1FMsblDnOXKZKfSiHLxYub1eS0IHuRXsio9eA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-29.0.0.tgz", + "integrity": "sha512-0AWznVt415KMCxcJPaE2+tWaruw0w8aRrKH1Y/NZUx3+Pd9f20jQjUR82iHqGSuYS4EOHL9uI8SjAhJk+ET91g==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*" } }, "jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -29664,9 +29740,9 @@ } }, "jest-worker": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-28.1.3.tgz", - "integrity": "sha512-CqRA220YV/6jCo8VWvAt1KKx6eek1VIHMPeLEbpcfSfkEeWyBNppynM/o6q+Wmw+sOhos2ml34wZbSX3G13//g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-29.0.0.tgz", + "integrity": "sha512-2t9Panx3F9N1wAvRuZT7xLEptRFc1C5G90DOHniIGz1JIgF9uhd5u8jNBsc7wN63lhnaiLeVLnNx21wT7OVFEQ==", "dev": true, "requires": { "@types/node": "*", @@ -29686,13 +29762,12 @@ } }, "pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, @@ -29730,68 +29805,68 @@ } }, "jest-runtime": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-runtime/-/jest-runtime-28.1.3.tgz", - "integrity": "sha512-NU+881ScBQQLc1JHG5eJGU7Ui3kLKrmwCPPtYsJtBykixrM2OhVQlpMmFWJjMyDfdkGgBMNjXCGB/ebzsgNGQw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-runtime/-/jest-runtime-29.0.0.tgz", + "integrity": "sha512-dU0qFpTRWZY7Rur7yBgpz4g67mITSozBZ1jlhoG4ER/P/NiTFyZ/W8nMd5floeAMafmbrOc/5A9SlCu7SQCoBA==", "dev": true, "requires": { - "@jest/environment": "^28.1.3", - "@jest/fake-timers": "^28.1.3", - "@jest/globals": "^28.1.3", - "@jest/source-map": "^28.1.2", - "@jest/test-result": "^28.1.3", - "@jest/transform": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/environment": "^29.0.0", + "@jest/fake-timers": "^29.0.0", + "@jest/globals": "^29.0.0", + "@jest/source-map": "^29.0.0", + "@jest/test-result": "^29.0.0", + "@jest/transform": "^29.0.0", + "@jest/types": "^29.0.0", + "@types/node": "*", "chalk": "^4.0.0", "cjs-module-lexer": "^1.0.0", "collect-v8-coverage": "^1.0.0", - "execa": "^5.0.0", "glob": "^7.1.3", "graceful-fs": "^4.2.9", - "jest-haste-map": "^28.1.3", - "jest-message-util": "^28.1.3", - "jest-mock": "^28.1.3", - "jest-regex-util": "^28.0.2", - "jest-resolve": "^28.1.3", - "jest-snapshot": "^28.1.3", - "jest-util": "^28.1.3", + "jest-haste-map": "^29.0.0", + "jest-message-util": "^29.0.0", + "jest-mock": "^29.0.0", + "jest-regex-util": "^29.0.0", + "jest-resolve": "^29.0.0", + "jest-snapshot": "^29.0.0", + "jest-util": "^29.0.0", "slash": "^3.0.0", "strip-bom": "^4.0.0" }, "dependencies": { "@jest/environment": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-28.1.3.tgz", - "integrity": "sha512-1bf40cMFTEkKyEf585R9Iz1WayDjHoHqvts0XFYEqyKM3cFWDpeMoqKKTAF9LSYQModPUlh8FKptoM2YcMWAXA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-29.0.0.tgz", + "integrity": "sha512-ZHLvUENMAnwXowtyhmPRS0QLCXM4TS0ZfuiSR4QfRsJVN5lG4KdBDvI9kHJe/21vrgzPVOkvI7IBnkyPFCbV7g==", "dev": true, "requires": { - "@jest/fake-timers": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/fake-timers": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", - "jest-mock": "^28.1.3" + "jest-mock": "^29.0.0" } }, "@jest/fake-timers": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-28.1.3.tgz", - "integrity": "sha512-D/wOkL2POHv52h+ok5Oj/1gOG9HSywdoPtFsRCUmlCILXNn5eIWmcnd3DIiWlJnpGvQtmajqBP95Ei0EimxfLw==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-29.0.0.tgz", + "integrity": "sha512-4tqH5fT9H0+Ms3Z1HLZ/JfpzJluep2Zo3uuj0KPyu6IIyYSHCDfkXuiBQNWUGvumZDLQ2Si03cC7Gq0r73VgVg==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@sinonjs/fake-timers": "^9.1.2", "@types/node": "*", - "jest-message-util": "^28.1.3", - "jest-mock": "^28.1.3", - "jest-util": "^28.1.3" + "jest-message-util": "^29.0.0", + "jest-mock": "^29.0.0", + "jest-util": "^29.0.0" } }, "@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -29809,9 +29884,9 @@ } }, "@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "requires": { "@types/yargs-parser": "*" @@ -29852,39 +29927,39 @@ } }, "jest-message-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", - "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.0.0.tgz", + "integrity": "sha512-4U0RdNV0TBTgVGzEchjryEpq4sqLO3gUQT7TEIbO5+q0K5MuiofOPcXk4GLpWviWByMRJjliQNMuzJ4YGT+oGQ==", "dev": true, "requires": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" } }, "jest-mock": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-28.1.3.tgz", - "integrity": "sha512-o3J2jr6dMMWYVH4Lh/NKmDXdosrsJgi4AviS8oXLujcjpCMBb1FMsblDnOXKZKfSiHLxYub1eS0IHuRXsio9eA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-29.0.0.tgz", + "integrity": "sha512-0AWznVt415KMCxcJPaE2+tWaruw0w8aRrKH1Y/NZUx3+Pd9f20jQjUR82iHqGSuYS4EOHL9uI8SjAhJk+ET91g==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*" } }, "jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -29902,13 +29977,12 @@ } }, "pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, @@ -29940,43 +30014,44 @@ "dev": true }, "jest-snapshot": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-snapshot/-/jest-snapshot-28.1.3.tgz", - "integrity": "sha512-4lzMgtiNlc3DU/8lZfmqxN3AYD6GGLbl+72rdBpXvcV+whX7mDrREzkPdp2RnmfIiWBg1YbuFSkXduF2JcafJg==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-snapshot/-/jest-snapshot-29.0.0.tgz", + "integrity": "sha512-rR3B8GInk/IibF0M/sQCukSM8xX8bPI3Q0kjoAw4HT9Mx0Q3bS0MmF74rsreBOnVJgzN0Iwrc7YY56Yp8KQ7kA==", "dev": true, "requires": { "@babel/core": "^7.11.6", "@babel/generator": "^7.7.2", + "@babel/plugin-syntax-jsx": "^7.7.2", "@babel/plugin-syntax-typescript": "^7.7.2", "@babel/traverse": "^7.7.2", "@babel/types": "^7.3.3", - "@jest/expect-utils": "^28.1.3", - "@jest/transform": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/expect-utils": "^29.0.0", + "@jest/transform": "^29.0.0", + "@jest/types": "^29.0.0", "@types/babel__traverse": "^7.0.6", "@types/prettier": "^2.1.5", "babel-preset-current-node-syntax": "^1.0.0", "chalk": "^4.0.0", - "expect": "^28.1.3", + "expect": "^29.0.0", "graceful-fs": "^4.2.9", - "jest-diff": "^28.1.3", - "jest-get-type": "^28.0.2", - "jest-haste-map": "^28.1.3", - "jest-matcher-utils": "^28.1.3", - "jest-message-util": "^28.1.3", - "jest-util": "^28.1.3", + "jest-diff": "^29.0.0", + "jest-get-type": "^29.0.0", + "jest-haste-map": "^29.0.0", + "jest-matcher-utils": "^29.0.0", + "jest-message-util": "^29.0.0", + "jest-util": "^29.0.0", "natural-compare": "^1.4.0", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "semver": "^7.3.5" }, "dependencies": { "@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -29985,9 +30060,9 @@ } }, "@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "requires": { "@types/yargs-parser": "*" @@ -30004,29 +30079,29 @@ } }, "jest-message-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", - "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-29.0.0.tgz", + "integrity": "sha512-4U0RdNV0TBTgVGzEchjryEpq4sqLO3gUQT7TEIbO5+q0K5MuiofOPcXk4GLpWviWByMRJjliQNMuzJ4YGT+oGQ==", "dev": true, "requires": { "@babel/code-frame": "^7.12.13", - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/stack-utils": "^2.0.0", "chalk": "^4.0.0", "graceful-fs": "^4.2.9", "micromatch": "^4.0.4", - "pretty-format": "^28.1.3", + "pretty-format": "^29.0.0", "slash": "^3.0.0", "stack-utils": "^2.0.3" } }, "jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -30035,13 +30110,12 @@ } }, "pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, @@ -30091,26 +30165,26 @@ } }, "jest-validate": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-validate/-/jest-validate-28.1.3.tgz", - "integrity": "sha512-SZbOGBWEsaTxBGCOpsRWlXlvNkvTkY0XxRfh7zYmvd8uL5Qzyg0CHAXiXKROflh801quA6+/DsT4ODDthOC/OA==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-validate/-/jest-validate-29.0.0.tgz", + "integrity": "sha512-UhgDKmahJnv5s5MK6a8kQ397YNS9euvL7gWTvUf7y0OO7vZeafUItlq3tguvfFVazQJ+kBGUm/XCJes7V61l8g==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "camelcase": "^6.2.0", "chalk": "^4.0.0", - "jest-get-type": "^28.0.2", + "jest-get-type": "^29.0.0", "leven": "^3.1.0", - "pretty-format": "^28.1.3" + "pretty-format": "^29.0.0" }, "dependencies": { "@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -30119,9 +30193,9 @@ } }, "@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "requires": { "@types/yargs-parser": "*" @@ -30144,13 +30218,12 @@ } }, "pretty-format": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", - "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.0.0.tgz", + "integrity": "sha512-tMkFRn1vxRwZdiDETcveuNeonRKDg4doOvI+iyb1sOAtxYioGzRicqnsr+d3C/lLv9hBiM/2lDBi5ilR81h2bQ==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", - "ansi-regex": "^5.0.1", + "@jest/schemas": "^29.0.0", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" }, @@ -30172,28 +30245,28 @@ } }, "jest-watcher": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-watcher/-/jest-watcher-28.1.3.tgz", - "integrity": "sha512-t4qcqj9hze+jviFPUN3YAtAEeFnr/azITXQEMARf5cMwKY2SMBRnCQTXLixTl20OR6mLh9KLMrgVJgJISym+1g==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-watcher/-/jest-watcher-29.0.0.tgz", + "integrity": "sha512-GoRq5QJt5/dv3keK7rIzg9R0e/HpTnjyMNYtCTTDZgGIj6QUDMpiJqt7Mwfyyaxwg5PS8gVyQvRQn6Lril4cuQ==", "dev": true, "requires": { - "@jest/test-result": "^28.1.3", - "@jest/types": "^28.1.3", + "@jest/test-result": "^29.0.0", + "@jest/types": "^29.0.0", "@types/node": "*", "ansi-escapes": "^4.2.1", "chalk": "^4.0.0", "emittery": "^0.10.2", - "jest-util": "^28.1.3", + "jest-util": "^29.0.0", "string-length": "^4.0.1" }, "dependencies": { "@jest/types": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", - "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-29.0.0.tgz", + "integrity": "sha512-ErShruvByUF7vphEtPugMAphCtDIDdfWh3DxpBLxPEtHhL/H5MaidHsOutnOUhKpPL7QA6/7GitjFgLOLeGa1A==", "dev": true, "requires": { - "@jest/schemas": "^28.1.3", + "@jest/schemas": "^29.0.0", "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", "@types/node": "*", @@ -30202,9 +30275,9 @@ } }, "@types/yargs": { - "version": "17.0.10", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.10.tgz", - "integrity": "sha512-gmEaFwpj/7f/ROdtIlci1R1VYU1J4j95m8T+Tj3iBgiBFKg1foE/PSl93bBd5T9LDXNPo8UlNN6W0qwD8O5OaA==", + "version": "17.0.11", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.11.tgz", + "integrity": "sha512-aB4y9UDUXTSMxmM4MH+YnuR0g5Cph3FLQBoWoMB21DSvFVAxRVEHEMx3TLh+zUZYMCQtKiqazz0Q4Rre31f/OA==", "dev": true, "requires": { "@types/yargs-parser": "*" @@ -30221,12 +30294,12 @@ } }, "jest-util": { - "version": "28.1.3", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", - "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "version": "29.0.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-29.0.0.tgz", + "integrity": "sha512-HMjW/pkFgi34LGKumjNDK03DYonV+nPMNUZ63rZX8PFdBkdIWUtOCEiaa7sAJkWrw5MyMVzSpa22NcOJjoQ3JQ==", "dev": true, "requires": { - "@jest/types": "^28.1.3", + "@jest/types": "^29.0.0", "@types/node": "*", "chalk": "^4.0.0", "ci-info": "^3.2.0", @@ -30310,10 +30383,6 @@ "integrity": "sha512-1hqLFMSrGHRHxav9q9gNjJ5EXznIxGVO09xQRrwplcS8qs28pZ8s8hupZAmqDwZUmVZ2Qb2jnyPOWcDH8m8dlA==", "dev": true }, - "jsonexport": { - "version": "3.2.0", - "dev": true - }, "jsonfile": { "version": "6.1.0", "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", @@ -30372,10 +30441,12 @@ } }, "latest-version": { - "version": "5.1.0", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/latest-version/-/latest-version-7.0.0.tgz", + "integrity": "sha512-KvNT4XqAMzdcL6ka6Tl3i2lYeFDgXNCuIX+xNx6ZMVR1dFq+idXd9FLKNMOIx0t9mJ9/HudyX4oZWXZQ0UJHeg==", "dev": true, "requires": { - "package-json": "^6.3.0" + "package-json": "^8.1.0" } }, "lazy-ass": { @@ -30411,9 +30482,9 @@ "dev": true }, "linkinator": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/linkinator/-/linkinator-3.1.0.tgz", - "integrity": "sha512-ikQtLZ0JtY2JQXGZlzHID9Y87R4Zxe4TPAtFTem9T2UxQqXr0Ab8z9fse+apHEaD2l+WIX8f/P0IMODBMHhPWw==", + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/linkinator/-/linkinator-4.0.2.tgz", + "integrity": "sha512-PkwPiMx2NsRXaKQiOkTH8uMkkUrN3rh0gI6nFwjme2A7TVVYzlwGfmb00wbDEEdLrO49tDbajUEJGup64swmog==", "dev": true, "requires": { "chalk": "^5.0.0", @@ -30421,12 +30492,12 @@ "gaxios": "^5.0.0", "glob": "^8.0.1", "htmlparser2": "^8.0.1", - "jsonexport": "^3.2.0", "marked": "^4.0.3", "meow": "^10.1.1", "mime": "^3.0.0", "server-destroy": "^1.0.1", - "update-notifier": "^5.1.0" + "srcset": "^5.0.0", + "update-notifier": "^6.0.0" }, "dependencies": { "mime": { @@ -31412,28 +31483,28 @@ "peer": true }, "next": { - "version": "12.2.5", - "resolved": "https://registry.npmjs.org/next/-/next-12.2.5.tgz", - "integrity": "sha512-tBdjqX5XC/oFs/6gxrZhjmiq90YWizUYU6qOWAfat7zJwrwapJ+BYgX2PmiacunXMaRpeVT4vz5MSPSLgNkrpA==", + "version": "12.2.4", + "resolved": "https://registry.npmjs.org/next/-/next-12.2.4.tgz", + "integrity": "sha512-b1xlxEozmAWokAXzXsi5vlmU/IfJcFNIJA8dpU5UdkFbyDPio8wwb8mAQ/Y7rGtfTgG/t/u49BiyEA+xAgFvow==", "requires": { - "@next/env": "12.2.5", - "@next/swc-android-arm-eabi": "12.2.5", - "@next/swc-android-arm64": "12.2.5", - "@next/swc-darwin-arm64": "12.2.5", - "@next/swc-darwin-x64": "12.2.5", - "@next/swc-freebsd-x64": "12.2.5", - "@next/swc-linux-arm-gnueabihf": "12.2.5", - "@next/swc-linux-arm64-gnu": "12.2.5", - "@next/swc-linux-arm64-musl": "12.2.5", - "@next/swc-linux-x64-gnu": "12.2.5", - "@next/swc-linux-x64-musl": "12.2.5", - "@next/swc-win32-arm64-msvc": "12.2.5", - "@next/swc-win32-ia32-msvc": "12.2.5", - "@next/swc-win32-x64-msvc": "12.2.5", + "@next/env": "12.2.4", + "@next/swc-android-arm-eabi": "12.2.4", + "@next/swc-android-arm64": "12.2.4", + "@next/swc-darwin-arm64": "12.2.4", + "@next/swc-darwin-x64": "12.2.4", + "@next/swc-freebsd-x64": "12.2.4", + "@next/swc-linux-arm-gnueabihf": "12.2.4", + "@next/swc-linux-arm64-gnu": "12.2.4", + "@next/swc-linux-arm64-musl": "12.2.4", + "@next/swc-linux-x64-gnu": "12.2.4", + "@next/swc-linux-x64-musl": "12.2.4", + "@next/swc-win32-arm64-msvc": "12.2.4", + "@next/swc-win32-ia32-msvc": "12.2.4", + "@next/swc-win32-x64-msvc": "12.2.4", "@swc/helpers": "0.4.3", "caniuse-lite": "^1.0.30001332", "postcss": "8.4.14", - "styled-jsx": "5.0.4", + "styled-jsx": "5.0.2", "use-sync-external-store": "1.2.0" } }, @@ -31772,120 +31843,15 @@ "devOptional": true }, "package-json": { - "version": "6.5.0", + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/package-json/-/package-json-8.1.0.tgz", + "integrity": "sha512-hySwcV8RAWeAfPsXb9/HGSPn8lwDnv6fabH+obUZKX169QknRkRhPxd1yMubpKDskLFATkl3jHpNtVtDPFA0Wg==", "dev": true, "requires": { - "got": "^9.6.0", - "registry-auth-token": "^4.0.0", - "registry-url": "^5.0.0", - "semver": "^6.2.0" - }, - "dependencies": { - "@sindresorhus/is": { - "version": "0.14.0", - "dev": true - }, - "@szmarczak/http-timer": { - "version": "1.1.2", - "dev": true, - "requires": { - "defer-to-connect": "^1.0.1" - } - }, - "cacheable-request": { - "version": "6.1.0", - "dev": true, - "requires": { - "clone-response": "^1.0.2", - "get-stream": "^5.1.0", - "http-cache-semantics": "^4.0.0", - "keyv": "^3.0.0", - "lowercase-keys": "^2.0.0", - "normalize-url": "^4.1.0", - "responselike": "^1.0.2" - } - }, - "decompress-response": { - "version": "3.3.0", - "dev": true, - "requires": { - "mimic-response": "^1.0.0" - } - }, - "defer-to-connect": { - "version": "1.1.3", - "dev": true - }, - "got": { - "version": "9.6.0", - "dev": true, - "requires": { - "@sindresorhus/is": "^0.14.0", - "@szmarczak/http-timer": "^1.1.2", - "cacheable-request": "^6.0.0", - "decompress-response": "^3.3.0", - "duplexer3": "^0.1.4", - "get-stream": "^4.1.0", - "lowercase-keys": "^1.0.1", - "mimic-response": "^1.0.1", - "p-cancelable": "^1.0.0", - "to-readable-stream": "^1.0.0", - "url-parse-lax": "^3.0.0" - }, - "dependencies": { - "get-stream": { - "version": "4.1.0", - "dev": true, - "requires": { - "pump": "^3.0.0" - } - }, - "lowercase-keys": { - "version": "1.0.1", - "dev": true - } - } - }, - "json-buffer": { - "version": "3.0.0", - "dev": true - }, - "keyv": { - "version": "3.1.0", - "dev": true, - "requires": { - "json-buffer": "3.0.0" - } - }, - "normalize-url": { - "version": "4.5.1", - "dev": true - }, - "p-cancelable": { - "version": "1.1.0", - "dev": true - }, - "responselike": { - "version": "1.0.2", - "dev": true, - "requires": { - "lowercase-keys": "^1.0.0" - }, - "dependencies": { - "lowercase-keys": { - "version": "1.0.1", - "dev": true - } - } - }, - "semver": { - "version": "6.3.0", - "dev": true - }, - "to-readable-stream": { - "version": "1.0.0", - "dev": true - } + "got": "^12.1.0", + "registry-auth-token": "^5.0.1", + "registry-url": "^6.0.0", + "semver": "^7.3.7" } }, "param-case": { @@ -32167,6 +32133,12 @@ "property-information": { "version": "6.0.1" }, + "proto-list": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/proto-list/-/proto-list-1.2.4.tgz", + "integrity": "sha512-vtK/94akxsTMhe0/cbfpR+syPuszcuwhqVjJq26CuNDgFGj682oRBXOP5MJpv2r7JtE8MsiepGIqvvOTBwn2vA==", + "dev": true + }, "proxy-addr": { "version": "2.0.7", "requires": { @@ -32202,10 +32174,12 @@ "version": "2.1.1" }, "pupa": { - "version": "2.1.1", + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/pupa/-/pupa-3.1.0.tgz", + "integrity": "sha512-FLpr4flz5xZTSJxSeaheeMKN/EDzMdK7b8PTOC6a5PYFKTucWbdqjgqaEyH0shFiSJrVB1+Qqi4Tk19ccU6Aug==", "dev": true, "requires": { - "escape-goat": "^2.0.0" + "escape-goat": "^4.0.0" } }, "puppeteer": { @@ -32313,6 +32287,8 @@ }, "rc": { "version": "1.2.8", + "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", + "integrity": "sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==", "dev": true, "requires": { "deep-extend": "^0.6.0", @@ -32323,6 +32299,8 @@ "dependencies": { "strip-json-comments": { "version": "2.0.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", + "integrity": "sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ==", "dev": true } } @@ -32611,17 +32589,21 @@ } }, "registry-auth-token": { - "version": "4.2.1", + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/registry-auth-token/-/registry-auth-token-5.0.1.tgz", + "integrity": "sha512-UfxVOj8seK1yaIOiieV4FIP01vfBDLsY0H9sQzi9EbbUdJiuuBjJgLa1DpImXMNPnVkBD4eVxTEXcrZA6kfpJA==", "dev": true, "requires": { - "rc": "^1.2.8" + "@pnpm/npm-conf": "^1.0.4" } }, "registry-url": { - "version": "5.1.0", + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/registry-url/-/registry-url-6.0.1.tgz", + "integrity": "sha512-+crtS5QjFRqFCoQmvGduwYWEBng99ZvmFvF+cUJkGYF1L1BfU8C6Zp9T7f5vPAwyLkUExpvK+ANVZmGU49qi4Q==", "dev": true, "requires": { - "rc": "^1.2.8" + "rc": "1.2.8" } }, "regjsgen": { @@ -33287,16 +33269,12 @@ } }, "semver-diff": { - "version": "3.1.1", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/semver-diff/-/semver-diff-4.0.0.tgz", + "integrity": "sha512-0Ju4+6A8iOnpL/Thra7dZsSlOHYAHIeMxfhWQRI1/VLcT3WDBZKKtQt/QkBOsiIN9ZpuvHE6cGZ0x4glCMmfiA==", "dev": true, "requires": { - "semver": "^6.3.0" - }, - "dependencies": { - "semver": { - "version": "6.3.0", - "dev": true - } + "semver": "^7.3.5" } }, "send": { @@ -33639,7 +33617,7 @@ "version": "5.0.0", "resolved": "https://registry.npmjs.org/srcset/-/srcset-5.0.0.tgz", "integrity": "sha512-SqEZaAEhe0A6ETEa9O1IhSPC7MdvehZtCnTR0AftXk3QhY2UNgb+NApFOUPZILXk/YTDfFxMTNJOBpzrJsEdIA==", - "optional": true + "devOptional": true }, "stack-utils": { "version": "2.0.5", @@ -33860,9 +33838,9 @@ } }, "styled-jsx": { - "version": "5.0.4", - "resolved": "https://registry.npmjs.org/styled-jsx/-/styled-jsx-5.0.4.tgz", - "integrity": "sha512-sDFWLbg4zR+UkNzfk5lPilyIgtpddfxXEULxhujorr5jtePTUqiPDc5BC0v1NRqTr/WaFBGQQUoYToGlF4B2KQ==", + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/styled-jsx/-/styled-jsx-5.0.2.tgz", + "integrity": "sha512-LqPQrbBh3egD57NBcHET4qcgshPks+yblyhPlH2GY8oaDgKs8SK4C3dBh3oSJjgzJ3G5t1SYEZGHkP+QEpX9EQ==", "requires": {} }, "styled-system": { @@ -34223,6 +34201,8 @@ }, "typedarray-to-buffer": { "version": "3.1.5", + "resolved": "https://registry.npmjs.org/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz", + "integrity": "sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==", "dev": true, "requires": { "is-typedarray": "^1.0.0" @@ -34320,10 +34300,12 @@ } }, "unique-string": { - "version": "2.0.0", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/unique-string/-/unique-string-3.0.0.tgz", + "integrity": "sha512-VGXBUVwxKMBUznyffQweQABPRRW1vHZAbadFZud4pLFAqRGvv/96vafgjWFqzourzr8YonlQiPgH0YCJfawoGQ==", "dev": true, "requires": { - "crypto-random-string": "^2.0.0" + "crypto-random-string": "^4.0.0" } }, "unist-builder": { @@ -34424,33 +34406,25 @@ } }, "update-notifier": { - "version": "5.1.0", + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/update-notifier/-/update-notifier-6.0.2.tgz", + "integrity": "sha512-EDxhTEVPZZRLWYcJ4ZXjGFN0oP7qYvbXWzEgRm/Yql4dHX5wDbvh89YHP6PK1lzZJYrMtXUuZZz8XGK+U6U1og==", "dev": true, "requires": { - "boxen": "^5.0.0", - "chalk": "^4.1.0", - "configstore": "^5.0.1", - "has-yarn": "^2.1.0", - "import-lazy": "^2.1.0", - "is-ci": "^2.0.0", + "boxen": "^7.0.0", + "chalk": "^5.0.1", + "configstore": "^6.0.0", + "has-yarn": "^3.0.0", + "import-lazy": "^4.0.0", + "is-ci": "^3.0.1", "is-installed-globally": "^0.4.0", - "is-npm": "^5.0.0", - "is-yarn-global": "^0.3.0", - "latest-version": "^5.1.0", - "pupa": "^2.1.1", - "semver": "^7.3.4", - "semver-diff": "^3.1.1", - "xdg-basedir": "^4.0.0" - }, - "dependencies": { - "chalk": { - "version": "4.1.2", - "dev": true, - "requires": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" - } - } + "is-npm": "^6.0.0", + "is-yarn-global": "^0.4.0", + "latest-version": "^7.0.0", + "pupa": "^3.1.0", + "semver": "^7.3.7", + "semver-diff": "^4.0.0", + "xdg-basedir": "^5.1.0" } }, "upper-case": { @@ -34473,19 +34447,6 @@ "punycode": "^2.1.0" } }, - "url-parse-lax": { - "version": "3.0.0", - "dev": true, - "requires": { - "prepend-http": "^2.0.0" - }, - "dependencies": { - "prepend-http": { - "version": "2.0.0", - "dev": true - } - } - }, "url-template": { "version": "3.0.0" }, @@ -34935,10 +34896,25 @@ "dev": true }, "widest-line": { - "version": "3.1.0", + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-4.0.1.tgz", + "integrity": "sha512-o0cyEG0e8GPzT4iGHphIOh0cJOV8fivsXxddQasHPHfoZf1ZexrfeA21w2NaEN1RHE+fXlfISmOE8R9N3u3Qig==", "dev": true, "requires": { - "string-width": "^4.0.0" + "string-width": "^5.0.1" + }, + "dependencies": { + "string-width": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", + "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", + "dev": true, + "requires": { + "eastasianwidth": "^0.2.0", + "emoji-regex": "^9.2.2", + "strip-ansi": "^7.0.1" + } + } } }, "word-wrap": { @@ -34968,6 +34944,8 @@ }, "write-file-atomic": { "version": "3.0.3", + "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-3.0.3.tgz", + "integrity": "sha512-AvHcyZ5JnSfq3ioSyjrBkH9yW4m7Ayk8/9My/DD9onKeu/94fwrMocemO2QAJFAlnnDN+ZDS+ZjAR5ua1/PV/Q==", "dev": true, "requires": { "imurmurhash": "^0.1.4", @@ -34984,7 +34962,9 @@ "requires": {} }, "xdg-basedir": { - "version": "4.0.0", + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-5.1.0.tgz", + "integrity": "sha512-GCPAHLvrIH13+c0SuacwvRYj2SxJXQ4kaVTT5xgL3kPrz56XxkF21IGhjSE1+W0aw7gpBWRGXLCPnPby6lSpmQ==", "dev": true }, "xml2js": { @@ -35031,9 +35011,9 @@ }, "dependencies": { "yargs-parser": { - "version": "21.0.1", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.0.1.tgz", - "integrity": "sha512-9BK1jFpLzJROCI5TzwZL/TU4gqjK5xiHV/RfWLOahrjAko/e4DJkRDZQXfvqAsiZzzYhgAzbgz6lg48jcm4GLg==", + "version": "21.1.1", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", + "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", "dev": true } } diff --git a/package.json b/package.json index 696af1ee7f..5bdd205e62 100644 --- a/package.json +++ b/package.json @@ -55,7 +55,7 @@ "mdast-util-to-string": "^3.1.0", "morgan": "^1.10.0", "msgpack5rpc": "^1.1.0", - "next": "12.2.5", + "next": "12.2.4", "parse5": "7.0.0", "port-used": "^2.0.8", "react": "^17.0.2", @@ -99,7 +99,7 @@ "@babel/preset-env": "^7.18.2", "@graphql-inspector/core": "^3.1.2", "@graphql-tools/load": "^7.5.14", - "@jest/globals": "^28.1.1", + "@jest/globals": "29.0.0", "@octokit/graphql": "4.8.0", "@octokit/rest": "^18.12.0", "@types/github-slugger": "^1.3.0", @@ -136,13 +136,13 @@ "http-status-code": "^2.1.0", "husky": "^8.0.1", "japanese-characters": "^1.1.0", - "jest": "28.1.3", + "jest": "29.0.0", "jest-environment-puppeteer": "^5.0.4", "jest-fail-on-console": "^2.4.2", "jest-github-actions-reporter": "^1.0.3", "jest-slow-test-reporter": "^1.0.0", "kill-port": "2.0.0", - "linkinator": "^3.1.0", + "linkinator": "4.0.2", "lint-staged": "^13.0.1", "make-promises-safe": "^5.1.0", "minimatch": "^5.1.0", @@ -183,7 +183,7 @@ "build": "next build", "debug": "cross-env NODE_ENV=development ENABLED_LANGUAGES='en,ja' nodemon --inspect server.js", "dev": "cross-env npm start", - "index-test-fixtures": "node script/search/index-elasticsearch.js -s tests/content/fixtures/search-indexes -l en -V ghae -V dotcom", + "index-test-fixtures": "node script/search/index-elasticsearch.js -s tests/content/fixtures/search-indexes -l en -V ghae -V dotcom --index-prefix tests", "lint": "eslint '**/*.{js,mjs,ts,tsx}'", "lint-translation": "cross-env NODE_OPTIONS=--experimental-vm-modules TEST_TRANSLATION=true jest tests/linting/lint-files.js", "prepare": "husky install", diff --git a/pages/500.tsx b/pages/500.tsx deleted file mode 100644 index 0b75f32263..0000000000 --- a/pages/500.tsx +++ /dev/null @@ -1,5 +0,0 @@ -import { GenericError } from 'components/GenericError' - -export default function Custom500() { - return -} diff --git a/pages/[versionId]/rest/quickstart.tsx b/pages/[versionId]/rest/quickstart.tsx new file mode 100644 index 0000000000..d54de08809 --- /dev/null +++ b/pages/[versionId]/rest/quickstart.tsx @@ -0,0 +1,5 @@ +import GlobalPage from '../[productId]/index' + +export { getServerSideProps } from '../[productId]/index' + +export default GlobalPage diff --git a/pages/_error.tsx b/pages/_error.tsx index 2f6fd315f8..11ab286483 100644 --- a/pages/_error.tsx +++ b/pages/_error.tsx @@ -1,10 +1,104 @@ -import { NextPage } from 'next' +import type { NextPageContext } from 'next' + import { GenericError } from 'components/GenericError' -type Props = {} - -const ErrorPage: NextPage = () => { +function Error() { return } -export default ErrorPage +Error.getInitialProps = async (ctx: NextPageContext) => { + // If this getInitialProps() is called in client-side rendering, + // you won't have a `.res` object. It's only present when it's + // rendered Node (SSR). That's our clue to know that, we should + // send this error to Failbot. + // In client-side, it's undefined. In server, it's a ServerResponse object. + const { err, req, res } = ctx + let statusCode = 500 + if (res?.statusCode) { + statusCode = res.statusCode + } + + // 'err' will by falsy if it's a 404 + // But note, at the time of writing this comment, we have a dedicated + // `pages/404.tsx` which takes care of 404 messages. + if (err && res && req) { + // This is a (necessary) hack! + // You can't import `../lib/failbot.js` here in this + // file because it gets imported by webpack to be used in the + // client-side JS bundle. It *could* be solved by overriding + // the webpack configuration in our `next.config.js` but this is prone + // to be fragile since ignoring code can be hard to get right + // and the more we override there, the harder it will become to + // upgrade NextJS in the future because of moving parts. + // So the solution is to essentially do what the contextualizers + // do which mutate the Express request object by attaching + // callables to it. This way it's only ever present in SSR executed + // code and doesn't need any custom webpack configuration. + const expressRequest = req as any + const FailBot = expressRequest.FailBot + if (FailBot) { + try { + // An inclusion-list of headers we're OK with sending because + // they don't contain an PII. + const OK_HEADER_KEYS = ['user-agent', 'referer', 'accept-encoding', 'accept-language'] + const reported = FailBot.report(err, { + path: req.url, + request: JSON.stringify( + { + method: expressRequest.method, + query: expressRequest.query, + language: expressRequest.language, + }, + undefined, + 2 + ), + headers: JSON.stringify( + Object.fromEntries( + Object.entries(req.headers).filter(([k]) => OK_HEADER_KEYS.includes(k)) + ), + undefined, + 2 + ), + }) + + // Within FailBot.report() (which is our wrapper for Failbot in + // the `@github/failbot` package), it might exit only because + // it has no configured backends to send to. I.e. it returns undefined. + // Otherwise, it should return `Array>`. + if (!reported) { + console.warn( + 'The FailBot.report() returned undefined which means the error was NOT sent to Failbot.' + ) + } else if ( + Array.isArray(reported) && + reported.length && + reported.every((thing) => thing instanceof Promise) + ) { + // Make sure we await the promises even though we don't care + // about the results. This makes the code cleaner rather than + // letting the eventloop take care of it which could result + // in cryptic error messages if the await does fail for some + // reason. + try { + await Promise.all(reported) + } catch (error) { + console.warn('Unable to await reported FailBot errors', error) + } + } + } catch (error) { + // This does not necessarily mean FailBot failed to send. It's + // most likely that we failed to *send to* FailBot before it + // even has a chance to use the network. This is because + // `FailBot.report` returns an array of Promises which themselves + // could go wrong, but that's a story for another try/catch. + // Basically, this catch it just to avoid other errors that + // might prevent the pretty error page to render at all. + console.warn('Failed to send error to FailBot.', error) + } + } + } + + return { statusCode, message: err?.message } +} + +export default Error diff --git a/pages/search.tsx b/pages/search.tsx index 51872ff8f9..fa6281d615 100644 --- a/pages/search.tsx +++ b/pages/search.tsx @@ -21,6 +21,15 @@ export default function Page({ mainContext }: Props) { } export const getServerSideProps: GetServerSideProps = async (context) => { + // The dedicated search results page depends on a working Elasticsearch, + // ultimately, but unfortunately, that might not be up and running. + // So if that's the case, which might be true in production (Aug 2022) + // or on an engineers local development, we basically pretend the + // page doesn't exist. + if (!process.env.ELASTICSEARCH_URL) { + return { notFound: true } + } + const req = context.req as any const res = context.res as any diff --git a/script/i18n/lint-translation-files.js b/script/i18n/lint-translation-files.js index 58a784fe0f..93e6db9531 100755 --- a/script/i18n/lint-translation-files.js +++ b/script/i18n/lint-translation-files.js @@ -7,6 +7,8 @@ // // [end-readme] +// Remove this when removing translations directory B504EDD0 + import { execSync } from 'child_process' import { program } from 'commander' import fs from 'fs' diff --git a/script/rendered-content-link-checker.js b/script/rendered-content-link-checker.js index e3ece57f06..af0e69f2ca 100755 --- a/script/rendered-content-link-checker.js +++ b/script/rendered-content-link-checker.js @@ -12,6 +12,7 @@ import path from 'path' import cheerio from 'cheerio' import { program, Option, InvalidArgumentError } from 'commander' import chalk from 'chalk' +import got from 'got' import shortVersions from '../middleware/contextualizers/short-versions.js' import contextualize from '../middleware/context.js' @@ -20,6 +21,7 @@ import getRedirect from '../lib/get-redirect.js' import warmServer from '../lib/warm-server.js' import renderContent from '../lib/render-content/index.js' import { deprecated } from '../lib/enterprise-server-releases.js' +import excludedLinks from '../lib/excluded-links.js' const STATIC_PREFIXES = { assets: path.resolve('assets'), @@ -32,6 +34,18 @@ Object.entries(STATIC_PREFIXES).forEach(([key, value]) => { } }) +// Return a function that can as quickly as possible check if a certain +// href input should be skipped. +// Do this so we can use a `Set` and a `iterable.some()` for a speedier +// check. +function linksToSkipFactory() { + const set = new Set(excludedLinks.filter((regexOrURL) => typeof regexOrURL === 'string')) + const regexes = excludedLinks.filter((regexOrURL) => regexOrURL instanceof RegExp) + return (href) => set.has(href) || regexes.some((regex) => regex.test(href)) +} + +const linksToSkip = linksToSkipFactory(excludedLinks) + const CONTENT_ROOT = path.resolve('content') const deprecatedVersionPrefixesRegex = new RegExp( @@ -56,6 +70,7 @@ program .option('-b, --bail', 'Exit on the first flaw') .option('--check-anchors', "Validate links that start with a '#' too") .option('--check-images', 'Validate local images too') + .option('--check-external-links', 'Check external URLs too') .option('-v, --verbose', 'Verbose outputs') .option('--debug', "Loud about everything it's doing") .option('--random', 'Load pages in a random order (useful for debugging)') @@ -92,7 +107,7 @@ program main(program.opts(), program.args) async function main(opts, files) { - const { random, language, filter, exit, debug, max, verbose, list } = opts + const { random, language, filter, exit, debug, max, verbose, list, checkExternalLinks } = opts // Note! The reason we're using `warmServer()` in this script, // even though there's no server involved, is because @@ -133,6 +148,14 @@ async function main(opts, files) { const pages = getPages(pageList, languages, filters, files, max) debug && console.timeEnd('getPages') + if (checkExternalLinks && pages.length >= 100) { + console.warn( + chalk.yellow( + `Warning! Checking external URLs can be time costly. You're testing ${pages.length} pages.` + ) + ) + } + const processPagesStart = new Date() const flawsGroups = await Promise.all( pages.map((page) => processPage(page, pageMap, redirects, opts)) @@ -240,38 +263,58 @@ async function processPage(page, pageMap, redirects, opts) { } async function processPermalink(permalink, page, pageMap, redirects, opts) { - const { level, checkAnchors, checkImages } = opts + const { level, checkAnchors, checkImages, checkExternalLinks } = opts const html = await renderInnerHTML(page, permalink) const $ = cheerio.load(html) const flaws = [] + const links = [] $('a[href]').each((i, link) => { - const { href } = link.attribs - - // The global cache can't be used for anchor links because they - // depend on each page it renders - if (!href.startsWith('#')) { - if (globalHrefCheckCache.has(href)) { - globalCacheHitCount++ - return globalHrefCheckCache.get(href) - } - globalCacheMissCount++ - } - - const flaw = checkHrefLink(href, $, redirects, pageMap, checkAnchors) - - // Again if it's *not* an anchor link, we can use the cache. - if (!href.startsWith('#')) { - globalHrefCheckCache.set(href, flaw) - } - - if (flaw) { - if (level === 'critical' && !flaw.CRITICAL) { - return - } - const text = $(link).text() - flaws.push({ permalink, page, href, flaw, text }) - } + links.push(link) }) + const newFlaws = await Promise.all( + links.map(async (link) => { + const { href } = link.attribs + + // The global cache can't be used for anchor links because they + // depend on each page it renders + if (!href.startsWith('#')) { + if (globalHrefCheckCache.has(href)) { + globalCacheHitCount++ + return globalHrefCheckCache.get(href) + } + globalCacheMissCount++ + } + + const flaw = await checkHrefLink( + href, + $, + redirects, + pageMap, + checkAnchors, + checkExternalLinks + ) + + if (flaw) { + if (level === 'critical' && !flaw.CRITICAL) { + return + } + const text = $(link).text() + if (!href.startsWith('#')) { + globalHrefCheckCache.set(href, { href, flaw, text }) + } + return { href, flaw, text } + } else { + if (!href.startsWith('#')) { + globalHrefCheckCache.set(href, flaw) + } + } + }) + ) + for (const flaw of newFlaws) { + if (flaw) { + flaws.push(Object.assign(flaw, { page, permalink })) + } + } if (checkImages) { $('img[src]').each((i, img) => { @@ -353,7 +396,14 @@ const globalImageSrcCheckCache = new Map() let globalCacheHitCount = 0 let globalCacheMissCount = 0 -function checkHrefLink(href, $, redirects, pageMap, checkAnchors = false) { +async function checkHrefLink( + href, + $, + redirects, + pageMap, + checkAnchors = false, + checkExternalLinks = false +) { if (href === '#') { if (checkAnchors) { return { WARNING: 'Link is just an empty `#`' } @@ -399,9 +449,80 @@ function checkHrefLink(href, $, redirects, pageMap, checkAnchors = false) { return { CRITICAL: 'Broken link' } } } + } else if (checkExternalLinks) { + if (!href.startsWith('https://')) { + return { WARNING: `Will not check external URLs that are not HTTPS (${href})` } + } + if (linksToSkip(href)) { + return + } + let failed = false + + try { + failed = await checkExternalURL(href) + } catch (err) { + return { WARNING: `Got error when testing ${href}: ${err.toString()}` } + } + if (failed) { + return { CRITICAL: 'Broken external link ' } + } } } +const externalResponseCache = new Map() +const externalResponseWaiting = new Set() + +const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms)) + +async function checkExternalURL(url) { + if (!url.startsWith('https://')) throw new Error('Invalid URL') + + if (externalResponseCache.has(url)) { + const result = externalResponseCache.get(url) + return result + } + if (externalResponseWaiting.has(url)) { + // Because this whole script is based on `Promise.all()` you can't + // guarantee that you first make the list of external URLs distinct, + // so you'll end up with N concurrent threads that both start, + // waiting for the same URL to check. + // If there's one going on, sleep and retry all over. + await sleep(500 + Math.random() * 100) + return await checkExternalURL(url) + } + externalResponseWaiting.add(url) + + // The way `got` does retries: + // + // sleep = 1000 * Math.pow(2, retry - 1) + Math.random() * 100 + // + // So, it means: + // + // 1. ~1000ms + // 2. ~2000ms + // 3. ~4000ms + // + // ...if the limit we set is 3. + // Our own timeout, in ./middleware/timeout.js defaults to 10 seconds. + // So there's no point in trying more attempts than 3 because it would + // just timeout on the 10s. (i.e. 1000 + 2000 + 4000 + 8000 > 10,000) + const retry = { + limit: 3, + } + const timeout = 2000 + + const r = await got(url, { + throwHttpErrors: false, + retry, + timeout, + }) + + const failed = r.statusCode !== 200 + externalResponseCache.set(url, failed) + externalResponseWaiting.delete(url) + return failed +} + function checkImageSrc(src, $) { const pathname = new URL(src, 'http://example.com').pathname if (!pathname.startsWith('/')) { diff --git a/script/rest/test-open-api-schema.js b/script/rest/test-open-api-schema.js index 8d1fd5c81b..a0e4198497 100755 --- a/script/rest/test-open-api-schema.js +++ b/script/rest/test-open-api-schema.js @@ -132,6 +132,7 @@ function throughDirectory(directory) { !directory.includes('rest/guides') && !directory.includes('rest/overview') && !file.includes('index.md') && + !file.includes('quickstart.md') && !file.includes('README.md') ) { return contentFiles.push(absolute) diff --git a/script/rest/utils/get-body-params.js b/script/rest/utils/get-body-params.js new file mode 100644 index 0000000000..2618cd32e1 --- /dev/null +++ b/script/rest/utils/get-body-params.js @@ -0,0 +1,152 @@ +#!/usr/bin/env node +import renderContent from '../../../lib/render-content/index.js' + +// If there is a oneOf at the top level, then we have to present just one +// in the docs. We don't currently have a convention for showing more than one +// set of input parameters in the docs. Having a top-level oneOf is also very +// uncommon. +// Currently there aren't very many operations that require this treatment. +// As an example, the 'Add status check contexts' and 'Set status check contexts' +// operations have a top-level oneOf. + +async function getTopLevelOneOfProperty(schema) { + if (!schema.oneOf) { + throw new Error('Schema does not have a requestBody oneOf property defined') + } + if (!(Array.isArray(schema.oneOf) && schema.oneOf.length > 0)) { + throw new Error('Schema requestBody oneOf property is not an array') + } + // When a oneOf exists but the `type` differs, the case has historically + // been that the alternate option is an array, where the first option + // is the array as a property of the object. We need to ensure that the + // first option listed is the most comprehensive and preferred option. + const firstOneOfObject = schema.oneOf[0] + const allOneOfAreObjects = schema.oneOf.every((elem) => elem.type === 'object') + let required = firstOneOfObject.required || [] + let properties = firstOneOfObject.properties || {} + + // When all of the oneOf objects have the `type: object` we + // need to display all of the parameters. + // This merges all of the properties and required values. + if (allOneOfAreObjects) { + for (const each of schema.oneOf.slice(1)) { + Object.assign(firstOneOfObject.properties, each.properties) + required = firstOneOfObject.required.concat(each.required) + } + properties = firstOneOfObject.properties + } + return { properties, required } +} + +// Gets the body parameters for a given schema recursively. +export async function getBodyParams(schema, topLevel = false) { + const bodyParametersParsed = [] + const schemaObject = schema.oneOf && topLevel ? await getTopLevelOneOfProperty(schema) : schema + const properties = schemaObject.properties || {} + const required = schemaObject.required || [] + + for (const [paramKey, param] of Object.entries(properties)) { + const paramDecorated = {} + + // OpenAPI 3.0 only had a single value for `type`. OpenAPI 3.1 + // will either be a single value or an array of values. + // This makes type an array regardless of how many values the array + // includes. This allows us to support 3.1 while remaining backwards + // compatible with 3.0. + const paramType = Array.isArray(param.type) ? param.type : [param.type] + const additionalPropertiesType = param.additionalProperties + ? Array.isArray(param.additionalProperties.type) + ? param.additionalProperties.type + : [param.additionalProperties.type] + : [] + const childParamsGroups = [] + + // If the parameter is an array or object there may be child params + // If the parameter has oneOf or additionalProperties, they need to be + // recursively read too. + + // There are a couple operations with additionalProperties, which allows + // the api to define input parameters with the type dictionary. These are the only + // two operations (at the time of adding this code) that use additionalProperties + // Create a snapshot of dependencies for a repository + // Update a gist + if (param.additionalProperties && additionalPropertiesType.includes('object')) { + const keyParam = { + type: 'object', + name: 'key', + description: await renderContent( + `A user-defined key to represent an item in \`${paramKey}\`.` + ), + isRequired: param.required, + enum: param.enum, + default: param.default, + childParamsGroups: [], + } + keyParam.childParamsGroups.push(...(await getBodyParams(param.additionalProperties, false))) + childParamsGroups.push(keyParam) + } else if (paramType && paramType.includes('array')) { + const arrayType = param.items.type + if (arrayType) { + paramType.splice(paramType.indexOf('array'), 1, `array of ${arrayType}s`) + } + if (arrayType === 'object') { + childParamsGroups.push(...(await getBodyParams(param.items, false))) + } + } else if (paramType && paramType.includes('object')) { + childParamsGroups.push(...(await getBodyParams(param, false))) + } else if (param && param.oneOf) { + // get concatenated description and type + const descriptions = [] + for (const childParam of param.oneOf) { + paramType.push(childParam.type) + // If there is no parent description, create a description from + // each type + if (!param.description) { + if (childParam.type === 'array') { + if (childParam.items.description) { + descriptions.push({ + type: childParam.type, + description: childParam.items.description, + }) + } + } else { + if (childParam.description) { + descriptions.push({ type: childParam.type, description: childParam.description }) + } + } + } + } + // Occasionally, there is no parent description and the description + // is in the first child parameter. + const oneOfDescriptions = descriptions.length ? descriptions[0].description : '' + if (!param.description) param.description = oneOfDescriptions + } + + // Supports backwards compatibility for OpenAPI 3.0 + // In 3.1 a nullable type is part of the param.type array and + // the property param.nullable does not exist. + if (param.nullable) paramType.push('null') + paramDecorated.type = paramType.filter(Boolean).join(' or ') + paramDecorated.name = paramKey + if (topLevel) { + paramDecorated.in = 'body' + } + paramDecorated.description = await renderContent(param.description) + if (required.includes(paramKey)) { + paramDecorated.isRequired = true + } + if (childParamsGroups.length > 0) { + paramDecorated.childParamsGroups = childParamsGroups + } + if (param.enum) { + paramDecorated.enum = param.enum + } + if (param.default) { + paramDecorated.default = param.default + } + + bodyParametersParsed.push(paramDecorated) + } + + return bodyParametersParsed +} diff --git a/script/rest/utils/operation.js b/script/rest/utils/operation.js index 0b47929dfe..88a087d6a4 100644 --- a/script/rest/utils/operation.js +++ b/script/rest/utils/operation.js @@ -1,19 +1,18 @@ #!/usr/bin/env node import Ajv from 'ajv' -import GitHubSlugger from 'github-slugger' import httpStatusCodes from 'http-status-code' import { readFile } from 'fs/promises' -import { get, flatten, isPlainObject } from 'lodash-es' +import { get, isPlainObject } from 'lodash-es' import { parseTemplate } from 'url-template' import renderContent from '../../../lib/render-content/index.js' import getCodeSamples from './create-rest-examples.js' import operationSchema from './operation-schema.js' +import { getBodyParams } from './get-body-params.js' const { operationUrls } = JSON.parse( await readFile('script/rest/utils/rest-api-overrides.json', 'utf8') ) -const slugger = new GitHubSlugger() export default class Operation { #operation @@ -36,7 +35,6 @@ export default class Operation { } this.serverUrl = this.serverUrl.replace('http:', 'http(s):') - this.serverUrlOverride() // Attach some global properties to the operation object to use // during processing @@ -81,17 +79,6 @@ export default class Operation { } } - serverUrlOverride() { - // TODO - remove this once github pull #214649 - // lands in this repo's lib/rest/static/dereferenced directory - if ( - this.#operation['x-github'].subcategory && - this.#operation['x-github'].subcategory === 'management-console' - ) { - this.serverUrl = this.serverUrl.replace('/api/v3', '') - } - } - async process() { await Promise.all([ this.renderDescription(), @@ -169,54 +156,13 @@ export default class Operation { // and the request body parameter types are the same for both. // Operation Id: markdown/render-raw const contentType = Object.keys(this.#operation.requestBody.content)[0] - let bodyParamsObject = get( - this.#operation, - `requestBody.content.${contentType}.schema.properties`, - {} - ) - let requiredParams = get( - this.#operation, - `requestBody.content.${contentType}.schema.required`, - [] - ) - const oneOfObject = get( - this.#operation, - `requestBody.content.${contentType}.schema.oneOf`, - undefined - ) - - // oneOf is an array of input parameter options, so we need to either - // use the first option or munge the options together. - if (oneOfObject) { - const firstOneOfObject = oneOfObject[0] - const allOneOfAreObjects = - oneOfObject.filter((elem) => elem.type === 'object').length === oneOfObject.length - - // TODO: Remove this check - // This operation shouldn't have a oneOf in this case, it needs to be - // removed from the schema in the openapi schema repo. - if (this.#operation.operationId === 'checks/create') { - delete bodyParamsObject.oneOf - } else if (allOneOfAreObjects) { - // When all of the oneOf objects have the `type: object` we - // need to display all of the parameters. - // This merges all of the properties and required values into the - // first requestBody object. - for (let i = 1; i < oneOfObject.length; i++) { - Object.assign(firstOneOfObject.properties, oneOfObject[i].properties) - requiredParams = firstOneOfObject.required.concat(oneOfObject[i].required) - } - bodyParamsObject = firstOneOfObject.properties - } else if (oneOfObject) { - // When a oneOf exists but the `type` differs, the case has historically - // been that the alternate option is an array, where the first option - // is the array as a property of the object. We need to ensure that the - // first option listed is the most comprehensive and preferred option. - bodyParamsObject = firstOneOfObject.properties - requiredParams = firstOneOfObject.required - } + const schema = get(this.#operation, `requestBody.content.${contentType}.schema`, {}) + // TODO: Remove this check + if (this.#operation.operationId === 'checks/create') { + delete schema.oneOf } - this.bodyParameters = await getBodyParams(bodyParamsObject, requiredParams) + + this.bodyParameters = isPlainObject(schema) ? await getBodyParams(schema, true) : [] } async renderPreviewNotes() { @@ -239,216 +185,3 @@ export default class Operation { ) } } - -// need to use this function recursively to get child and grandchild params -async function getBodyParams(paramsObject, requiredParams) { - if (!isPlainObject(paramsObject)) return [] - - return Promise.all( - Object.keys(paramsObject).map(async (paramKey) => { - const param = paramsObject[paramKey] - param.name = paramKey - param.in = 'body' - param.rawType = param.type - // OpenAPI 3.0 only had a single value for `type`. OpenAPI 3.1 - // will either be a single value or an array of values. - // This makes type an array regardless of how many values the array - // includes. This allows us to support 3.1 while remaining backwards - // compatible with 3.0. - if (!Array.isArray(param.type)) param.type = [param.type] - param.rawDescription = param.description - - // Stores the types listed under the `Type` column in the `Parameters` - // table in the REST API docs. When the parameter contains oneOf - // there are multiple acceptable parameters that we should list. - let paramArray = [] - - const oneOfArray = param.oneOf - const isOneOfObjectOrArray = oneOfArray - ? oneOfArray.filter((elem) => elem.type !== 'object' || elem.type !== 'array') - : false - - // When oneOf has the type array or object, the type is defined - // in a child object - if (oneOfArray && isOneOfObjectOrArray.length > 0) { - // Store the defined types - paramArray.push(oneOfArray.filter((elem) => elem.type).map((elem) => elem.type)) - - // If an object doesn't have a description, it is invalid - const oneOfArrayWithDescription = oneOfArray.filter((elem) => elem.description) - - // Use the parent description when set, otherwise enumerate each - // description in the `Description` column of the `Parameters` table. - if (!param.description && oneOfArrayWithDescription.length > 1) { - param.description = oneOfArray - .filter((elem) => elem.description) - .map((elem) => `**Type ${elem.type}** - ${elem.description}`) - .join('\n\n') - } else if (!param.description && oneOfArrayWithDescription.length === 1) { - // When there is only on valid description, use that one. - param.description = oneOfArrayWithDescription[0].description - } - } - - // Arrays require modifying the displayed type (e.g., array of strings) - if (param.type.includes('array')) { - if (param.items.type) paramArray.push(`array of ${param.items.type}s`) - if (param.items.oneOf) { - paramArray.push(param.items.oneOf.map((elem) => `array of ${elem.type}s`)) - } - // push the remaining types in the param.type array - // that aren't type array - const remainingItems = [...param.type] - const indexOfArrayType = remainingItems.indexOf('array') - remainingItems.splice(indexOfArrayType, 1) - paramArray.push(...remainingItems) - } else if (param.type) { - paramArray = paramArray.flat() - for (const type of param.type) { - if (type && paramArray.indexOf(type) === -1) { - paramArray.push(type) - } - } - } - // Supports backwards compatibility for OpenAPI 3.0 - // In 3.1 a nullable type is part of the param.type array and - // the property param.nullable does not exist. - if (param.nullable) paramArray.push('null') - - param.type = paramArray.flat().join(' or ') - param.description = param.description || '' - const isRequired = requiredParams && requiredParams.includes(param.name) - param.isRequired = isRequired - param.description = await renderContent(param.description) - // there may be zero, one, or multiple object parameters that have children parameters - param.childParamsGroups = [] - let childParamsGroup - - // When additionalProperties is defined with a type of `object` - // the input parameter is a dictionary. This handles cases for - // a dictionary. We don't have any list cases yet, and when - // the type is `string` we don't need to render additional rows of - // parameters. - // https://swagger.io/docs/specification/data-models/dictionaries/ - - // This conditional accounts for additionalProperties of type object - // and [null, 'object'] - if ( - param.additionalProperties && - (param.additionalProperties.type === 'object' || - (Array.isArray(param.additionalProperties.type) && - param.additionalProperties.type.includes('object'))) - ) { - // Add the first element which will always be the user-defined key - slugger.reset() - const id = slugger.slug(`${param.name}-${param.type}`) - param.childParamsGroups.push({ - parentName: param.name, - parentType: param.type, - id, - params: [ - { - description: `

    A user-defined key to represent an item in ${param.name}.

    `, - type: 'string', - name: 'key', - in: 'body', - rawType: 'string', - rawDescription: `A key to represent an item in ${param.name}.`, - }, - ], - }) - - // Construct a new parameter using the child properties set in - // additionalProperties. - const newParam = param.additionalProperties - newParam.rawType = 'object' - newParam.name = 'key' - childParamsGroup = await getChildParamsGroup(newParam) - } else { - childParamsGroup = await getChildParamsGroup(param) - } - - if (childParamsGroup && childParamsGroup.params.length) { - param.childParamsGroups.push(childParamsGroup) - } - - // If the param is an object, it may have child object params that have child params :/ - // Objects can potentially be null where the rawType is [ 'object', 'null' ]. - if ( - param.rawType === 'object' || - (Array.isArray(param.rawType) && param.rawType.includes('object')) - ) { - param.childParamsGroups.push( - ...flatten( - childParamsGroup.params - .filter((param) => param.childParamsGroups?.length) - .map((param) => param.childParamsGroups) - ) - ) - } - const paramDecorated = { ...param } - delete paramDecorated.items - delete paramDecorated.rawDescription - delete paramDecorated.rawType - if (paramDecorated.childParamsGroups.length === 0) delete paramDecorated.childParamsGroups - return paramDecorated - }) - ) -} - -async function getChildParamsGroup(param) { - // Only objects, arrays of objects, anyOf, allOf, and oneOf have child params. - // Objects can potentially be null where the rawType is [ 'object', 'null' ]. - if ( - !( - param.rawType === 'array' || - (Array.isArray(param.rawType) && param.rawType.includes('array')) || - param.rawType === 'object' || - (Array.isArray(param.rawType) && param.rawType.includes('object')) || - param.oneOf - ) - ) - return - if ( - param.oneOf && - !param.oneOf.filter((param) => param.type === 'object' || param.type === 'array') - ) - return - if (param.items && param.items.type !== 'object') return - - const childParamsObject = - param.rawType === 'array' || (Array.isArray(param.rawType) && param.rawType.includes('array')) - ? param.items.properties - : param.properties - const requiredParams = - param.rawType === 'array' || (Array.isArray(param.rawType) && param.rawType.includes('array')) - ? param.items.required - : param.required - const childParams = await getBodyParams(childParamsObject, requiredParams) - - // adjust the type for easier readability in the child table - let parentType - - if (param.rawType === 'array') { - parentType = 'items' - } else if (Array.isArray(param.rawType) && param.rawType.includes('array')) { - // handle the case where rawType is [ 'array', 'null' ] - parentType = 'items' - } else if (Array.isArray(param.rawType) && param.rawType.includes('object')) { - // handle the case where rawType is [ 'object', 'null' ] - parentType = 'object' - } else { - parentType = param.rawType - } - - // add an ID to the child table so they can be linked to - slugger.reset() - const id = slugger.slug(`${param.name}-${parentType}`) - - return { - parentName: param.name, - parentType, - id, - params: childParams, - } -} diff --git a/script/search/index-elasticsearch.js b/script/search/index-elasticsearch.js index ad055f6ce8..3e41ca2413 100755 --- a/script/search/index-elasticsearch.js +++ b/script/search/index-elasticsearch.js @@ -13,11 +13,15 @@ import path from 'path' import { Client } from '@elastic/elasticsearch' import { program, Option } from 'commander' import chalk from 'chalk' +import dotenv from 'dotenv' import { languageKeys } from '../../lib/languages.js' import { allVersions } from '../../lib/all-versions.js' import { decompress } from '../../lib/search/compress.js' +// Now you can optionally have set the ELASTICSEARCH_URL in your .env file. +dotenv.config() + // Create an object that maps the "short name" of a version to // all information about it. E.g // @@ -61,6 +65,7 @@ program '-s, --source-directory ', `Directory where records files are (default ${DEFAULT_SOURCE_DIRECTORY})` ) + .option('-p, --index-prefix ', 'Index string to put before index name') .parse(process.argv) main(program.opts()) @@ -122,10 +127,13 @@ async function main(opts) { console.log(`Indexing on languages ${chalk.bold(languages.join(', '))}`) } + const { indexPrefix } = opts + const prefix = indexPrefix ? `${indexPrefix}_` : '' + for (const language of languages) { for (const versionKey of versionKeys) { console.log(chalk.yellow(`Indexing ${chalk.bold(versionKey)} in ${chalk.bold(language)}`)) - const indexName = `github-docs-${versionKey}-${language}` + const indexName = `${prefix}github-docs-${versionKey}-${language}` console.time(`Indexing ${indexName}`) await indexVersion(client, indexName, versionKey, language, sourceDirectory, verbose) diff --git a/stylesheets/extended-markdown.scss b/stylesheets/extended-markdown.scss index a0ec5a761d..067e47f67f 100644 --- a/stylesheets/extended-markdown.scss +++ b/stylesheets/extended-markdown.scss @@ -10,10 +10,6 @@ } } - p { - margin: 0; - } - p:not(:first-child) { margin-top: 1rem; } @@ -27,6 +23,15 @@ padding: 0.5rem 0.5rem 0.5rem 0; margin-bottom: 0; } + + &.note, + &.warning, + &.tip, + &.danger { + p { + margin: 0; + } + } } .warning { diff --git a/tests/content/api-search.js b/tests/content/api-search.js index 1b326fadb5..5637df873f 100644 --- a/tests/content/api-search.js +++ b/tests/content/api-search.js @@ -15,6 +15,7 @@ import { jest, test, expect } from '@jest/globals' import { describeIfElasticsearchURL } from '../helpers/conditional-runs.js' import { get } from '../helpers/e2etest.js' +import { SURROGATE_ENUMS } from '../../middleware/set-fastly-surrogate-key.js' if (!process.env.ELASTICSEARCH_URL) { console.warn( @@ -62,7 +63,10 @@ describeIfElasticsearchURL('search middleware', () => { // Check that it can be cached at the CDN expect(res.headers['set-cookie']).toBeUndefined() expect(res.headers['cache-control']).toContain('public') - expect(res.headers['cache-control']).toMatch(/max-age=\d+/) + expect(res.headers['cache-control']).toMatch(/max-age=[1-9]/) + expect(res.headers['surrogate-control']).toContain('public') + expect(res.headers['surrogate-control']).toMatch(/max-age=[1-9]/) + expect(res.headers['surrogate-key']).toBe(SURROGATE_ENUMS.DEFAULT) }) test('debug search', async () => { diff --git a/tests/content/crowdin-config.js b/tests/content/crowdin-config.js deleted file mode 100644 index fb216e545d..0000000000 --- a/tests/content/crowdin-config.js +++ /dev/null @@ -1,54 +0,0 @@ -import CrowdinConfig from '../helpers/crowdin-config.js' -import { loadPages } from '../../lib/page-data.js' -import { jest } from '@jest/globals' - -const config = CrowdinConfig.read() -const ignoredPagePaths = config.files[0].ignore -const ignoredDataPaths = config.files[2].ignore - -describe('crowdin.yml config file', () => { - jest.setTimeout(60 * 1000) - - let pages - beforeAll(async () => { - pages = await loadPages() - }) - - test('has expected file structure', async () => { - expect(config.files.length).toBe(3) - expect(config.files[0].source).toBe('/content/**/*.md') - expect(config.files[0].ignore).toContain('/content/README.md') - }) - - test('ignores all Early Access paths', async () => { - expect(ignoredPagePaths).toContain('/content/early-access') - expect(ignoredDataPaths).toContain('/data/early-access') - }) - - test('ignores all hidden pages', async () => { - const hiddenPages = pages - .filter( - (page) => page.hidden && page.languageCode === 'en' && !page.hasExperimentalAlternative - ) - .map((page) => `/content/${page.relativePath}`) - const overlooked = hiddenPages.filter((page) => !isIgnored(page, ignoredPagePaths)) - const message = `Found some hidden pages that are not yet excluded from localization. - Please copy and paste the lines below into the \`ignore\` section of /crowdin.yml: \n\n"${overlooked.join( - '",\n"' - )}"` - - // This may not be true anymore given the separation of Early Access docs - // expect(hiddenPages.length).toBeGreaterThan(0) - expect(ignoredPagePaths.length).toBeGreaterThan(0) - expect(overlooked, message).toHaveLength(0) - }) -}) - -// file is ignored if its exact filename in the list, -// or if it's within an ignored directory -function isIgnored(filename, ignoredPagePaths) { - return ignoredPagePaths.some((ignoredPath) => { - const isDirectory = !ignoredPath.endsWith('.md') - return ignoredPath === filename || (isDirectory && filename.startsWith(ignoredPath)) - }) -} diff --git a/tests/content/featured-links.js b/tests/content/featured-links.js index 476fc3a549..b2dbca5e7d 100644 --- a/tests/content/featured-links.js +++ b/tests/content/featured-links.js @@ -4,7 +4,6 @@ import { fileURLToPath } from 'url' import { beforeAll, jest } from '@jest/globals' import nock from 'nock' -import japaneseCharacters from 'japanese-characters' import { getDOM, getJSON } from '../helpers/e2etest.js' import enterpriseServerReleases from '../../lib/enterprise-server-releases.js' @@ -49,23 +48,6 @@ describe('featuredLinks', () => { ).toBe(true) }) - test('localized intro links link to localized pages', async () => { - const $jaPages = await getDOM('/ja') - const $enPages = await getDOM('/en') - const $jaFeaturedLinks = $jaPages('[data-testid=article-list] a') - const $enFeaturedLinks = $enPages('[data-testid=article-list] a') - expect($jaFeaturedLinks.length).toBe($enFeaturedLinks.length) - expect($jaFeaturedLinks.eq(0).attr('href').startsWith('/ja')).toBe(true) - - // Footer translations change very rarely if ever, so we can more - // reliably test those text values for the language - const footerText = [] - $jaPages('footer a').each((index, element) => { - footerText.push($jaPages(element).text()) - }) - expect(footerText.some((elem) => japaneseCharacters.presentIn(elem))) - }) - test('Enterprise user intro links have expected values', async () => { const $ = await getDOM(`/en/enterprise/${enterpriseServerReleases.latest}/user/get-started`) const $featuredLinks = $('[data-testid=article-list] a') diff --git a/tests/content/glossary.js b/tests/content/glossary.js index 12bbae0664..fef36c2882 100644 --- a/tests/content/glossary.js +++ b/tests/content/glossary.js @@ -37,13 +37,6 @@ describe('glossaries', () => { }) }) - test('non-English external glossary is in correct order', async () => { - const vals = loadSiteData().ja.site.data.glossaries.external - vals.forEach((val, i) => { - expect(val.term.localeCompare(vals[i + 1], 'ja')).toBeGreaterThan(0) - }) - }) - test('candidates all have a term, but no description', async () => { expect(glossaries.candidates.length).toBeGreaterThan(20) glossaries.candidates.forEach((entry) => { diff --git a/tests/content/search.js b/tests/content/search.js index e42898d5c6..f99423cb7a 100644 --- a/tests/content/search.js +++ b/tests/content/search.js @@ -31,16 +31,6 @@ describe('search', () => { }) }) }) - - test('has Lunr index for every language for dotcom', async () => { - expect(languageCodes.length).toBeGreaterThan(0) - languageCodes.forEach((languageCode) => { - const indexName = `${namePrefix}-dotcom-${languageCode}` - const indexRecordName = `${indexName}-records` - expect(lunrIndexNames.includes(indexName)).toBe(true) - expect(lunrIndexNames.includes(indexRecordName)).toBe(true) - }) - }) }) function getDate(date) { diff --git a/tests/content/site-data.js b/tests/content/site-data.js index 46f6f2fe2f..cb473d8208 100644 --- a/tests/content/site-data.js +++ b/tests/content/site-data.js @@ -19,7 +19,6 @@ describe('siteData module (English)', () => { test('sets a top-level key for each language', async () => { expect('en' in data).toEqual(true) - expect('ja' in data).toEqual(true) }) test('includes English variables', async () => { @@ -35,16 +34,6 @@ describe('siteData module (English)', () => { expect(reusable).toBe('1. Change the current working directory to your local repository.') }) - test('includes Japanese variables', async () => { - const prodName = get(data, 'ja.site.data.variables.product.prodname_dotcom') - expect(prodName).toBe('GitHub') - }) - - test('includes Japanese reusables', async () => { - const reusable = get(data, 'ja.site.data.reusables.audit_log.octicon_icon') - expect(reusable.includes('任意のページの左上で')).toBe(true) - }) - test('all Liquid tags are valid', async () => { const dataMap = flat(data) for (const key in dataMap) { diff --git a/tests/content/site-tree.js b/tests/content/site-tree.js index 64551eb266..8d930eb235 100644 --- a/tests/content/site-tree.js +++ b/tests/content/site-tree.js @@ -2,7 +2,6 @@ import revalidator from 'revalidator' import schema from '../helpers/schemas/site-tree-schema.js' import EnterpriseServerReleases from '../../lib/enterprise-server-releases.js' import { loadSiteTree } from '../../lib/page-data.js' -import japaneseCharacters from 'japanese-characters' import nonEnterpriseDefaultVersion from '../../lib/non-enterprise-default-version.js' import { jest } from '@jest/globals' @@ -18,7 +17,6 @@ describe('siteTree', () => { test('has language codes as top-level keys', () => { expect('en' in siteTree).toBe(true) - expect('ja' in siteTree).toBe(true) }) test('object order and structure', () => { @@ -29,19 +27,6 @@ describe('siteTree', () => { }) describe('localized titles', () => { - // skipped because it has rendering errors. See translations/log/ja-resets.csv - test.skip('titles for categories', () => { - const japaneseTitle = - siteTree.ja[nonEnterpriseDefaultVersion].childPages[0].childPages[0].page.title - expect(typeof japaneseTitle).toBe('string') - expect(japaneseCharacters.presentIn(japaneseTitle)).toBe(true) - - const englishTitle = - siteTree.en[nonEnterpriseDefaultVersion].childPages[0].childPages[0].page.title - expect(typeof englishTitle).toBe('string') - expect(japaneseCharacters.presentIn(englishTitle)).toBe(false) - }) - test('articles that include site data in liquid templating', async () => { const ghesLatest = `enterprise-server@${latestEnterpriseRelease}` const ghesSiteTree = siteTree.en[ghesLatest] diff --git a/tests/helpers/crowdin-config.js b/tests/helpers/crowdin-config.js deleted file mode 100644 index 5d10555146..0000000000 --- a/tests/helpers/crowdin-config.js +++ /dev/null @@ -1,12 +0,0 @@ -import { fileURLToPath } from 'url' -import path from 'path' -import fs from 'fs' -import yaml from 'js-yaml' -const __dirname = path.dirname(fileURLToPath(import.meta.url)) - -export const read = function () { - const filename = path.join(__dirname, '../../crowdin.yml') - return yaml.load(fs.readFileSync(filename, 'utf8'), { filename }) -} - -export default { read } diff --git a/tests/helpers/e2etest.js b/tests/helpers/e2etest.js index 2e1ef00ba0..6195b72c4c 100644 --- a/tests/helpers/e2etest.js +++ b/tests/helpers/e2etest.js @@ -10,7 +10,6 @@ export async function get( followRedirects: false, followAllRedirects: false, headers: {}, - cookieJar: undefined, } ) { const method = opts.method || 'get' @@ -22,7 +21,6 @@ export async function get( body: opts.body, headers: opts.headers, retry: { limit: 0 }, - cookieJar: opts.cookieJar, throwHttpErrors: false, followRedirect: opts.followAllRedirects || opts.followRedirects, }, @@ -62,14 +60,13 @@ export function post(route, opts) { export async function getDOM( route, - { headers, allow500s, allow404, cookieJar } = { + { headers, allow500s, allow404 } = { headers: undefined, allow500s: false, allow404: false, - cookieJar: undefined, } ) { - const res = await get(route, { followRedirects: true, headers, cookieJar }) + const res = await get(route, { followRedirects: true, headers }) if (!allow500s && res.status >= 500) { throw new Error(`Server error (${res.status}) on ${route}`) } diff --git a/tests/helpers/lint-translation-reporter.js b/tests/helpers/lint-translation-reporter.js index dae6fc02b8..3e532f66f5 100644 --- a/tests/helpers/lint-translation-reporter.js +++ b/tests/helpers/lint-translation-reporter.js @@ -1,3 +1,5 @@ +// Remove this when removing translations directory B504EDD0 + import chalk from 'chalk' import stripAnsi from 'strip-ansi' import { groupBy } from 'lodash-es' diff --git a/tests/helpers/schemas/languages-schema.js b/tests/helpers/schemas/languages-schema.js deleted file mode 100644 index 73099ceedc..0000000000 --- a/tests/helpers/schemas/languages-schema.js +++ /dev/null @@ -1,48 +0,0 @@ -export default { - properties: { - name: { - required: true, - description: 'the English name', - type: 'string', - }, - - nativeName: { - description: 'the native name', - type: 'string', - }, - - code: { - required: true, - description: 'the code used in the URL', - type: 'string', - minLength: 2, - maxLength: 2, - }, - - dir: { - required: true, - description: 'the local relative path to files in this language', - type: 'string', - }, - - // https://support.google.com/webmasters/answer/189077 - // https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes - // http://unicode.org/iso15924/iso15924-codes.html - hreflang: { - required: true, - description: 'the ISO 639-1, ISO 3166-1 Alpha 2, or ISO 15924 language code', - type: 'string', - minLength: 2, - }, - - redirectPatterns: { - description: 'array of regular expressions used for redirecting incorrect URLs', - type: 'array', - }, - - wip: { - description: 'boolean indicating whether translations are incomplete', - type: 'boolean', - }, - }, -} diff --git a/tests/linting/lint-files.js b/tests/linting/lint-files.js index 93cf500f81..b1ef96ada2 100644 --- a/tests/linting/lint-files.js +++ b/tests/linting/lint-files.js @@ -277,6 +277,7 @@ if (!process.env.TEST_TRANSLATION) { ) learningTracksToLint = zip(learningTracksYamlRelPaths, learningTracksYamlAbsPaths) } else { + // Remove this `else` when removing translations directory B504EDD0 // get all translated markdown or yaml files by comparing files changed to main branch const changedFilesRelPaths = execSync( 'git -c diff.renameLimit=10000 diff --name-only origin/main', diff --git a/tests/meta/repository-references.js b/tests/meta/repository-references.js index 2626a15d32..261ce28119 100644 --- a/tests/meta/repository-references.js +++ b/tests/meta/repository-references.js @@ -59,6 +59,7 @@ const PUBLIC_REPOS = new Set([ 'roadmap', 'securitylab', 'semantic', + 'ssh_data', 'site-policy', 'smimesign', 'stack-graphs', diff --git a/tests/rendering/block-robots.js b/tests/rendering/block-robots.js index 8bc7041391..2e93df331f 100644 --- a/tests/rendering/block-robots.js +++ b/tests/rendering/block-robots.js @@ -1,5 +1,4 @@ import { blockIndex } from '../../middleware/block-robots.js' -import languages from '../../lib/languages.js' import { productMap } from '../../lib/all-products.js' import enterpriseServerReleases from '../../lib/enterprise-server-releases.js' @@ -14,13 +13,6 @@ describe('block robots', () => { expect(allowIndex('/en/articles/verifying-your-email-address')).toBe(true) }) - it('allows crawling of generally available localized content', async () => { - Object.values(languages).forEach((language) => { - expect(allowIndex(`/${language.code}`)).toBe(true) - expect(allowIndex(`/${language.code}/articles/verifying-your-email-address`)).toBe(true) - }) - }) - it('disallows crawling of WIP products', async () => { const wipProductIds = Object.values(productMap) .filter((product) => product.wip) @@ -29,19 +21,11 @@ describe('block robots', () => { wipProductIds.forEach((id) => { const { href } = productMap[id] const blockedPaths = [ - // English `/en${href}`, `/en${href}/overview`, `/en${href}/overview/intro`, `/en/enterprise/${enterpriseServerReleases.latest}/user${href}`, `/en/enterprise/${enterpriseServerReleases.oldestSupported}/user${href}`, - - // Japanese - `/ja${href}`, - `/ja${href}/overview`, - `/ja${href}/overview/intro`, - `/ja/enterprise/${enterpriseServerReleases.latest}/user${href}`, - `/ja/enterprise/${enterpriseServerReleases.oldestSupported}/user${href}`, ] blockedPaths.forEach((path) => { @@ -59,14 +43,7 @@ describe('block robots', () => { const { versions } = productMap[id] const blockedPaths = versions .map((version) => { - return [ - // English - `/en/${version}/${id}`, - `/en/${version}/${id}/some-early-access-article`, - // Japanese - `/ja/${version}/${id}`, - `/ja/${version}/${id}/some-early-access-article`, - ] + return [`/en/${version}/${id}`, `/en/${version}/${id}/some-early-access-article`] }) .flat() @@ -90,16 +67,10 @@ describe('block robots', () => { it('disallows crawling of deprecated enterprise releases', async () => { enterpriseServerReleases.deprecated.forEach((version) => { const blockedPaths = [ - // English `/en/enterprise-server@${version}/actions`, `/en/enterprise/${version}/actions`, `/en/enterprise-server@${version}/actions/overview`, `/en/enterprise/${version}/actions/overview`, - // Japanese - `/ja/enterprise-server@${version}/actions`, - `/ja/enterprise/${version}/actions`, - `/ja/enterprise-server@${version}/actions/overview`, - `/ja/enterprise/${version}/actions/overview`, ] blockedPaths.forEach((path) => { diff --git a/tests/rendering/breadcrumbs.js b/tests/rendering/breadcrumbs.js index db31e6f57b..aeb9e46987 100644 --- a/tests/rendering/breadcrumbs.js +++ b/tests/rendering/breadcrumbs.js @@ -83,12 +83,6 @@ describe('breadcrumbs', () => { const $breadcrumbs = $('[data-testid=breadcrumbs] a') expect($breadcrumbs[0].attribs.href).toBe('/en/get-started') }) - - test('localized breadcrumbs link to localize pages', async () => { - const $ = await getDOM('/ja/get-started/learning-about-github') - const $breadcrumbs = $('[data-testid=breadcrumbs] a') - expect($breadcrumbs[0].attribs.href).toBe('/ja/get-started') - }) }) describeInternalOnly('early access rendering', () => { diff --git a/tests/rendering/curated-homepage-links.js b/tests/rendering/curated-homepage-links.js index ccbba75c04..e5a6e5a352 100644 --- a/tests/rendering/curated-homepage-links.js +++ b/tests/rendering/curated-homepage-links.js @@ -29,25 +29,4 @@ describe('curated homepage links', () => { expect($(el).find('p p').length).toBe(0) }) }) - - test('Japanese', async () => { - const $ = await getDOM('/ja') - const $links = $('[data-testid=bump-link]') - expect($links.length).toBeGreaterThanOrEqual(8) - - // Check that each link is localized and includes a title and intro - $links.each((i, el) => { - const linkUrl = $(el).attr('href') - - expect(linkUrl.startsWith('/ja/')).toBe(true) - expect( - $(el).find('[data-testid=link-with-intro-title]').text().trim().length, - `Did not find a title for the linked article ${linkUrl}` - ).toBeGreaterThan(0) - expect( - $(el).find('[data-testid=link-with-intro-intro]').text().trim().length, - `Did not find an intro for the linked article ${linkUrl}` - ).toBeGreaterThan(0) - }) - }) }) diff --git a/tests/rendering/head.js b/tests/rendering/head.js index b196bda20f..3a4132421b 100644 --- a/tests/rendering/head.js +++ b/tests/rendering/head.js @@ -1,5 +1,4 @@ import { getDOM } from '../helpers/e2etest.js' -import languages from '../../lib/languages.js' import { jest } from '@jest/globals' jest.useFakeTimers({ legacyFakeTimers: true }) @@ -7,24 +6,6 @@ jest.useFakeTimers({ legacyFakeTimers: true }) describe('', () => { jest.setTimeout(5 * 60 * 1000) - test('includes hreflangs (references to all language versions of the same page)', async () => { - const $ = await getDOM('/en') - const $hreflangs = $('link[rel="alternate"]') - expect($hreflangs.length).toEqual(Object.keys(languages).length) - expect($('link[href="https://docs.github.com/cn"]').length).toBe(1) - expect($('link[href="https://docs.github.com/ja"]').length).toBe(1) - // Due to a bug in either NextJS, JSX, or TypeScript, - // when put `` in a .tsx file, this incorrectly - // gets rendered out as `` in the final HTML. - // Note the uppercase L. It's supposed to become ``. - // When cheerio serializes to HTML, it gets this right so it lowercases - // the attribute. So if this rendering in this jest test was the first - // ever cold hit, you might get the buggy HTML from React or you - // might get the correct HTML from cheerio's `.html()` serializer. - // This is why we're looking for either. - expect($('link[hreflang="en"]').length + $('link[hrefLang="en"]').length).toBe(1) - }) - test('includes page intro in `description` meta tag', async () => { const $ = await getDOM('/en/articles/about-ssh') const $description = $('meta[name="description"]') diff --git a/tests/rendering/header.js b/tests/rendering/header.js index ba594b10a2..0351a999fc 100644 --- a/tests/rendering/header.js +++ b/tests/rendering/header.js @@ -6,99 +6,6 @@ import { oldestSupported } from '../../lib/enterprise-server-releases.js' describe('header', () => { jest.setTimeout(5 * 60 * 1000) - test('includes localized meta tags', async () => { - const $ = await getDOM('/en') - expect($('link[rel="alternate"]').length).toBeGreaterThan(2) - }) - - test("includes a link to the homepage (in the current page's language)", async () => { - let $ = await getDOM('/en') - expect($('#github-logo a[href="/en"]').length).toBe(2) - - $ = await getDOM('/ja') - expect($('#github-logo a[href="/ja"]').length).toBe(2) - expect($('#github-logo a[href="/en"]').length).toBe(0) - }) - - describe.skip('language links', () => { - test('lead to the same page in a different language', async () => { - const $ = await getDOM( - '/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule' - ) - expect( - $( - 'li a[href="/ja/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule"]' - ).length - ).toBe(1) - }) - - test('display the native name and the English name for each translated language', async () => { - const $ = await getDOM('/en') - - expect($('[data-testid=language-picker] li a[href="/en"]').text().trim()).toBe('English') - expect($('[data-testid=language-picker] li a[href="/cn"]').text().trim()).toBe('简体中文') - expect($('[data-testid=language-picker] li a[href="/ja"]').text().trim()).toBe('日本語') - }) - - test('emphasize the current language', async () => { - const $ = await getDOM('/en') - expect($('[data-testid=desktop-header] [data-testid=language-picker] button').text()).toBe( - 'English' - ) - }) - }) - - describe('notices', () => { - // Docs engineering issue: 1055 - test.skip('displays a "localization in progress" notice for WIP languages', async () => { - const $ = await getDOM('/de') - expect($('[data-testid=header-notification][data-type=TRANSLATION]').length).toBe(1) - expect($('[data-testid=header-notification] a[href="/en"]').length).toBe(1) - }) - - test('displays "complete" notice for non-WIP non-English languages', async () => { - const $ = await getDOM('/ja') - expect($('[data-testid=header-notification][data-type=TRANSLATION]').length).toBe(1) - expect($('[data-testid=header-notification] a[href="/en"]').length).toBe(1) - }) - - // Docs Engineering issue: 966 - test.skip('does not display any notices for English', async () => { - const $ = await getDOM('/en') - expect($('[data-testid=header-notification]').length).toBe(0) - }) - - test.skip("renders a link to the same page in user's preferred language, if available", async () => { - // const headers = { 'accept-language': 'ja' } - // const $ = await getDOM('/en', { headers }) - // expect(getUserLanguage($)).toBe('ja') - }) - - test.skip("renders a link to the same page if user's preferred language is Chinese - PRC", async () => { - // const headers = { 'accept-language': 'zh-CN' } - // const $ = await getDOM('/en', { headers }) - // expect(getUserLanguage($)).toBe('cn') - }) - - test.skip("renders a link to the same page in user's preferred language from multiple, if available", async () => { - // const headers = { 'accept-language': 'ja, *;q=0.9' } - // const $ = await getDOM('/en', { headers }) - // expect(getUserLanguage($)).toBe('ja') - }) - - test.skip("renders a link to the same page in user's preferred language with weights, if available", async () => { - // const headers = { 'accept-language': 'ja;q=1.0, *;q=0.9' } - // const $ = await getDOM('/en', { headers }) - // expect(getUserLanguage($)).toBe('ja') - }) - - test.skip("renders a link to the user's 2nd preferred language if 1st is not available", async () => { - // const headers = { 'accept-language': 'zh-TW,zh;q=0.9,ja *;q=0.8' } - // const $ = await getDOM('/en', { headers }) - // expect(getUserLanguage($)).toBe('ja') - }) - }) - describe('mobile-only product dropdown links', () => { test('include Get started and admin, and emphasize the current product', async () => { const $ = await getDOM( @@ -113,14 +20,6 @@ describe('header', () => { expect(ghec.text().trim()).toBe('Enterprise administrators') }) - test("point to homepages in the current page's language", async () => { - const $ = await getDOM('/ja/github/site-policy/github-terms-of-service') - const $breadcrumbRefs = $('[data-testid=breadcrumbs] a') - expect($breadcrumbRefs[0].attribs.href.startsWith('/ja')).toBe(true) - const $sidebarRefs = $('[data-testid=sidebar] a') - expect($sidebarRefs[0].attribs.href.startsWith('/ja')).toBe(true) - }) - test('emphasizes the product that corresponds to the current page', async () => { const $ = await getDOM( `/en/enterprise-server@${oldestSupported}/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-git-repository-using-the-command-line` diff --git a/tests/rendering/page-titles.js b/tests/rendering/page-titles.js index ac87defb08..9a4288f28d 100644 --- a/tests/rendering/page-titles.js +++ b/tests/rendering/page-titles.js @@ -51,13 +51,4 @@ describe('page titles', () => { `GitHub Enterprise Server Help Documentation - GitHub Enterprise Server ${enterpriseServerReleases.latest} Docs` ) }) - - // TODO enable this once translated content has synced with the versioning changes - // Note the expected translations may need to be updated, since the English title changed - // from `GitHub.com Help Documentation` to `GitHub Documentation` - // Docs Engineering issue: 967 - test.skip('displays only the site name on localized homepages', async () => { - expect((await getDOM('/cn'))('title').text()).toBe('GitHub 帮助文档') - expect((await getDOM('/ja'))('title').text()).toBe('GitHub ヘルプドキュメント') - }) }) diff --git a/tests/rendering/products.js b/tests/rendering/products.js index 72462beea7..8579aa5fbf 100644 --- a/tests/rendering/products.js +++ b/tests/rendering/products.js @@ -16,9 +16,6 @@ describe('mobile-only products nav', () => { ['/desktop', 'GitHub Desktop'], ['/actions', 'GitHub Actions'], - - // localized - ['/ja/desktop', 'GitHub Desktop'], ] test.each(cases)('on %p, renders current product %p', async (url, name) => { diff --git a/tests/rendering/robots-txt.js b/tests/rendering/robots-txt.js index 5c05bad054..b51688901b 100644 --- a/tests/rendering/robots-txt.js +++ b/tests/rendering/robots-txt.js @@ -1,4 +1,3 @@ -import languages from '../../lib/languages.js' import robotsParser from 'robots-parser' import { get } from '../helpers/e2etest.js' import { jest } from '@jest/globals' @@ -24,17 +23,6 @@ describe('robots.txt', () => { ).toBe(true) }) - it('allows indexing of generally available localized content', async () => { - Object.values(languages).forEach((language) => { - expect(robots.isAllowed(`https://docs.github.com/${language.code}`)).toBe(true) - expect( - robots.isAllowed( - `https://docs.github.com/${language.code}/articles/verifying-your-email-address` - ) - ).toBe(true) - }) - }) - it('disallows indexing of azurecontainer.io domains', async () => { const res = await get('/robots.txt', { headers: { diff --git a/tests/rendering/server.js b/tests/rendering/server.js index a7ed3fe0d7..66f71f47d5 100644 --- a/tests/rendering/server.js +++ b/tests/rendering/server.js @@ -7,7 +7,6 @@ import CspParse from 'csp-parse' import { productMap } from '../../lib/all-products.js' import { SURROGATE_ENUMS } from '../../middleware/set-fastly-surrogate-key.js' import { describe, jest } from '@jest/globals' -import { languageKeys } from '../../lib/languages.js' const AZURE_STORAGE_URL = 'githubdocs.azureedge.net' const activeProducts = Object.values(productMap).filter( @@ -141,12 +140,6 @@ describe('server', () => { expect($('body').length).toBe(1) }) - test('sets `lang` attribute on attribute', async () => { - expect((await getDOM('/en'))('html').attr('lang')).toBe('en') - expect((await getDOM('/en/articles/set-up-git'))('html').attr('lang')).toBe('en') - expect((await getDOM('/ja'))('html').attr('lang')).toBe('ja') - }) - test('renders a 404 page', async () => { const $ = await getDOM('/not-a-real-page', { allow404: true }) expect($('h1').text()).toBe('Ooops!') @@ -326,7 +319,7 @@ describe('server', () => { test('renders mini TOC in articles with more than one heading', async () => { const $ = await getDOM('/en/github/getting-started-with-github/githubs-products') expect($('h2#in-this-article').length).toBe(1) - expect($('h2#in-this-article + div div ul').length).toBeGreaterThan(1) + expect($('h2#in-this-article + nav ul li').length).toBeGreaterThan(1) }) test('renders mini TOC in articles that includes h3s when specified by frontmatter', async () => { @@ -334,8 +327,8 @@ describe('server', () => { '/en/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise' ) expect($('h2#in-this-article').length).toBe(1) - expect($('h2#in-this-article + div div ul').length).toBeGreaterThan(0) // non-indented items - expect($('h2#in-this-article + div div ul li div div ul.ml-3').length).toBeGreaterThan(0) // indented items + expect($('h2#in-this-article + nav ul').length).toBeGreaterThan(0) // non-indented items + expect($('h2#in-this-article + nav ul div ul div').length).toBeGreaterThan(0) // indented items }) test('does not render mini TOC in articles with only one heading', async () => { @@ -358,13 +351,7 @@ describe('server', () => { // TODO test('renders mini TOC with correct links when headings contain markup', async () => { const $ = await getDOM('/en/actions/using-workflows/workflow-syntax-for-github-actions') - expect($('h2#in-this-article + div div ul a[href="#on"]').length).toBe(1) - }) - - // TODO - test('renders mini TOC with correct links when headings contain markup in localized content', async () => { - const $ = await getDOM('/ja/actions/using-workflows/workflow-syntax-for-github-actions') - expect($('h2#in-this-article + div div ul a[href="#on"]').length).toBe(1) + expect($('h2#in-this-article + nav ul li a[href="#on"]').length).toBe(1) }) }) @@ -633,23 +620,6 @@ describe('server', () => { expect(res.headers['set-cookie']).toBeUndefined() }) - test('redirects / to appropriate language preference if specified', async () => { - await Promise.all( - languageKeys.map(async (languageKey) => { - const res = await get('/', { - headers: { - 'accept-language': `${languageKey}`, - }, - followRedirects: false, - }) - expect(res.statusCode).toBe(302) - expect(res.headers.location).toBe(`/${languageKey}`) - expect(res.headers['cache-control']).toBe('private, no-store') - expect(res.headers['set-cookie']).toBeUndefined() - }) - ) - }) - // This test exists because in a previous life, our NextJS used to // 500 if the 'Accept-Language' header was malformed. // We *used* have a custom middleware to cope with this and force a @@ -749,18 +719,6 @@ describe('server', () => { }) }) -describe('URLs by language', () => { - test('heading IDs and links on translated pages are in English', async () => { - const $ = await getDOM('/ja/site-policy/github-terms/github-terms-of-service') - expect($.res.statusCode).toBe(200) - // This check is true on either the translated version of the page, or when the title is pending translation and is in English. - expect($('h1')[0].children[0].data).toMatch( - /(GitHub利用規約|GitHub Terms of Service|GitHub のサービス条件)/ - ) - expect($('h2 a[href="#summary"]').length).toBe(1) - }) -}) - describe('GitHub Enterprise URLs', () => { test('renders the GHE user docs homepage', async () => { const $ = await getDOM(`/en/enterprise/${enterpriseServerReleases.latest}/user/get-started`) @@ -798,12 +756,6 @@ describe('GitHub Enterprise URLs', () => { expect($(`a[href^="${installationCategoryHome}/"]`).length).toBeGreaterThan(1) }) - test('renders a translated Enterprise Admin category with English links', async () => { - const installationCategoryHome = `/ja/enterprise-server@${enterpriseServerReleases.latest}/admin/installation` - const $ = await getDOM(installationCategoryHome) - expect($(`a[href^="${installationCategoryHome}/"]`).length).toBeGreaterThan(1) - }) - test('renders an Enterprise Admin category article', async () => { const $ = await getDOM( `/en/enterprise/${enterpriseServerReleases.latest}/admin/overview/about-github-enterprise-server` @@ -828,26 +780,6 @@ describe('GitHub Enterprise URLs', () => { ) expect($.text()).toContain('Before upgrading GitHub Enterprise') }) - - test('renders Enterprise homepage in Japanese', async () => { - const res = await get(`/ja/enterprise-server@${enterpriseServerReleases.latest}`) - expect(res.statusCode).toBe(200) - }) - - test('renders Enterprise Admin homepage in Japanese', async () => { - const res = await get(`/ja/enterprise-server@${enterpriseServerReleases.latest}/admin`) - expect(res.statusCode).toBe(200) - }) - - test('renders Enterprise homepage in Chinese', async () => { - const res = await get(`/cn/enterprise-server@${enterpriseServerReleases.latest}`) - expect(res.statusCode).toBe(200) - }) - - test('renders Enterprise Admin homepage in Chinese', async () => { - const res = await get(`/cn/enterprise-server@${enterpriseServerReleases.latest}/admin`) - expect(res.statusCode).toBe(200) - }) }) describe('GitHub Desktop URLs', () => { @@ -878,11 +810,6 @@ describe('GitHub Desktop URLs', () => { ) expect(res.statusCode).toBe(200) }) - - test('renders the Desktop homepage in Japanese', async () => { - const res = await get('/ja/desktop') - expect(res.statusCode).toBe(200) - }) }) describe('extended Markdown', () => { @@ -918,13 +845,9 @@ describe('extended Markdown', () => { test('renders expected mini TOC headings in platform-specific content', async () => { const $ = await getDOM('/en/github/using-git/associating-text-editors-with-git') expect($('h2#in-this-article').length).toBe(1) - expect($('h2#in-this-article + div div ul li.extended-markdown.mac').length).toBeGreaterThan(1) - expect( - $('h2#in-this-article + div div ul li.extended-markdown.windows').length - ).toBeGreaterThan(1) - expect($('h2#in-this-article + div div ul li.extended-markdown.linux').length).toBeGreaterThan( - 1 - ) + expect($('h2#in-this-article + nav ul div.extended-markdown.mac').length).toBeGreaterThan(1) + expect($('h2#in-this-article + nav ul div.extended-markdown.windows').length).toBeGreaterThan(1) + expect($('h2#in-this-article + nav ul div.extended-markdown.linux').length).toBeGreaterThan(1) }) }) @@ -1060,15 +983,8 @@ describe('REST reference pages', () => { const res = await get('/en/rest/repos') expect(res.statusCode).toBe(200) }) - test('view the rest/repos page in Japanese', async () => { - const res = await get('/ja/rest/repos') - expect(res.statusCode).toBe(200) - }) + test('deeper pages in English', async () => { - const res = await get('/ja/enterprise-cloud@latest/rest/code-scanning') - expect(res.statusCode).toBe(200) - }) - test('deeper pages in Japanese', async () => { const res = await get('/en/enterprise-cloud@latest/rest/code-scanning') expect(res.statusCode).toBe(200) }) diff --git a/tests/rendering/sidebar.js b/tests/rendering/sidebar.js index 51ef3a72b5..d8bca619a0 100644 --- a/tests/rendering/sidebar.js +++ b/tests/rendering/sidebar.js @@ -120,6 +120,7 @@ describe('sidebar', () => { !directory.includes('rest/guides') && !directory.includes('rest/overview') && !absolute.includes('rest/index.md') && + !absolute.includes('rest/quickstart.md') && !file.includes('README.md') ) { return contentFiles.push(absolute) diff --git a/tests/routing/deprecated-enterprise-versions.js b/tests/routing/deprecated-enterprise-versions.js index d26fc4047c..b02820863e 100644 --- a/tests/routing/deprecated-enterprise-versions.js +++ b/tests/routing/deprecated-enterprise-versions.js @@ -3,7 +3,6 @@ import { describe, jest, test } from '@jest/globals' import enterpriseServerReleases from '../../lib/enterprise-server-releases.js' import { get, getDOM } from '../helpers/e2etest.js' import { SURROGATE_ENUMS } from '../../middleware/set-fastly-surrogate-key.js' -import { PREFERRED_LOCALE_COOKIE_NAME } from '../../lib/constants.js' jest.useFakeTimers({ legacyFakeTimers: true }) @@ -99,16 +98,7 @@ describe('recently deprecated redirects', () => { // Deliberately no cache control because it is user-dependent expect(res.headers['cache-control']).toBe('private, no-store') }) - test('basic enterprise 3.0 redirects by cookie', async () => { - const res = await get('/enterprise/3.0', { - headers: { - Cookie: `${PREFERRED_LOCALE_COOKIE_NAME}=ja`, - }, - followRedirects: false, - }) - expect(res.statusCode).toBe(302) - expect(res.headers.location).toBe('/ja/enterprise-server@3.0') - }) + test('already languaged enterprise 3.0 redirects', async () => { const res = await get('/en/enterprise/3.0') expect(res.statusCode).toBe(301) @@ -116,7 +106,7 @@ describe('recently deprecated redirects', () => { // 301 redirects are safe to cache aggressively expect(res.headers['set-cookie']).toBeUndefined() expect(res.headers['cache-control']).toContain('public') - expect(res.headers['cache-control']).toMatch(/max-age=\d+/) + expect(res.headers['cache-control']).toMatch(/max-age=[1-9]/) }) test('redirects enterprise-server 3.0 with actual redirect without language', async () => { const res = await get( @@ -132,20 +122,7 @@ describe('recently deprecated redirects', () => { '/en/enterprise-server@3.0/get-started/learning-about-github/githubs-products' ) }) - test('redirects enterprise-server 3.0 with actual redirect with language', async () => { - const res = await get( - '/ja/enterprise-server@3.0/github/getting-started-with-github/githubs-products' - ) - expect(res.statusCode).toBe(301) - expect(res.headers['set-cookie']).toBeUndefined() - expect(res.headers['cache-control']).toContain('public') - expect(res.headers['cache-control']).toMatch(/max-age=\d+/) - // This is based on - // https://github.com/github/help-docs-archived-enterprise-versions/blob/master/3.0/redirects.json - expect(res.headers.location).toBe( - '/ja/enterprise-server@3.0/get-started/learning-about-github/githubs-products' - ) - }) + test('follow redirects enterprise-server 3.0 with actual redirect without language', async () => { const res = await get( '/enterprise-server@3.0/github/getting-started-with-github/githubs-products', @@ -214,6 +191,9 @@ describe('JS and CSS assets', () => { expect(result.statusCode).toBe(200) expect(result.headers['x-is-archived']).toBe('true') expect(result.headers['content-type']).toBe('text/css; charset=utf-8') + expect(result.headers['cache-control']).toContain('public') + expect(result.headers['cache-control']).toMatch(/max-age=[1-9]/) + expect(result.headers['surrogate-key']).toBe(SURROGATE_ENUMS.MANUAL) }) it('returns the expected CSS file', async () => { diff --git a/tests/routing/language-code-redirects.js b/tests/routing/language-code-redirects.js deleted file mode 100644 index 585d2f3701..0000000000 --- a/tests/routing/language-code-redirects.js +++ /dev/null @@ -1,27 +0,0 @@ -import { jest } from '@jest/globals' - -import { get } from '../helpers/e2etest.js' - -describe('language code redirects', () => { - jest.setTimeout(5 * 60 * 1000) - - test('redirects accidental /jp* requests to /ja*', async () => { - let res = await get('/jp') - expect(res.statusCode).toBe(301) - expect(res.headers.location).toBe('/ja') - - res = await get('/jp/articles/about-your-personal-dashboard') - expect(res.statusCode).toBe(301) - expect(res.headers.location).toBe('/ja/articles/about-your-personal-dashboard') - }) - - test('redirects accidental /zh-CN* requests to /cn*', async () => { - let res = await get('/zh-CN') - expect(res.statusCode).toBe(301) - expect(res.headers.location).toBe('/cn') - - res = await get('/zh-TW/articles/about-your-personal-dashboard') - expect(res.statusCode).toBe(301) - expect(res.headers.location).toBe('/cn/articles/about-your-personal-dashboard') - }) -}) diff --git a/tests/routing/redirects.js b/tests/routing/redirects.js index 65eb194fec..47a5e12f60 100644 --- a/tests/routing/redirects.js +++ b/tests/routing/redirects.js @@ -9,7 +9,6 @@ import enterpriseServerReleases, { import Page from '../../lib/page.js' import { get, head } from '../helpers/e2etest.js' import versionSatisfiesRange from '../../lib/version-satisfies-range.js' -import { PREFERRED_LOCALE_COOKIE_NAME } from '../../lib/constants.js' const __dirname = path.dirname(fileURLToPath(import.meta.url)) @@ -128,39 +127,6 @@ describe('redirects', () => { expect(res.headers['cache-control']).toBe('private, no-store') }) - test('homepage redirects to preferred language', async () => { - const res = await get('/', { headers: { 'Accept-Language': 'ja' }, followRedirects: false }) - expect(res.statusCode).toBe(302) - expect(res.headers.location).toBe('/ja') - expect(res.headers['cache-control']).toBe('private, no-store') - }) - - test('homepage redirects to preferred language by cookie', async () => { - const res = await get('/', { - headers: { - Cookie: `${PREFERRED_LOCALE_COOKIE_NAME}=ja`, - 'Accept-Language': 'es', // note how this is going to be ignored - }, - followRedirects: false, - }) - expect(res.statusCode).toBe(302) - expect(res.headers.location).toBe('/ja') - expect(res.headers['cache-control']).toBe('private, no-store') - }) - - test('homepage redirects to preferred language by cookie if valid', async () => { - const res = await get('/', { - headers: { - Cookie: `${PREFERRED_LOCALE_COOKIE_NAME}=xy`, - 'Accept-Language': 'ja', // note how this is going to be ignored - }, - followRedirects: false, - }) - expect(res.statusCode).toBe(302) - expect(res.headers.location).toBe('/ja') - expect(res.headers['cache-control']).toBe('private, no-store') - }) - test('trailing slash on languaged homepage should permantently redirect', async () => { const res = await get('/en/') expect(res.statusCode).toBe(301) @@ -169,15 +135,6 @@ describe('redirects', () => { expect(res.headers['cache-control']).toContain('public') expect(res.headers['cache-control']).toMatch(/max-age=\d+/) }) - - test('trailing slash with query string on languaged homepage should permantently redirect', async () => { - const res = await get('/ja/?foo=bar&bar=foo') - expect(res.statusCode).toBe(301) - expect(res.headers.location).toBe('/ja?foo=bar&bar=foo') - expect(res.headers['set-cookie']).toBeUndefined() - expect(res.headers['cache-control']).toContain('public') - expect(res.headers['cache-control']).toMatch(/max-age=\d+/) - }) }) describe('external redirects', () => { @@ -210,87 +167,10 @@ describe('redirects', () => { expect(res.statusCode).toBe(301) expect(res.headers.location).toBe('https://gitready.com/') }) - - test('work for top-level request paths with /ja/ prefix', async () => { - const res = await get('/ja/git-ready') - expect(res.statusCode).toBe(301) - expect(res.headers.location).toBe('https://gitready.com/') - }) - }) - - describe('localized redirects', () => { - const redirectFrom = - '/desktop/contributing-to-projects/changing-a-remote-s-url-from-github-desktop' - const redirectTo = - '/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/changing-a-remotes-url-from-github-desktop' - - test('redirect_from for renamed pages', async () => { - const res = await get(`/ja${redirectFrom}`) - expect(res.statusCode).toBe(301) - const expected = `/ja${redirectTo}` - expect(res.headers.location).toBe(expected) - }) - - test('redirect_from for renamed pages by Accept-Language header', async () => { - const res = await get(redirectFrom, { - headers: { - 'Accept-Language': 'ja', - }, - followRedirects: false, - }) - expect(res.statusCode).toBe(302) - const expected = `/ja${redirectTo}` - expect(res.headers.location).toBe(expected) - expect(res.headers['cache-control']).toBe('private, no-store') - }) - - test('redirect_from for renamed pages but ignore Accept-Language header if not recognized', async () => { - const res = await get(redirectFrom, { - headers: { - // None of these are recognized - 'Accept-Language': 'sv,fr,gr', - }, - followRedirects: false, - }) - expect(res.statusCode).toBe(302) - const expected = `/en${redirectTo}` - expect(res.headers.location).toBe(expected) - expect(res.headers['cache-control']).toBe('private, no-store') - }) - - test('redirect_from for renamed pages but ignore unrecognized Accept-Language header values', async () => { - const res = await get(redirectFrom, { - headers: { - // Only the last one is recognized - 'Accept-Language': 'sv,ja', - }, - followRedirects: false, - }) - expect(res.statusCode).toBe(302) - const expected = `/ja${redirectTo}` - expect(res.headers.location).toBe(expected) - expect(res.headers['cache-control']).toBe('private, no-store') - }) - - test('will inject the preferred language from cookie', async () => { - const res = await get(redirectFrom, { - headers: { - Cookie: `${PREFERRED_LOCALE_COOKIE_NAME}=ja`, - 'Accept-Language': 'es', // note how this is going to be ignored - }, - followRedirects: false, - }) - // 302 because the redirect depended on cookie - expect(res.statusCode).toBe(302) - const expected = `/ja${redirectTo}` - expect(res.headers.location).toBe(expected) - expect(res.headers['cache-control']).toBe('private, no-store') - }) }) describe('enterprise home page', () => { const enterpriseHome = `/en/enterprise-server@${enterpriseServerReleases.latest}` - const japaneseEnterpriseHome = enterpriseHome.replace('/en/', '/ja/') test('/enterprise', async () => { const res = await get('/enterprise') @@ -310,12 +190,6 @@ describe('redirects', () => { expect(res.headers.location).toBe(enterpriseHome) }) - test('no version redirects to latest version (japanese)', async () => { - const res = await get('/ja/enterprise') - expect(res.statusCode).toBe(301) - expect(res.headers.location).toBe(japaneseEnterpriseHome) - }) - test('hardcoded @latest redirects to latest version', async () => { const res = await get('/en/enterprise-server@latest') expect(res.statusCode).toBe(302) @@ -358,7 +232,6 @@ describe('redirects', () => { const { firstRestoredAdminGuides, getPreviousReleaseNumber, latest } = enterpriseServerReleases const lastBeforeRestoredAdminGuides = getPreviousReleaseNumber(firstRestoredAdminGuides) const enterpriseAdmin = `/en/enterprise-server@${latest}/admin` - const japaneseEnterpriseAdmin = enterpriseAdmin.replace('/en/', '/ja/') test('no language code redirects to english', async () => { const res = await get(`/enterprise/${latest}/admin`) @@ -413,30 +286,10 @@ describe('redirects', () => { const expected = `/en/enterprise-server@${firstRestoredAdminGuides}/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server` expect(res.headers.location).toBe(expected) }) - - test('no version redirects to latest version (japanese)', async () => { - const res = await get('/ja/enterprise/admin') - expect(res.statusCode).toBe(301) - expect(res.headers.location).toBe(japaneseEnterpriseAdmin) - }) - - test('admin/guides redirects to admin on <2.21 (japanese)', async () => { - const res = await get(`/ja/enterprise-server@${lastBeforeRestoredAdminGuides}/admin/guides`) - expect(res.statusCode).toBe(301) - expect(res.headers.location).toBe( - japaneseEnterpriseAdmin.replace(latest, lastBeforeRestoredAdminGuides) - ) - }) - - test('admin/guides does not redirect to admin on >=2.21 (japanese)', async () => { - const res = await get(`/ja/enterprise-server@${firstRestoredAdminGuides}/admin/guides`) - expect(res.statusCode).toBe(200) - }) }) describe('enterprise user homepage', () => { const enterpriseUser = `/en/enterprise-server@${enterpriseServerReleases.latest}` - const japaneseEnterpriseUser = enterpriseUser.replace('/en/', '/ja/') test('no product redirects to GitHub.com product', async () => { const res = await get(`/en/enterprise/${enterpriseServerReleases.latest}/user`) @@ -455,17 +308,10 @@ describe('redirects', () => { expect(res.statusCode).toBe(301) expect(res.headers.location).toBe(enterpriseUser) }) - - test('no version redirects to latest version (japanese)', async () => { - const res = await get('/ja/enterprise/user/github') - expect(res.statusCode).toBe(301) - expect(res.headers.location).toBe(japaneseEnterpriseUser) - }) }) describe('enterprise user article', () => { const userArticle = `/en/enterprise-server@${enterpriseServerReleases.latest}/get-started/quickstart/fork-a-repo` - const japaneseUserArticle = userArticle.replace('/en/', '/ja/') test('no product redirects to GitHub.com product on the latest version', async () => { const res = await get( @@ -494,18 +340,11 @@ describe('redirects', () => { expect(res.statusCode).toBe(301) expect(res.headers.location).toBe(userArticle) }) - - test('no version redirects to latest version (japanese)', async () => { - const res = await get('/ja/enterprise/articles/fork-a-repo') - expect(res.statusCode).toBe(301) - expect(res.headers.location).toBe(japaneseUserArticle) - }) }) describe('enterprise user article with frontmatter redirect', () => { const userArticle = `/en/enterprise-server@${enterpriseServerReleases.latest}/get-started/quickstart/fork-a-repo` const redirectFromPath = '/articles/fork-a-repo' - const japaneseUserArticle = userArticle.replace('/en/', '/ja/') test('redirects to expected article', async () => { const res = await get( @@ -528,18 +367,11 @@ describe('redirects', () => { expect(res.statusCode).toBe(301) expect(res.headers.location).toBe(userArticle) }) - - test('no version redirects to latest version (japanese)', async () => { - const res = await get(`/ja/enterprise/user${redirectFromPath}`) - expect(res.statusCode).toBe(301) - expect(res.headers.location).toBe(japaneseUserArticle) - }) }) describe('desktop guide', () => { const desktopGuide = '/en/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request' - const japaneseDesktopGuides = desktopGuide.replace('/en/', '/ja/') test('no language code redirects to english', async () => { const res = await get( @@ -556,14 +388,6 @@ describe('redirects', () => { expect(res.statusCode).toBe(301) expect(res.headers.location).toBe(desktopGuide) }) - - test('desktop/guides redirects to desktop (japanese)', async () => { - const res = await get( - '/ja/desktop/guides/contributing-and-collaborating-using-github-desktop/creating-an-issue-or-pull-request' - ) - expect(res.statusCode).toBe(301) - expect(res.headers.location).toBe(japaneseDesktopGuides) - }) }) describe('recently deprecated ghes version redirects that lack language', () => { diff --git a/tests/translations/empty-sources-test.js b/tests/translations/empty-sources-test.js deleted file mode 100644 index 3984c1d822..0000000000 --- a/tests/translations/empty-sources-test.js +++ /dev/null @@ -1,13 +0,0 @@ -import {execSync} from 'child_process' - -describe('source directories', () => { - // crowdin upload sources command fails if there are empty source files - // please refer to crowdin-support #117 for more details - it('should not contain empty files', () => { - const command = "find content data -type f -empty" - const emptyFiles = execSync(command).toString().split("\n") - const disallowedEmptyFiles = emptyFiles.filter(file => file.match(/\.(yml|md)$/)) - - expect(disallowedEmptyFiles).toEqual([]) - }) -}) diff --git a/tests/translations/files.js b/tests/translations/files.js new file mode 100644 index 0000000000..2fcea620d6 --- /dev/null +++ b/tests/translations/files.js @@ -0,0 +1,73 @@ +import languages from '../../lib/languages.js' +import { omit } from 'lodash-es' +import walk from 'walk-sync' +import { execSync } from 'child_process' +import { get } from '../helpers/e2etest.js' +import { jest } from '@jest/globals' + +function difference (A, B) { + const A2 = new Set(A) + B.forEach(b => A2.delete(b)) + return A2 +} + +const englishPaths = new Set(walk('content', { + directories: false, + ignore: ['**/README.md', 'search', 'early-access'], +})) + +const nonEnglish = Object.entries(omit(languages, 'en')) + +const langWalksTable = nonEnglish.map(([code, lang]) => [ + code, + lang, + new Set(walk(`${lang.dir}/content`, { + directories: false, + ignore: ['**/README.md'], + })) +]) + +describe('files', () => { + jest.setTimeout(60 * 1000) + + test.each(Object.entries(languages))('%s matches language schema', async (_, lang) => { + expect(lang.name).toMatch(/\w+/) + if (lang.nativeName) expect(lang.nativeName).toMatch(/.+/) + expect(lang.code).toMatch(/\w{2}/) + if (lang.code !== 'en') expect(lang.dir).toMatch(/.+/) + expect(lang.hreflang).toMatch(/\w{2}/) + if (lang.redirectPatterns) expect(lang.redirectPatterns).toBeInstanceOf(Array) + }) + + // crowdin upload sources command fails if there are empty source files + // please refer to crowdin-support #117 for more details + it('should not contain empty files', () => { + const command = "find content data -type f -empty" + const emptyFiles = execSync(command).toString().split("\n") + const disallowedEmptyFiles = emptyFiles.filter(file => file.match(/\.(yml|md)$/)) + + expect(disallowedEmptyFiles).toEqual([]) + }) + + test.each(langWalksTable)("falls back to the English page if it can't find a %s page", async (code, lang, langPaths) => { + const paths = [...difference(englishPaths, langPaths)] + .map(path => path.replace('/index.md', '')) + .map(path => path.replace('.md', '')) + for (const path of paths) { + const res = await get(`/${code}/${path}`) + expect(res.statusCode, path).toBeGreaterThanOrEqual(200) + expect(res.statusCode, path).toBeLessThanOrEqual(399) + } + }) + + test.each(langWalksTable)("only loads a %s page if there's an English page", async (code, lang, langPaths) => { + const paths = [...difference(langPaths, englishPaths)] + .map(path => path.replace('/index.md', '')) + .map(path => path.replace('.md', '')) + for (const path of paths) { + const res = await get(`/${code}/${path}`) + expect(res.statusCode, path).toBeGreaterThanOrEqual(300) + expect(res.statusCode, path).toBeLessThanOrEqual(499) + } + }) +}) diff --git a/tests/translations/frame.js b/tests/translations/frame.js new file mode 100644 index 0000000000..4723b74945 --- /dev/null +++ b/tests/translations/frame.js @@ -0,0 +1,62 @@ +import { languageKeys } from '../../lib/languages.js' +import { blockIndex } from '../../middleware/block-robots.js' +import { getDOM } from '../helpers/e2etest.js' + +const langs = languageKeys.filter(lang => lang !== 'en') + +describe('frame', () => { + test.each(langs)('allows crawling of %s pages', async (lang) => { + expect(blockIndex(`/${lang}/articles/verifying-your-email-address`)).toBe(false) + }) + + test.each(langs)('breadcrumbs link to %s pages', async (lang) => { + const $ = await getDOM(`/${lang}/get-started/learning-about-github`) + const $breadcrumbs = $('[data-testid=breadcrumbs] a') + expect($breadcrumbs[0].attribs.href).toBe(`/${lang}/get-started`) + }) + + test.each(langs)('homepage links go to %s pages', async (lang) => { + const $ = await getDOM(`/${lang}`) + const $links = $('[data-testid=bump-link]') + $links.each((i, el) => { + const linkUrl = $(el).attr('href') + expect(linkUrl.startsWith(`/${lang}/`)).toBe(true) + }) + }) + + test.each(langs)('includes homepage hreflang to %s', async (lang) => { + const $ = await getDOM('/en') + expect($(`link[rel="alternate"][href="https://docs.github.com/${lang}"]`).length).toBe(1) + }) + + test.each(langs)('sets `lang` attribute on attribute in %s', async (lang) => { + const $ = await getDOM(`/${lang}`) + expect($('html').attr('lang')).toBe(lang) + }) + + test.each(langs)('autogenerated heading IDs on %s are in english', async (lang) => { + const $ = await getDOM(`/${lang}/site-policy/github-terms/github-terms-of-service`) + expect($('h2 a[href="#summary"]').length).toBe(1) + }) + + test.each(langs)('loads the side bar via site tree in %s', async (lang) => { + const $en = await getDOM(`/en/get-started`) + const $ = await getDOM(`/${lang}/get-started`) + expect( + $(`a[href="/${lang}/get-started"]`).text() + ).not.toEqual( + $en(`a[href="/${lang}/get-started"]`).text() + ) + }) + + test.each(langs)('loads the survey via site data in %s', async (lang) => { + const $en = await getDOM(`/en`) + const $ = await getDOM(`/${lang}`) + expect( + $('[data-testid="survey-form"] h2').text() + ).not.toEqual( + $en('[data-testid="survey-form"] h2').text() + ) + }) +}) + diff --git a/tests/translations/matching-liquid-tags-test.js b/tests/translations/matching-liquid-tags-test.js deleted file mode 100644 index 5f43c2f111..0000000000 --- a/tests/translations/matching-liquid-tags-test.js +++ /dev/null @@ -1,65 +0,0 @@ -import languages from '../../lib/languages.js' -import { languageFiles, compareLiquidTags } from '../../lib/liquid-tags/tokens.js' - -const currentTranslations = [] - -// populate currentTranslations -Object.keys(languages).forEach((code) => { - const language = languages[code] - if (!language.wip && code !== 'en') { - currentTranslations.push(language) - } -}) - -function diffToErrorString(diff) { - return ` - ${diff.translation} does not match liquid tags in ${diff.file}: - - ${diff.diff.output} - ` -} - -function formatMessage(parsingErrors, mismatches) { - return ` - ${parsingErrors.length} files have parsing errors. - ${mismatches.length} files have mismatching liquid tags. - - ${'#'.repeat(80)} - Parsing errors were found in the following files: - ${'#'.repeat(80)} - - ${parsingErrors.map((error) => `- ${error.message}`).join('\n')} - - ${'#'.repeat(80)} - ${mismatches.length} files do not match liquid tags: - ${'#'.repeat(80)} - - ${mismatches.map((diff) => diffToErrorString(diff)).join('\n')} - ` -} - -describe('translated pages', () => { - currentTranslations.forEach((language) => { - test.skip(`every ${language.name} has the same number of liquid tags as the English one`, () => { - const mismatches = [] - const files = languageFiles(language) - const parsingErrors = [] - - files.forEach((file) => { - try { - const comparison = compareLiquidTags(file, language) - - if (comparison.diff.count > 0) { - mismatches.push(comparison) - } - } catch (e) { - parsingErrors.push(e) - } - }) - - const message = formatMessage(parsingErrors, mismatches) - - expect(mismatches.length, message).toEqual(0) - }) - }) -}) diff --git a/tests/translations/redirects.js b/tests/translations/redirects.js new file mode 100644 index 0000000000..be1a948487 --- /dev/null +++ b/tests/translations/redirects.js @@ -0,0 +1,44 @@ +import { languageKeys } from '../../lib/languages.js' +import { get } from '../helpers/e2etest.js' +import { PREFERRED_LOCALE_COOKIE_NAME } from '../../lib/constants.js' + +const langs = languageKeys.filter(lang => lang !== 'en') + +describe('redirects', () => { + test.each(langs)('redirects to %s if accept-language', async (lang) => { + const res = await get('/get-started', { + headers: { 'accept-language': lang }, + followRedirects: false, + }) + expect(res.statusCode).toBe(302) + expect(res.headers.location).toBe(`/${lang}/get-started`) + expect(res.headers['cache-control']).toBe('private, no-store') + expect(res.headers['set-cookie']).toBeUndefined() + }) + + test.each(langs)('redirects to %s if PREFERRED_LOCALE_COOKIE_NAME', async (lang) => { + const res = await get('/get-started', { + headers: { + 'accept-language': 'en', + Cookie: `${PREFERRED_LOCALE_COOKIE_NAME}=${lang}`, + }, + followRedirects: false, + }) + expect(res.statusCode).toBe(302) + expect(res.headers.location).toBe(`/${lang}/get-started`) + expect(res.headers['cache-control']).toBe('private, no-store') + expect(res.headers['set-cookie']).toBeUndefined() + }) + + test('redirects accidental /jp* requests to /ja*', async () => { + const res = await get('/jp') + expect(res.statusCode).toBe(301) + expect(res.headers.location).toBe('/ja') + }) + + test('redirects accidental /zh-CN* requests to /cn*', async () => { + const res = await get('/zh-CN') + expect(res.statusCode).toBe(301) + expect(res.headers.location).toBe('/cn') + }) +}) diff --git a/tests/translations/search.js b/tests/translations/search.js new file mode 100644 index 0000000000..451afc630f --- /dev/null +++ b/tests/translations/search.js @@ -0,0 +1,13 @@ +import { languageKeys } from '../../lib/languages' +import { get } from '../helpers/e2etest.js' + +const langs = languageKeys.filter(lang => lang !== 'en') + +// Skipping for now, as we would need to download the indexes with LFS +// in Actions to run these. Explore again after ES switch over. +describe.skip('search', () => { + test.each(langs)('search in %s', async (lang) => { + const res = await get(`/search?language=${lang}&version=dotcom&query=pages`) + expect(res.statusCode).toBe(200) + }) +}) diff --git a/tests/unit/anchor-redirect.js b/tests/unit/anchor-redirect.js index f7ae7819fe..cc77ed0e65 100644 --- a/tests/unit/anchor-redirect.js +++ b/tests/unit/anchor-redirect.js @@ -1,5 +1,7 @@ import { describe, expect } from '@jest/globals' + import { get } from '../helpers/e2etest.js' +import { SURROGATE_ENUMS } from '../../middleware/set-fastly-surrogate-key.js' import clientSideRedirects from '../../lib/redirects/static/client-side-rest-api-redirects.json' describe('anchor-redirect middleware', () => { @@ -41,4 +43,15 @@ describe('anchor-redirect middleware', () => { const { to } = JSON.parse(res.text) expect(to).toBe(undefined) }) + test('reasonably aggressive cache-control headers', async () => { + const sp = new URLSearchParams() + sp.set('path', 'foo') + sp.set('hash', 'bar') + const res = await get('/anchor-redirect?' + sp) + expect(res.headers['cache-control']).toContain('public') + expect(res.headers['cache-control']).toMatch(/max-age=[1-9]/) + expect(res.headers['surrogate-control']).toContain('public') + expect(res.headers['surrogate-control']).toMatch(/max-age=[1-9]/) + expect(res.headers['surrogate-key']).toBe(SURROGATE_ENUMS.DEFAULT) + }) }) diff --git a/tests/unit/detect-language.js b/tests/unit/detect-language.js deleted file mode 100644 index e39d15e0e8..0000000000 --- a/tests/unit/detect-language.js +++ /dev/null @@ -1,22 +0,0 @@ -import { expect } from '@jest/globals' -import { getLanguageCodeFromPath } from '../../middleware/detect-language.js' - -describe('detect-language - getLanguageCodeFromPath', () => { - test('should handle client-side routing path shape', () => { - expect(getLanguageCodeFromPath('/_next/data/development/ja/articles/foo')).toBe('ja') - }) - - test('should not error on /_next/data/ input', () => { - expect(getLanguageCodeFromPath('/_next/data/')).toBe('en') - }) - - test('should return for paths with an extension', () => { - expect(getLanguageCodeFromPath('/ja.json')).toBe('ja') - expect(getLanguageCodeFromPath('/_next/data/development/ja.json')).toBe('ja') - }) - - test('should return en for invalid languages', () => { - expect(getLanguageCodeFromPath('/xx/articles/foo')).toBe('en') - expect(getLanguageCodeFromPath('/_next/data/development/xx/articles/foo')).toBe('en') - }) -}) diff --git a/tests/unit/find-page.js b/tests/unit/find-page.js index 9692558849..51880d36a2 100644 --- a/tests/unit/find-page.js +++ b/tests/unit/find-page.js @@ -8,25 +8,6 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url)) describe('find page', () => { jest.setTimeout(1000 * 1000) - test("falls back to the English page if it can't find a localized page", async () => { - const page = await Page.init({ - relativePath: 'page-that-does-not-exist-in-translations-dir.md', - basePath: path.join(__dirname, '../fixtures'), - languageCode: 'en', - }) - - const englishPermalink = page.permalinks[0].href - const japanesePermalink = englishPermalink.replace('/en/', '/ja/') - - // add named keys - const pageMap = { - [englishPermalink]: page, - } - - const localizedPage = findPage(japanesePermalink, pageMap, {}) - expect(typeof localizedPage.title).toBe('string') - }) - test('follows redirects', async () => { const page = await Page.init({ relativePath: 'page-with-redirects.md', diff --git a/tests/unit/get-redirect.js b/tests/unit/get-redirect.js index fd401e4d86..0d51e67982 100644 --- a/tests/unit/get-redirect.js +++ b/tests/unit/get-redirect.js @@ -1,36 +1,8 @@ -import { describe, expect, test } from '@jest/globals' +import { describe, expect } from '@jest/globals' -import getRedirect, { splitPathByLanguage } from '../../lib/get-redirect.js' +import getRedirect from '../../lib/get-redirect.js' import { latest } from '../../lib/enterprise-server-releases.js' -describe('splitPathByLanguage', () => { - test('basic', () => { - const [language, withoutLanguage] = splitPathByLanguage('/foo/') - expect(language).toBe('en') - expect(withoutLanguage).toBe('/foo/') - }) - test('already has /en in it', () => { - const [language, withoutLanguage] = splitPathByLanguage('/en/foo/') - expect(language).toBe('en') - expect(withoutLanguage).toBe('/foo/') - }) - test('basic with different fallback', () => { - const [language, withoutLanguage] = splitPathByLanguage('/foo/', 'ja') - expect(language).toBe('ja') - expect(withoutLanguage).toBe('/foo/') - }) - test('already has /en different fallback', () => { - const [language, withoutLanguage] = splitPathByLanguage('/en/foo/', 'ja') - expect(language).toBe('en') - expect(withoutLanguage).toBe('/foo/') - }) - test('unrecognized prefix is ignored', () => { - const [language, withoutLanguage] = splitPathByLanguage('/sv/foo/') - expect(language).toBe('en') - expect(withoutLanguage).toBe('/sv/foo/') - }) -}) - describe('getRedirect basics', () => { it('should sometimes not correct the version prefix', () => { // This essentially tests legacy entries that come from the @@ -153,20 +125,6 @@ describe('getRedirect basics', () => { expect(getRedirect(`/en/enterprise-cloud@latest/user/foo`, ctx)).toBeUndefined() }) - it('should only inject language sometimes', () => { - const ctx = { - pages: {}, - redirects: { - '/foo': '/bar', - }, - } - // Nothing's needed here because it's not /admin/guides and - // it already has the enterprise-server prefix. - expect(getRedirect('/foo', ctx)).toBe('/en/bar') - expect(getRedirect('/en/foo', ctx)).toBe('/en/bar') - expect(getRedirect('/ja/foo', ctx)).toBe('/ja/bar') - }) - it('should redirect both the prefix and the path needs to change', () => { const ctx = { pages: {}, @@ -179,20 +137,6 @@ describe('getRedirect basics', () => { expect(getRedirect('/enterprise-server/foo', ctx)).toBe(`/en/enterprise-server@${latest}/bar`) }) - it('should redirect according to the req.context.userLanguage', () => { - const ctx = { - pages: {}, - redirects: { - '/foo': '/bar', - }, - userLanguage: 'ja', - } - expect(getRedirect('/foo', ctx)).toBe(`/ja/bar`) - // falls back to 'en' if it's falsy - ctx.userLanguage = null - expect(getRedirect('/foo', ctx)).toBe(`/en/bar`) - }) - it('should work for some deprecated enterprise-server URLs too', () => { // Starting with enterprise-server 3.0, we have made redirects become // a *function* rather than a lookup on a massive object. diff --git a/tests/unit/languages.js b/tests/unit/languages.js deleted file mode 100644 index e10fb5aced..0000000000 --- a/tests/unit/languages.js +++ /dev/null @@ -1,19 +0,0 @@ -import revalidator from 'revalidator' -import languages from '../../lib/languages.js' -import schema from '../helpers/schemas/languages-schema.js' - -describe('languages module', () => { - test('is an object with language codes as keys', () => { - expect('en' in languages).toBe(true) - expect('ja' in languages).toBe(true) - expect('cn' in languages).toBe(true) - }) - - test('every language is valid', () => { - Object.values(languages).forEach((language) => { - const { valid, errors } = revalidator.validate(language, schema) - const expectation = JSON.stringify(errors, null, 2) - expect(valid, expectation).toBe(true) - }) - }) -}) diff --git a/tests/unit/liquid-helpers.js b/tests/unit/liquid-helpers.js index 107c0bd6b7..7589132112 100644 --- a/tests/unit/liquid-helpers.js +++ b/tests/unit/liquid-helpers.js @@ -15,7 +15,6 @@ describe('liquid helper tags', () => { context.pages = pageMap context.redirects = { '/en/desktop/contributing-and-collaborating-using-github-desktop': `/en/${nonEnterpriseDefaultVersion}/desktop/contributing-and-collaborating-using-github-desktop`, - '/ja/desktop/contributing-and-collaborating-using-github-desktop': `/ja/${nonEnterpriseDefaultVersion}/desktop/contributing-and-collaborating-using-github-desktop`, '/en/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories': `/en/${nonEnterpriseDefaultVersion}/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories`, '/en/github/writing-on-github/basic-writing-and-formatting-syntax': `/en/${nonEnterpriseDefaultVersion}/github/writing-on-github/basic-writing-and-formatting-syntax`, } diff --git a/tests/unit/load-translation-orphans.js b/tests/unit/load-translation-orphans.js deleted file mode 100644 index 581c6ee23c..0000000000 --- a/tests/unit/load-translation-orphans.js +++ /dev/null @@ -1,60 +0,0 @@ -import path from 'path' -import { fileURLToPath } from 'url' - -import { expect } from '@jest/globals' - -import languages from '../../lib/languages.js' -import Page from '../../lib/page.js' -import { loadPageMap, correctTranslationOrphans } from '../../lib/page-data.js' -const __dirname = path.dirname(fileURLToPath(import.meta.url)) - -describe('loading page map with translation orphans', () => { - test('inject missing translations from English', async () => { - const basePath = path.join(__dirname, '../fixtures') - const page = await Page.init({ - relativePath: 'page-that-does-not-exist-in-translations-dir.md', - basePath, - languageCode: 'en', - }) - console.assert(page, 'page could not be loaded') - - const pageList = [page] - const pageMap = await loadPageMap(await correctTranslationOrphans(pageList, basePath)) - // It should make a copy of the English into each language - expect(Object.keys(pageMap).length).toBe(Object.keys(languages).length) - - // +1 for the test just above, 2 tests per language. - expect.assertions(1 + Object.keys(languages).length * 2) - - for (const languageCode of Object.keys(languages)) { - for (const permalink of page.permalinks) { - const translationHref = permalink.href.replace('/en', `/${languageCode}`) - const translationPage = pageMap[translationHref] - expect(translationPage).toBeTruthy() - expect(translationPage.languageCode).toBe(languageCode) - } - } - }) - - test('remove translation pages that were not in English', async () => { - const basePath = path.join(__dirname, '../fixtures') - const page = await Page.init({ - relativePath: 'page-that-does-not-exist-in-translations-dir.md', - basePath, - languageCode: 'en', - }) - console.assert(page, 'page could not be loaded') - const orphan = await Page.init({ - relativePath: 'article-with-videos.md', - basePath, - languageCode: 'ja', - }) - console.assert(orphan, 'page could not be loaded') - const orphanPermalinks = orphan.permalinks.map((p) => p.href) - - const pageList = await correctTranslationOrphans([page, orphan], basePath) - const pageMap = await loadPageMap(pageList) - expect(pageMap[orphanPermalinks[0]]).toBeFalsy() - expect(Object.keys(pageMap).length).toBe(Object.keys(languages).length) - }) -}) diff --git a/tests/unit/openapi-schema.js b/tests/unit/openapi-schema.js index 9dd72eb006..7b82ba7ecf 100644 --- a/tests/unit/openapi-schema.js +++ b/tests/unit/openapi-schema.js @@ -29,7 +29,13 @@ describe('markdown for each rest version', () => { test('markdown file exists for every operationId prefix in all versions of the OpenAPI schema', async () => { // list of REST markdown files that do not correspond to REST API resources // TODO could we get this list dynamically, say via page frontmatter? - const excludeFromResourceNameCheck = ['README.md', 'index.md', 'guides', 'overview'] + const excludeFromResourceNameCheck = [ + 'README.md', + 'index.md', + 'guides', + 'overview', + 'quickstart.md', + ] // Unique set of all categories across all versions of the OpenAPI schema const allCategories = new Set() diff --git a/tests/unit/page.js b/tests/unit/page.js index ca572f83da..d1b9150477 100644 --- a/tests/unit/page.js +++ b/tests/unit/page.js @@ -31,15 +31,6 @@ describe('Page class', () => { expect(page.fullPath.includes(page.relativePath)).toBe(true) }) - test('does not error out on translated TOC with no links', async () => { - const page = await Page.init({ - relativePath: 'translated-toc-with-no-links-index.md', - basePath: path.join(__dirname, '../fixtures'), - languageCode: 'ja', - }) - expect(typeof page.title).toBe('string') - }) - describe('showMiniToc page property', () => { let article, articleWithFM, tocPage @@ -612,17 +603,6 @@ describe('Page class', () => { it('works for the homepage', () => { const variants = Page.getLanguageVariants('/en') expect(variants.find(({ code }) => code === 'en').href).toBe('/en') - // expect(variants.find(({ code }) => code === 'ja').href).toBe('/ja') - }) - - it('works for enterprise URLs', () => { - const variants = Page.getLanguageVariants( - `/ja/enterprise/${enterpriseServerReleases.oldestSupported}/user/articles/github-glossary` - ) - expect(variants.find(({ code }) => code === 'en').href).toBe( - `/en/enterprise/${enterpriseServerReleases.oldestSupported}/user/articles/github-glossary` - ) - // expect(variants.find(({ code }) => code === 'ja').href).toBe('/ja/enterprise/2.14/user/articles/github-glossary') }) }) diff --git a/tests/unit/pages.js b/tests/unit/pages.js index 32f97d35cf..271afeeb2b 100644 --- a/tests/unit/pages.js +++ b/tests/unit/pages.js @@ -6,24 +6,12 @@ import { liquid } from '../../lib/render-content/index.js' import patterns from '../../lib/patterns.js' import GithubSlugger from 'github-slugger' import { decode } from 'html-entities' -import walk from 'walk-sync' -import { chain, difference, pick } from 'lodash-es' +import { chain, pick } from 'lodash-es' import checkIfNextVersionOnly from '../../lib/check-if-next-version-only.js' import removeFPTFromPath from '../../lib/remove-fpt-from-path.js' const languageCodes = Object.keys(libLanguages) const slugger = new GithubSlugger() -// By default, the tests don't change that each translation has an -// equivalent English page (e.g. `translations/*/content/foo.md` -// expects `content/foo.md`) -// Set the environment variable `TEST_TRANSLATION_MATCHING=true` -// to enable that test. -const testIfRequireTranslationMatching = JSON.parse( - process.env.TEST_TRANSLATION_MATCHING || 'false' -) - ? test - : test.skip - describe('pages module', () => { jest.setTimeout(60 * 1000) @@ -163,30 +151,6 @@ describe('pages module', () => { const failureMessage = JSON.stringify(liquidErrors, null, 2) expect(liquidErrors.length, failureMessage).toBe(0) }) - - testIfRequireTranslationMatching( - 'every non-English page has a matching English page', - async () => { - const englishPaths = chain(walk('content', { directories: false })) - .uniq() - .value() - - const nonEnglishPaths = chain(Object.values(libLanguages)) - .filter((language) => language.code !== 'en') - .map((language) => walk(`${language.dir}/content`, { directories: false })) - .flatten() - .uniq() - .value() - - const diff = difference(nonEnglishPaths, englishPaths) - const failureMessage = ` -Found ${diff.length} non-English pages without a matching English page:\n - ${diff.join('\n - ')} - -Remove them with script/i18n/prune-stale-files.js and commit your changes using "git commit --no-verify". -` - expect(diff.length, failureMessage).toBe(0) - } - ) }) describe('loadPageMap', () => { diff --git a/tests/unit/static-assets.js b/tests/unit/static-assets.js index d8ba7441c9..5c645269ff 100644 --- a/tests/unit/static-assets.js +++ b/tests/unit/static-assets.js @@ -112,10 +112,10 @@ describe('archived enterprise static assets', () => { setDefaultFastlySurrogateKey(req, res, () => {}) await archivedEnterpriseVersionsAssets(req, res, next) expect(res.statusCode).toBe(200) - checkCachingHeaders(res, true, 60) + checkCachingHeaders(res, false, 60) }) - it('should proxy if the Referrer header indicates so', async () => { + it('should proxy if the Referrer header indicates so on home page', async () => { const req = mockRequest('/_next/static/only-on-proxy.css', { headers: { Referrer: '/enterprise/2.21', @@ -128,10 +128,10 @@ describe('archived enterprise static assets', () => { setDefaultFastlySurrogateKey(req, res, () => {}) await archivedEnterpriseVersionsAssets(req, res, next) expect(res.statusCode).toBe(200) - checkCachingHeaders(res, true, 60) + checkCachingHeaders(res, false, 60) }) - it('should proxy if the Referrer header indicates so', async () => { + it('should proxy if the Referrer header indicates so on sub-page', async () => { const req = mockRequest('/_next/static/only-on-2.3.css', { headers: { Referrer: '/en/enterprise-server@2.3/some/page', @@ -144,7 +144,7 @@ describe('archived enterprise static assets', () => { setDefaultFastlySurrogateKey(req, res, () => {}) await archivedEnterpriseVersionsAssets(req, res, next) expect(res.statusCode).toBe(200) - checkCachingHeaders(res, true, 60) + checkCachingHeaders(res, false, 60) }) it('might still 404 even with the right referrer', async () => { diff --git a/tests/javascripts/user-agent.js b/tests/unit/user-agent.js similarity index 96% rename from tests/javascripts/user-agent.js rename to tests/unit/user-agent.js index 49bc60b84a..b11e03c6ec 100644 --- a/tests/javascripts/user-agent.js +++ b/tests/unit/user-agent.js @@ -1,4 +1,4 @@ -import parseUserAgent from '../../components/lib/user-agent' +import { parseUserAgent } from '../../components/lib/user-agent.ts' describe('parseUserAgent', () => { it('android, chrome', () => { diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md index 6d236d1cd1..d6b35dde09 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md @@ -1,63 +1,63 @@ --- -title: Setting your profile to private -intro: 'A private profile displays only limited information, and hides some activity.' +title: Configurar tu perfil como privado +intro: Un perfil privado muestra información limitada únicamente y oculta algo de actividad. versions: fpt: '*' topics: - Profiles -shortTitle: Set profile to private +shortTitle: Configurar el perfil como privado --- -## About private profiles +## Acerca de los perfiles privados {% note %} -**Note:** Private profiles are currently in beta and are subject to change. +**Nota:** Los perfiles privados se encuentran actualmente en beta y están sujetos a cambios. {% endnote %} -To hide parts of your profile page, you can make your profile private. This also hides your activity in various social features on {% data variables.product.prodname_dotcom_the_website %}. A private profile hides information from all users, and there is currently no option to allow specified users to see your activity. +Para ocultar partes de tu página de perfil, puedes hacer a tu perfil privado. Esto también oculta tu actividad en varias características sociales de {% data variables.product.prodname_dotcom_the_website %}. Un perfil privado oculta información para todos los usuarios y actualmente no hay una opción para permitir que usuarios específicos vea tu actividad. -After making your profile private, you can still view all your information when you visit your own profile. +Después de hacer a tu perfil privado, aún puedes ver toda tu información cuando visitas tu propio perfil. -Private profiles cannot receive sponsorships under [{% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors). To be eligible for {% data variables.product.prodname_sponsors %}, your profile cannot be private. +Los perfiles privados no pueden recibir patrocinios bajo [{% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors). Para que pueda ser elegible para {% data variables.product.prodname_sponsors %}, tu perfil no puede ser privado. -## Differences between private and public profiles +## Diferencias entre los perfiles públicos y privados -When your profile is private, the following content is hidden from your profile page: +Cuando tu perfil es privado, el siguiente contenido se oculta de tu página de perfil: -- Achievements and highlights. -- Activity overview and activity feed. -- Contribution graph. -- Follower and following counts. -- Follow and Sponsor buttons. -- Organization memberships. -- Stars, projects, packages, and sponsoring tabs. +- Los logros y puntos destacados. +- El resumen de la actividad y la fuente de actividad. +- La gráfica de contribuciones. +- Los conteos de seguidores y seguidos. +- Los botones de seguir y de patrocinar. +- Las membrecías de organización. +- Las pestañas de favoritos, proyectos, paquetes y patrocinando. {% note %} -**Note**: When your profile is private, some optional fields are still publicly visible, such as the README, biography, and profile photo. +**Nota**: Cuando tu perfil es privado, algunos de los campos opcionales aún se encuentran visibles para el público tal como el README, la biografía y la foto de perfil. {% endnote %} -## Changes to reporting on your activities +## Cambios a reportar en tus actividades -By making your profile private, you will not remove or hide past activity; this setting only applies to your activity while the private setting is enabled. +Al hacer tu perfil privado, no eliminarás ni ocultarás la actividad anterior; este ajuste solo aplica a tu actividad mientras el ajuste privado esté habilitado. -When your profile is private, your {% data variables.product.prodname_dotcom_the_website %} activity will not appear in the following locations: +Cuando tu perfil es privado, tu actividad de {% data variables.product.prodname_dotcom_the_website %} no se mostrará en las siguientes ubicaciones: -- Activity feeds for other users. -- Discussions leaderboards. -- The [Trending](https://github.com/trending) page. +- Fuentes de actividad para otros usuarios. +- Tablas de clasificación de debates. +- La página de [Tendencias](https://github.com/trending). {% note %} -**Note**: Your activity on public repositories will still be publicly visible to anyone viewing those repositories, and some activity data may still be available through the {% data variables.product.prodname_dotcom %} API. +**Nota**: Cualquiera que vea estos repositorios tendrá visibilidad del público en general para tu actividad en los repositorios públicos y algunos datos de la actividad aún estarán disponibles mediante la API de {% data variables.product.prodname_dotcom %}. {% endnote %} -## Changing your profile's privacy settings +## Cambiar los ajustes de privacidad de tu perfil {% data reusables.user-settings.access_settings %} -1. Under "Contributions & Activity", select the checkbox next to **Make profile private and hide activity**. +1. Dababjo de "Contribuciones & actividad", selecciona la casilla de verificación junto a **Hacer perfil privado y ocultar actividad**. {% data reusables.user-settings.update-preferences %} diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md index cdc8f7a80c..3bb4ede446 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md @@ -1,6 +1,6 @@ --- title: Setting up and managing your personal account on GitHub -intro: 'You can manage settings for your personal account on {% data variables.product.prodname_dotcom %}, including email preferences, collaborator access for personal repositories, and organization memberships.' +intro: 'You can manage settings for your personal account on {% ifversion fpt or ghec or ghes %}{% data variables.product.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %}, including email preferences, access to personal repositories, and organization memberships. You can also manage the account itself.' shortTitle: Cuentas personales redirect_from: - /categories/setting-up-and-managing-your-github-user-account @@ -15,6 +15,7 @@ topics: - Accounts children: - /managing-personal-account-settings + - /managing-your-personal-account - /managing-email-preferences - /managing-access-to-your-personal-repositories - /managing-your-membership-in-organizations diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md index 1288b54218..21dc884ac7 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md @@ -1,6 +1,6 @@ --- title: Administrar las configuraciones del usuario de la cuenta -intro: 'Puedes cambiar varias configuraciones de tu cuenta personal, lo que incluye cambiar tu nombre de usuario y eliminar tu cuenta.' +intro: 'You can manage settings for your personal account, including your theme, username, default branch, accessibility, and security settings.' redirect_from: - /categories/29/articles - /categories/user-accounts @@ -19,9 +19,6 @@ children: - /managing-your-theme-settings - /managing-your-tab-size-rendering-preference - /changing-your-github-username - - /merging-multiple-personal-accounts - - /converting-a-user-into-an-organization - - /deleting-your-personal-account - /permission-levels-for-a-personal-account-repository - /permission-levels-for-a-project-board-owned-by-a-personal-account - /managing-accessibility-settings @@ -29,7 +26,6 @@ children: - /managing-security-and-analysis-settings-for-your-personal-account - /managing-access-to-your-personal-accounts-project-boards - /integrating-jira-with-your-personal-projects - - /best-practices-for-leaving-your-company - /what-does-the-available-for-hire-checkbox-do shortTitle: Ajustes de cuenta personal --- diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md similarity index 96% rename from translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company.md rename to translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md index 43c747822e..14c1b83cfd 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md @@ -6,6 +6,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/best-practices-for-leaving-your-company - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/best-practices-for-leaving-your-company - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/best-practices-for-leaving-your-company + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company versions: fpt: '*' ghec: '*' diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md similarity index 95% rename from translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization.md rename to translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md index c2c41a63e6..57ad4ace23 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md @@ -7,6 +7,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/converting-a-user-into-an-organization - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization intro: Puedes convertir tu cuenta personal en una organización. Esto permite que haya más permisos granulares para repositorios que pertenecen a la organización. versions: fpt: '*' @@ -66,5 +67,5 @@ También puedes convertir tu cuenta personal directamente en una organización. ## Leer más - "[Configurar equipos](/articles/setting-up-teams)" -{% ifversion fpt or ghec %}- "[Invitar usuarios a unirse a tu organización](/articles/inviting-users-to-join-your-organization)"{% endif %} +{% ifversion fpt or ghec %}- "[Invitar usuarios para que se unan a tu organización](/articles/inviting-users-to-join-your-organization)"{% endif %} - "[Acceder a una organización](/articles/accessing-an-organization)" diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md similarity index 59% rename from translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account.md rename to translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md index 23d646bd21..0757d38da6 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md @@ -1,39 +1,53 @@ --- title: Deleting your personal account -intro: 'Puedes borrar tu cuenta personal de {% data variables.product.product_name %} en cualquier momento.' +intro: 'Puedes borrar tu cuenta personal de {% data variables.product.product_location %} en cualquier momento.' redirect_from: - /articles/deleting-a-user-account - /articles/deleting-your-user-account - /github/setting-up-and-managing-your-github-user-account/deleting-your-user-account - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account versions: fpt: '*' ghes: '*' ghec: '*' topics: - Accounts -shortTitle: Borrar tu cuenta personal +shortTitle: Delete your account --- -El borrar tu cuenta personal elimina todos los repositorios, bifurcaciones de repositorios privados, wikis, propuestas, solicitudes de cambios y páginas que pertenecen a tu cuenta. {% ifversion fpt or ghec %}No se eliminarán las propuestas ni las solicitudes de extracción que hayas creado ni los comentarios que hayas hecho en repositorios que sean propiedad de otros usuarios. En lugar de eliminarlos, se los asociará con nuestro [Usuario fantasma](https://github.com/ghost).{% else %}No se eliminarán las propuestas ni las solicitudes de extracción que hayas creado ni los comentarios que hayas hecho en repositorios que sean propiedad de otros usuarios.{% endif %} +## About deletion of your personal account -{% ifversion fpt or ghec %} Dejaremos de cobrarte cuando borras tu cuenta. La dirección asociada con la cuenta se hace disponible para utilizarse con una cuenta diferente en {% data variables.product.product_location %}. Después de 90 días, el nombre de cuenta también pone disponible para que cualquiera con una cuenta nueva lo utilice. {% endif %} +El borrar tu cuenta personal elimina todos los repositorios, bifurcaciones de repositorios privados, wikis, propuestas, solicitudes de cambios y páginas que pertenecen a tu cuenta. {% ifversion fpt or ghec %}Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted. Your resources and comments will become associated with the [ghost user](https://github.com/ghost).{% else %}Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted.{% endif %} -Si eres el único propietario de una organización, deberás transferir la propiedad a otra persona o borrar la organización antes de que puedas borrar tu cuenta personal. Si existen otros propietarios en la organización, debes eliminarte de ella antes de que puedas borrar tu cuenta personal. +{% ifversion ghec %} + +{% note %} + +**Note**: If your enterprise manages your account and you sign into {% data variables.product.product_location %} through your company's identity provider (IdP), you cannot delete your account. Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_emus %}](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)". + +{% endnote %} + +{% endif %} + +{% ifversion fpt or ghec %}When you delete your account we stop billing you. La dirección asociada con la cuenta se hace disponible para utilizarse con una cuenta diferente en {% data variables.product.product_location %}. Después de 90 días, el nombre de cuenta también pone disponible para que cualquiera con una cuenta nueva lo utilice. {% endif %} + +If you're the only owner of an organization, you must transfer ownership to another person or delete the organization before you can delete your personal account. Si existen otros propietarios en la organización, debes eliminarte de ella antes de que puedas borrar tu cuenta personal. + +Para obtener más información, consulta los siguientes artículos. -Para obtener más información, consulta: - "[Transferir la propiedad de la organización](/articles/transferring-organization-ownership)" - "[Eliminar una cuenta de la organización](/articles/deleting-an-organization-account)" - "[Eliminarte de una organización](/articles/removing-yourself-from-an-organization/)" ## Copias de seguridad de los datos de tu cuenta -Antes de que borres tu cuenta personal, haz una copia de todos los repositorios, bifurcaciones privadas, wikis, propuestas y solicitudes de cambios que le pertenezcan a tu cuenta. +Antes de que borres tu cuenta personal, haz una copia de todos los repositorios, bifurcaciones privadas, wikis, propuestas y solicitudes de cambios que le pertenezcan a tu cuenta. For more information, see "[Backing up a repository](/repositories/archiving-a-github-repository/backing-up-a-repository)." {% warning %} -**Advertencia** Una vez que tu cuenta personal se haya borrado, GitHub no podrá restablecer tu contenido. +**Warning:** Once your personal account has been deleted, {% ifversion fpt or ghec %}{% data variables.product.company_short %}{% elsif ghes or ghae %}an enterprise owner{% endif %} cannot restore your content. {% endwarning %} diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md new file mode 100644 index 0000000000..ab1c7a9394 --- /dev/null +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md @@ -0,0 +1,19 @@ +--- +title: Managing your personal account +intro: 'You can manage your personal account on {% ifversion fpt or ghec or ghes %}{% data variables.product.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %}. For example, you can {% ifversion fpt or ghec %}manage multiple accounts, {% endif %}convert an account to an organization{% ifversion fpt or ghec or ghes %}, or delete an account{% endif %}.' +shortTitle: Manage personal account +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - Accounts +children: + - /managing-multiple-accounts + - /merging-multiple-personal-accounts + - /converting-a-user-into-an-organization + - /best-practices-for-leaving-your-company + - /deleting-your-personal-account +--- + diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md new file mode 100644 index 0000000000..9af9d7d083 --- /dev/null +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md @@ -0,0 +1,105 @@ +--- +title: Managing multiple accounts +intro: 'If you use one workstation to contribute to projects for more than one account on {% data variables.product.product_location %}, you can modify your Git configuration to simplify the contribution process.' +versions: + feature: multiple-accounts-one-workstation +topics: + - Accounts + - Git + - GitHub +shortTitle: Manage multiple accounts +--- + +## About management of multiple accounts + +In some cases, you may need to use multiple accounts on {% data variables.product.product_location %}. For example, you may have a personal account for open source contributions, and your employer may also create and manage a user account for you within an enterprise. + +You cannot use your {% data variables.product.prodname_managed_user %} to contribute to public projects on {% data variables.product.product_location %}, so you must contribute to those resources using your personal account. Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_emus %}]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#abilities-and-restrictions-of-managed-user-accounts){% ifversion fpt %}" en la documentación de {% data variables.product.prodname_ghe_cloud %}.{% elsif ghec %}".{% endif %} + +If you want to use one workstation to contribute from both accounts, you can simplify contribution with Git by using a mixture of protocols to access repository data, or by using credentials on a per-repository basis. + +{% warning %} + +**Warning**: Be mindful when you use one workstation to contribute to two separate accounts. Management of two or more accounts can increase the chance of mistakenly leaking internal code to the public. + +{% endwarning %} + +If you aren't required to use a {% data variables.product.prodname_managed_user %}, {% data variables.product.company_short %} recommends that you use one personal account for all your work on {% data variables.product.product_location %}. With a single personal account, you can contribute to a combination of personal, open source, or professional projects using one identity. Other people can invite the account to contribute to both individual repositories and repositories owned by an organization, and the account can be a member of multiple organizations or enterprises. + +## Contributing to two accounts using HTTPS and SSH + +If you contribute with two accounts from one workstation, you can access repositories by using a different protocol and credentials for each account. + +Git can use either the HTTPS or SSH protocol to access and update data in repositories on {% data variables.product.product_location %}. The protocol you use to clone a repository determines which credentials your workstation will use to authenticate when you access the repository. With this approach to account management, you store the credentials for one account to use for HTTPS connections and upload an SSH key to the other account to use for SSH connections. + +You can find both the HTTPS or an SSH URLs for cloning a repository on {% data variables.product.product_name %}. Para obtener más información, consulta "[Clonar un repositorio](/repositories/creating-and-managing-repositories/cloning-a-repository)". + +For more information about the use of SSH to access repositories on {% data variables.product.product_name %}, see "[Connecting to {% data variables.product.prodname_dotcom %} with SSH](/authentication/connecting-to-github-with-ssh)." + +## Contributing to multiple accounts using HTTPS and PATs + +Alternatively, if you want to use the HTTPS protocol for both accounts, you can use different personal access tokens (PAT) for each account by configuring Git to store different credentials for each repository. + +{% mac %} + +{% data reusables.git.open-terminal %} +{% data reusables.git.confirm-credential-manager %} +{% data reusables.git.clear-the-stored-credentials %} + {% data reusables.git.no-credential-manager %} + - If the output is `osxkeychain`, you're using the macOS keychain. To clear the credentials, enter the following command. + + ```shell{:copy} + git credential-osxkeychain erase https://github.com + ``` + {% data reusables.git.clear-stored-gcm-credentials %} +{% data reusables.git.cache-on-repository-path %} +{% data reusables.accounts.create-personal-access-tokens %} +{% data reusables.git.provide-credentials %} + +{% endmac %} + +{% windows %} + +1. Abre Git Bash. +{% data reusables.git.confirm-credential-manager %} +{% data reusables.git.clear-the-stored-credentials %} + {% data reusables.git.no-credential-manager %} + {% data reusables.git.clear-stored-gcm-credentials %} + - If the output is `wincred`, you're using the Windows Credential Manager. To clear the credentials, enter the following command. + + ```shell{:copy} + cmdkey /delete:LegacyGeneric:target=git:https://github.com + ``` +{% data reusables.git.cache-on-repository-path %} +{% data reusables.accounts.create-personal-access-tokens %} +{% data reusables.git.provide-credentials %} + +{% endwindows %} + +{% linux %} + +{% data reusables.git.open-terminal %} +{% data reusables.git.confirm-credential-manager %} +{% data reusables.git.clear-the-stored-credentials %} + {% data reusables.git.no-credential-manager %} + {% data reusables.git.clear-stored-gcm-credentials %} +{% data reusables.git.cache-on-repository-path %} +{% data reusables.accounts.create-personal-access-tokens %} +{% data reusables.git.provide-credentials %} + +{% endlinux %} + +## Contributing to multiple accounts using SSH and `GIT_SSH_COMMAND` + +If you want to use the SSH protocol for both accounts, you can use different SSH keys for each account. For more information about using SSH, see "[Connecting to {% data variables.product.prodname_dotcom %} with SSH](/authentication/connecting-to-github-with-ssh)." + +To use a different SSH key for different repositories that you clone to your workstation, you must write a shell wrapper function for Git operations. The function should perform the following steps. +1. Determine the repository's full name with owner, using a command such as `git config --get remote.origin.url`. +2. Choose the correct SSH key for authentication. +3. Modify `GIT_SSH_COMMAND` accordingly. For more information about `GIT_SSH_COMMAND`, see [Environment Variables](https://git-scm.com/docs/git#Documentation/git.txt-codeGITSSHCOMMANDcode) in the Git documentation. + +Por ejemplo, el siguiente comando configura la variable de ambiente `GIT_SSH_COMMAND` para que especifique un comando SSH que utiliza el archivo de llave privada en **_PATH/TO/KEY/FILE_** para autenticación para clonar el repositorio que se llama **_OWNER_**/**_REPOSITORY_** en {% data variables.product.product_location %}. + +
    +GIT_SSH_COMMAND='ssh -i PATH/TO/KEY/FILE -o IdentitiesOnly=yes' git clone git@github.com:OWNER/REPOSITORY
+
    diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md similarity index 85% rename from translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts.md rename to translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md index e4c08c19a7..46520223f7 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md @@ -8,12 +8,13 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/merging-multiple-user-accounts - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts versions: fpt: '*' ghec: '*' topics: - Accounts -shortTitle: Fusionar cuentas personales múltiples +shortTitle: Merge multiple accounts --- {% tip %} @@ -41,7 +42,7 @@ shortTitle: Fusionar cuentas personales múltiples 1. [Transfiere cualquier repositorio](/articles/how-to-transfer-a-repository) desde la cuenta que deseas eliminar a la cuenta que deseas mantener. También se transfieren propuestas, solicitudes de extracción y wikis. Verifica que los repositorios existan en la cuenta que deseas mantener. 2. [Actualiza las URL remotas](/github/getting-started-with-github/managing-remote-repositories) en cualquier clon local de los repositorios que se movieron. 3. [Elimina la cuenta](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account) que ya no deseas utilizar. -4. Para atribuir las confirmaciones pasadas a la cuenta nueva, agrega la dirección de correo electrónico que utilizaste para crear dichas confirmaciones a la cuenta que vas a conservar. Para obtener más información, consulta"[¿Por qué mis contribuciones no se muestran en mi perfil?](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)" +4. Para atribuir las confirmaciones pasadas a la cuenta nueva, agrega la dirección de correo electrónico que utilizaste para crear dichas confirmaciones a la cuenta que vas a conservar. Para obtener más información, consulta "[¿Por qué mis contribuciones no se están mostrando en mi perfil?](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)" ## Leer más diff --git a/translations/es-ES/content/actions/creating-actions/metadata-syntax-for-github-actions.md b/translations/es-ES/content/actions/creating-actions/metadata-syntax-for-github-actions.md index 309dd65fc3..ce79effbf6 100644 --- a/translations/es-ES/content/actions/creating-actions/metadata-syntax-for-github-actions.md +++ b/translations/es-ES/content/actions/creating-actions/metadata-syntax-for-github-actions.md @@ -354,7 +354,7 @@ runs: #### `runs.steps[*].with` -**Opcional** un `map` de los parámetros de entrada que define la acción. Cada parámetro de entrada es un par clave/valor. Los parámetros de entrada se establecen como variables del entorno. La variable utiliza el prefijo INPUT_ y se convierte en mayúsculas. +**Opcional** un `map` de los parámetros de entrada que define la acción. Cada parámetro de entrada es un par clave/valor. Para obtener más información, consulta la sección [Ejemplo: Especificar entradas](#example-specifying-inputs). ```yaml runs: diff --git a/translations/es-ES/content/actions/creating-actions/publishing-actions-in-github-marketplace.md b/translations/es-ES/content/actions/creating-actions/publishing-actions-in-github-marketplace.md index 8460af8274..e4de4d807a 100644 --- a/translations/es-ES/content/actions/creating-actions/publishing-actions-in-github-marketplace.md +++ b/translations/es-ES/content/actions/creating-actions/publishing-actions-in-github-marketplace.md @@ -38,8 +38,10 @@ Puedes agregar la acción que has creado para {% data variables.product.prodname Para preparar un nuevo lanzamiento y publicar la acción en {% data variables.product.prodname_marketplace %}, sigue estas instrucciones: {% data reusables.repositories.navigate-to-repo %} -1. Cuando un repositorio contiene un archivo de metadatos de acción (`action.yml` o `action.yaml`), verás un mensaje emergente para publicar la acción en {% data variables.product.prodname_marketplace %}. Haz clic en **Draft a release (Crear el borrador de un lanzamiento)**. ![Publicar esta acción en el botón de Marketplace](/assets/images/help/repository/publish-github-action-to-markeplace-button.png) -1. Selecciona **Publish this action to the (Publicar esta acción en) {% data variables.product.prodname_marketplace %}**. Si no puedes seleccionar la casilla de verificación **Publish this action to the (Publicar esta acción en) {% data variables.product.prodname_marketplace %}**, deberás leer y aceptar el acuerdo primero {% data variables.product.prodname_marketplace %}. ![Selecciona publicar en Marketplace](/assets/images/help/repository/marketplace_actions_publish.png) +1. Navega al archivo de metadatos de la acción en tu repositorio (`action.yml` o `action.yaml`) y verás un letrero para publicar la acción a {% data variables.product.prodname_marketplace %}. Haz clic en **Draft a release (Crear el borrador de un lanzamiento)**. + + ![Botón de publicar esta acción en marketplace](/assets/images/help/repository/publish-github-action-to-marketplace-button.png) +1. Debajo de "Lanzar acción", selecciona la casilla de verificación para publicar la acción en {% data variables.product.prodname_marketplace %}. Si no puedes seleccionar la casilla de verificación, primero debes hacer clic en el enlace para leer y aceptar el Acuerdo de Desarrollador de {% data variables.product.prodname_marketplace %}. ![Selecciona publicar en Marketplace](/assets/images/help/repository/marketplace_actions_publish.png) 1. Si las etiquetas en tu archivo de metadatos contienen algún problema, verás un mensaje de error. ![Ver notificación](/assets/images/help/repository/marketplace_actions_fixerrors.png) 1. Si ves alguna sugerencia en pantalla, la solucionas actualizando tu archivo de metadatos. Una vez que esté completo, verás un mensaje "Everything looks Good" (Todo se ve bien). ![Corregir errores](/assets/images/help/repository/marketplace_actions_looksgood.png) 1. Elige una "Primary Category" (Categoría principal) y, de manera opcional, "Another Category" (Otra categoría) que ayudará a las personas a encontrar tu acción en {% data variables.product.prodname_marketplace %}. ![Elegir categoría](/assets/images/help/repository/marketplace_actions_categories.png) diff --git a/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md b/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md index 0e5e9f0b68..f3eecc8858 100644 --- a/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md +++ b/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md @@ -73,6 +73,7 @@ The following example OIDC token uses a subject (`sub`) that references a job en "repository": "octo-org/octo-repo", "repository_owner": "octo-org", "actor_id": "12", + "repo_visibility": private, "repository_id": "74", "repository_owner_id": "65", "run_id": "example-run-id", @@ -128,6 +129,7 @@ The token also includes custom claims provided by {% data variables.product.prod | `job_workflow_ref`| This is the ref path to the reusable workflow used by this job. For more information, see "["Using OpenID Connect with reusable workflows"](/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows)." | | `ref`| _(Reference)_ The git ref that triggered the workflow run. | | `ref_type`| The type of `ref`, for example: "branch". | +| `repo_visibility` | The visibility of the repository where the workflow is running. Accepts the following values: `internal`, `private`, or `public`. | | `repository`| The repository from where the workflow is running. | | `repository_id`| The ID of the repository from where the workflow is running. | | `repository_owner`| The name of the organization in which the `repository` is stored. | @@ -143,11 +145,11 @@ With OIDC, a {% data variables.product.prodname_actions %} workflow requires a t Audience and Subject claims are typically used in combination while setting conditions on the cloud role/resources to scope its access to the GitHub workflows. - **Audience**: By default, this value uses the URL of the organization or repository owner. This can be used to set a condition that only the workflows in the specific organization can access the cloud role. -- **Subject**: Has a predefined format and is a concatenation of some of the key metadata about the workflow, such as the {% data variables.product.prodname_dotcom %} organization, repository, branch, or associated [`job`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idenvironment) environment. See "[Example subject claims](#example-subject-claims)" to see how the subject claim is assembled from concatenated metadata. +- **Subject**: By default, has a predefined format and is a concatenation of some of the key metadata about the workflow, such as the {% data variables.product.prodname_dotcom %} organization, repository, branch, or associated [`job`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idenvironment) environment. See "[Example subject claims](#example-subject-claims)" to see how the subject claim is assembled from concatenated metadata. -There are also many additional claims supported in the OIDC token that can also be used for setting these conditions. +If you need more granular trust conditions, you can customize the issuer (`iss`) and subject (`sub`) claims that are included with the JWT. For more information, see "[Customizing the token claims](#customizing-the-token-claims)". -In addition, your cloud provider could allow you to assign a role to the access tokens, letting you specify even more granular permissions. +There are also many additional claims supported in the OIDC token that can be used for setting these conditions. In addition, your cloud provider could allow you to assign a role to the access tokens, letting you specify even more granular permissions. {% note %} @@ -238,6 +240,198 @@ curl -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" "$ACTIONS_ID_TOK {% data reusables.actions.oidc-permissions-token %} +{% ifversion actions-oidc-hardening-config %} +## Customizing the token claims + +You can security harden your OIDC configuration by customizing the claims that are included with the JWT. These customisations allow you to define more granular trust conditions on your cloud roles when allowing your workflows to access resources hosted in the cloud: + +{% ifversion ghec %} - For an additional layer of security, you can append the `issuer` url with your enterprise slug. This lets you set conditions on the issuer (`iss`) claim, configuring it to only accept JWT tokens from a unique `issuer` URL that must include your enterprise slug.{% endif %} +- You can standardize your OIDC configuration by setting conditions on the subject (`sub`) claim that require JWT tokens to originate from a specific repository, reusable workflow, or other source. +- You can define granular OIDC policies by using additional OIDC token claims, such as `repository_id` and `repo_visibility`. For more information, see "[Understanding the OIDC token](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#understanding-the-oidc-token)". + +To customize these claim formats, organization and repository admins can use the REST API endpoints described in the following sections. + +{% ifversion ghec %} + +### Switching to a unique token URL + +By default, the JWT is issued by {% data variables.product.prodname_dotcom %}'s OIDC provider at `https://token.actions.githubusercontent.com`. This path is presented to your cloud provider using the `iss` value in the JWT. + +Enterprise admins can security harden their OIDC configuration by configuring their enterprise to receive tokens from a unique URL at `https://api.github.com/enterprises//actions/oidc/customization/issuer`. Replace `` with the slug value of your enterprise. + +This configuration means that your enterprise will receive the OIDC token from a unique URL, and you can then configure your cloud provider to only accept tokens from that URL. This helps ensure that only the enterprise's repositories can access your cloud resources using OIDC. + +To activate this setting for your enterprise, an enterprise admin must use the `/enterprises/{enterprise}/actions/oidc/customization/issuer` endpoint and specify `"include_enterprise_slug": true` in the request body. For more information, see "[Set the {% data variables.product.prodname_actions %} OIDC custom issuer policy for an enterprise](/rest/actions/oidc#set-the-github-actions-oidc-custom-issuer-policy-for-an-enterprise)." + +After this setting is applied, the JWT will contain the updated `iss` value. In the following example, the `iss` key uses `octocat-inc` as its `enterpriseSlug` value: + +```json +{ + "jti": "6f4762ed-0758-4ccb-808d-ee3af5d723a8" + "sub": "repo:octocat-inc/private-server:ref:refs/heads/main" + "aud": "http://octocat-inc.example/octocat-inc" + "enterprise": "octocat-inc" + "iss": "https://api.github.com/enterprises/octocat-inc/actions/oidc/customization/issuer", + "bf": 1755350653, + "exp": 1755351553, + "iat": 1755351253 +} +``` + +{% endif %} + +### Customizing the subject claims for an organization + +To configure organization-wide security, compliance, and standardization, you can customize the standard claims to suit your required access conditions. If your cloud provider supports conditions on subject claims, you can create a condition that checks whether the `sub` value matches the path of the reusable workflow, such as `"job_workflow_ref: "octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main""`. The exact format will vary depending on your cloud provider's OIDC configuration. To configure the matching condition on {% data variables.product.prodname_dotcom %}, you can can use the REST API to require that the `sub` claim must always include a specific custom claim, such as `job_workflow_ref`. For more information, see "[Set the customization template for an OIDC subject claim for an organization](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization)." + +Customizing the claims results in a new format for the entire `sub` claim, which replaces the default predefined `sub` format in the token described in "[Example subject claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims)." + +The following example templates demonstrate various ways to customize the subject claim. To configure these settings on {% data variables.product.prodname_dotcom %}, organization admins use the REST API to specify a list of claims that must be included in the subject (`sub`) claim. {% data reusables.actions.use-request-body-api %} + +To customize your subject claims, you should first create a matching condition in your cloud provider's OIDC configuration, before customizing the configuration using the REST API. Once the configuration is completed, each time a new job runs, the OIDC token generated during that job will follow the new customization template. If the matching condition doesn't exist in the cloud provider's OIDC configuration before the job runs, the generated token might not be accepted by the cloud provider, since the cloud conditions may not be synchronized. + +{% note %} + +**Note**: When the organization template is applied, it will not affect any existing repositories that already use OIDC. For existing repositories, as well as any new repositories that are created after the template has been applied, the repository owner will need to opt-in to receive this configuration. For more information, see "[Set the opt-in flag of an OIDC subject claim customization for a repository](/rest/actions/oidc#set-the-opt-in-flag-of-an-oidc-subject-claim-customization-for-a-repository)." + +{% endnote %} + +#### Example: Allowing repository based on visibility and owner + +This example template allows the `sub` claim to have a new format, using `repository_owner` and `repository_visibility`: + +```json +{ + "include_claim_keys": [ + "repository_owner", + "repository_visibility" + ] +} +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repository_owner` and `repository_visibility`. For example: `"repository_owner: "monalisa":repository_visibility:private"`. The approach lets you restrict cloud role access to only private repositories within an organization or enterprise. + +#### Example: Allowing access to all repositories with a specific owner + +This example template enables the `sub` claim to have a new format with only the value of `repository_owner`. {% data reusables.actions.use-request-body-api %} + +```json +{ + "include_claim_keys": [ + "repository_owner" + ] +} + +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include a specific value for `repository_owner`. For example: `"repository_owner: "monalisa""` + +#### Example: Requiring a reusable workflow + +This example template allows the `sub` claim to have a new format that contains the value of the `job_workflow_ref` claim. This enables an enterprise to use [reusable workflows](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims) to enforce consistent deployments across its organizations and repositories. + +{% data reusables.actions.use-request-body-api %} + +```json + { + "include_claim_keys": [ + "job_workflow_ref" + ] + } +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include a specific value for `job_workflow_ref`. For example: `"job_workflow_ref: "octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main""`. + +#### Example: Requiring a reusable workflow and other claims + +The following example template combines the requirement of a specific reusable workflow with additional claims. {% data reusables.actions.use-request-body-api %} + +This example also demonstrates how to use `"context"` to define your conditions. This is the part that follows the repository in the [default `sub` format](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims). For example, when the job references an environment, the context contains: `environment:`. + +```json +{ + "include_claim_keys": [ + "repo", + "context", + "job_workflow_ref" + ] +} +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repo`, `context`, and `job_workflow_ref`. + +This customization template requires that the `sub` uses the following format: `repo::environment::job_workflow_ref:`. +For example: `"sub": "repo:octo-org/octo-repo:environment:prod:job_workflow_ref:octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main"` + +#### Example: Granting access to a specific repository + +This example template lets you grant cloud access to all the workflows in a specific repository, across all branches/tags and environments. To help improve security, combine this template with the custom issuer URL described in "[Customizing the token URL for an enterprise](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-url-for-an-enterprise)." + +{% data reusables.actions.use-request-body-api %} + +```json +{ + "include_claim_keys": [ + "repo" + ] +} +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require a `repo` claim that matches the required value. + +#### Example: Using system-generated GUIDs + +This example template enables predictable OIDC claims with system-generated GUIDs that do not change between renames of entities (such as renaming a repository). {% data reusables.actions.use-request-body-api %} + +```json + { + "include_claim_keys": [ + "repository_id" + ] + } +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require a `repository_id` claim that matches the required value. + +or: + +```json +{ + "include_claim_keys": [ + "repository_owner_id" + ] +} +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require a `repository_owner_id` claim that matches the required value. + +#### Resetting your customizations + +This example template resets the subject claims to the default format. {% data reusables.actions.use-request-body-api %} This template effectively opts out of any organization-level customization policy. + +```json +{ + "include_claim_keys": [ + "repo", + "context" + ] +} +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repo` and `context`. + +#### Using the default subject claims + +For repositories that can receive a subject claim policy from their organization, the repository owner can later choose to opt-out and instead use the default `sub` claim format. To configure this, the repository admin must use the REST API endpoint at "[Set the opt-out flag of an OIDC subject claim customization for a repository](/rest/actions/oidc#set-the-opt-out-flag-of-an-oidc-subject-claim-customization-for-a-repository)" with the following request body: + +```json +{ + "use_default": true +} +``` + +{% endif %} + ## Updating your workflows for OIDC You can now update your YAML workflows to use OIDC access tokens instead of secrets. Popular cloud providers have published their official login actions that make it easy for you to get started with OIDC. For more information about updating your workflows, see the cloud-specific guides listed below in "[Enabling OpenID Connect for your cloud provider](#enabling-openid-connect-for-your-cloud-provider)." diff --git a/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md b/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md index decbb3fdfb..99523f9764 100644 --- a/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md +++ b/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md @@ -32,10 +32,52 @@ Esta guía te proporciona un resumen de cómo configurar HashiCorp Vault para qu Para utilizar OIDC con HashiCorp Vault, necesitarás agregar una configuración de confianza para el proveedor de OIDC de {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta la [documentación](https://www.vaultproject.io/docs/auth/jwt) de HashiCorp Vault. -Configura la bóveda para que acepte Tokens Web JSON (JWT) para la autenticación: -- Para el `oidc_discovery_url`, utiliza {% ifversion ghes %}`https://HOSTNAME/_services/token`{% else %}`https://token.actions.githubusercontent.com`{% endif %} -- Para `bound_issuer`, utiliza {% ifversion ghes %}`https://HOSTNAME/_services/token`{% else %}`https://token.actions.githubusercontent.com`{% endif %} -- Asegúrate de que `bound_subject` se defina correctamente para tus requisitos de seguridad. Para obtener más información, consulta la sección ["Configurar la confianza de OIDC con la nube"](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#configuring-the-oidc-trust-with-the-cloud) y [`hashicorp/vault-action`](https://github.com/hashicorp/vault-action). +Para configurar tu servidor de Vault para que acepte tokens web de JSON (JWT) para autenticación: + +1. Habilita el método `auth` del JWT y utiliza `write` para aplicar la configuración a tu bóveda. Para los parámetros de `oidc_discovery_url` y `bound_issuer`, utiliza {% ifversion ghes %}`https://HOSTNAME/_services/token`{% else %}`https://token.actions.githubusercontent.com`{% endif %}. Los parámetros permiten que el servidor de Vault verifique los tokens web de JSON (JWT) durante el proceso de autenticación. + + ```sh{:copy} + vault auth enable jwt + ``` + + ```sh{:copy} + vault write auth/jwt/config \ + bound_issuer="{% ifversion ghes %}https://HOSTNAME/_services/token{% else %}https://token.actions.githubusercontent.com{% endif %}" \ + oidc_discovery_url="{% ifversion ghes %}https://HOSTNAME/_services/token{% else %}https://token.actions.githubusercontent.com{% endif %}" + ``` +2. Configura una política que solo otorgue acceso a las rutas específicas que utilizarán tus flujos de trabajo para recuperar los secretos. Para obtener más políticas avanzadas, consulta la [documentación de las políticas](https://www.vaultproject.io/docs/concepts/policies) de HashiCorp Vault. + + ```sh{:copy} + vault policy write myproject-production - <`: Reemplaza esto con la URL de tu HashiCorp Vault. +- ``: Reemplaza esto con el designador de nombre que configuraste en HashiCorp Vault. Por ejemplo: `admin`. - ``: Reemplaza esto con el rol que configuraste en la relación de confianza de HashiCorp Vault. -- ``: Reemplaza esto con la audiencia que definiste en la relación de confianza de HashiCorp Vault. -- ``: Reemplaza esto con la ruta al secreto que estás recuperando desde HashiCorp Vault. Por ejemplo: `secret/data/ci npmToken`. +- ``: Reemplaza esto con la ruta al secreto que estás recuperando desde HashiCorp Vault. Por ejemplo: `secret/data/production/ci npmToken`. ```yaml{:copy} jobs: - retrieve-secret: - steps: - - name: Retrieve secret from Vault - uses: hashicorp/vault-action@v2.4.0 - with: - url: - role: - method: jwt - jwtGithubAudience: - secrets: + retrieve-secret: + runs-on: ubuntu-latest + permissions: + id-token: write + contents: read + steps: + - name: Retrieve secret from Vault + uses: hashicorp/vault-action@v2.4.0 + with: + method: jwt + url: + namespace: + role: + secrets: - - name: Use secret from Vault - run: | - # This step has access to the secret retrieved above; see hashicorp/vault-action for more details. + - name: Use secret from Vault + run: | + # This step has access to the secret retrieved above; see hashicorp/vault-action for more details. +``` + +{% note %} + +**Nota**: + +- Si no se puede acceder a tu servidor de Vault desde la red pública, considera utilizar un ejecutor auto-hospedado con otros [métodos de autenticación](https://www.vaultproject.io/docs/auth) de Vault disponibles. Para obtener más información, consulta "[Acerca de los ejecutores autoalojados](/actions/hosting-your-own-runners/about-self-hosted-runners)." +- `` debe configurarse para el despliegue de una empresa de Vault (incluyendo a HCP Vault). Para obtener más información, consulta la sección [designador de nombre de Vault](https://www.vaultproject.io/docs/enterprise/namespaces). + +{% endnote %} + +### Revocar el token de acceso + +Predeterminadamente, el servidor de Vault revocará automáticamente los tokens de acceso cuando su TTL expire para que no tengas que revocarlos manualmente. Sin embargo, si quieres revocarlos de inmediato después de que tu job se haya completado o haya fallado, puedes revocar manualmente el token emitido utilizando la [API de Vault](https://www.vaultproject.io/api/auth/token#revoke-a-token-self). + +1. Configura la opción `exportToken` en `true` (predeterminado: `false`). Esto exporta el token de acceso emitido de Vault como una variable de ambiente: `VAULT_TOKEN`. +2. Agrega un paso para llamar a la API de Vault [Revocar un token (auto)](https://www.vaultproject.io/api/auth/token#revoke-a-token-self) para revocar el token de acceso. + +```yaml{:copy} +jobs: + retrieve-secret: + runs-on: ubuntu-latest + permissions: + id-token: write + contents: read + steps: + - name: Retrieve secret from Vault + uses: hashicorp/vault-action@v2.4.0 + with: + exportToken: true + method: jwt + url: + role: + secrets: + + - name: Use secret from Vault + run: | + # This step has access to the secret retrieved above; see hashicorp/vault-action for more details. + + - name: Revoke token + # This step always runs at the end regardless of the previous steps result + if: always() + run: | + curl -X POST -sv -H "X-Vault-Token: {% raw %}${{ env.VAULT_TOKEN }}{% endraw %}" \ + /v1/auth/token/revoke-self ``` diff --git a/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md b/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md index 1fb177d065..25ba9d8db0 100644 --- a/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md +++ b/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md @@ -23,11 +23,18 @@ topics: Rather than copying and pasting deployment jobs from one workflow to another, you can create a reusable workflow that performs the deployment steps. A reusable workflow can be used by another workflow if it meets one of the access requirements described in "[Reusing workflows](/actions/learn-github-actions/reusing-workflows#access-to-reusable-workflows)." -When combined with OpenID Connect (OIDC), reusable workflows let you enforce consistent deployments across your repository, organization, or enterprise. You can do this by defining trust conditions on cloud roles based on reusable workflows. +You should be familiar with the concepts described in "[Reusing workflows](/actions/learn-github-actions/reusing-workflows" and "[About security hardening with OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)." -In order to create trust conditions based on reusable workflows, your cloud provider must support custom claims for `job_workflow_ref`. This allows your cloud provider to identify which repository the job originally came from. If your cloud provider only supports the standard claims (_audience_ and _subject_), it will not be able to determine that the job originated from the reusable workflow repository. Cloud providers that support `job_workflow_ref` include Google Cloud Platform and HashiCorp Vault. +## Defining the trust conditions -Before proceeding, you should be familiar with the concepts of [reusable workflows](/actions/learn-github-actions/reusing-workflows) and [OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect). +When combined with OpenID Connect (OIDC), reusable workflows let you enforce consistent deployments across your repository, organization, or enterprise. You can do this by defining trust conditions on cloud roles based on reusable workflows. The available options will vary depending on your cloud provider: + +- **Using `job_workflow_ref`**: + - To create trust conditions based on reusable workflows, your cloud provider must support custom claims for `job_workflow_ref`. This allows your cloud provider to identify which repository the job originally came from. + - For clouds that only support the standard claims (audience (`aud`) and subject (`sub`)), you can use the API to customize the `sub` claim to include `job_workflow_ref`. For more information, see "[Customizing the token claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". Support for custom claims is currently available for Google Cloud Platform and HashiCorp Vault. + +- **Customizing the token claims**: + - You can configure more granular trust conditions by customizing the issuer (`iss`) and subject (`sub`) claims included with the JWT. For more information, see "[Customizing the token claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". ## How the token works with reusable workflows diff --git a/translations/es-ES/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md b/translations/es-ES/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md index d1601bbd6d..35d45be725 100644 --- a/translations/es-ES/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md +++ b/translations/es-ES/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md @@ -18,15 +18,23 @@ shortTitle: Ejecutar la app del ejecutor al inicio {% capture service_first_step %}1. Detén la aplicación del ejecutor autoalojado si se está ejecutando actualmente.{% endcapture %} {% capture service_non_windows_intro_shell %}En la máquina del ejecutor, abre un shell en el directorio en el que instalaste la aplicación del ejecutor autoalojado. Usa los comandos que se indican a continuación para instalar y administrar el servicio de ejecutor autoalojado.{% endcapture %} -{% capture service_nonwindows_intro %} Debes agregar un ejecutor a {% data variables.product.product_name %} antes de que puedas configurar la aplicación del ejecutor auto-hospedado como servicio. Para obtener más información, consulta "[Agregar ejecutores autoalojados](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)."{% endcapture %} -{% capture service_win_name %}actions.runner.*{% endcapture %} +{% capture service_nonwindows_intro %} + +{% note %} + +**Note:** You must add a runner to {% data variables.product.product_name %} before you can configure the self-hosted runner application as a service. Para obtener más información, consulta "[Agregar ejecutores autoalojados](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)". + +{% endnote %} +{% endcapture %} + +{% capture service_win_name %}actions.runner.*{% endcapture %} {% linux %} {{ service_nonwindows_intro }} -Para los sistemas Linux que usan `systemd`, puedes usar el script `svc.sh` distribuido con la aplicación del ejecutor autoalojado para instalar y administrar el uso de la aplicación como un servicio. +For Linux systems that use `systemd`, you can use the `svc.sh` script that is created after successfully adding the runner to install and manage using the application as a service. {{ service_non_windows_intro_shell }} diff --git a/translations/es-ES/content/actions/learn-github-actions/contexts.md b/translations/es-ES/content/actions/learn-github-actions/contexts.md index 2cd8c3d9ac..a8abf6ce7e 100644 --- a/translations/es-ES/content/actions/learn-github-actions/contexts.md +++ b/translations/es-ES/content/actions/learn-github-actions/contexts.md @@ -38,6 +38,8 @@ You can access contexts using the expression syntax. For more information, see " | `github` | `object` | Information about the workflow run. For more information, see [`github` context](#github-context). | | `env` | `object` | Contains environment variables set in a workflow, job, or step. For more information, see [`env` context](#env-context). | | `job` | `object` | Information about the currently running job. For more information, see [`job` context](#job-context). | +{%- ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} +| `jobs` | `object` | For reusable workflows only, contains outputs of jobs from the reusable workflow. For more information, see [`jobs` context](#jobs-context). |{% endif %} | `steps` | `object` | Information about the steps that have been run in the current job. For more information, see [`steps` context](#steps-context). | | `runner` | `object` | Information about the runner that is running the current job. For more information, see [`runner` context](#runner-context). | | `secrets` | `object` | Contains the names and values of secrets that are available to a workflow run. For more information, see [`secrets` context](#secrets-context). | @@ -87,7 +89,7 @@ The following table indicates where each context and special function can be use | jobs.<job_id>.name | github, needs, strategy, matrix, inputs | | | jobs.<job_id>.outputs.<output_id> | github, needs, strategy, matrix, job, runner, env, secrets, steps, inputs | | | jobs.<job_id>.runs-on | github, needs, strategy, matrix, inputs | | -| jobs.<job_id>.secrets.<secrets_id> | github, needs, secrets{% ifversion actions-unified-inputs %}, inputs{% endif %} | | +| jobs.<job_id>.secrets.<secrets_id> | github, needs,{% ifversion actions-reusable-workflow-matrix %} strategy, matrix,{% endif %} secrets{% ifversion actions-unified-inputs %}, inputs{% endif %} | | | jobs.<job_id>.services | github, needs, strategy, matrix, inputs | | | jobs.<job_id>.services.<service_id>.credentials | github, needs, strategy, matrix, env, secrets, inputs | | | jobs.<job_id>.services.<service_id>.env.<env_id> | github, needs, strategy, matrix, job, runner, env, secrets, inputs | | @@ -101,7 +103,7 @@ The following table indicates where each context and special function can be use | jobs.<job_id>.steps.working-directory | github, needs, strategy, matrix, job, runner, env, secrets, steps, inputs | hashFiles | | jobs.<job_id>.strategy | github, needs, inputs | | | jobs.<job_id>.timeout-minutes | github, needs, strategy, matrix, inputs | | -| jobs.<job_id>.with.<with_id> | github, needs{% ifversion actions-unified-inputs %}, inputs{% endif %} | | +| jobs.<job_id>.with.<with_id> | github, needs{% ifversion actions-reusable-workflow-matrix %}, strategy, matrix{% endif %}{% ifversion actions-unified-inputs %}, inputs{% endif %} | | | on.workflow_call.inputs.<inputs_id>.default | github{% ifversion actions-unified-inputs %}, inputs{% endif %} | | | on.workflow_call.outputs.<output_id>.value | github, jobs, inputs | | {% else %} @@ -404,6 +406,72 @@ jobs: - run: ./run-tests ``` +{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} + +## `jobs` context + +The `jobs` context is only available in reusable workflows, and can only be used to set outputs for a reusable workflow. For more information, see "[Reusing workflows](/actions/using-workflows/reusing-workflows#using-outputs-from-a-reusable-workflow)." + +| Property name | Type | Description | +|---------------|------|-------------| +| `jobs` | `object` | This is only available in reusable workflows, and can only be used to set outputs for a reusable workflow. This object contains all the properties listed below. +| `jobs..result` | `string` | The result of a job in the reusable workflow. Possible values are `success`, `failure`, `cancelled`, or `skipped`. | +| `jobs..outputs` | `object` | The set of outputs of a job in a reusable workflow. | +| `jobs..outputs.` | `string` | The value of a specific output for a job in a reusable workflow. | + +### Example contents of the `jobs` context + +This example `jobs` context contains the result and outputs of a job from a reusable workflow run. + +```json +{ + example_job: { + result: success, + outputs: { + output1: hello, + output2: world + } + } +} +``` + +### Example usage of the `jobs` context + +This example reusable workflow uses the `jobs` context to set outputs for the reusable workflow. Note how the outputs flow up from the steps, to the job, then to the `workflow_call` trigger. For more information, see "[Reusing workflows](/actions/using-workflows/reusing-workflows#using-outputs-from-a-reusable-workflow)." + +{% raw %} +```yaml{:copy} +name: Reusable workflow + +on: + workflow_call: + # Map the workflow outputs to job outputs + outputs: + firstword: + description: "The first output string" + value: ${{ jobs.example_job.outputs.output1 }} + secondword: + description: "The second output string" + value: ${{ jobs.example_job.outputs.output2 }} + +jobs: + example_job: + name: Generate output + runs-on: ubuntu-latest + # Map the job outputs to step outputs + outputs: + output1: ${{ steps.step1.outputs.firstword }} + output2: ${{ steps.step2.outputs.secondword }} + steps: + - id: step1 + run: echo "::set-output name=firstword::hello" + - id: step2 + run: echo "::set-output name=secondword::world" +``` +{% endraw %} + +{% endif %} + ## `steps` context The `steps` context contains information about the steps in the current job that have an [`id`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsid) specified and have already run. diff --git a/translations/es-ES/content/actions/learn-github-actions/expressions.md b/translations/es-ES/content/actions/learn-github-actions/expressions.md index df7fc1511c..f0522a65bc 100644 --- a/translations/es-ES/content/actions/learn-github-actions/expressions.md +++ b/translations/es-ES/content/actions/learn-github-actions/expressions.md @@ -129,17 +129,17 @@ Arroja `true` si `search` contiene `item`. Si `search` es una matriz, esta funci `contains('Hello world', 'llo')` arroja `true`. -#### Example using an object filter +#### Ejemplo utilizando un filtro de objeto `contains(github.event.issue.labels.*.name, 'bug')` returns `true` if the issue related to the event has a label "bug". -For more information, see "[Object filters](#object-filters)." +Para obtener más información, consulta la sección "[Filtros de objeto](#object-filters)". -#### Example matching an array of strings +#### Ejemplo empatando un arreglo de secuencias -Instead of writing `github.event_name == "push" || github.event_name == "pull_request"`, you can use `contains()` with `fromJson()` to check if an array of strings contains an `item`. +En vez de escribir `github.event_name == "push" || github.event_name == "pull_request"`, puedes utilizar `contains()` con `fromJson()` para verificar si un arreglo de secuencias contiene un `item`. -For example, `contains(fromJson('["push", "pull_request"]'), github.event_name)` returns `true` if `github.event_name` is "push" or "pull_request". +Por ejemplo, `contains(fromJson('["push", "pull_request"]'), github.event_name)` devuelve `true` si `github.event_name` es "push" o "pull_request". ### startsWith diff --git a/translations/es-ES/content/actions/learn-github-actions/understanding-github-actions.md b/translations/es-ES/content/actions/learn-github-actions/understanding-github-actions.md index e269783393..8fb0045e0d 100644 --- a/translations/es-ES/content/actions/learn-github-actions/understanding-github-actions.md +++ b/translations/es-ES/content/actions/learn-github-actions/understanding-github-actions.md @@ -93,7 +93,7 @@ Para obtener más información, consulta la sección "[Crear acciones](/actions/ - Para seguir aprendiendo sobre las {% data variables.product.prodname_actions %}, consulta la sección "[Encontrar y personalizar las acciones](/actions/learn-github-actions/finding-and-customizing-actions)". {% ifversion fpt or ghec or ghes %} -- Para entender cómo funciona la facturación de las {% data variables.product.prodname_actions %}, consulta la sección "[Acerca de la facturación para las {% data variables.product.prodname_actions %}](/actions/reference/usage-limits-billing-and-administration#about-billing-for-github-actions)". +- Para entender cómo funciona la facturación de las {% data variables.product.prodname_actions %}, consulta la sección "[Acerca de la facturación para las {% data variables.product.prodname_actions %}](/actions/reference/usage-limits-billing-and-administration#about-billing-for-github-actions)." {% endif %} ## Contactar con soporte técnico diff --git a/translations/es-ES/content/actions/publishing-packages/publishing-nodejs-packages.md b/translations/es-ES/content/actions/publishing-packages/publishing-nodejs-packages.md index bb16664970..2c2330de27 100644 --- a/translations/es-ES/content/actions/publishing-packages/publishing-nodejs-packages.md +++ b/translations/es-ES/content/actions/publishing-packages/publishing-nodejs-packages.md @@ -98,9 +98,9 @@ Cada vez que creas un lanzamiento nuevo, puedes desencadenar un flujo de trabajo ### Configurar el repositorio de destino -Si no proporcionas la clave del `repository` en tu archivo *package.json*, entonces el {% data variables.product.prodname_registry %} publicará un paquete en el repositorio de {% data variables.product.prodname_dotcom %} que especifiques en el campo `name` del archivo *package.json*. Por ejemplo, un paquete denominado `@my-org/test` se publicará en el repositorio `my-org/test` de {% data variables.product.prodname_dotcom %}. +Linking your package to {% data variables.product.prodname_registry %} using the `repository` key is optional. If you choose not to provide the `repository` key in your *package.json* file, then {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the `name` field of the *package.json* file. Por ejemplo, un paquete denominado `@my-org/test` se publicará en el repositorio `my-org/test` de {% data variables.product.prodname_dotcom %}. If the `url` specified in the `repository` key is invalid, your package may still be published however it won't be linked to the repository source as intended. -Sin embargo, si no proporcionas la clave del `repository`, entonces el repositorio en esa clave se utilizará como el registro de npm de destino para el {% data variables.product.prodname_registry %}. Por ejemplo, el publicar el siguiente *package.json* dará como resultado un paquete denominado `my-amazing-package` que se publicará en el repositorio `octocat/my-other-repo` de {% data variables.product.prodname_dotcom %}. +If you do provide the `repository` key in your *package.json* file, then the repository in that key is used as the destination npm registry for {% data variables.product.prodname_registry %}. Por ejemplo, el publicar el siguiente *package.json* dará como resultado un paquete denominado `my-amazing-package` que se publicará en el repositorio `octocat/my-other-repo` de {% data variables.product.prodname_dotcom %}. Once published, only the repository source is updated, and the package doesn't inherit any permissions from the destination repository. ```json { diff --git a/translations/es-ES/content/actions/using-workflows/about-workflows.md b/translations/es-ES/content/actions/using-workflows/about-workflows.md index 4706a7fb4a..d86a02068f 100644 --- a/translations/es-ES/content/actions/using-workflows/about-workflows.md +++ b/translations/es-ES/content/actions/using-workflows/about-workflows.md @@ -1,7 +1,7 @@ --- title: Acerca de los flujos de trabajo shortTitle: Acerca de los flujos de trabajo -intro: 'Get a high level overview {% data variables.product.prodname_actions %} workflows, including triggers, syntax, and advanced features.' +intro: 'Obtén flujos de trabajo de {% data variables.product.prodname_actions %} de resumen de alto nivel, incluyendo activadores, sintaxis y características avanzadas.' versions: fpt: '*' ghes: '*' @@ -20,15 +20,15 @@ miniTocMaxHeadingLevel: 3 {% data reusables.actions.about-workflows-long %} -## Workflow basics +## Puntos básicos de los flujos de trabajo -A workflow must contain the following basic components: +Un flujo de trabajo debe contener los siguientes componentes básicos: -1. One or more _events_ that will trigger the workflow. -1. One or more _jobs_, each of which will execute on a _runner_ machine and run a series of one or more _steps_. -1. Each step can either run a script that you define or run an action, which is a reusable extension that can simplify your workflow. +1. Uno o más _eventos_ que activarán el flujo de trabajo. +1. Uno o más _jobs_, cada uno de los cuales se ejecutará en una máquina _ejecutora_ y ejecutará una serie de uno o más _pasos_. +1. Cada paso puede ya sea ejecutar un script que defines o ejecutar una acción, la cual es una extensión reutilizable que puede simplificar tu flujo de trabajo. -For more information on these basic components, see "[Understanding GitHub Actions](/actions/learn-github-actions/understanding-github-actions#the-components-of-github-actions)." +Para obtener más información sobre estos componentes básicos, consulta la sección "[Entender las GitHub Actions](/actions/learn-github-actions/understanding-github-actions#the-components-of-github-actions)". ![Resumen del flujo de trabajo](/assets/images/help/images/overview-actions-simple.png) @@ -36,32 +36,32 @@ For more information on these basic components, see "[Understanding GitHub Actio {% data reusables.actions.about-triggers %} -For more information, see "[Triggering a workflow](/actions/using-workflows/triggering-a-workflow)", and for a full list of events, see "[Events that trigger workflows](/actions/using-workflows/events-that-trigger-workflows)." +Para obtener más información, consulta la sección "[Activar un flujo de trabajo](/actions/using-workflows/triggering-a-workflow)" y para encontrar una lista completa de eventos, consulta la sección "[Eventos que activan flujos de trabajo](/actions/using-workflows/events-that-trigger-workflows)". ## Sintaxis de flujos de trabajo -Workflow are defined using YAML. For the full reference of the YAML syntax for authoring workflows, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#about-yaml-syntax-for-workflows)." +Los flujos de trabajo se definen utilizando YAML. Para encontrar una referencia completa de la sintaxis de YAML para flujos de trabajo de creación, consulta la sección "[Sintaxis de fluljo de trabajo para GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#about-yaml-syntax-for-workflows)". {% data reusables.actions.workflow-basic-example-and-explanation %} -For more on managing workflow runs, such as re-running, cancelling, or deleting a workflow run, see "[Managing workflow runs](/actions/managing-workflow-runs)." +Para ver más información sobre cómo manejar las ejecuciones de flujo de trabajo tales como re-ejecutar, cancelar o borrar una ejecución de flujo de trabajo, consulta la sección "[Administrar las ejecuciones de flujo de trabajo](/actions/managing-workflow-runs)". ## Utilizar flujos de trabajo iniciales {% data reusables.actions.workflow-template-overview %} -For more information on using and creating starter workflows, see "[Using starter workflows](/actions/using-workflows/using-starter-workflows)" and "[Creating starter workflows for your organization](/actions/using-workflows/creating-starter-workflows-for-your-organization)." +Para obtener más información sobre cómo utilizar y crear flujos de trabajo iniciales, consulta las secciones "[Utilizar flujos de trabajo iniciales](/actions/using-workflows/using-starter-workflows)" y "[Crear flujos de trabajo iniciales para tu organización](/actions/using-workflows/creating-starter-workflows-for-your-organization)". ## Características avanzadas de los flujos de trabajo -This section briefly describes some of the advanced features of {% data variables.product.prodname_actions %} that help you create more complex workflows. +Esta sección describe brevemente algunas de las características avanzadas de {% data variables.product.prodname_actions %} que te ayudan a crear flujos de trabajo más complejos. ### Almacenar secretos -Si tus flujos de trabajo utilizan datos sensibles tales como contraseñas o certificados, puedes guardarlos en {% data variables.product.prodname_dotcom %} como _secretos_ y luego usarlos en tus flujos de trabajo como variables de ambiente. This means that you will be able to create and share workflows without having to embed sensitive values directly in the workflow's YAML source. +Si tus flujos de trabajo utilizan datos sensibles tales como contraseñas o certificados, puedes guardarlos en {% data variables.product.prodname_dotcom %} como _secretos_ y luego usarlos en tus flujos de trabajo como variables de ambiente. Esto significa que podrás crear y compartir flujos de trabajo sin tener que embeber valores sensibles directamente en la fuente de YAML del flujo de trabajo. -This example job demonstrates how to reference an existing secret as an environment variable, and send it as a parameter to an example command. +Este job de ejemplo demuestra como referenciar un secreto existente como una variable de ambiente y enviarlo como un parámetro a un comando de ejemplo. {% raw %} ```yaml @@ -81,7 +81,7 @@ Para obtener más información, consulta la sección "[Secretos cifrados](/actio ### Crear jobs dependientes -Predeterminadamente, los jobs en tu flujo de trabajo se ejecutan todos en paralelo y al mismo tiempo. If you have a job that must only run after another job has completed, you can use the `needs` keyword to create this dependency. If one of the jobs fails, all dependent jobs are skipped; however, if you need the jobs to continue, you can define this using the `if` conditional statement. +Predeterminadamente, los jobs en tu flujo de trabajo se ejecutan todos en paralelo y al mismo tiempo. Si tienes un job que solo se debe ejecutar después de que se complete otro, puedes utilizar la palabra clave `needs` para crear esta dependencia. Si uno de los jobs falla, todos los jobs dependientes se omiten; sin embargo, si necesites que estos continúen, puedes definir esto utilizando la declaración condicional `if`. En este ejemplo, los jobs de `setup`, `build`, y `test` se ejecutan en serie, y `build` y `test` son dependientes de que el job que las precede se complete con éxito: @@ -107,7 +107,7 @@ Para obtener más información, consulta la sección "[Definir los jobs de prerr ### Utilizar una matriz -{% data reusables.actions.jobs.about-matrix-strategy %} The matrix is created using the `strategy` keyword, which receives the build options as an array. For example, this matrix will run the job multiple times, using different versions of Node.js: +{% data reusables.actions.jobs.about-matrix-strategy %} La matriz se crea utilizando la palabra clave `strategy`, la cual recibe las opciones de compilación como un arreglo. Por ejemplo, esta matriz ejecutará el job varias veces, utilizando versiones diferentes de Node.js: ```yaml jobs: @@ -127,7 +127,7 @@ Para obtener más información, consulta la sección "[Utilizar una matriz para {% ifversion actions-caching %} ### Almacenar dependencias en caché -If your jobs regularly reuse dependencies, you can consider caching these files to help improve performance. Una vez que se crea el caché, estará disponible para todos los flujos de trabajo en el mismo repositorio. +Si tus jobs utilizan dependencias con frecuencia, puedes considerar almacenar estos archivos en caché para ayudar a mejorar el desempeño. Una vez que se crea el caché, estará disponible para todos los flujos de trabajo en el mismo repositorio. Este ejemplo ilustra cómo almacenar el directorio `~/.npm` en el caché: @@ -173,7 +173,7 @@ jobs: POSTGRES_PORT: 5432 ``` -For more information, see "[Using containerized services](/actions/using-containerized-services)." +Para obtener más información, consulta la sección "[Utilizar servicios en contenedores](/actions/using-containerized-services)". ### Utilizar etiquetas para enrutar los flujos de trabajo @@ -187,12 +187,12 @@ jobs: runs-on: [self-hosted, linux, x64, gpu] ``` -Un flujo de trabajo solo se ejecutará en un ejecutor que tenga todas las etiquetas en el arreglo `runs-on`. El job irá preferencialmente a un ejecutor auto-hospedado inactivo con las etiquetas especificadas. {% ifversion fpt or ghec %}If none are available and a {% data variables.product.prodname_dotcom %}-hosted runner with the specified labels exists, the job will go to a {% data variables.product.prodname_dotcom %}-hosted runner.{% endif %} +Un flujo de trabajo solo se ejecutará en un ejecutor que tenga todas las etiquetas en el arreglo `runs-on`. El job irá preferencialmente a un ejecutor auto-hospedado inactivo con las etiquetas especificadas. {% ifversion fpt or ghec %}Si ninguno está disponible y existe un ejecutor hospedado en {% data variables.product.prodname_dotcom %} con las etiquetes especificadas, el job irá al ejecutor hospedado en {% data variables.product.prodname_dotcom %}.{% endif %} -To learn more about self-hosted runner labels, see "[Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners)." +Para aprender más sobre las etiquetas de ejecución auto-hospedadas, consulta la sección "[Utilizar etiquetas con los ejecutores auto-hospedados](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners)". {% ifversion fpt or ghec %} -To learn more about {% data variables.product.prodname_dotcom %}-hosted runner labels, see "[Supported runners and hardware resources](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources)." +Para aprender más sobre las etiquetas de ejecutores hospedados en {% data variables.product.prodname_dotcom %}, consulta la sección "[Recursos de hardware y ejecutores compatibles](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources)". {% endif %} {% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} @@ -202,4 +202,4 @@ To learn more about {% data variables.product.prodname_dotcom %}-hosted runner l ### Utilizar ambientes -You can configure environments with protection rules and secrets to control the execution of jobs in a workflow. Cad job en un flujo de trabajo puede referenciar un solo ambiente. Cualquier regla de protección que se configure para el ambiente debe pasar antes de que un job que referencia al ambiente se envíe a un ejecutor. Para obtener más información, consulta la sección "[Utilizar ambientes para despliegue](/actions/deployment/using-environments-for-deployment)". +Puedes configurar ambientes con reglas de protección y secretos para controlar la ejecución de jobs en un flujo de trabajo. Cad job en un flujo de trabajo puede referenciar un solo ambiente. Cualquier regla de protección que se configure para el ambiente debe pasar antes de que un job que referencia al ambiente se envíe a un ejecutor. Para obtener más información, consulta la sección "[Utilizar ambientes para despliegue](/actions/deployment/using-environments-for-deployment)". diff --git a/translations/es-ES/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md b/translations/es-ES/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md index f43c7fb8f3..d353ce0f33 100644 --- a/translations/es-ES/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md +++ b/translations/es-ES/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md @@ -51,7 +51,7 @@ Para obtener más información sobre los artefactos de ejecución de flujos de t Un flujo de trabajo puede acceder y restaurar una caché creada en la rama actual, la rama base (incluidas las ramas base de los repositorios bifurcados) o la rama predeterminada (por lo general `main`). Por ejemplo, un caché creado en la rama predeterminada sería accesible desde cualquier solicitud de cambios. También, si la rama `feature-b` tiene la rama base `feature-a`, un flujo de trabajo activado en `feature-b` tendría acceso a las cachés creadas en la rama predeterminada (`main`), `feature-a` y `feature-b`. -Las restricciones de acceso proporcionan aislamiento y seguridad de caché al crear una frontera lógica entre las ramas diferentes. Por ejemplo, una solicitud de cambios para la rama `feature-c` (con la base `main`) no podría acceder a un caché que se creó para la rama `feature-a` (con la base `main`). +Access restrictions provide cache isolation and security by creating a logical boundary between different branches or tags. Por ejemplo, una solicitud de cambios para la rama `feature-c` (con la base `main`) no podría acceder a un caché que se creó para la rama `feature-a` (con la base `main`). On similar lines, a cache created for the tag `release-a` (from the base `main`) would not be accessible to a workflow triggered for the tag `release-b` (with the base `main`). Los flujos de trabajo múltiples dentro de un repositorio comparten entradas de caché. Puede accederse a un caché que se crea para una rama dentro de un flujo de trabajo y se puede establecer desde otro flujo de trabajo para el mismo repositorio y rama. @@ -172,7 +172,7 @@ npm-d5ea0750 ### Utilizar la salida de la acción `cache` -Puedes utilizar la salida de la acción `cache` para hacer algo con base en si se suscita una ocurrencia u omisión en caché. When an exact match is found for a cache for the specified `key`, the `cache-hit` output is set to `true`. +Puedes utilizar la salida de la acción `cache` para hacer algo con base en si se suscita una ocurrencia u omisión en caché. Cuando se encuentra una coincidencia exacta para un caché para la `key` especificada, la salida `cache-hit` se configura como `true`. En el flujo de trabajo del ejemplo anterior, hay un paso que lista el estado de los módulos de nodo si se suscitó una omisión de caché: diff --git a/translations/es-ES/content/actions/using-workflows/events-that-trigger-workflows.md b/translations/es-ES/content/actions/using-workflows/events-that-trigger-workflows.md index 4a10751f7a..713a6b936d 100644 --- a/translations/es-ES/content/actions/using-workflows/events-that-trigger-workflows.md +++ b/translations/es-ES/content/actions/using-workflows/events-that-trigger-workflows.md @@ -812,6 +812,8 @@ Ejecuta tu flujo de trabajo cuando ocurre alguna actividad en la solicitud de ca Este evento se ejecuta en el contexto de la base de la solicitud de cambios en vez de en aquel de la confirmación de fusión, como lo hace el evento `pull_request`. Esto previene la ejecución del código no seguro desde el encabezado de la solicitud de cambios que pudiera alterar tu repositorio o robar cualquier secreto que utilices en tu flujo de trabajo. Este evento permite que tu flujo de trabajo haga cosas como etiquetar o comentar en las solicitudes de cambios de las bifurcaciones. Evita utilizar este evento si necesitas compilar o ejecutar código desde la solicitud de cambios. +To ensure repository security, branches with names that match certain patterns (such as those which look similar to SHAs) may not trigger workflows with the `pull_request_target` event. + {% warning %} **Advertencia:** En el caso de los flujos de trabajo que se activan con el evento `pull_request_target`, se otorgarán permisos de lectura/escritura en el repositorio al `GITHUB_TOKEN` a menos de que se especifique la clave `permissions` y que el flujo de trabajo pueda acceder a los secretos, incluso cuando se activa desde una bifurcación. Aunque las ejecuciones de flujo de trabajo se ejecutan en el contexto de la base de la solicitud de cambios, debes asegurarte de que no revisas, compilas o ejecutas código no confiable desde ella con este evento. Adicionalmente, cualquier caché comparte el mismo alcance que la rama base. Para ayudar a prevenir el envenenamiento del caché, no debes guardarlo si existe la posibilidad de que su contenido se haya alterado. Para obtener más información, consulta la sección "[Mantener seguros tus GitHub Actions y flujos de trabajo: Prevenir solicitudes de pwn](https://securitylab.github.com/research/github-actions-preventing-pwn-requests)" en el sitio web de GitHub Security Lab. diff --git a/translations/es-ES/content/actions/using-workflows/reusing-workflows.md b/translations/es-ES/content/actions/using-workflows/reusing-workflows.md index d672e978a3..7fbf626fd9 100644 --- a/translations/es-ES/content/actions/using-workflows/reusing-workflows.md +++ b/translations/es-ES/content/actions/using-workflows/reusing-workflows.md @@ -39,7 +39,7 @@ Puedes ver los flujos de trabajo reutilizados que se referencian en tus flujos d ### Flujos de trabajo reutilizables e iniciales -Los flujos de trabajo iniciales permiten que toda persona en tu organización que tenga permiso para crear flujos de trabajo lo haga de forma más fácil y rápida. Cuando las personas crean un flujo de trabajo nuevo, pueden elegir un flujo de trabajo inicial y parte o todo el trabajo de escribir dicho flujo de trabajo se hará automáticamente. Dentro de un flujo de trabajo inicial, también puedes referenciar los flujos de trabajo reutilizables para hacer más fácil que las personas se beneficien de reutilizar el código de flujo de trabajo que se administra centralmente. Si utilizas un nombre de rama o etiqueta cuando referencias el flujo de trabajo reutilizable, puedes garantizar que todo aquél que reutilice ese flujo de trabajo siempre estará utilizando el mismo código de YAML. Sin embargo, si referencias un flujo de trabajo reutilizable mediante una etiqueta o rama, asegúrate de que puedas confiar en esa versión del flujo de trabajo. Para obtener más información, consulta la sección "[Fortalecimiento de seguridad para las {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions#reusing-third-party-workflows)". +Los flujos de trabajo iniciales permiten que toda persona en tu organización que tenga permiso para crear flujos de trabajo lo haga de forma más fácil y rápida. Cuando las personas crean un flujo de trabajo nuevo, pueden elegir un flujo de trabajo inicial y parte o todo el trabajo de escribir dicho flujo de trabajo se hará automáticamente. Dentro de un flujo de trabajo inicial, también puedes referenciar los flujos de trabajo reutilizables para hacer más fácil que las personas se beneficien de reutilizar el código de flujo de trabajo que se administra centralmente. Si utilizas un SHA de confirmación cuando referencias el flujo de trabajo reutilizable, puedes garantizar que cualquiera que utilice este flujo de trabajo siempre esté utilizando el mismo código de YAML. Sin embargo, si referencias un flujo de trabajo reutilizable mediante una etiqueta o rama, asegúrate de que puedas confiar en esa versión del flujo de trabajo. Para obtener más información, consulta la sección "[Fortalecimiento de seguridad para las {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions#reusing-third-party-workflows)". Para obtener más información, consulta la sección "[Crear flujos de trabajo iniciales para tu organización](/actions/learn-github-actions/creating-starter-workflows-for-your-organization)". @@ -69,10 +69,14 @@ Los flujos de trabajo llamados que pertenecen al mismo usuario u organización{% ## Limitaciones +{% ifversion nested-reusable-workflow %} +* Puedes conectar hasta cuatro niveles de flujos de trabajo. Para obtener más información, consulta la sección "[Llamar a un flujo de trabajo reutilizable anidado](#calling-a-nested-reusable-workflow)" +{% else %} * Los flujos de trabajo reutilizables no pueden llamar a otros que también sean reutilizables. +{% endif %} * Los flujos de trabajo solo podrán usar a los reutilizables que se encuentren almacenados en un repositorio privado en caso de que estos también se encuentren en el mismo repositorio. -* Ninguna variable de ambiente que se configure en un contexto de `env` que se defina a nivel del flujo de trabajo en aquél llamante se propagará al flujo llamado. Para obtener más información sobre el contexto `env`, consulta la sección "[Sintaxis de contexto y expresión para GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions#env-context)". -* La propiedad `strategy` no es compatible en ningún job que llame a un flujo de trabajo reutilizable. +* Ninguna variable de ambiente que se configure en un contexto de `env` que se defina a nivel del flujo de trabajo en aquél llamante se propagará al flujo llamado. Para obtener más información sobre el contexto `env`, consulta la sección "[Sintaxis de contexto y expresión para las GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions#env-context)".{% ifversion actions-reusable-workflow-matrix %}{% else %} +* La propiedad `strategy` no es compatible con ningún job que llame a un flujo de trabajo reutilizable.{% endif %} ## Crear un flujo de trabajo reutilizable @@ -105,7 +109,13 @@ Puedes definir entradas y secretos, las cuales pueden pasarse desde el flujo de {% endraw %} Para encontrar los detalles de la sintaxis para definir entradas y secretos, consulta [`on.workflow_call.inputs`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callinputs) y [`on.workflow_call.secrets`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callsecrets). {% ifversion actions-inherit-secrets-reusable-workflows %} -1. En el flujo de trabajo reutilizable, referencia la entrada o secreto que definiste en la clave `on` en el paso anterior. Si los secretos se heredan utilizando `secrets: inherit`, puedes referenciarlos incluso si no se definen en la clave `on`. +1. En el flujo de trabajo reutilizable, referencia la entrada o secreto que definiste en la clave `on` en el paso anterior. + + {% note %} + + **Nota**: Si los secretos se heredan utilizando `secrets: inherit` en el flujo de trabajo llamante, puedes referenciarlos incluso si no se definen explícitamente en la clave `on`. Para obtener más información, consultala sección "[Sintaxis de flujo de trabajo para GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit)". + + {% endnote %} {%- else %} 1. En el flujo de trabajo reutilizable, referencia la entrada o secreto que definiste en la clave `on` en el paso anterior. {%- endif %} @@ -164,7 +174,36 @@ jobs: token: ${{ secrets.token }} ``` {% endraw %} +{% ifversion actions-reusable-workflow-matrix %} +## Utilizar una estrategia de matriz con un flujo de trabajo reutilizable +Los jobs que utilizan la estrategia de matriz pueden llamar a un flujo de trabajo reutilizable. + +A matrix strategy lets you use variables in a single job definition to automatically create multiple job runs that are based on the combinations of the variables. Por ejemplo, puedes utilizar una estrategia de matriz para pasar entradas diferentes a un flujo de trabajo reutilizable. Para obtener más información sobre las matrices, consulta la sección "[Utilizar una matriz para tus jobs](/actions/using-jobs/using-a-matrix-for-your-jobs)". + +### Estrategia de matriz ejemplo con un flujo de trabajo reutilizable + +Este archivo de flujo de trabajo referencia el contexto de la matriz definiendo la variable `target` con los valores `[dev, stage, prod]`. The workflow will run three jobs, one for each value in the variable. El archivo de flujo de trabajo también llama a un flujo de trabajo reutilizable utilizando la palabra clave `uses`. + +{% raw %} +```yaml{:copy} +name: Reusable workflow with matrix strategy + +on: + push: + +jobs: + ReuseableMatrixJobForDeployment: + strategy: + matrix: + target: [dev, stage, prod] + uses: octocat/octo-repo/.github/workflows/deployment.yml@main + with: + target: ${{ matrix.target }} +``` +{% endraw %} + +{% endif %} ## Llamar a un flujo de trabajo reutilizable Se llama a un flujo de trabajo reutilizable utilizando la palabra clave `uses`. A diferencia de cuando utilizas acciones en un flujo de trabajo, los flujos de trabajo reutilizables se llaman directamente desde un job y no dentro de los pasos de un job. @@ -234,9 +273,61 @@ jobs: ``` {% endraw %} +{% ifversion nested-reusable-workflow %} +## Anidar los flujos de trabajo reutilizables + +Puedes conectar un máximo de cuatro niveles de flujos de trabajo; es decir, el flujo de trabajo llamante de nivel superior y hasta tres niveles de flujos de trabajo reutilizables. Por ejemplo: _caller-workflow.yml_ → _called-workflow-1.yml_ → _called-workflow-2.yml_ → _called-workflow-3.yml_. No se permiten bucles en el árbol de flujo de trabajo. + +Desde dentro de un flujo de trabajo reutilizable, puedes llamar a otro. + +{% raw %} +```yaml{:copy} +name: Reusable workflow + +on: + workflow_call: + +jobs: + call-another-reusable: + uses: octo-org/example-repo/.github/workflows/another-reusable.yml@v1 +``` +{% endraw %} + +### Pasar secretos a flujos de trabajo anidados + +Puedes utilizar `jobs..secrets` en un flujo de trabajo llamante para pasar secretos nombrados a un fluljo de trabajo directamente llamado. Como alternativa, puedes utilizar `jobs..secrets.inherit` para pasar todos los secretos de un flujo de trabajo llamante a un flujo de trabajo directamente llamado. Para obtener más información, consulta la sección anterior "[Pasar entradas y secretos a un flujo de trabajo retuilizable](/actions/using-workflows/reusing-workflows#passing-inputs-and-secrets-to-a-reusable-workflow)" y el artículo de referencia "[Sintaxis de flujo de trabajo para GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit)". Los secretos solo se pasan para a un flujo de trabajo llamado directamente para que, en la cadena de flujo de trabajo A > B > C, el flujo de trabajo C solo reciba los secretos de A si ya pasaron de A a B y luego de B a C. + +En el siguiente ejemplo, un flujo de trabajo A pasa todos su secretos al B utilizando la palabra clave `inherit`, pero el flujo B solo pasas un secreto a un flujo de trabajo C. Cualquiera de los otros secretos que pasaron a flujo de trabajo B no están disponibles para el flujo de trabajo C. + +{% raw %} +```yaml +jobs: + workflowA-calls-workflowB: + uses: octo-org/example-repo/.github/workflows/B.yml@main + secrets: inherit # pass all secrets +``` + +```yaml +jobs: + workflowB-calls-workflowC: + uses: different-org/example-repo/.github/workflows/C.yml@main + secrets: + envPAT: ${{ secrets.envPAT }} # pass just this secret +``` +{% endraw %} + +### Acceso y permisos + +Un flujo de trabajo que contiene flujos de trabajo reutilizables anidados fallará si ninguno de los flujos de trabajo anidados es inaccesible para el flujo de trabajo llamante inicial. Para obtener más información, consulta la sección "[Acceder a los flujos de trabajo reutilizables](/actions/using-workflows/reusing-workflows#access-to-reusable-workflows)". + +Los permisos de un `GITHUB_TOKEN` solo pueden ser iguales o más restrictivos en los flujos de trabajo anidados. Por ejemplo, en la cadena de flujo de trabajo A > B > C, si el flujo de trabajo A tiene permisos de token de `package: read`, entonces B y C no pueden tener el permiso `package: write`. Para obtener más información, consulta la sección "[Autenticación automática de tokens](/actions/security-guides/automatic-token-authentication)". +{% endif %} + ## Utilizar salidas desde un flujo de trabajo reutilizable -Un flujo de trabajo reutilizable podría generar datos que quieras utilizar en el flujo de trabajo llamante. Para utilizar estas salidas, debes especificarlas como las salidas del flujo de trabajo reutilizable. +Un flujo de trabajo reutilizable podría generar datos que quieras utilizar en el flujo de trabajo llamante. Para utilizar estas salidas, debes especificarlas como aquellas del flujo de trabajo reutilizable.{% ifversion actions-reusable-workflow-matrix %} + +Si un flujo de trabajo reutilizable que configura una salida se ejecuta con una estrategia de matriz, dicha salida será aquella que configure el último flujo de trabajo reutilizable de la matriz que se complete exitosamente y que de hecho configure un valor. Esto significa que, si el último flujo de trabajo reutilizable que se completa exitosamente configura una secuencia vacía para su salida y el segundo flujo de trabajo reutilizable que se completa con éxito configura un valor real para su salida, dicha salida contendrá el valor del penúltimo flujo de trabajo reutilizable que se complete.{% endif %} Los siguientes flujos de trabajo reutilizables tienen un solo job que contiene dos pasos. En cada uno de estos pasos, configuramos una sola palabra como la salida: "hello" y "world". En la sección de `outputs` del job, mapeamos estas salidas de paso a las salidas de jobs llamadas: `output1` y `output2`. En la sección de `on.workflow_call.outputs`, definimos entonces a las dos salidas del mismo flujo de trabajo, una llamada `firstword`, la cual mapeamos a `output1`, y otra llamada `secondword`, la cual mapeamos a `output2`. diff --git a/translations/es-ES/content/actions/using-workflows/workflow-syntax-for-github-actions.md b/translations/es-ES/content/actions/using-workflows/workflow-syntax-for-github-actions.md index 2607f856d8..f8ba221850 100644 --- a/translations/es-ES/content/actions/using-workflows/workflow-syntax-for-github-actions.md +++ b/translations/es-ES/content/actions/using-workflows/workflow-syntax-for-github-actions.md @@ -365,9 +365,9 @@ A name for your step to display on {% data variables.product.prodname_dotcom %}. Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a [published Docker container image](https://hub.docker.com/). -We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag number. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update. +We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update. - Using the commit SHA of a released action version is the safest for stability and security. -- Using the specific major action version allows you to receive critical fixes and security patches while still maintaining compatibility. It also assures that your workflow should still work. +- If the action publishes major version tags, you should expect to receive critical fixes and security patches while still retaining compatibility. Note that this behavior is at the discretion of the action's author. - Using the default branch of an action may be convenient, but if someone releases a new major version with a breaking change, your workflow could break. Some actions require inputs that you must set using the [`with`](#jobsjob_idstepswith) keyword. Review the action's README file to determine the inputs required. @@ -1037,15 +1037,23 @@ You can use special characters in path, branch, and tag filters. - `[]` Matches one character listed in the brackets or included in ranges. Ranges can only include `a-z`, `A-Z`, and `0-9`. For example, the range`[0-9a-z]` matches any digit or lowercase letter. For example, `[CB]at` matches `Cat` or `Bat` and `[1-2]00` matches `100` and `200`. - `!`: At the start of a pattern makes it negate previous positive patterns. It has no special meaning if not the first character. -The characters `*`, `[`, and `!` are special characters in YAML. If you start a pattern with `*`, `[`, or `!`, you must enclose the pattern in quotes. +The characters `*`, `[`, and `!` are special characters in YAML. If you start a pattern with `*`, `[`, or `!`, you must enclose the pattern in quotes. Also, if you use a [flow sequence](https://yaml.org/spec/1.2.2/#flow-sequences) with a pattern containing `[` and/or `]`, the pattern must be enclosed in quotes. ```yaml # Valid -- '**/README.md' +branches: + - '**/README.md' # Invalid - creates a parse error that # prevents your workflow from running. -- **/README.md +branches: + - **/README.md + +# Valid +branches: [ main, 'release/v[0-9].[0-9]' ] + +# Invalid - creates a parse error +branches: [ main, release/v[0-9].[0-9] ] ``` For more information about branch, tag, and path filter syntax, see "[`on..`](#onpushbranchestagsbranches-ignoretags-ignore)", "[`on..`](#onpull_requestpull_request_targetbranchesbranches-ignore)", and "[`on..paths`](#onpushpull_requestpull_request_targetpathspaths-ignore)." diff --git a/translations/es-ES/content/admin/configuration/configuring-github-connect/about-github-connect.md b/translations/es-ES/content/admin/configuration/configuring-github-connect/about-github-connect.md index ca217cd8a9..fa2ab3e4f8 100644 --- a/translations/es-ES/content/admin/configuration/configuring-github-connect/about-github-connect.md +++ b/translations/es-ES/content/admin/configuration/configuring-github-connect/about-github-connect.md @@ -8,6 +8,7 @@ type: overview topics: - Enterprise - GitHub Connect +miniTocMaxHeadingLevel: 3 --- ## Acerca de {% data variables.product.prodname_github_connect %} @@ -37,6 +38,16 @@ Después de que configuras la conexión entre {% data variables.product.product_ ## Transmisión de datos para {% data variables.product.prodname_github_connect %} +When {% data variables.product.prodname_github_connect %} is enabled, a record on {% data variables.product.prodname_ghe_cloud %} stores information about the connection. If you enable individual features of {% data variables.product.prodname_github_connect %}, additional data is transmitted. + +{% note %} + +**Nota:** Jamás se transmitirán repositorios, propuestas o solicitudes de cambios desde {% data variables.product.product_name %} hacia {% data variables.product.prodname_dotcom_the_website %} mediante {% data variables.product.prodname_github_connect %}. + +{% endnote %} + +### Data transmitted when {% data variables.product.prodname_github_connect %} is enabled + Cuando habilitas {% data variables.product.prodname_github_connect %} o características específicas de {% data variables.product.prodname_github_connect %}, un registro en las tiendas de {% data variables.product.prodname_ghe_cloud %} almacena la siguiente información sobre la conexión. {% ifversion ghes %} - La parte pública de la clave de tu licencia {% data variables.product.prodname_ghe_server %} @@ -54,23 +65,19 @@ Cuando habilitas {% data variables.product.prodname_github_connect %} o caracter {% data variables.product.prodname_github_connect %} sincroniza los datos de conexión anteriores entre {% data variables.product.product_location %}y {% data variables.product.prodname_ghe_cloud %} semanalmente, desde el día y hora aproximada en que se habilitó {% data variables.product.prodname_github_connect %}. -{% note %} - -**Nota:** Jamás se transmitirán repositorios, propuestas o solicitudes de cambios desde {% data variables.product.product_name %} hacia {% data variables.product.prodname_dotcom_the_website %} mediante {% data variables.product.prodname_github_connect %}. - -{% endnote %} +### Data transmitted by individual features of {% data variables.product.prodname_github_connect %} Los datos adicionales se transmiten si habilitas las características individuales de {% data variables.product.prodname_github_connect %}. -| Característica | Datos | ¿De qué forma fluyen los datos? | ¿Dónde se utilizan los datos? | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------- |{% ifversion ghes %} -| Sincronización automática de licencias de usuario | Cada ID de usuario y dirección de correo electrónico de un usuario de {% data variables.product.product_name %} | Desde {% data variables.product.product_name %} hacia {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %} |{% endif %}{% ifversion ghes or ghae %} -| {% data variables.product.prodname_dependabot_alerts %} | Alertas de vulnerabilidades | Desde {% data variables.product.prodname_dotcom_the_website %} hasta {% data variables.product.product_name %} | {% data variables.product.product_name %} |{% endif %}{% ifversion dependabot-updates-github-connect %} -| {% data variables.product.prodname_dependabot_updates %} | Las dependencias y los metadatos de cada repositorio de una dependencia

    Si una dependencia se almacena en un repositorio privado de {% data variables.product.prodname_dotcom_the_website %}, los datos solo se transmitirán si el {% data variables.product.prodname_dependabot %} se configura y se autoriza su acceso a dicho repositorio. | Desde {% data variables.product.prodname_dotcom_the_website %} hasta {% data variables.product.product_name %} | {% data variables.product.product_name %} {% endif %} -| Acciones de {% data variables.product.prodname_dotcom_the_website %} | Nombre de la acción, acción (archivo YAML de {% data variables.product.prodname_marketplace %}) | De {% data variables.product.prodname_dotcom_the_website %} a {% data variables.product.product_name %}

    De {% data variables.product.product_name %} a {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %}{% ifversion server-statistics %} -| {% data variables.product.prodname_server_statistics %} | Métricas de uso agregadas de {% data variables.product.prodname_ghe_server %}
    Para la lista de métricas agregadas recolectadas, consulta la sección "[Datos recolectados de {% data variables.product.prodname_server_statistics %}](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)". | Desde {% data variables.product.product_name %} hacia {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %}{% endif %} -| Búsqueda unificada | Términos de búsqueda, resultados de búsqueda | De {% data variables.product.prodname_dotcom_the_website %} a {% data variables.product.product_name %}

    De {% data variables.product.product_name %} a {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %} -| Contribuciones unificadas | Conteo de contribuciones | Desde {% data variables.product.product_name %} hacia {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.prodname_dotcom_the_website %} +| Característica | Datos | ¿De qué forma fluyen los datos? | ¿Dónde se utilizan los datos? | +| ---------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------- |{% ifversion ghes %} +| Sincronización automática de licencias de usuario | Cada ID de usuario y dirección de correo electrónico de un usuario de {% data variables.product.product_name %} | Desde {% data variables.product.product_name %} hacia {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %} |{% endif %}{% ifversion ghes or ghae %} +| {% data variables.product.prodname_dependabot_alerts %} | Alertas de vulnerabilidades | Desde {% data variables.product.prodname_dotcom_the_website %} hasta {% data variables.product.product_name %} | {% data variables.product.product_name %} |{% endif %}{% ifversion dependabot-updates-github-connect %} +| {% data variables.product.prodname_dependabot_updates %} | Las dependencias y los metadatos de cada repositorio de una dependencia

    Si una dependencia se almacena en un repositorio privado de {% data variables.product.prodname_dotcom_the_website %}, los datos solo se transmitirán si el {% data variables.product.prodname_dependabot %} se configura y se autoriza su acceso a dicho repositorio. | Desde {% data variables.product.prodname_dotcom_the_website %} hasta {% data variables.product.product_name %} | {% data variables.product.product_name %} {% endif %} +| Acciones de {% data variables.product.prodname_dotcom_the_website %} | Nombre de la acción, acción (archivo YAML de {% data variables.product.prodname_marketplace %}) | De {% data variables.product.prodname_dotcom_the_website %} a {% data variables.product.product_name %}

    De {% data variables.product.product_name %} a {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %}{% ifversion server-statistics %} +| {% data variables.product.prodname_server_statistics %} | Aggregate metrics about your usage of {% data variables.product.prodname_ghe_server %}. For the complete list of metrics, see "[About {% data variables.product.prodname_server_statistics %}](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)." | Desde {% data variables.product.product_name %} hacia {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %}{% endif %} +| Búsqueda unificada | Términos de búsqueda, resultados de búsqueda | De {% data variables.product.prodname_dotcom_the_website %} a {% data variables.product.product_name %}

    De {% data variables.product.product_name %} a {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %} +| Contribuciones unificadas | Conteo de contribuciones | Desde {% data variables.product.product_name %} hacia {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.prodname_dotcom_the_website %} ## Leer más diff --git a/translations/es-ES/content/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise.md b/translations/es-ES/content/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise.md index a9c9b79a9a..13d6b1583a 100644 --- a/translations/es-ES/content/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise.md +++ b/translations/es-ES/content/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise.md @@ -12,9 +12,9 @@ shortTitle: Estadísticas del servidor ## Acerca de las {% data variables.product.prodname_server_statistics %} -{% data variables.product.prodname_server_statistics %} collects aggregate usage data from {% data variables.product.product_location %}, which you can use to better anticipate the needs of your organization, understand how your team works, and show the value you get from {% data variables.product.prodname_ghe_server %}. +{% data variables.product.prodname_server_statistics %} recopila los datos de uso agregado de {% data variables.product.product_location %}, lo que te permite anticipar las necesidades de tu organización de una forma mejor, entender cómo trabaja tu equipo y mostrar el valor que obtienes de {% data variables.product.prodname_ghe_server %}. -{% data variables.product.prodname_server_statistics %} only collects certain aggregate metrics on repositories, issues, pull requests, and other features.{% data variables.product.prodname_dotcom %} content, such as code, issues, comments, or pull request content, is not collected. Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_server_statistics %}](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics)". +{% data variables.product.prodname_server_statistics %} solo recopila ciertas métricas agregadas en los repositorios, propuestas, solicitudes de cambio y otras características. No se recopila el contenido de {% data variables.product.prodname_dotcom %} tal como el código, las propuestas, los comentarios o el contenido de las solicitudes de cambio. Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_server_statistics %}](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics)". By enabling {% data variables.product.prodname_server_statistics %}, you are also helping to improve {% data variables.product.company_short %}. The aggregated data you will provide helps us understand how our customers are using {% data variables.product.prodname_dotcom %}, and make better and more informed product decisions, ultimately benefiting you. diff --git a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md index 1652755f7b..5fa9384fb2 100644 --- a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md +++ b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md @@ -672,7 +672,7 @@ You can add the optional `--prune` argument to remove unreachable Git objects th {% warning %} -**Warning**: Before using the `--prune` argument to remove unreachable Git objects, put {% data variables.product.product_location %} into maintenance mode, or ensure the repository is offline. For more information, see "[Enabling and scheduling maintenance mode](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." +**Warning**: Before using the `--prune` argument to remove unreachable Git objects, put {% data variables.product.product_location %} into maintenance mode, or ensure all repositories within the same repository network are locked. For more information, see "[Enabling and scheduling maintenance mode](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." {% endwarning %} diff --git a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md index 3471576d3e..75f1ca9141 100644 --- a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md +++ b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md @@ -31,12 +31,15 @@ Para las restricciones a nivel de instancia que utilizan los NSG de Azure, conta ## Agregar una dirección IP permitida +{% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} {% data reusables.identity-and-permissions.ip-allow-lists-add-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-add-description %} {% data reusables.identity-and-permissions.ip-allow-lists-add-entry %} +{% data reusables.identity-and-permissions.check-ip-address %} ## Permitir el acceso mediante {% data variables.product.prodname_github_apps %} @@ -44,6 +47,8 @@ Para las restricciones a nivel de instancia que utilizan los NSG de Azure, conta ## Habilitar direcciones IP permitidas +{% data reusables.identity-and-permissions.about-enabling-allowed-ip-addresses %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} @@ -52,6 +57,8 @@ Para las restricciones a nivel de instancia que utilizan los NSG de Azure, conta ## Editar una dirección IP permitida +{% data reusables.identity-and-permissions.about-editing-ip-allow-list-entries %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} @@ -59,6 +66,18 @@ Para las restricciones a nivel de instancia que utilizan los NSG de Azure, conta {% data reusables.identity-and-permissions.ip-allow-lists-edit-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-description %} 8. Da clic en **Actualizar**. +{% data reusables.identity-and-permissions.check-ip-address %} + +{% ifversion ip-allow-list-address-check %} +## Verificar si se permite una dirección IP + +{% data reusables.identity-and-permissions.about-checking-ip-address %} + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.security-tab %} +{% data reusables.identity-and-permissions.check-ip-address-step %} +{% endif %} ## Eliminar una dirección IP permitida diff --git a/translations/es-ES/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md b/translations/es-ES/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md index ccf5272e1b..c210522595 100644 --- a/translations/es-ES/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md +++ b/translations/es-ES/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md @@ -19,7 +19,7 @@ shortTitle: Create HA replica ## Creating a high availability replica 1. Set up a new {% data variables.product.prodname_ghe_server %} appliance on your desired platform. The replica appliance should mirror the primary appliance's CPU, RAM, and storage settings. We recommend that you install the replica appliance in an independent environment. The underlying hardware, software, and network components should be isolated from those of the primary appliance. If you are a using a cloud provider, use a separate region or zone. For more information, see ["Setting up a {% data variables.product.prodname_ghe_server %} instance"](/enterprise/admin/guides/installation/setting-up-a-github-enterprise-server-instance). -1. Ensure that both the primary appliance and the new replica appliance can communicate with each other over ports 122/TCP and 1194/UDP. For more information, see "[Network ports](/admin/configuration/configuring-network-settings/network-ports#administrative-ports)." +1. Ensure that the new appliance can communicate with all other appliances in this high availability environment over ports 122/TCP and 1194/UDP. For more information, see "[Network ports](/admin/configuration/configuring-network-settings/network-ports#administrative-ports)." 1. In a browser, navigate to the new replica appliance's IP address and upload your {% data variables.product.prodname_enterprise %} license. {% data reusables.enterprise_installation.replica-steps %} 1. Connect to the replica appliance's IP address using SSH. diff --git a/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md b/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md index a7e8e7bd93..4bd60e165e 100644 --- a/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md +++ b/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md @@ -45,9 +45,9 @@ La cantidad máxima de ejecución simultánea de jobs sin pérdida de rendimient {%- ifversion ghes > 3.5 %} -The CPU and memory resources available to {% data variables.product.product_location %} determine the number of runners that can be configured without performance loss. {% data reusables.actions.minimum-hardware %} +Los recursos de memoria y CPU disponibles para {% data variables.product.product_location %} determinan la cantidad de ejecutores que se pueden configurar sin pérdida de rendimiento. {% data reusables.actions.minimum-hardware %} -The peak quantity of connected runners without performance loss depends on such factors as job duration, artifact usage, number of repositories running Actions, and how much other work your instance is doing not related to Actions. Las pruebas internas en GitHub demostraron los siguientes objetivos de rendimiento para GitHub Enterprise Server en un rango de configuraciones de memoria y CPU: +La cantidad máxima de ejecutores conectados sin pérdida de rendimiento depende de factores tales como la duración de un job, el uso de artefactos, la cantidad de repositorios que ejecutan acciones y qué tantos otros trabajos no relacionados con las acciones realiza tu instancia. Las pruebas internas en GitHub demostraron los siguientes objetivos de rendimiento para GitHub Enterprise Server en un rango de configuraciones de memoria y CPU: {% endif %} @@ -94,15 +94,15 @@ La simultaneidad máxima se midió utilizando repositorios múltiples, una durac {% data reusables.actions.hardware-requirements-3.6 %} -{% data variables.product.company_short %} measured maximum connected runners using multiple repositories, job duration of approximately 10 minutes, and 10 MB artifact uploads. Puedes experimentar rendimientos diferentes dependiendo de los niveles de actividad generales de tu instancia. +{% data variables.product.company_short %} midió los ejecutores máximos conectados utilizando repositorios múltiples, la duración de jobs de aproximadamente 10 minutos y cargas de artefactos de 10 MB. Puedes experimentar rendimientos diferentes dependiendo de los niveles de actividad generales de tu instancia. {% note %} **Notas:** -- Beginning with {% data variables.product.prodname_ghe_server %} 3.6, {% data variables.product.company_short %} documents connected runners as opposed to concurrent jobs. Connected runners represents the most runners you can connect and expect to utilize. It should also be noted that connecting more runners than you can expect to utilize can negatively impact performance. +- Comenzando con {% data variables.product.prodname_ghe_server %} 3.6, los documentos de {% data variables.product.company_short %} conectaron ejecutores a diferencia de los jobs concurrentes. Los ejecutores conectados representan la mayor cantidad de ejecutores que puedes conectar y que se espera utilices. También se debe tomar en cuenta que el conectar más ejecutores de los que esperas utilizar puede impactar el rendimiento negativamente. -- Beginning with {% data variables.product.prodname_ghe_server %} 3.5, {% data variables.product.company_short %}'s internal testing uses 3rd generation CPUs to better reflect a typical customer configuration. Este cambio en el CPU representa una porción pequeña de los cambios a los objetivos de desempeño en esta versión de {% data variables.product.prodname_ghe_server %}. +- Iniciando con {% data variables.product.prodname_ghe_server %} 3.5, las pruebas internas de {% data variables.product.company_short %} utilizan CPU de tercera generación para reflejar mejor una configuración de usuario habitual. Este cambio en el CPU representa una porción pequeña de los cambios a los objetivos de desempeño en esta versión de {% data variables.product.prodname_ghe_server %}. {% endnote %} {%- endif %} diff --git a/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md b/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md index ed71174e55..0582e6ab1c 100644 --- a/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md +++ b/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md @@ -82,7 +82,11 @@ Estas restricciones no son aceptables para algunas empresas. Para determinar si ### ¿Tus desarrolladores confían en la colaboración fuera de tu empresa? -{% data variables.product.prodname_managed_users_caps %} solo puede contribuir con los repositorios dentro de tu empresa. Si tus desarrolladores necesitan colaborar en repositorios externos a tu empresa, incluso si estos son privados, para completar su trabajo, {% data variables.product.prodname_emus %} podría no ser lo correcto para tu empresa y el SSO de SAML podría ser una mejor solución. +{% data variables.product.prodname_managed_users_caps %} solo puede contribuir con los repositorios dentro de tu empresa. Si tus desarrolladores deben contribuir con ambos repositorios dentro y fuera de tu empresa, incluyendo a los repositorios privados, {% data variables.product.prodname_emus %} podría no ser lo correcto para tu empresa. El SSO de SAML podría ser una mejor solución. + +Algunas empresas mantienen repositorios dentro de una empresa existente utilizando el SSO de SAML en {% data variables.product.product_location %} y también crean una {% data variables.product.prodname_emu_enterprise %}. Los desarrolladores que contribuyen con los repositorios que le pertenecen a ambas empresas desde una estación de trabajo única deben cambiar entre las cuentas de {% data variables.product.product_location %} dentro de un solo buscador o utilizar un buscador diferente para cada cuenta. El desarrollador también podría necesitar personalizar la configuración de Git de la estación de trabajo para acomodar las dos cuentas. La complejidad de este flujo de trabajo puede incrementar el riesgo de filtrar el código interno al público por accidente. + +Si decides crear una {% data variables.product.prodname_emu_enterprise %} pero necesitas que los desarrolladores contribuyan con los recursos fuera de la empresa desde una sola estación de trabajo, puedes proporcionar compatibilidad para cambiar entre las cuentas de una configuración local de Git del desarrollador. Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_emus %}](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#supporting-developers-with-multiple-user-accounts-on-githubcom)". ### ¿Tu empresa depende de colaboradores externos? diff --git a/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/changing-authentication-methods.md b/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/changing-authentication-methods.md index cf63cbeb21..c43aea77bd 100644 --- a/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/changing-authentication-methods.md +++ b/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/changing-authentication-methods.md @@ -40,4 +40,4 @@ Otras cuestiones que deberías tener en cuenta son las siguientes: * **Autenticación de dos factores:** {% data reusables.enterprise_user_management.external_auth_disables_2fa %} -* **Fallback authentication for users with no account on your external authentication provider:** You can invite users to authenticate to {% data variables.product.product_location %} without adding them to your identity provider. For more information, see "[Allowing built-in authentication for users outside your provider](/admin/identity-and-access-management/managing-iam-for-your-enterprise/allowing-built-in-authentication-for-users-outside-your-provider)." +* **Autenticación de segunda opción para los usuarios que no tienen una cuenta en tu proveedor de autenticación externa:** Puedes invitar a los usuarios para que se autentiquen en {% data variables.product.product_location %} sin agregarlos a tu proveedor de identidad. Para obtener más información, consulta la sección "[Permitir la autenticación integrada para los usuarios fuera de tu proveedor](/admin/identity-and-access-management/managing-iam-for-your-enterprise/allowing-built-in-authentication-for-users-outside-your-provider)". diff --git a/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/troubleshooting-identity-and-access-management-for-your-enterprise.md b/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/troubleshooting-identity-and-access-management-for-your-enterprise.md index 8a0bc59ed1..1ffcbea270 100644 --- a/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/troubleshooting-identity-and-access-management-for-your-enterprise.md +++ b/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/troubleshooting-identity-and-access-management-for-your-enterprise.md @@ -23,7 +23,7 @@ topics: {% ifversion ghec %} ## Errors when switching authentication configurations -If you're experiencing problems while switching between different authentication configurations, such as changing your SAML SSO configuration from an organization to an enterprise account or migrating from SAML to OIDC for {% data variables.product.prodname_emus %}, ensure you're following our best practices for the change. +Si estás teniendo problemas al cambiar entre las diferentes configuraciones de autenticación, tales como cambiar tu configuración del SSO de SAML de una organización a una cuenta empresarial o migrándote de SAML a OIDC para las {% data variables.product.prodname_emus %}, asegúrate de estar siguiendo nuestras mejores prácticas para dicho cambio. - "[Switching your SAML configuration from an organization to an enterprise account](/admin/identity-and-access-management/using-saml-for-enterprise-iam/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account)" - "[Migrating from SAML to OIDC](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc)" diff --git a/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication.md b/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication.md index 467df68ece..0e5cba2071 100644 --- a/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication.md +++ b/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication.md @@ -1,6 +1,6 @@ --- -title: Username considerations for external authentication -shortTitle: Username considerations +title: Consideraciones de nombre de usuario para la autenticación externa +shortTitle: Consideraciones de nombre de usuario intro: '{% ifversion ghes or ghec %}Cuando utilizas {% ifversion ghes %}CAS, LDAP o SAML para la autenticación{% elsif ghec %}{% data variables.product.prodname_emus %}{% endif %}, {% endif %}{% data variables.product.product_name %} sigue reglas específicas para determinar el nombre de usuario de cada cuenta de usuario {% ifversion ghec or ghae %}en tu empresa{% elsif ghes %}en tu instancia{% endif %}.' miniTocMaxHeadingLevel: 3 versions: @@ -19,62 +19,62 @@ topics: {% ifversion ghec %} {% note %} -**Note:** This article only applies to {% data variables.product.prodname_emus %}. If you use {% data variables.product.prodname_ghe_cloud %} without {% data variables.product.prodname_emus %}, usernames are created by users, not {% data variables.product.prodname_dotcom %}. +**Nota:** Este artículo solo aplica a {% data variables.product.prodname_emus %}. Si tuilizas {% data variables.product.prodname_ghe_cloud %} sin {% data variables.product.prodname_emus %}, los usuarios crearán sus nombres de usuario y no {% data variables.product.prodname_dotcom %}. {% endnote %} {% endif %} -## About usernames with external authentication +## Acerca de los nombres de usuario con autenticación externa {% ifversion ghes %} -You can configure external authentication for {% data variables.product.product_name %} using CAS, LDAP, or SAML. Para obtener más información, consulta la sección "[Acerca de la autenticación para tu empresa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise#authentication-methods-for-github-enterprise-server)". +Puedes configurar la autenticación externa para {% data variables.product.product_name %} utilizando CAS, LDAP o SAML. Para obtener más información, consulta la sección "[Acerca de la autenticación para tu empresa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise#authentication-methods-for-github-enterprise-server)". -When you use external authentication, {% data variables.product.product_location %} automatically creates a username for each person when the person signs into {% data variables.product.product_location %} through your external authentication system for the first time. +Cuando utilizas autenticación externa, {% data variables.product.product_location %} crea automáticamente un nombre de usuario para cada persona cuando inician sesión en {% data variables.product.product_location %} mediante tu sistema de autenticación externa para la primera ocasión. {% elsif ghec %} -If you use an enterprise with {% data variables.product.prodname_emus %}, members of your enterprise authenticate to access {% data variables.product.prodname_dotcom %} through your SAML identity provider (IdP). Para obtener más información, consulta las secciones"[Acerca de las {% data variables.product.prodname_emus %}](/admin/identity-and-access-management/using-enterprise-managed-users-and-saml-for-iam/about-enterprise-managed-users)" y "[Acerca de la autenticación para tu empresa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise#authentication-methods-for-github-enterprise-server)". +Si utilizas una empresa con {% data variables.product.prodname_emus %}, los miembros de tu empresa se autentican para acceder a {% data variables.product.prodname_dotcom %} mediante tu proveedor de identidad (IdP) de SAML. Para obtener más información, consulta las secciones"[Acerca de las {% data variables.product.prodname_emus %}](/admin/identity-and-access-management/using-enterprise-managed-users-and-saml-for-iam/about-enterprise-managed-users)" y "[Acerca de la autenticación para tu empresa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise#authentication-methods-for-github-enterprise-server)". -{% data variables.product.product_name %} automatically creates a username for each person when their user account is provisioned via SCIM, by normalizing an identifier provided by your IdP. If multiple identifiers are normalized into the same username, a username conflict occurs, and only the first user account is created. You can resolve username conflicts by making a change in your IdP so that the normalized usernames will be unique. +{% data variables.product.product_name %} crea automáticamente un nombre de usuario para cada persona cuando su cuenta de usuario se aprovisiona a través de SCIM mediante la normalización de un identificador que proporciona tu IdP. Si se normalizan identificadores múltiples en el mismo nombre de usuario, ocurrirá un conflicto de nombre de usuario y solo se creará la primera cuenta de usuario. Puedes resolver conflictos de nombre de usuario haciendo un cambio en tu IdP para que los nombres de usuario normalizados sean únicos. {% elsif ghae %} -{% data variables.product.product_name %} uses SAML SSO for authentication, and automatically creates a username for each person when the person signs in through your identity provider (IdP) for the first time. +{% data variables.product.product_name %} utiliza el SSO de SAML para la autenticación y crea automáticamente un nombre de usuario para cada persona cuando esta inicia sesión mediante tu proveedor de identidad (IdP) por primera vez. {% endif %} {% ifversion ghec %} -## About usernames for {% data variables.product.prodname_managed_users %} +## Acerca de los nombres de usuario para {% data variables.product.prodname_managed_users %} -When your {% data variables.product.prodname_emu_enterprise %} is created, you will choose a short code that will be used as the suffix for your enterprise members' usernames. {% data reusables.enterprise-accounts.emu-shortcode %} El usuario de configuración que configure el SSO de SAML tendrá un nombre de usuario en el formato **@SHORT-CODE_admin**. +Cuando se crea tu {% data variables.product.prodname_emu_enterprise %}, debes elegir un código corto que se utilizará como el sufijo para los nombres de usuario de los miembros de tu empresa. {% data reusables.enterprise-accounts.emu-shortcode %} El usuario de configuración que configure el SSO de SAML tendrá un nombre de usuario en el formato **@SHORT-CODE_admin**. -Cuando aprovisionas un usuario nuevo desde tu proveedor de identidad, el {% data variables.product.prodname_managed_user %} nuevo tendrá un nombre de usuario de {% data variables.product.prodname_dotcom %} en el formato de **@IDP-USERNAME_SHORT-CODE**. The IDP-USERNAME component is formed by normalizing the SCIM `userName` attribute value sent from the IdP. +Cuando aprovisionas un usuario nuevo desde tu proveedor de identidad, el {% data variables.product.prodname_managed_user %} nuevo tendrá un nombre de usuario de {% data variables.product.prodname_dotcom %} en el formato de **@IDP-USERNAME_SHORT-CODE**. El componente IDP-USERNAME se forma normalizando el valor de atributo de SCIM `userName` que se envía desde el IdP. | Proveedor de identidad | Nombre de usuario de {% data variables.product.prodname_dotcom %} -| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Azure Active Directory (Azure AD) | _IDP-USERNAME_ is formed by normalizing the characters preceding the `@` character in the UPN (User Principal Name), which does not include the `#EXT#` for guest accounts. | -| Okta | _IDP-USERNAME_ is the normalized username attribute provided by the IdP. | +| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Azure Active Directory (Azure AD) | _IDP-USERNAME_ se conforma al normalizar los caracteres que preceden al carácter `@` en el UPN (Nombre Principal de Usuario), el cual no incluye el `#EXT#` para las cuentas de invitado. | +| Okta | _IDP-USERNAME_ es el atributo de nombre de usuario normalizado que proporciona el IdP. | -These rules may result in your IdP providing the same _IDP-USERNAME_ for multiple users. For example, for Azure AD, the following UPNs will result in the same username: +Estas reglas podrían dar como resultado que tu IdP proporcione la misma _IDP-USERNAME_ para varios usuarios. Por ejemplo, para Azure AD, las siguientes UPN darán como resultado el mismo nombre de usuario: - `bob@contoso.com` - `bob@fabrikam.com` - `bob#EXT#fabrikamcom@contoso.com` -This will cause a username conflict, and only the first user will be provisioned. For more information, see "[Resolving username conflicts](#resolving-username-conflicts)." +Esto ocasionará un conflicto de nombre de usuario y solo el primero se aprovisionará. Para obtener más información, consulta la sección "[Resolver conflictos de nombre de usuario](#resolving-username-conflicts)". {% endif %} -Usernames{% ifversion ghec %}, including underscore and short code,{% endif %} must not exceed 39 characters. +Los nombres de usuario{% ifversion ghec %}, incluyendo los guiones bajos y el código corto,{% endif %} no deben ser de más de 39 caracteres. -## About username normalization +## Acerca de la normalización de nombres de usuario Usernames for user accounts on {% ifversion ghes or ghae %}{% data variables.product.product_name %}{% elsif ghec %}{% data variables.product.prodname_dotcom_the_website %}{% endif %} can only contain alphanumeric characters and dashes (`-`). {% ifversion ghec %} When you configure SAML authentication, {% data variables.product.product_name %} uses the SCIM `userName` attribute value sent from the IdP to determine the username for the corresponding user account on {% data variables.product.prodname_dotcom_the_website %}. If this value includes unsupported characters, {% data variables.product.product_name %} will normalize the username per the following rules. {% elsif ghes %} -When you configure CAS, LDAP, or SAML authentication, {% data variables.product.product_name %} uses an identifier from the user account on your external authentication provider to determine the username for the corresponding user account on {% data variables.product.product_name %}. If the identifier includes unsupported characters, {% data variables.product.product_name %} will normalize the username per the following rules. +Cuando configuras la autenticación de CAS, LDAP o SAML, {% data variables.product.product_name %} utiliza un identificador de la cuenta de usuario en tu proveedor de autenticación externo para determinar el nombre de usuario de la cuenta de usuario correspondiente en {% data variables.product.product_name %}. If the identifier includes unsupported characters, {% data variables.product.product_name %} will normalize the username per the following rules. {% elsif ghae %} When you configure SAML authentication, {% data variables.product.product_name %} uses an identifier from the user account on your IdP to determine the username for the corresponding user account on {% data variables.product.product_name %}. Si el identificador incluye caracteres no compatibles, {% data variables.product.product_name %} normalizará el nombre de usuario de acuerdo con las siguientes reglas. {% endif %} @@ -100,7 +100,7 @@ When you configure SAML authentication, {% data variables.product.product_name % {% ifversion not ghec %} ### About username normalization with SAML -{% ifversion ghes %}If you configure SAML authentication for {% data variables.product.product_location %}, {% endif %}{% data variables.product.product_name %} determines each person's username by one of the following assertions in the SAML response, ordered by descending priority. +{% ifversion ghes %}Si configuras la autenticación de SAML para {% data variables.product.product_location %}, {% endif %}{% data variables.product.product_name %} determina el nombre de cada persona mediante una de las siguientes aserciones en la respuesta de SAML, ordenado por prioridad de forma descendente. 1. The custom `username` attribute, if defined and present 1. Una aserción `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name`, si hay una. @@ -153,5 +153,5 @@ To resolve username conflicts in Okta, update the attribute mapping settings for 1. In Okta, open the {% data variables.product.prodname_emu_idp_application %} application. 1. Haz clic en **Iniciar sesión**. 1. In the "Settings" section, click **Edit**. -1. Update the "Application username format." +1. Actualiza el "formato de aplicación de nombre de usuario". {% endif %} diff --git a/translations/es-ES/content/admin/identity-and-access-management/using-cas-for-enterprise-iam/using-cas.md b/translations/es-ES/content/admin/identity-and-access-management/using-cas-for-enterprise-iam/using-cas.md index 0743a56c7f..d33d0b7be0 100644 --- a/translations/es-ES/content/admin/identity-and-access-management/using-cas-for-enterprise-iam/using-cas.md +++ b/translations/es-ES/content/admin/identity-and-access-management/using-cas-for-enterprise-iam/using-cas.md @@ -8,7 +8,7 @@ redirect_from: - /admin/authentication/using-cas - /enterprise/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-cas - /admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-cas -intro: 'If you use Central Authentication Service (CAS) to centralize access to multiple web applications, you can integrate {% data variables.product.product_name %} by configuring CAS authentication for your instance.' +intro: 'Si utilizas el Servicio de Autenticación Central (CAS) para centralizar el acceso a diversas aplicaciones web, puedes integrar a {% data variables.product.product_name %} configurando la autenticación de CAS para tu instancia.' versions: ghes: '*' type: how_to @@ -20,13 +20,13 @@ topics: - SSO --- -## About CAS authentication for {% data variables.product.product_name %} +## Acerca de la autenticación de CAS para {% data variables.product.product_name %} -CAS is a single sign-on (SSO) protocol that centralizes authentication to multiple web applications. For more information, see "[Central Authentication Service](https://en.wikipedia.org/wiki/Central_Authentication_Service)" on Wikipedia. +CAS es un protocolo de inicio de sesión única (SSO) que centraliza la autenticación a varias aplicaciones web. Para obtener más información, consulta "[Central Authentication Service](https://en.wikipedia.org/wiki/Central_Authentication_Service)" en Wikipedia. -After you configure CAS, people who use {% data variables.product.product_location %} must use a personal access token to authenticate API or Git requests over HTTP(S). CAS credentials cannot be used to authenticate these requests. Para obtener más información, consulta la sección "[Crear un token de acceso personal](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)". +Después de que configuras CAS, las personas que utilizan {% data variables.product.product_location %} debe utilizar un token de acceso personal para autenticar la API o las solicitudes de Git sobre HTTP(S). Las credenciales de CAS no pueden utilizarse para autenticar estas solicitudes. Para obtener más información, consulta la sección "[Crear un token de acceso personal](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)". -If you configure CAS, people with accounts on your identity provider (IdP) do not consume a user license until the person signs into {% data variables.product.product_location %}. +Si configuras CAS, las personas con cuentas en tu proveedor de identidad (IdP) no consumen una licencia de usuario sino hasta que la persona inicie sesión en {% data variables.product.product_location %}. {% data reusables.enterprise_user_management.built-in-authentication %} @@ -49,8 +49,8 @@ Están disponibles los siguientes atributos. {% data reusables.enterprise_management_console.authentication %} 3. Selecciona **CAS**. - ![Screenshot of selection of CAS for authentication](/assets/images/enterprise/management-console/cas-select.png) + ![Captura de pantalla de la selección de CAS para la autenticación](/assets/images/enterprise/management-console/cas-select.png) 4. {% data reusables.enterprise_user_management.built-in-authentication-option %} - ![Screenshot of of fallback built-in authentication option for CAS](/assets/images/enterprise/management-console/cas-built-in-authentication.png) + ![Captura de pantalla de segunda opción de autenticación integrada para CAS](/assets/images/enterprise/management-console/cas-built-in-authentication.png) 5. En el campo **URL del servidor**, escribe la URL completa de tu servidor CAS. Si tu servidor CAS usa un certificado que no puede ser validado por {% data variables.product.prodname_ghe_server %}, puedes usar el comando `ghe-ssl-ca-certificate-install` para instalarlo como un certificado de confianza. Para obtener más información, consulta la sección "[Utilidades de línea de comandos](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-ssl-ca-certificate-install)". diff --git a/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md b/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md index 392f7da3ca..b24cbb3525 100644 --- a/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md +++ b/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md @@ -36,15 +36,13 @@ Puedes otorgar acceso a los {% data variables.product.prodname_managed_users %}, El nombre de usuario de los {% data variables.product.prodname_managed_users %} de tu empresa y su información de perfil, tal como los nombres y direcciones de correo electrónico que se muestran, se configuran mediante tu IdP y no pueden cambiarlos los mismos usuarios. Para obtener más información, consulta la sección "[Nombres de usuario e información de perfil](#usernames-and-profile-information)". -{% data reusables.enterprise-accounts.emu-forks %} - Los propietarios de las empresas pueden auditar todas las acciones de los {% data variables.product.prodname_managed_users %} en {% data variables.product.prodname_dotcom %}. For more information, see "[Audit log events for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise#about-audit-log-events-for-your-enterprise)." Para utilizar los {% data variables.product.prodname_emus %}, necesitas un tipo separado de cuenta empresarial con {% data variables.product.prodname_emus %} habilitados. Para obtener más información sobre cómo crear esta cuenta, consulta la sección "[Acerca de las empresas con usuarios administrados](#about-enterprises-with-managed-users)". {% note %} -**Note:** There are multiple options for identity and access management with {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_emus %} is not the best solution for every customer. For more information about whether {% data variables.product.prodname_emus %} is right for your enterprise, see "[About authentication for your enterprise](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise#identifying-the-best-authentication-method-for-your-enterprise)." +**Note:** There are multiple options for identity and access management with {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_emus %} is not the best solution for every customer. Para obtener más información sobre si las {% data variables.product.prodname_emus %} son correctas para tu empresa, consulta la sección "[Acerca de la autenticación para tu empresa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise#identifying-the-best-authentication-method-for-your-enterprise)". {% endnote %} @@ -75,7 +73,8 @@ Los {% data variables.product.prodname_managed_users_caps %} solo pueden colabor * Los {% data variables.product.prodname_managed_users_caps %} no pueden crear gists o comentar en ellos. * Los {% data variables.product.prodname_managed_users_caps %} no pueden instalar {% data variables.product.prodname_github_apps %} en sus cuentas de usuario. * Otros usuarios de {% data variables.product.prodname_dotcom %} no pueden ver, mencionar o invitar a {% data variables.product.prodname_managed_user %} para colaborar. -* Los {% data variables.product.prodname_managed_users_caps %} solo pueden ser propietarios de repositorios privados y los {% data variables.product.prodname_managed_users %} solo pueden invitar a otros miembros de la empresa para que colaboren con sus propios repositorios. +* You can choose whether {% data variables.product.prodname_managed_users %} are able to create repositories owned by their user accounts. Para obtener más información, consulta la sección "[Requerir políticas de administración de repositorios en tu empresa](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-repository-creation)". +* If you allow {% data variables.product.prodname_managed_users %} to create repositories owned by their user accounts, they can only own private repositories and can only invite other enterprise members to collaborate on their user-owned repositories. * {% data reusables.enterprise-accounts.emu-forks %} * Solo se pueden crear repositorios internos y privados en las organizaciones que pertenezcan a una {% data variables.product.prodname_emu_enterprise %}, dependiendo de los ajustes de visibilidad del repositorio o empresa. * {% data variables.product.prodname_managed_users_caps %} are limited in their use of {% data variables.product.prodname_pages %}. Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages#limitations-for-enterprise-managed-users)". @@ -113,6 +112,8 @@ Before your developers can use {% data variables.product.prodname_ghe_cloud %} w 5. Once authentication and provisioning are configured, you can start provisioning members and managing teams. Para obtener más información, consulta la sección "[Administrar las membrecías de equipo con los grupos de proveedor de identidades](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups)". +If members of your enterprise must use one workstation to contribute to repositories on {% data variables.product.product_location %} from both a {% data variables.product.prodname_managed_user %} and a personal account, you can provide support. For more information, see "[Supporting developers with multiple user accounts on {% data variables.product.prodname_dotcom_the_website %}](#supporting-developers-with-multiple-user-accounts-on-githubcom)." + ## Autenticarse como una {% data variables.product.prodname_managed_user %} Los {% data variables.product.prodname_managed_users_caps %} se deben autenticar mediante su proveedor de identidad. Para autenticarse, un {% data variables.product.prodname_managed_user %} puede visitar su portal de aplicación IdP o utilizar una página de inicio de sesión en {% data variables.product.prodname_dotcom_the_website %}. @@ -132,3 +133,9 @@ Los {% data variables.product.prodname_managed_users_caps %} se deben autenticar A conflict may occur when provisioning users if the unique parts of the identifier provided by your IdP are removed during normalization. If you're unable to provision a user due to a username conflict, you should modify the username provided by your IdP. For more information, see "[Resolving username conflicts](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication#resolving-username-conflicts)." El nombre de perfil y dirección de correo electrónico de un {% data variables.product.prodname_managed_user %} también lo proporciona el IdP. {% data variables.product.prodname_managed_users_caps %} cannot change their profile name or email address on {% data variables.product.prodname_dotcom %}, and the IdP can only provide a single email address. + +## Supporting developers with multiple user accounts on {% data variables.product.product_location %} + +People on your team may need to contribute to resources on {% data variables.product.product_location %} that are outside of your {% data variables.product.prodname_emu_enterprise %}. For example, you may wish to maintain a separate enterprise for your company's open source projects. Because a {% data variables.product.prodname_managed_user %} cannot contribute to public resources, users will need to maintain a separate, personal account for this work. + +People who must contribute from two user accounts on {% data variables.product.product_location %} using one workstation can configure Git to simplify the process. For more information, see "[Managing multiple accounts](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts)." diff --git a/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md b/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md index 22baa3473e..e2c8a03c3e 100644 --- a/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md +++ b/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md @@ -22,9 +22,11 @@ CAP support is enabled automatically for any {% data variables.product.prodname_ Para obtener más información sobre cómo utilizar OIDC con {% data variables.product.prodname_emus %}, consulta las secciones "[Configurar OIDC para los usuarios empresariales administrados](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-oidc-for-enterprise-managed-users) y "[Migrarse de SAML a OIDC](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc)". -## About using CAP with IP allow lists +{% note %} -We recommend disabling your enterprise account's IP allow list and relying on your IdP's CAP. If you enable IP allow lists for your enterprise and also make use of your IdP's CAP, both the IP allow list and CAP will be enforced. If either restriction rejects a user's IP address, the request fails. Para obtener más información sobre las listas de IP permitidas, consulta la sección "[Requerir políticas para la configuración de seguridad en tu empresa](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)". +**Note:** If you use Conditional Access (CA) network location policies in your Azure AD tenant, do not use the IP allow list feature on {% data variables.product.prodname_dotcom_the_website %}, with your enterprise account or with any of the organizations owned by the enterprise. Using both is unsupported and can result in the wrong policy applying. Para obtener más información acerca de las listas de direcciones IP permitidas, consulta las secciones "[Requerir ajustes de seguridad en tu empresa](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)" y "[Administrar direcciones IP permitidas en tu organización](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization)". + +{% endnote %} ## Considerations for integrations and automations diff --git a/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md b/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md index 494cb14c8b..bc479a0b8b 100644 --- a/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md +++ b/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md @@ -1,5 +1,5 @@ --- -title: Migrating from SAML to OIDC +title: Migrarte de SAML a OIDC shortTitle: Migrarte de SAML a OIDC intro: 'If you''re using SAML to authenticate members in your {% data variables.product.prodname_emu_enterprise %}, you can migrate to OpenID Connect (OIDC) and benefit from support for your IdP''s Conditional Access Policy.' product: '{% data reusables.gated-features.emus %}' @@ -26,11 +26,12 @@ If you're new to {% data variables.product.prodname_emus %} and haven't yet conf {% note %} -**Note:** To sign in as the setup user, you will need a recovery code. If you do not already have your recovery codes, you can access the codes while signed in as an enterprise owner. For more information, see "[Downloading your enterprise account's single sign-on recovery codes](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes)." +**Note:** To sign in as the setup user, you will need a recovery code. If you do not already have your recovery codes, you can access the codes while signed in as an enterprise owner. Para obtener más información, consulta la sección "[Descargar los códigos de recuperación de inicio de sesión único de tu cuenta empresarial](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes)". {% endnote %} 1. Before you begin the migration, sign in to Azure and disable provisioning in the existing {% data variables.product.prodname_emu_idp_application %} application. +1. Si utilizas [Políticas de ubicación de red con Acceso Condicional (CA)](https://docs.microsoft.com/en-us/azure/active-directory/conditional-access/location-condition) en Azure AD y actualmente utilizas una lista de direcciones IP permitidas con tu cuenta empresarial o con cualquier organización que le pertenezca a la cuenta empresarial en {% data variables.product.prodname_dotcom_the_website %}, inhabilita las listas de direcciones IP permitidas. Para obtener más información, consulta las secciones "[Requerir ajustes de seguridad en tu empresa](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)" y "[Administrar direcciones IP permitidas en tu organización](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization)". 1. Sign into {% data variables.product.prodname_dotcom_the_website %} as the setup user for your enterprise with the username **@SHORT-CODE_admin**. 1. When prompted to continue to your identity provider, click **Use a recovery code** and sign in using one of your enterprise's recovery codes. {% data reusables.enterprise-accounts.access-enterprise %} diff --git a/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md b/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md index c846099ee0..38178d2800 100644 --- a/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md +++ b/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md @@ -1,6 +1,6 @@ --- title: Configurar la autenticación y el aprovisionamiento para tu empresa utilizando Azure AD -shortTitle: Configure with Azure AD +shortTitle: Configurar con Azure AD intro: 'Puedes utilizar un inquilino en Azure Active Directory (Azure AD) como proveedor de identidad (IdP) para administrar centralmente la autenticación y el aprovisionamiento de usuarios para {% data variables.product.product_location %}.' permissions: 'Enterprise owners can configure authentication and provisioning for an enterprise on {% data variables.product.product_name %}.' versions: diff --git a/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-for-your-enterprise.md b/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-for-your-enterprise.md index 7800bccfd9..1f7a1307b8 100644 --- a/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-for-your-enterprise.md +++ b/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-for-your-enterprise.md @@ -1,6 +1,6 @@ --- title: Configurar el aprovisionamiento de usuarios para tu empresa -shortTitle: Configure user provisioning +shortTitle: Configurar el aprovisionamiento de usuarios intro: 'Puedes configurar el Sistema para la Administración de Identidad entre Dominios (SCIM) para tu empresa, el cual aprovisiona las cuentas de usuario automáticamente en {% data variables.product.product_location %} cuando asignas la aplicación para {% data variables.product.product_location %} a un usuario en tu proveedor de identidad (IdP).' permissions: 'Enterprise owners can configure user provisioning for an enterprise on {% data variables.product.product_name %}.' versions: @@ -21,9 +21,9 @@ redirect_from: {% data reusables.saml.ae-uses-saml-sso %} Para obtener más información, consulta la sección "[Configurar el incio de sesión único de SAML para tu empresa](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise)". -You can configure user provisioning with SCIM to automatically create or suspend user accounts and grant access for {% data variables.product.product_name %} when you assign or unassign the application on your IdP. For more information about SCIM, see [System for Cross-domain Identity Management: Protocol (RFC 7644)](https://tools.ietf.org/html/rfc7644) on the IETF website. +Puedes configurar el aprovisionamiento de usuarios con SCIM para crear o suspender cuentas de usuario automáticamente y obetner acceso para {% data variables.product.product_name %} cuando asignes o desasignes la aplicación en tu IdP. Para obtener más información sobre el SCIM, consulta [System for Cross-domain Identity Management: Protocol (RFC 7644)](https://tools.ietf.org/html/rfc7644) en el sitio web de IETF. -If you do not configure user provisioning with SCIM, your IdP will not communicate with {% data variables.product.product_name %} automatically when you assign or unassign the application to a user. Without SCIM, {% data variables.product.product_name %} creates a user account using SAML Just-in-Time (JIT) provisioning the first time someone navigates to {% data variables.product.product_name %} and signs in by authenticating through your IdP. +Si no configuras el aprovisionamiento de usuarios con SCIM, tu IdP no se comunicará automáticamente con {% data variables.product.product_name %} cuando asignes o desasignes la aplicación a un usuario. Sin SCIM, {% data variables.product.product_name %} crea una cuenta de usuario utilizando el aprovisionamiento SAML Just-in-Time (JIT) la primera vez que alguien navegue a {% data variables.product.product_name %} e inicie sesión autenticándose a través de tu IdP. Configurar el aprovisionamiento le permite a tu IdP comunicarse con {% data variables.product.product_location %} cuando asignas o desasignas la aplicación para {% data variables.product.product_name %} a un usuario en tu IdP. Cuando asignas la aplicación, tu IdP pedirá que {% data variables.product.product_location %} cree una cuenta y enviará un correo electrónico de incorporación al usuario. Cuando desasignas la aplicación, tu IdP se comunicará con {% data variables.product.product_name %} para invalidad cualquier sesión de SAML e inhabilitar la cuenta del miembro. diff --git a/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/mapping-okta-groups-to-teams.md b/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/mapping-okta-groups-to-teams.md index 4d05b3a42a..572265309c 100644 --- a/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/mapping-okta-groups-to-teams.md +++ b/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/mapping-okta-groups-to-teams.md @@ -1,7 +1,7 @@ --- -title: Mapping Okta groups to teams -shortTitle: Map Okta groups to teams -intro: 'You can map your Okta groups to teams on {% data variables.product.prodname_ghe_managed %} to automatically add and remove team members.' +title: Mapear los grupos de Okta a los equipos +shortTitle: Mapear los grupos de Okta a los equipos +intro: 'Puedes mapear tus grupos de Okta a los equipos en {% data variables.product.prodname_ghe_managed %} para que agreguen y eliminen a los miembros automáticamente.' permissions: 'Enterprise owners can configure authentication and provisioning for {% data variables.product.prodname_ghe_managed %}.' versions: ghae: '*' @@ -19,9 +19,9 @@ topics: {% data reusables.saml.okta-ae-sso-beta %} -## About team mapping +## Acerca del mapeo de equipos -If you use Okta as your IdP, you can map your Okta group to a team in {% data variables.product.prodname_ghe_managed %}. Members of the Okta group will automatically become members of the mapped {% data variables.product.prodname_ghe_managed %} team. To configure this mapping, you can configure the Okta "GitHub AE" app to push the group and its members to {% data variables.product.prodname_ghe_managed %}. You can then choose which team in {% data variables.product.prodname_ghe_managed %} will be mapped to the Okta group. +Si utilizas Okta como tu IdP, puedes mapear tu grupo de Okta a un equipo en {% data variables.product.prodname_ghe_managed %}. Members of the Okta group will automatically become members of the mapped {% data variables.product.prodname_ghe_managed %} team. To configure this mapping, you can configure the Okta "GitHub AE" app to push the group and its members to {% data variables.product.prodname_ghe_managed %}. You can then choose which team in {% data variables.product.prodname_ghe_managed %} will be mapped to the Okta group. ## Prerrequisitos diff --git a/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md b/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md index be369be988..26ada0fd5c 100644 --- a/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md +++ b/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md @@ -75,10 +75,12 @@ The SP metadata for your enterprise on {% data variables.product.product_name %} The following SAML attributes are available for {% data variables.product.product_name %}.{% ifversion ghes %} You can change the attribute names in the management console, with the exception of the `administrator` attribute. For more information, see "[Accessing the management console](/admin/configuration/configuring-your-enterprise/accessing-the-management-console)."{% endif %} -| Nombre | Required? | Descripción | -|:--------------------- |:--------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `ID del nombre` | Sí | Un identificador de usuario persistente. Se puede usar cualquier formato de identificador de nombre persistente. {% ifversion ghec %}If you use an enterprise with {% data variables.product.prodname_emus %}, {% endif %}{% data variables.product.product_name %} will normalize the `NameID` element to use as a username unless one of the alternative assertions is provided. Para obtener más información, consulta la sección "[Consideraciones de nombre de usuario para la autenticación externa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication)". | -| `SessionNotOnOrAfter` | No | The date that {% data variables.product.product_name %} invalidates the associated session. After invalidation, the person must authenticate once again to access {% ifversion ghec or ghae %}your enterprise's resources{% elsif ghes %}{% data variables.product.product_location %}{% endif %}. For more information, see "[Session duration and timeout](#session-duration-and-timeout)." | +| Nombre | Required? | Descripción | +|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |:--------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `ID del nombre` | Sí | Un identificador de usuario persistente. Se puede usar cualquier formato de identificador de nombre persistente. | +| {% ifversion ghec %}If you use an enterprise with {% data variables.product.prodname_emus %}, {% endif %}{% data variables.product.product_name %} will normalize the `NameID` element to use as a username unless one of the alternative assertions is provided. Para obtener más información, consulta la sección "[Consideraciones de nombre de usuario para la autenticación externa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication)".

    {% note %}**Nota:** Es importante utilizar un identificador persistente y legible para humanos. Using a transient identifier format like `urn:oasis:names:tc:SAML:2.0:nameid-format:transient` will result in re-linking of accounts on every sign-in, which can be detrimental to authorization management.{% endnote %} | | | +| | | | +| `SessionNotOnOrAfter` | No | The date that {% data variables.product.product_name %} invalidates the associated session. After invalidation, the person must authenticate once again to access {% ifversion ghec or ghae %}your enterprise's resources{% elsif ghes %}{% data variables.product.product_location %}{% endif %}. For more information, see "[Session duration and timeout](#session-duration-and-timeout)." | {%- ifversion ghes or ghae %} | `administrator` | No | When the value is `true`, {% data variables.product.product_name %} will automatically promote the user to be a {% ifversion ghes %}site administrator{% elsif ghae %}enterprise owner{% endif %}. Setting this attribute to anything but `true` will result in demotion, as long as the value is not blank. Omitting this attribute or leaving the value blank will not change the role of the user. | | `username` | No | The username for {% data variables.product.product_location %}. | {%- endif %} diff --git a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics.md b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics.md index bf573eb516..7408d37941 100644 --- a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics.md +++ b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics.md @@ -1,6 +1,6 @@ --- -title: About Server Statistics -intro: 'You can use {% data variables.product.prodname_server_statistics %} to analyze your own aggregate data from {% data variables.product.prodname_ghe_server %}, and help us improve {% data variables.product.company_short %} products.' +title: Acerca de las estadísitcas del servidor +intro: 'Puedes utilizar {% data variables.product.prodname_server_statistics %} para analizar tus propios datos agregados de {% data variables.product.prodname_ghe_server %} y ayudarnos a mejorar los productos de {% data variables.product.company_short %}.' versions: feature: server-statistics permissions: 'Enterprise owners can enable {% data variables.product.prodname_server_statistics %}.' @@ -10,11 +10,11 @@ topics: - Enterprise --- -## About the benefits of {% data variables.product.prodname_server_statistics %} +## Acerca de los beneficios de las {% data variables.product.prodname_server_statistics %} -{% data variables.product.prodname_server_statistics %} can help you anticipate the needs of your organization, understand how your team works, and show the value you get from {% data variables.product.prodname_ghe_server %}. +Las {% data variables.product.prodname_server_statistics %} pueden ayudarte a anticipar las necesidades de tu organización, entender cómo funciona tu equipo y mostrarte el valor que obtienes de {% data variables.product.prodname_ghe_server %}. -Once enabled, {% data variables.product.prodname_server_statistics %} collects aggregate data on how much certain features are used on your instance over time. Unlike other [Admin Stats API](/rest/reference/enterprise-admin#admin-stats) endpoints, which only return data for the last day, {% data variables.product.prodname_server_statistics %} provides historical data of all {% data variables.product.prodname_server_statistics %} metrics collected since the day you enabled the feature. Para obtener más información, consulta la sección "[Habilitar la {% data variables.product.prodname_server_statistics %} en tu empresa](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)". +Once enabled, {% data variables.product.prodname_server_statistics %} collects aggregate data on how much certain features are used on your instance over time. A diferencia de otras terminales de la [API de estadísticas administrativas](/rest/reference/enterprise-admin#admin-stats), las cuales solo devuelven datos del último día, {% data variables.product.prodname_server_statistics %} proporciona datos históricos de todas las métricas de {% data variables.product.prodname_server_statistics %} desde el día en el que habilitaste la característica. Para obtener más información, consulta la sección "[Habilitar la {% data variables.product.prodname_server_statistics %} en tu empresa](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)". When you enable {% data variables.product.prodname_server_statistics %}, you're helping to build a better {% data variables.product.prodname_dotcom %}. The aggregated data you'll provide gives us insights into how {% data variables.product.prodname_dotcom %} adds value to our customers. This information allows {% data variables.product.company_short %} to make better and more informed product decisions, ultimately benefiting you. @@ -34,7 +34,7 @@ For a better understanding of how we store and secure {% data variables.product. ### About data retention and deletion -{% data variables.product.company_short %} collects {% data variables.product.prodname_server_statistics %} data for as long as your {% data variables.product.prodname_ghe_server %} license is active and the {% data variables.product.prodname_server_statistics %} feature is enabled. +{% data variables.product.company_short %} recopila datos de {% data variables.product.prodname_server_statistics %} durante todo el tiempo en el que tu licencia de {% data variables.product.prodname_ghe_server %} esté activa y la característica de {% data variables.product.prodname_server_statistics %} esté habilitada. If you would like to delete your data, you may do so by contacting GitHub Support, your {% data variables.product.prodname_dotcom %} account representative, or your Customer Success Manager. Generally, we delete data in the timeframe specified in our privacy statement. For more information, see [{% data variables.product.company_short %}'s privacy statement](/free-pro-team@latest/site-policy/privacy-policies/github-privacy-statement#data-retention-and-deletion-of-data) in the {% data variables.product.prodname_dotcom_the_website %} documentation. diff --git a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api.md b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api.md index 12e72822cf..8c045d76e0 100644 --- a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api.md +++ b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api.md @@ -8,8 +8,8 @@ redirect_from: - /early-access/github/analyze-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api --- -You can request up to 365 days of metrics in a single {% data variables.product.prodname_server_statistics %} REST API request. Estos datos, los cuales incluyen métricas agregadas en los repositorios, propuestas y solicitudes de cambio pueden ayudarte a anticipar las necesidades de tu organización, entender cómo funciona tu equipo y mostrarte el valor que obtienes de {% data variables.product.prodname_ghe_server %}. For a list of the metrics collected, see "[{% data variables.product.prodname_server_statistics %} data collected](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)." +You can request up to 365 days of metrics in a single {% data variables.product.prodname_server_statistics %} REST API request. Estos datos, los cuales incluyen métricas agregadas en los repositorios, propuestas y solicitudes de cambio pueden ayudarte a anticipar las necesidades de tu organización, entender cómo funciona tu equipo y mostrarte el valor que obtienes de {% data variables.product.prodname_ghe_server %}. Para encontrar una lista de las métricas recopiladas, consulta la sección "[Datos de {% data variables.product.prodname_server_statistics %} recopilados](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)". Before you can use the {% data variables.product.prodname_server_statistics %} REST API, you must enable {% data variables.product.prodname_server_statistics %}. Para obtener más información, consulta la sección "[Habilitar la {% data variables.product.prodname_server_statistics %} en tu empresa](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)". -For more information about using the REST API to request server statistics, see "[Get {% data variables.product.prodname_ghe_server %} statistics](/enterprise-cloud@latest/rest/enterprise-admin/admin-stats#get-github-enterprise-server-statistics)" in the {% data variables.product.prodname_ghe_cloud %} REST API documentation. +Para obtener más información sobre cómo utilizar la API de REST para solicitar estadísticas de servidor, consulta la sección "[Obtener estadísticas de {% data variables.product.prodname_ghe_server %}](/enterprise-cloud@latest/rest/enterprise-admin/admin-stats#get-github-enterprise-server-statistics)" en la documentación de la API de REST de {% data variables.product.prodname_ghe_cloud %}. diff --git a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md index 3167eec355..cbefb7dcff 100644 --- a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md +++ b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md @@ -256,57 +256,57 @@ El alcance de los eventos que se muestran en la bitácora de auditoría de tu em | -------------------- | ----------------------------- | | `discussion.destroy` | Se borró un debate de equipo. | -## `discussion_comment` category actions +## Acciones de la categoría `discussion_comment` -| Acción | Descripción | -| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `discussion_comment.destroy` | A [comment on a team discussion post was deleted](/communities/moderating-comments-and-conversations/managing-disruptive-comments#deleting-a-comment). | -| `discussion_comment.update` | A [comment on a team discussion post was edited](/communities/moderating-comments-and-conversations/managing-disruptive-comments#editing-a-comment). | +| Acción | Descripción | +| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `discussion_comment.destroy` | [Se borró un comentario en una publicación de debate de equipo](/communities/moderating-comments-and-conversations/managing-disruptive-comments#deleting-a-comment). | +| `discussion_comment.update` | [Se editó un comentario en una publicación de debate de equipo](/communities/moderating-comments-and-conversations/managing-disruptive-comments#editing-a-comment). | ## acciones de la categoría `discussion_post` -| Acción | Descripción | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------ | -| `discussion_post.destroy` | A [team discussion post was deleted](/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion). | -| `discussion_post.update` | A [team discussion post was edited](/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion). | +| Acción | Descripción | +| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `discussion_post.destroy` | [Se borró una publicación de debate de equipo](/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion). | +| `discussion_post.update` | [Se editó una publicación de debate de equipo](/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion). | ## acciones de la categoría `discussion_post_reply` -| Acción | Descripción | -| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `discussion_post_reply.destroy` | A [reply to a team discussion post was deleted](/communities/moderating-comments-and-conversations/managing-disruptive-comments#deleting-a-comment). | -| `discussion_post_reply.update` | A [reply to a team discussion post was edited](/communities/moderating-comments-and-conversations/managing-disruptive-comments#editing-a-comment). | +| Acción | Descripción | +| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `discussion_post_reply.destroy` | [Se borró una respuesta a una publicación de debate de equipo](/communities/moderating-comments-and-conversations/managing-disruptive-comments#deleting-a-comment). | +| `discussion_post_reply.update` | [Se editó una respuesta a una publicación de debate de equipo](/communities/moderating-comments-and-conversations/managing-disruptive-comments#editing-a-comment). | {%- endif %} {%- ifversion ghec or ghes %} -## `dotcom_connection` category actions +## Acciones de la categoría `dotcom_connection` -| Acción | Descripción | -| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dotcom_connection.create` | A {% data variables.product.prodname_github_connect %} connection to {% data variables.product.prodname_dotcom_the_website %} was created. | -| `dotcom_connection.destroy` | A {% data variables.product.prodname_github_connect %} connection to {% data variables.product.prodname_dotcom_the_website %} was deleted. | -| `dotcom_connection.token_updated` | The {% data variables.product.prodname_github_connect %} connection token for {% data variables.product.prodname_dotcom_the_website %} was updated. | -| `dotcom_connection.upload_license_usage` | {% data variables.product.prodname_ghe_server %} license usage was manually uploaded to {% data variables.product.prodname_ghe_cloud %}. | -| `dotcom_connection.upload_usage_metrics` | {% data variables.product.prodname_ghe_server %} usage metrics were uploaded to {% data variables.product.prodname_dotcom_the_website %}. | +| Acción | Descripción | +| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `dotcom_connection.create` | Se creó una conexión de {% data variables.product.prodname_github_connect %} al {% data variables.product.prodname_dotcom_the_website %}. | +| `dotcom_connection.destroy` | Se borró una conexión de {% data variables.product.prodname_github_connect %} al {% data variables.product.prodname_dotcom_the_website %}. | +| `dotcom_connection.token_updated` | Se actualizó el token de conexión de {% data variables.product.prodname_github_connect %} para {% data variables.product.prodname_dotcom_the_website %}. | +| `dotcom_connection.upload_license_usage` | El uso de la licencia de {% data variables.product.prodname_ghe_server %} se cargó manualmente a {% data variables.product.prodname_ghe_cloud %}. | +| `dotcom_connection.upload_usage_metrics` | Las métricas de uso de {% data variables.product.prodname_ghe_server %} se cargaron a {% data variables.product.prodname_dotcom_the_website %}. | {%- endif %} ## acciones de la categoría `enterprise` -| Acción | Descripción | -| ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `enterprise.config.disable_anonymous_git_access` | An enterprise owner{% ifversion ghes %} or site administrator{% endif %} disabled anonymous Git read access for repositories in the enterprise. Para obtener más información consulta la sección "[Requerir políticas de administración de repositorios en tu empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | -| `enterprise.config.enable_anonymous_git_access` | An enterprise owner{% ifversion ghes %} or site administrator{% endif %} enabled anonymous Git read access for repositories in the enterprise. Para obtener más información consulta la sección "[Requerir políticas de administración de repositorios en tu empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | -| `enterprise.config.lock_anonymous_git_access` | An enterprise owner{% ifversion ghes %} or site administrator{% endif %} locked anonymous Git read access to prevent repository admins from changing existing anonymous Git read access settings for repositories in the enterprise. Para obtener más información consulta la sección "[Requerir políticas de administración de repositorios en tu empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | -| `enterprise.config.unlock_anonymous_git_access` | An enterprise owner{% ifversion ghes %} or site administrator{% endif %} unlocked anonymous Git read access to allow repository admins to change existing anonymous Git read access settings for repositories in the enterprise. Para obtener más información consulta la sección "[Requerir políticas de administración de repositorios en tu empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | -| `enterprise.register_self_hosted_runner` | A new {% data variables.product.prodname_actions %} self-hosted runner was registered. Para obtener más información, consulta la sección "[Agregar un ejecutor auto-hospedado a un repositorio](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository)". | -| `enterprise.remove_self_hosted_runner` | A {% data variables.product.prodname_actions %} self-hosted runner was removed. Para obtener más información, consulta la sección "[Eliminar a un ejecutor de un repositorio](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository)". | -| `enterprise.runner_group_created` | A {% data variables.product.prodname_actions %} self-hosted runner group was created. Para obtener más información, consulta la sección "[Crear un grupo de ejecutores auto-hospedados para una organización](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-organization)". | -| `enterprise.runner_group_removed` | A {% data variables.product.prodname_actions %} self-hosted runner group was removed. Para obtener más información, consulta la sección "[Eliminar un grupo de ejecutores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)". | -| `enterprise.runner_group_renamed` | A {% data variables.product.prodname_actions %} self-hosted runner group was renamed. Para obtener más información, consulta la sección "[Cambiar la política de acceso para un grupo de ejecutores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)". | -| `enterprise.runner_group_updated` | The configuration of a {% data variables.product.prodname_actions %} self-hosted runner group was changed. Para obtener más información, consulta la sección "[Cambiar la política de acceso para un grupo de ejecutores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)". | -| `enterprise.runner_group_runner_removed` | The REST API was used to remove a {% data variables.product.prodname_actions %} self-hosted runner from a group. Para obtener más información, consulta la sección "[Eliminar un ejecutor auto-hospedado de un grupo en una organización](/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization)". | -| `enterprise.runner_group_runners_added` | A {% data variables.product.prodname_actions %} self-hosted runner was added to a group. Para obtener más información, consulta la sección [Mover un ejecutor auto-hospedado a un grupo](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group). | -| `enterprise.runner_group_runners_updated` | Se actualizó una lista de miembros de un grupo de ejecutores de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Configurar ejecutores auto-hospedados en un grupo para una organización](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)". | +| Acción | Descripción | +| ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `enterprise.config.disable_anonymous_git_access` | Un propietario de empresa{% ifversion ghes %} o administrador de sitio{% endif %} inhabilitó el acceso de lectura anónima de Git para los repositorios en la empresa. Para obtener más información consulta la sección "[Requerir políticas de administración de repositorios en tu empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | +| `enterprise.config.enable_anonymous_git_access` | Un propietario de empresa{% ifversion ghes %} o administrador de sitio{% endif %} habilitó el acceso de lectura anónima de Git para los repositorios en la empresa. Para obtener más información consulta la sección "[Requerir políticas de administración de repositorios en tu empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | +| `enterprise.config.lock_anonymous_git_access` | Un propietario de empresa{% ifversion ghes %} o administrador de sitio{% endif %} bloqueó el acceso de lectura anónima de Git para prevenir que los administradores de repositorios cambien los ajustes existentes del acceso de lectura anónima de Git para los repositorios en la empresa. Para obtener más información consulta la sección "[Requerir políticas de administración de repositorios en tu empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | +| `enterprise.config.unlock_anonymous_git_access` | Un propietario de empresa{% ifversion ghes %} o administrador de sitio{% endif %} desbloqueó el acceso de lectura anónima de Git para permitir que los administradores de repositorio cambien los ajustes de acceso de lectura anónima de Git para los repositorios de la empresa. Para obtener más información consulta la sección "[Requerir políticas de administración de repositorios en tu empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | +| `enterprise.register_self_hosted_runner` | Se registró un nuevo ejecutor auto-hospedado de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Agregar un ejecutor auto-hospedado a un repositorio](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository)". | +| `enterprise.remove_self_hosted_runner` | Se eliminó un ejecutor auto-hospedado de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Eliminar a un ejecutor de un repositorio](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository)". | +| `enterprise.runner_group_created` | Se creó un grupo de ejecutores auto-hospedados de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Crear un grupo de ejecutores auto-hospedados para una organización](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-organization)". | +| `enterprise.runner_group_removed` | Se eliminó un grupo de ejecutores auto-hospedados de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Eliminar un grupo de ejecutores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)". | +| `enterprise.runner_group_renamed` | Se renombró a un grupo de ejecutores auto-hospedados de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Cambiar la política de acceso para un grupo de ejecutores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)". | +| `enterprise.runner_group_updated` | Se cambió la configuración de un grupo de ejecutores auto-hospedados de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Cambiar la política de acceso para un grupo de ejecutores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)". | +| `enterprise.runner_group_runner_removed` | Se utilizó la API de REST para eliminar a un ejecutor auto-hospedado de {% data variables.product.prodname_actions %} de un grupo. Para obtener más información, consulta la sección "[Eliminar un ejecutor auto-hospedado de un grupo en una organización](/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization)". | +| `enterprise.runner_group_runners_added` | A {% data variables.product.prodname_actions %} self-hosted runner was added to a group. Para obtener más información, consulta la sección [Mover un ejecutor auto-hospedado a un grupo](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group). | +| `enterprise.runner_group_runners_updated` | Se actualizó una lista de miembros de un grupo de ejecutores de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Configurar ejecutores auto-hospedados en un grupo para una organización](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)". | {%- ifversion ghec %} | `enterprise.runner_group_visiblity_updated` | Se actualizó la visibilidad de un grupo de ejecutores auto hospedados de {% data variables.product.prodname_actions %} a través de la API de REST. Para obtener más información, consulta la sección "[Actualizar un grupo de ejecutores auto-hospedados para una organización](/rest/reference/actions#update-a-self-hosted-runner-group-for-an-organization)". {%- endif %} @@ -882,10 +882,10 @@ Before you'll see `git` category actions, you must enable Git events in the audi | `pull_request.merge` | A pull request was merged. Para obtener más información, consulta "[Fusionar una solicitud de extracción](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)". | | `pull_request.ready_for_review` | A pull request was marked as ready for review. Para obtener más información, consulta la sección "[Cambiar el estado de una solicitud de extracción](/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#marking-a-pull-request-as-ready-for-review)". | | `pull_request.remove_review_request` | A review request was removed from a pull request. Para obtener más información, consulta la sección "[Acerca de las revisiones de las solicitudes de extracción](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)". | -| `pull_request.reopen` | A pull request was reopened after previously being closed. | +| `pull_request.reopen` | Se volvió a abrir una solicitud de cambios después de que se había cerrado. | | `pull_request_review.delete` | Se borró una revisión en una solicitud de cambios. | | `pull_request_review.dismiss` | Se descartó una revisión de una solicitud de cambios. Para obtener más información, consulta "[Descartar una revisión de solicitud de extracción](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review)". | -| `pull_request_review.submit` | A review was submitted for a pull request. Para obtener más información, consulta la sección "[Acerca de las revisiones de las solicitudes de extracción](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)". | +| `pull_request_review.submit` | Se emitió una revisión para una solicitud de cambios. Para obtener más información, consulta la sección "[Acerca de las revisiones de las solicitudes de extracción](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)". | ## Acciones de la categoría `pull_request_review` @@ -1004,108 +1004,108 @@ Before you'll see `git` category actions, you must enable Git events in the audi | Acción | Descripción | | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `repository_secret_scanning_custom_pattern.create` | Se publicó un patrón personalizado para el escaneo de secretos en un repositorio. Para obtener más información, consulta la sección "[Definir los patrones personalizados para el escaneo de secretos](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-a-repository)". | -| `repository_secret_scanning_custom_pattern.delete` | A custom pattern is removed from secret scanning in a repository. Para obtener más información, consulta la sección "[Definir los patrones personalizados para el escaneo de secretos](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#removing-a-custom-pattern)". | -| `repository_secret_scanning_custom_pattern.update` | Changes to a custom pattern are saved for secret scanning in a repository. Para obtener más información, consulta la sección "[Definir los patrones personalizados para el escaneo de secretos](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#editing-a-custom-pattern)". | +| `repository_secret_scanning_custom_pattern.delete` | Se eliminó un patrón personalizado del escaneo de secretos en un repositorio. Para obtener más información, consulta la sección "[Definir los patrones personalizados para el escaneo de secretos](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#removing-a-custom-pattern)". | +| `repository_secret_scanning_custom_pattern.update` | Se guardan cambios a un patrón personalizado para el escaneo de secretos en un repositorio. Para obtener más información, consulta la sección "[Definir los patrones personalizados para el escaneo de secretos](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#editing-a-custom-pattern)". | ## Acciones de la categoría `repository_secret_scanning_push_protection` -| Acción | Descripción | -| ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `repository_secret_scanning_push_protection.disable` | A repository owner or administrator disabled secret scanning for a repository. Para obtener más información, consulta la sección "[Proteger las subidas de información con el escaneo de secretos](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)". | -| `repository_secret_scanning_push_protection.enable` | A repository owner or administrator enabled secret scanning for a repository. Para obtener más información, consulta la sección "[Proteger las subidas de información con el escaneo de secretos](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)". | +| Acción | Descripción | +| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `repository_secret_scanning_push_protection.disable` | Un propietario o administrador de repositorio inhabilitó el escaneo de secretos para un repositorio. Para obtener más información, consulta la sección "[Proteger las subidas de información con el escaneo de secretos](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)". | +| `repository_secret_scanning_push_protection.enable` | Un propietario o administrador de repositorio habilitó el escaneo de secretos para un repositorio. Para obtener más información, consulta la sección "[Proteger las subidas de información con el escaneo de secretos](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)". | {%- endif %} -## `repository_visibility_change` category actions +## Acciones de la categoría `repository_visibility_change` -| Acción | Descripción | -| -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `repository_visibility_change.clear` | The repository visibility change setting was cleared for an organization or enterprise. Para obtener más información, consulta las secciones "[restringir los cambios de visibilidad de los repositorios en tu organización](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)" y "[requerir una política para los cambios en la visibilidad de un repositorio](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-changes-to-repository-visibility) para una empresa". | -| `repository_visibility_change.disable` | The ability for enterprise members to update a repository's visibility was disabled. Members are unable to change repository visibilities in an organization, or all organizations in an enterprise. | -| `repository_visibility_change.enable` | The ability for enterprise members to update a repository's visibility was enabled. Members are able to change repository visibilities in an organization, or all organizations in an enterprise. | +| Acción | Descripción | +| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `repository_visibility_change.clear` | El ajuste de cambio de visibilidad de repositorio se autorizó para una organización o empresa. Para obtener más información, consulta las secciones "[restringir los cambios de visibilidad de los repositorios en tu organización](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)" y "[requerir una política para los cambios en la visibilidad de un repositorio](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-changes-to-repository-visibility) para una empresa". | +| `repository_visibility_change.disable` | Se inhabilitó la capacidad para que los miembros de la empresa actualicen la visibilidad de un repositorio. Los miembros no pueden cambiar las visibilidades de los repositorios en una organización o en todas las organizaciones de una empresa. | +| `repository_visibility_change.enable` | Se habilitó la capacidad de los miembros de una empresa para actualizar la visibilidad de un repositorio. Los miembros pueden cambiar las visibilidades de un repositorio en una organización o en todas las organizaciones de una empresa. | ## acciones de la categoría `repository_vulnerability_alert` | Acción | Descripción | | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `repository_vulnerability_alert.create` | {% data variables.product.product_name %} created a {% data variables.product.prodname_dependabot %} alert for a repository that uses an insecure dependency. Para obtener más información, consulta la sección "[Acerca de las {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)". | -| `repository_vulnerability_alert.dismiss` | An organization owner or repository administrator dismissed a {% data variables.product.prodname_dependabot %} alert about a vulnerable dependency{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %}. | -| `repository_vulnerability_alert.resolve` | Someone with write access to a repository pushed changes to update and resolve a {% data variables.product.prodname_dependabot %} alert in a project dependency. | +| `repository_vulnerability_alert.create` | {% data variables.product.product_name %} creó una {% data variables.product.prodname_dependabot %} para un repositorio que utiliza una dependencia insegura. Para obtener más información, consulta la sección "[Acerca de las {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)". | +| `repository_vulnerability_alert.dismiss` | Un propietario de organización o administrador de repositorio descartó una alerta de {% data variables.product.prodname_dependabot %} sobre una dependencia vulnerable{% ifversion GH-advisory-db-supports-malware %} o malware{% endif %}. | +| `repository_vulnerability_alert.resolve` | Alguien con acceso de escritura a un repositorio subió cambios para actualizar y resolver una alerta de {% data variables.product.prodname_dependabot %} en una dependencia de proyecto. | {%- ifversion fpt or ghec %} ## acciones de la categoría `repository_vulnerability_alerts` -| Acción | Descripción | -| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `repository_vulnerability_alerts.authorized_users_teams` | An organization owner or repository administrator updated the list of people or teams authorized to receive {% data variables.product.prodname_dependabot_alerts %} for the repository. Para obtener más información, consulta la sección "[Administrar la configuración de seguridad y análisis para tu repositorio](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)". | -| `repository_vulnerability_alerts.disable` | A repository owner or repository administrator disabled {% data variables.product.prodname_dependabot_alerts %}. | -| `repository_vulnerability_alerts.enable` | A repository owner or repository administrator enabled {% data variables.product.prodname_dependabot_alerts %}. | +| Acción | Descripción | +| -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `repository_vulnerability_alerts.authorized_users_teams` | Un propietario de organización o administrador de repositorio actualizó la lista de personas o equipos autorizados para recibir {% data variables.product.prodname_dependabot_alerts %} para el repositorio. Para obtener más información, consulta la sección "[Administrar la configuración de seguridad y análisis para tu repositorio](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)". | +| `repository_vulnerability_alerts.disable` | Un propietario o administrador de repositorio inhabilitó las {% data variables.product.prodname_dependabot_alerts %}. | +| `repository_vulnerability_alerts.enable` | Un propietario o administrador de repositorio habilitó las {% data variables.product.prodname_dependabot_alerts %}. | {%- endif %} -## `required_status_check` category actions +## Acciones de la categoría `required_status_check` -| Acción | Descripción | -| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `required_status_check.create` | A status check was marked as required for a protected branch. Para obtener más información, consulta la sección "[Requerir verificaciones de estado antes de la fusión](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-status-checks-before-merging)". | -| `required_status_check.destroy` | A status check was no longer marked as required for a protected branch. Para obtener más información, consulta la sección "[Requerir verificaciones de estado antes de la fusión](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-status-checks-before-merging)". | +| Acción | Descripción | +| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `required_status_check.create` | Se marcó una verificación de estado como requerida para una rama potencial. Para obtener más información, consulta la sección "[Requerir verificaciones de estado antes de la fusión](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-status-checks-before-merging)". | +| `required_status_check.destroy` | Se dejó de marcar una verificación de estado como requerida para una rama protegida. Para obtener más información, consulta la sección "[Requerir verificaciones de estado antes de la fusión](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-status-checks-before-merging)". | {%- ifversion ghec or ghes %} -## `restrict_notification_delivery` category actions +## Acciones de la categoría `restrict_notification_delivery` -| Acción | Descripción | -| ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `restrict_notification_delivery.enable` | Email notification restrictions for an organization or enterprise were enabled. Para obtener más información, consulta las secciones "[Restringir las notificaciones de correo electrónico de tu organización](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization)" y "[Restringir las notificaciones de correo electrónico para tu empresa](/admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise)". | -| `restrict_notification_delivery.disable` | Email notification restrictions for an organization or enterprise were disabled. Para obtener más información, consulta las secciones "[Restringir las notificaciones de correo electrónico de tu organización](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization)" y "[Restringir las notificaciones de correo electrónico para tu empresa](/admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise)". | +| Acción | Descripción | +| ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `restrict_notification_delivery.enable` | Se habilitaron las restricciones para las notificaciones de correo electrónico para una organización o empresa. Para obtener más información, consulta las secciones "[Restringir las notificaciones de correo electrónico de tu organización](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization)" y "[Restringir las notificaciones de correo electrónico para tu empresa](/admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise)". | +| `restrict_notification_delivery.disable` | Se inhabilitaron las restricciones de notificación por correo electrónico para una organización o empresa. Para obtener más información, consulta las secciones "[Restringir las notificaciones de correo electrónico de tu organización](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization)" y "[Restringir las notificaciones de correo electrónico para tu empresa](/admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise)". | {%- endif %} {%- ifversion custom-repository-roles %} ## Acciones de la categoría `role` -| Acción | Descripción | -| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `create (crear)` | An organization owner created a new custom repository role. Para obtener más información, consulta la sección "[Administrar los roles personalizados de repositorio en una organización](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". | -| `destroy (destruir)` | An organization owner deleted a custom repository role. Para obtener más información, consulta la sección "[Administrar los roles personalizados de repositorio en una organización](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". | -| `actualización` | An organization owner edited an existing custom repository role. Para obtener más información, consulta la sección "[Administrar los roles personalizados de repositorio en una organización](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". | +| Acción | Descripción | +| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `create (crear)` | El propietario de una organización creó un nuevo rol personalizado para un repositorio. Para obtener más información, consulta la sección "[Administrar los roles personalizados de repositorio en una organización](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". | +| `destroy (destruir)` | Un propietario de organización borró un rol de repositorio personalizado. Para obtener más información, consulta la sección "[Administrar los roles personalizados de repositorio en una organización](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". | +| `actualización` | Un propietario de organización editó un rol personalizado de un repositorio existente. Para obtener más información, consulta la sección "[Administrar los roles personalizados de repositorio en una organización](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". | {%- endif %} {%- ifversion ghec or ghes or ghae %} ## Acciones de la categoría `secret_scanning` -| Acción | Descripción | -| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `secret_scanning.disable` | An organization owner disabled secret scanning for all existing{% ifversion ghec %} private or internal{% endif %} repositories. Para obtener más información, consulta la sección "[Acerca del escaneo de secretos"](/github/administering-a-repository/about-secret-scanning). | -| `secret_scanning.enable` | An organization owner enabled secret scanning for all existing{% ifversion ghec %} private or internal{% endif %} repositories. | +| Acción | Descripción | +| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `secret_scanning.disable` | Un propietario de organización inhabilitó el escaneo de secretos para todos los repositorios {% ifversion ghec %} privados o internos{% endif %} existentes. Para obtener más información, consulta la sección "[Acerca del escaneo de secretos"](/github/administering-a-repository/about-secret-scanning). | +| `secret_scanning.enable` | Un propietario de una organización habilitó el escaneo de secretos para todos los repositorios {% ifversion ghec %} privados o internos{% endif %}. | {% ifversion secret-scanning-alert-audit-log %} ## Acciones de la categoría `secret_scanning_alert` -| Acción | Descripción | -| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `secret_scanning_alert.create` | {% data variables.product.prodname_dotcom %} detected a secret and created a {% data variables.product.prodname_secret_scanning %} alert. Para obtener más información, consulta la sección "[Administrar las alertas de {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/managing-alerts-from-secret-scanning)". | -| `secret_scanning_alert.reopen` | A user reopened a {% data variables.product.prodname_secret_scanning %} alert. | -| `secret_scanning_alert.resolve` | A user resolved a {% data variables.product.prodname_secret_scanning %} alert. | +| Acción | Descripción | +| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `secret_scanning_alert.create` | {% data variables.product.prodname_dotcom %} detectó un secreto y creó una alerta del {% data variables.product.prodname_secret_scanning %}. Para obtener más información, consulta la sección "[Administrar las alertas de {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/managing-alerts-from-secret-scanning)". | +| `secret_scanning_alert.reopen` | Un usuario volvió a abrir una alerta del {% data variables.product.prodname_secret_scanning %}. | +| `secret_scanning_alert.resolve` | Un usuario resolvió una alerta del {% data variables.product.prodname_secret_scanning %}. | {% endif %} ## Acciones de la categoría `secret_scanning_new_repos` -| Acción | Descripción | -| ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `secret_scanning_new_repos.disable` | An organization owner disabled secret scanning for all new{% ifversion ghec %} private or internal{% endif %} repositories. Para obtener más información, consulta la sección "[Acerca del escaneo de secretos"](/github/administering-a-repository/about-secret-scanning). | -| `secret_scanning_new_repos.enable` | An organization owner enabled secret scanning for all new{% ifversion ghec %} private or internal{% endif %} repositories. | +| Acción | Descripción | +| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `secret_scanning_new_repos.disable` | Un propietario de organización inhabilitó el escaneo de secretos para todos los repositorios {% ifversion ghec %} privados o internos{% endif %} existentes. Para obtener más información, consulta la sección "[Acerca del escaneo de secretos"](/github/administering-a-repository/about-secret-scanning). | +| `secret_scanning_new_repos.enable` | Un propietario de organización habilitó el escaneo de secretos para todos los repositorios {% ifversion ghec %} privados o internos{% endif %} nuevos. | {%- endif %} {% ifversion secret-scanning-push-protection-bypasses %} ## Acciones de la categoría `secret_scanning_push_protection` -| Acción | Descripción | -| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `bypass` | Se activa cuando un usuario omite la protección de subida en un secreto que detectó el escaneo de secretos. For more information, see "[Bypassing push protection for a secret](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#bypassing-push-protection-for-a-secret)."{% endif %} +| Acción | Descripción | +| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `bypass` | Se activa cuando un usuario omite la protección de subida en un secreto que detectó el escaneo de secretos. Para obtener más información, consulta la sección "[Omitir la protección contra subida de información para un secreto](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#bypassing-push-protection-for-a-secret)".{% endif %} {%- ifversion ghec or ghes or ghae %} -## `security_key` category actions +## Acciones de la categoría `security_key` -| Acción | Descripción | -| ----------------------- | ------------------------------------------------ | -| `security_key.register` | A security key was registered for an account. | -| `security_key.remove` | Se eliminó una llave de seguridad de una cuenta. | +| Acción | Descripción | +| ----------------------- | --------------------------------------------------- | +| `security_key.register` | Se registró una llave de seguridad para una cuenta. | +| `security_key.remove` | Se eliminó una llave de seguridad de una cuenta. | {%- endif %} {%- ifversion fpt or ghec %} @@ -1186,24 +1186,24 @@ Before you'll see `git` category actions, you must enable Git events in the audi {%- ifversion ghec or ghes or ghae %} | `team.demote_maintainer` | Se bajó de categoría a un usuario de mantenedor de equipo a miembro de equipo. | `team.promote_maintainer` | Se promovió a un usuario de miembro a mantenedor de equipo. Para obtener más información, consulta la sección "[Promover a un miembro de la organización a mantenedor de equipo](/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member#promoting-an-organization-member-to-team-maintainer)". {%- endif %} -| `team.remove_member` | Se eliminó a un miembro de una organización de un equipo. For more information, see "[Removing organization members from a team](/organizations/organizing-members-into-teams/removing-organization-members-from-a-team)." | `team.remove_repository` | A repository was no longer under a team's control. | `team.rename` | A team's name was changed. | `team.update_permission` | A team's access was changed. | `team.update_repository_permission` | A team's permission to a repository was changed. +| `team.remove_member` | Se eliminó a un miembro de una organización de un equipo. Para obtener más información, consulta la sección "[Eliminar miembros organizacionales de un equipo](/organizations/organizing-members-into-teams/removing-organization-members-from-a-team)". | `team.remove_repository` | Un repositorio dejó de estar bajo el control de un equipo. | `team.rename` | Se cambió el nombre de un equipo. | `team.update_permission` | Se cambió el acceso de un equipo. | `team.update_repository_permission` | Se cambió el permiso de un equipo para un repositorio. ## acciones de la categoría `team_discussions` -| Acción | Descripción | -| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `team_discussions.clear` | An organization owner cleared the setting to allow team discussions for an organization or enterprise. | -| `team_discussions.disable` | An organization owner disabled team discussions for an organization. Para obtener más información, consulta "[Desactivar los debates del equipo para tu organización](/organizations/organizing-members-into-teams/disabling-team-discussions-for-your-organization)". | -| `team_discussions.enable` | An organization owner enabled team discussions for an organization. | +| Acción | Descripción | +| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `team_discussions.clear` | Un propietario de una organización autorizó el ajuste para permitir debates de equipo para una organización o empresa. | +| `team_discussions.disable` | Un propietario de organización inhabilitó los debates de equipo para una organización. Para obtener más información, consulta "[Desactivar los debates del equipo para tu organización](/organizations/organizing-members-into-teams/disabling-team-discussions-for-your-organization)". | +| `team_discussions.enable` | Un propietario de organización habilitó los debates de equipo para una organización. | {%- ifversion ghec %} -## `team_sync_tenant` category actions +## Acciones de la categoría `team_sync_tenant` -| Acción | Descripción | -| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `team_sync_tenant.disabled` | Team synchronization with a tenant was disabled. Para obtener más información, consulta las secciones "[Administrar la sincronización de equipos para tu organización](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)" y "[Administrar la sincronización de equipos para las organizaciones en tu empresa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)". | -| `team_sync_tenant.enabled` | Team synchronization with a tenant was enabled. Para obtener más información, consulta las secciones "[Administrar la sincronización de equipos para tu organización](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)" y "[Administrar la sincronización de equipos para las organizaciones en tu empresa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)". | -| `team_sync_tenant.update_okta_credentials` | The Okta credentials for team synchronization with a tenant were changed. | +| Acción | Descripción | +| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `team_sync_tenant.disabled` | Se inhabilitó la sincronización de equipos con un inquilino. Para obtener más información, consulta las secciones "[Administrar la sincronización de equipos para tu organización](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)" y "[Administrar la sincronización de equipos para las organizaciones en tu empresa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)". | +| `team_sync_tenant.enabled` | Team synchronization with a tenant was enabled. Para obtener más información, consulta las secciones "[Administrar la sincronización de equipos para tu organización](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)" y "[Administrar la sincronización de equipos para las organizaciones en tu empresa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)". | +| `team_sync_tenant.update_okta_credentials` | The Okta credentials for team synchronization with a tenant were changed. | {%- endif %} {%- ifversion fpt or ghes %} diff --git a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/displaying-ip-addresses-in-the-audit-log-for-your-enterprise.md b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/displaying-ip-addresses-in-the-audit-log-for-your-enterprise.md index 558a5cb068..cda38b616c 100644 --- a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/displaying-ip-addresses-in-the-audit-log-for-your-enterprise.md +++ b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/displaying-ip-addresses-in-the-audit-log-for-your-enterprise.md @@ -24,7 +24,7 @@ If you choose to display IP addresses, the IP addresses only appear in your ente You can display IP addresses in the audit log regardless of which authentication method you use for your enterprise on {% data variables.product.product_location %}. Para obtener más información, consulta la sección "[Acerca de la autenticación para tu empresa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)". -When anyone creates an account on {% data variables.product.product_location %}, the person agrees to {% data variables.product.company_short %}'s collection of basic information about connections to {% data variables.product.company_short %}'s services, including source IP address. For more information, see "[GitHub Privacy Statement](/free-pro-team@latest/site-policy/privacy-policies/github-privacy-statement#usage-information)." +Cuando alguien crea una cuenta en {% data variables.product.product_location %}, la persona está de acuerdo en que {% data variables.product.company_short %} recopile información básica sobre las conexiones con los servicios de {% data variables.product.company_short %}, incluyendo las direcciones IP de origen. For more information, see "[GitHub Privacy Statement](/free-pro-team@latest/site-policy/privacy-policies/github-privacy-statement#usage-information)." ## Events that display IP addresses in the audit log diff --git a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md index 9c829d511b..0ecc3ec98d 100644 --- a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md +++ b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md @@ -44,7 +44,8 @@ Puedes configurar la transmisión de bitácoras de auditoría en {% data variabl - [Amazon S3](#setting-up-streaming-to-amazon-s3) - [Almacenamiento de Blobs de Azure](#setting-up-streaming-to-azure-blob-storage) -- [Azure Event Hubs](#setting-up-streaming-to-azure-event-hubs) +- [Azure Event Hubs](#setting-up-streaming-to-azure-event-hubs){% ifversion streaming-datadog %} +- [Datadog](#setting-up-streaming-to-datadog){% endif %} - [Google Cloud Storage](#setting-up-streaming-to-google-cloud-storage) - [Splunk](#setting-up-streaming-to-splunk) @@ -60,7 +61,7 @@ Puedes configurar la transmisión de S3 con claves de acceso o, para evitar el a #### Configurar la transmisión a S3 con llaves de acceso {% endif %} -Para transmitir bitácoras de auditoría a la terminal de Amazon S3, debes tener un bucket y llaves de acceso. Para obtener más información, consulta la sección [Crear, configurar y trabajar con los buckets de Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) en la documentación de AWS. Asegúrate de bloquear el acceso público al bucket para proteger la información de tu bitácora de auditoría. +Para transmitir bitácoras de auditoría a la terminal de Amazon S3, debes tener un bucket y llaves de acceso. Para obtener más información, consulta la sección "[Crear, configurar y trabajar con buckets de Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) en la documentación de AWS. Asegúrate de bloquear el acceso público al bucket para proteger la información de tu bitácora de auditoría. Para configurar la transmisión de bitácora de auditoría desde {% data variables.product.prodname_dotcom %}, necesitarás: * El nombrede tu bucket de Amazon S3 @@ -87,7 +88,7 @@ Para obtener más información sobre cómo crear o acceder a tu ID de llave de a {% note %} -**Note:** Streaming to Amazon S3 with OpenID Connect is currently in beta and subject to change. +**Nota:** La transmisión a Amazon S3 con OpenID Connect se encuentra actualmente en beta y está sujeta a cambios. {% endnote %} @@ -231,6 +232,32 @@ Necesitas dos partes de información sobre tu concentrador de eventos: su nombre {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +{% ifversion streaming-datadog %} +### Setting up streaming to Datadog + +To set up streaming to Datadog, you must create a client token or an API key in Datadog, then configure audit log streaming in {% data variables.product.product_name %} using the token for authentication. You do not need to create a bucket or other storage container in Datadog. + +After you set up streaming to Datadog, you can see your audit log data by filtering by "github.audit.streaming." For more information, see [Log Management](https://docs.datadoghq.com/logs/). + +1. If you don't already have a Datadog account, create one. +1. In Datadog, generate a client token or an API key, then click **Copy key**. For more information, see [API and Application Keys](https://docs.datadoghq.com/account_management/api-app-keys/) in Datadog Docs. +{% data reusables.enterprise.navigate-to-log-streaming-tab %} +1. Select the **Configure stream** dropdown menu and click **Datadog**. + + ![Screenshot of the "Configure stream" dropdown menu with "Datadog" highlighted](/assets/images/help/enterprises/audit-stream-choice-datadog.png) +1. Under "Token", paste the token you copied earlier. + + ![Screenshot of the "Token" field](/assets/images/help/enterprises/audit-stream-datadog-token.png) +1. Select the "Site" dropdown menu and click your Datadog site. To determine your Datadog site, compare your Datadog URL to the table in [Datadog sites](https://docs.datadoghq.com/getting_started/site/) in Datadog Docs. + + ![Screenshot of the "Site" dropdown menu](/assets/images/help/enterprises/audit-stream-datadog-site.png) +1. To verify that {% data variables.product.prodname_dotcom %} can connect and write to the Datadog endpoint, click **Check endpoint**. + + ![Verificar la terminal](/assets/images/help/enterprises/audit-stream-check.png) +{% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +1. After a few minutes, confirm that audit log data is appearing on the **Logs** tab in Datadog. If audit log data is not appearing, confirm that your token and site are correct in {% data variables.product.prodname_dotcom %}. +{% endif %} + ### Configurar la transmisión para Google Cloud Storage Para configurar la transmisión al Almacenamiento de Google Cloud, debes crear una cuenta de servicio en Google Cloud con las credenciales y permisos adecuados y luego configurar la transmisión de bitácoras de auditoría en {% data variables.product.product_name %} utilizando las credenciales de la cuenta de servicio para la autenticación. @@ -265,7 +292,7 @@ Para transmitir bitácoras de auditoría a la terminal del Recolector de Eventos {% data reusables.enterprise.navigate-to-log-streaming-tab %} 1. Haz clic en **Configurar transmisión** y selecciona **Splunk**. - ![Elige Splunk desde el menú desplegable](/assets/images/help/enterprises/audit-stream-choice-splunk.png) + ![Elegir Splunk del menú desplegable](/assets/images/help/enterprises/audit-stream-choice-splunk.png) 1. En la página de configuración, ingresa: * El dominio en el cual se hospeda la aplicación que quieres transmitir. @@ -291,6 +318,10 @@ Para transmitir bitácoras de auditoría a la terminal del Recolector de Eventos El pausar la transmisión te permite realizar el mantenimiento de la aplicación receptora sin perder datos de auditoría. Las bitácoras de auditoría se almacenan por hasta siete días en {% data variables.product.product_location %} y luego se exportan cuando dejas de pausar la transmisión. +{% ifversion streaming-datadog %} +Datadog only accepts logs from up to 18 hours in the past. If you pause a stream to a Datadog endpoint for more than 18 hours, you risk losing logs that Datadog won't accept after you resume streaming. +{% endif %} + {% data reusables.enterprise.navigate-to-log-streaming-tab %} 1. Haz clic en **Pausar transmisión**. diff --git a/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md b/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md index b1ed91a0ce..75b2044c67 100644 --- a/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md +++ b/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md @@ -79,12 +79,17 @@ You can also configure allowed IP addresses for an individual organization. For ### Adding an allowed IP address +{% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} + +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} {% data reusables.identity-and-permissions.ip-allow-lists-add-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-add-description %} {% data reusables.identity-and-permissions.ip-allow-lists-add-entry %} +{% data reusables.identity-and-permissions.check-ip-address %} ### Allowing access by {% data variables.product.prodname_github_apps %} @@ -92,6 +97,8 @@ You can also configure allowed IP addresses for an individual organization. For ### Enabling allowed IP addresses +{% data reusables.identity-and-permissions.about-enabling-allowed-ip-addresses %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} @@ -101,6 +108,8 @@ You can also configure allowed IP addresses for an individual organization. For ### Editing an allowed IP address +{% data reusables.identity-and-permissions.about-editing-ip-allow-list-entries %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} @@ -108,6 +117,18 @@ You can also configure allowed IP addresses for an individual organization. For {% data reusables.identity-and-permissions.ip-allow-lists-edit-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-description %} 8. Click **Update**. +{% data reusables.identity-and-permissions.check-ip-address %} + +{% ifversion ip-allow-list-address-check %} +### Checking if an IP address is permitted + +{% data reusables.identity-and-permissions.about-checking-ip-address %} + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.security-tab %} +{% data reusables.identity-and-permissions.check-ip-address-step %} +{% endif %} ### Deleting an allowed IP address diff --git a/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md b/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md index 9907694777..ebe7c2bde5 100644 --- a/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md +++ b/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md @@ -71,24 +71,28 @@ Si un propietario de empresa deja de permitir que los miembros de ésta creen ci {% endif %} -## Requerir una política para los permisos {% ifversion ghec or ghes or ghae %}base{% else %}predeterminados{% endif %} del repositorio +## Enforcing a policy for base repository permissions -En todas las organizaciones que pertenezcan a tu empresa, puedes configurar un nivel de permisos {% ifversion ghec or ghes or ghae %}base{% else %}predeterminado{% endif %} de los repositorios (ninguno, lectura, escritura o administración) para los miembros organizacionales o permitir que los propietarios administren el ajuste a nivel de organización. +Across all organizations owned by your enterprise, you can set a base repository permission level (none, read, write, or admin) for organization members, or allow owners to administer the setting on the organization level. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} -4. Debajo de "permisos {% ifversion ghec or ghes or ghae %}base{% else %}predeterminados{% endif %}", revisa la información sobre cómo cambiar el ajuste. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -5. Debajo de "Permisos{% ifversion ghec or ghes or ghae %}base{% else %}predeterminados{% endif %}", utiliza el menú desplegable y elige una política. - {% ifversion ghec or ghes or ghae %} - ![Menú desplegable con opciones de políticas de permisos de repositorios](/assets/images/help/business-accounts/repository-permissions-policy-drop-down.png) - {% else %} - ![Menú desplegable con opciones de políticas de permisos de repositorios](/assets/images/enterprise/business-accounts/repository-permissions-policy-drop-down.png) - {% endif %} +4. Under "Base permissions", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +5. En "Permisos base", usa el menú desplegable y elige una política. ![Menú desplegable con opciones de políticas de permisos de repositorios](/assets/images/help/business-accounts/repository-permissions-policy-drop-down.png) + ## Requerir una política para la creación de repositorios -En todas las organizaciones que le pertenecen a tu empresa, puedes permitir que los miembros creen repositorios, restringir la creación de repositorios para los propietarios de la organización o permitir que los propietarios administren los ajustes en el nivel de la organización. Si permites que los miembros creen repositorios, puedes decidir si pueden crear cualquier combinación de repositorios públicos, privados e internos. {% data reusables.repositories.internal-repo-default %} Para obtener más información acerca de los repositorios internos, consulta "[Crear un repositorio interno](/articles/creating-an-internal-repository)". +En todas las organizaciones que le pertenecen a tu empresa, puedes permitir que los miembros creen repositorios, restringir la creación de repositorios para los propietarios de la organización o permitir que los propietarios administren los ajustes en el nivel de la organización. + +If you allow members to create repositories in your organizations, you can choose which types of repositories (public, private, and internal) that members can create. + +{% ifversion enterprise-namespace-repo-setting %} +{% ifversion ghec %}If your enterprise uses {% data variables.product.prodname_emus %}, you{% else %}You{% endif %} can also prevent users from creating repositories owned by their user accounts. +{% endif %} + +{% data reusables.repositories.internal-repo-default %} Para obtener más información acerca de los repositorios internos, consulta "[Crear un repositorio interno](/articles/creating-an-internal-repository)". {% data reusables.organizations.repo-creation-constants %} @@ -96,33 +100,32 @@ En todas las organizaciones que le pertenecen a tu empresa, puedes permitir que {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} 5. En "Creación de repositorio", revisa la información sobre cómo modificar los parámetros. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -{% ifversion ghes or ghae or ghec %} {% data reusables.enterprise-accounts.repo-creation-policy %} -{% data reusables.enterprise-accounts.repo-creation-types %} -{% else %} -6. En "Creación de repositorios", usa el menú desplegable y elige una política. - - ![Menú desplegable con políticas para creación de repositorio](/assets/images/enterprise/site-admin-settings/repository-creation-drop-down.png) -{% endif %} +{% data reusables.enterprise-accounts.repo-creation-types %}{% ifversion enterprise-namespace-repo-setting %} +1. Optionally, {% ifversion ghec %}if your enterprise uses {% data variables.product.prodname_emus %} and you want {% endif %}to prevent enterprise members from creating repositories owned by their user accounts, select **Block the creation of user namespace repositories**. ![Screenshot showing the list of disabled options from forking policy](/assets/images/help/business-accounts/restrict-personal-namespace-enabled-setting.png){% endif %} ## Requerir una política para bifurcar repositorios privados o internos En todas las organizaciones que pertenezcan a tu empresa, puedes permitir o prohibir la bifurcación de un repositorio privado o interno o permitir a los propietarios administrar la configuración a nivel organizacional para todos los que tengan acceso a éstos. +{% ifversion enterprise-namespace-repo-setting %} +{% note %} + +**Nota:** Si {% ifversion ghec %}tu empresa utiliza {% data variables.product.prodname_emus %} y {% endif %} tu política de "Creación de repositorios" previene que los miembros de las empresas creen repositorios que le pertenezcan a sus cuentas de usuario, no se permitirá que dichos miembros bifurquen un repositorio en sus cuentas de usuario, sin importar tu política de "Bifurcación de repositorios". + +{% endnote %} +{% endif %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} 3. Debajo de "Bifurcación de repositorios", revisa la información sobre cómo cambiar el ajuste. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} 4. En "Bifurcación de repositorios", usa el menú desplegable y elige una política. - ![Menú desplegable con opciones de políticas de bifurcación de repositorios](/assets/images/help/business-accounts/repository-forking-policy-drop-down.png) - -{% ifversion innersource-fork-policies %} + ![Menú desplegable con opciones de políticas de bifurcación de repositorios](/assets/images/help/business-accounts/repository-forking-policy-drop-down.png){% ifversion innersource-fork-policies %} 5. Si se habilita la bifurcación, puedes especificar en dónde se permite que los usuarios bifurquen repositorios. Revisa la información sobre cómo cambiar el ajuste y elige una política. - ![Captura de pantalla que muestra la lista de opciones de políticas para bifurcar repositorios](/assets/images/help/business-accounts/repository-forking-policy-settings.png) -{% endif %} - + ![Captura de pantalla que muestra la lista de opciones de políticas para bifurcar repositorios](/assets/images/help/business-accounts/repository-forking-policy-settings.png){% endif %} ## Requerir una política para invitar colaboradores{% ifversion ghec %} externos{% endif %} a los repositorios @@ -140,8 +143,6 @@ En todas las organizaciones que pertenezcan a tu empresa, puedes permitir que lo ![Menú desplegable con opciones de política de invitación](/assets/images/enterprise/business-accounts/repository-invitation-policy-drop-down.png) {% endif %} -{% ifversion ghec or ghes or ghae %} - ## Requerir una política para el nombre de rama predeterminada Puedes configurar el nombre de rama predeterminada para cualquier repositorio miembro que creen los miembros en todas las organizaciones que pertenezcan a tu empresa. Puedes elegir el requerir un nombre de rama predeterminado a través de todas las organizaciones o permitir a algunas configurar un nombre diferente. @@ -152,8 +153,6 @@ Puedes configurar el nombre de rama predeterminada para cualquier repositorio mi 4. Opcionalmente, para requerir el nombre de rama predeterminado para todas las organizaciones en la empresa, selecciona **Requerir en toda la empresa**. ![Casilla de requerir](/assets/images/help/business-accounts/default-branch-name-enforce.png) 5. Da clic en **Actualizar**. ![Botón de actualizar](/assets/images/help/business-accounts/default-branch-name-update.png) -{% endif %} - ## Requerir una política para los cambios a la visibilidad del repositorio En todas las organizaciones que pertenezcan a tu empresa, puedes permitir que los miembros con acceso administrativo cambien la visibilidad de un repositorio, restrinjan los cambios de visibilidad del mismo a los propietarios de la organización o que permitan que los propietarios administren el ajuste a nivel organizacional. Cuando no permites que los miembros cambien la visibilidad del repositroio, únicamente los propietarios de la empresa podrán hacerlo. @@ -163,9 +162,8 @@ Si un propietario de empresa restringió la creación de repositorios en la mism {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} -5. En "Modificar visibilidad del repositorio", revisa la información sobre cómo modificar los parámetros. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} - -{% data reusables.enterprise-accounts.repository-visibility-policy %} +1. En "Modificar visibilidad del repositorio", revisa la información sobre cómo modificar los parámetros. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +1. Debajo de "Repository visibility change" (Cambio de visibilidad de repositorios), usa el menú desplegable y elige una política. ![Menú desplegable con opciones de políticas de visibilidad de repositorios](/assets/images/help/business-accounts/repository-visibility-policy-drop-down.png) ## Requerir una política para el borrado y transferencia de repositorios diff --git a/translations/es-ES/content/authentication/connecting-to-github-with-ssh/about-ssh.md b/translations/es-ES/content/authentication/connecting-to-github-with-ssh/about-ssh.md index 55caa8e709..1a3f28d82a 100644 --- a/translations/es-ES/content/authentication/connecting-to-github-with-ssh/about-ssh.md +++ b/translations/es-ES/content/authentication/connecting-to-github-with-ssh/about-ssh.md @@ -1,6 +1,6 @@ --- title: Acerca de SSH -intro: 'Usando el protocolo SSH, te puedes conectar y autenticar con servicios y servidores remotos. Con las llaves SSH puedes conectarte a {% data variables.product.product_name %} sin proporcionar tu nombre de usuario y token de acceso personal en cada visita.' +intro: 'Usando el protocolo SSH, te puedes conectar y autenticar con servicios y servidores remotos. With SSH keys, you can connect to {% data variables.product.product_name %} without supplying your username and personal access token at each visit.{% ifversion ssh-commit-verification %} You can also use an SSH key to sign commits.{% endif %}' redirect_from: - /articles/about-ssh - /github/authenticating-to-github/about-ssh @@ -16,7 +16,7 @@ topics: {% data reusables.ssh.about-ssh %} Para obtener más información sobre SSH, consulta la página de [Secure Shell](https://en.wikipedia.org/wiki/Secure_Shell) en Wikipedia. -Cuando configuras SSH, necesitarás generar una llave SSH privada nueva y agregarla al agente SSH. También debes agregar la llave SSH pública a tu cuenta en {% data variables.product.product_name %} antes de que utilices la llave para autenticarte. Para obtener más información, consulta las secciones "[Generar una llave SSH nueva y agregarla al ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)" y "[Agregar una llave SSH nueva a tu cuenta de {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)". +Cuando configuras SSH, necesitarás generar una llave SSH privada nueva y agregarla al agente SSH. You must also add the public SSH key to your account on {% data variables.product.product_name %} before you use the key to authenticate{% ifversion ssh-commit-verification %} or sign commits{% endif %}. Para obtener más información, consulta las secciones "[Generar una llave SSH nueva y agregarla al ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)"{% ifversion ssh-commit-verification %}, {% else %}y{% endif %} "[Agregar una llave SSH nueva a tu cuenta de {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account){% ifversion ssh-commit-verification %}" y "[Acerca de la verificación de firmas de confirmación](/articles/about-commit-signature-verification){% endif %}". Puedes asegurar tu llave SSH aún más si utilizas una llave de seguridad de hardware, la cual requiere que esta última se conecte físicamente a tu computadora cuando se utilice el par de llaves para autenticarte con SSH. También puedes asegurar tu llave SSH si la agregas al ssh-agent y utiliza una contraseña. Para obtener más información, consulta la sección "[Trabajar con frases de acceso con llave SSH](/github/authenticating-to-github/working-with-ssh-key-passphrases)". @@ -33,7 +33,6 @@ Las organizaciones que utilizan {% data variables.product.prodname_ghe_cloud %} {% else ghec or ghes or ghae %} Si eres miembro de una organización que provee certificados SSH, puedes usar tu certificado para acceder a los repositorios de esa organización sin agregar el certificado a tu cuenta de {% data variables.product.product_name %}. No puedes utilizar tu certificado para acceder a las bifurcaciones de los repositorios de la organización si estas bifurcaciones le pertenecen a tu cuenta personal. Para obtener más información, consulta la sección [Acerca de las autoridades de certificados SSH](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities)". {% endif %} - ## Leer más - "[Solucionar problemas de SSH](/articles/troubleshooting-ssh)" diff --git a/translations/es-ES/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md b/translations/es-ES/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md index 0d0d83bc2c..a4569d589d 100644 --- a/translations/es-ES/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md +++ b/translations/es-ES/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md @@ -19,6 +19,8 @@ shortTitle: Add a new SSH key {% data reusables.ssh.about-ssh %} For more information, see "[About SSH](/authentication/connecting-to-github-with-ssh/about-ssh)." +{% ifversion ssh-commit-verification %}You can also use SSH to sign commits and tags. For more information about commit signing, see "[About commit signature verification](/articles/about-commit-signature-verification)."{% endif %} + After you generate an SSH key pair, you must add the public key to {% ifversion fpt or ghec or ghes %}{% data variables.product.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %} to enable SSH access for your account. ## Prerequisites @@ -30,120 +32,46 @@ Before adding a new SSH key to your account on {% ifversion ghae %}{% data varia ## Adding a new SSH key to your account -After adding a new SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you can reconfigure any local repositories to use SSH. For more information, see "[Switching remote URLs from HTTPS to SSH](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-https-to-ssh)." +After adding a new SSH authentication key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you can reconfigure any local repositories to use SSH. For more information, see "[Switching remote URLs from HTTPS to SSH](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-https-to-ssh)." {% data reusables.ssh.key-type-support %} -{% mac %} - {% webui %} -1. Copy the SSH public key to your clipboard. - - If your SSH public key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace. - - ```shell - $ pbcopy < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub - # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard - ``` - - {% tip %} - - **Tip:** If `pbcopy` isn't working, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. - - {% endtip %} - +{% data reusables.gpg.copy-ssh-public-key %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.ssh %} 4. Click **New SSH key** or **Add SSH key**. +{% ifversion ssh-commit-verification %} + ![SSH Key button](/assets/images/help/settings/ssh-add-ssh-key-with-auth.png) +{% else %} ![SSH Key button](/assets/images/help/settings/ssh-add-ssh-key.png) -5. In the "Title" field, add a descriptive label for the new key. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air". -6. Paste your key into the "Key" field. +{% endif %} +5. In the "Title" field, add a descriptive label for the new key. For example, if you're using a personal laptop, you might call this key "Personal laptop". +{% ifversion ssh-commit-verification %} +6. Select the type of key, either authentication or signing. For more information about commit signing, see "[About commit signature verification](/articles/about-commit-signature-verification)." +{% endif %} +7. Paste your key into the "Key" field. +{% ifversion ssh-commit-verification %} + ![The key field](/assets/images/help/settings/ssh-key-paste-with-type.png) +{% else %} ![The key field](/assets/images/help/settings/ssh-key-paste.png) -7. Click **Add SSH key**. +{% endif %} +8. Click **Add SSH key**. ![The Add key button](/assets/images/help/settings/ssh-add-key.png) {% data reusables.user-settings.sudo-mode-popup %} {% endwebui %} -{% endmac %} - -{% windows %} - -{% webui %} - -1. Copy the SSH public key to your clipboard. - - If your SSH public key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace. - - ```shell - $ clip < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub - # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard - ``` - - {% tip %} - - **Tip:** If `clip` isn't working, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. - - {% endtip %} - -{% data reusables.user-settings.access_settings %} -{% data reusables.user-settings.ssh %} -4. Click **New SSH key** or **Add SSH key**. - ![SSH Key button](/assets/images/help/settings/ssh-add-ssh-key.png) -5. In the "Title" field, add a descriptive label for the new key. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air". -6. Paste your key into the "Key" field. - ![The key field](/assets/images/help/settings/ssh-key-paste.png) -7. Click **Add SSH key**. - ![The Add key button](/assets/images/help/settings/ssh-add-key.png) -{% data reusables.user-settings.sudo-mode-popup %} - -{% endwebui %} - -{% endwindows %} - -{% linux %} - -{% webui %} - -1. Copy the SSH public key to your clipboard. - - If your SSH public key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace. - - ```shell - $ cat ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub - # Then select and copy the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file - # displayed in the terminal to your clipboard - ``` - - {% tip %} - - **Tip:** Alternatively, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. - - {% endtip %} - -{% data reusables.user-settings.access_settings %} -{% data reusables.user-settings.ssh %} -4. Click **New SSH key** or **Add SSH key**. - ![SSH Key button](/assets/images/help/settings/ssh-add-ssh-key.png) -5. In the "Title" field, add a descriptive label for the new key. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air". -6. Paste your key into the "Key" field. - ![The key field](/assets/images/help/settings/ssh-key-paste.png) -7. Click **Add SSH key**. - ![The Add key button](/assets/images/help/settings/ssh-add-key.png) -{% data reusables.user-settings.sudo-mode-popup %} - -{% endwebui %} - -{% endlinux %} - {% cli %} {% data reusables.cli.cli-learn-more %} Before you can use the {% data variables.product.prodname_cli %} to add an SSH key to your account, you must authenticate to the {% data variables.product.prodname_cli %}. For more information, see [`gh auth login`](https://cli.github.com/manual/gh_auth_login) in the {% data variables.product.prodname_cli %} documentation. -To add an SSH key to your GitHub account, use the `ssh-key add` subcommand, specifying your public key. +{% ifversion ssh-commit-verification %}At present, you can only use {% data variables.product.prodname_cli %} to add SSH authentication keys, you cannot add SSH signing keys.{% endif %} + +To add an SSH authentication key to your GitHub account, use the `ssh-key add` subcommand, specifying your public key. ```shell gh ssh-key add key-file diff --git a/translations/es-ES/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md b/translations/es-ES/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md index adb05a61f9..b2287d3a5e 100644 --- a/translations/es-ES/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md +++ b/translations/es-ES/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md @@ -1,6 +1,6 @@ --- title: About commit signature verification -intro: 'Using GPG or S/MIME, you can sign tags and commits locally. These tags or commits are marked as verified on {% data variables.product.product_name %} so other people can be confident that the changes come from a trusted source.' +intro: 'Using GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME, you can sign tags and commits locally. These tags or commits are marked as verified on {% data variables.product.product_name %} so other people can be confident that the changes come from a trusted source.' redirect_from: - /articles/about-gpg-commit-and-tag-signatures - /articles/about-gpg @@ -19,10 +19,18 @@ shortTitle: Commit signature verification --- ## About commit signature verification -You can sign commits and tags locally, to give other people confidence about the origin of a change you have made. If a commit or tag has a GPG or S/MIME signature that is cryptographically verifiable, GitHub marks the commit or tag {% ifversion fpt or ghec %}"Verified" or "Partially verified."{% else %}"Verified."{% endif %} +You can sign commits and tags locally, to give other people confidence about the origin of a change you have made. If a commit or tag has a GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME signature that is cryptographically verifiable, {% data variables.product.product_name %} marks the commit or tag {% ifversion fpt or ghec %}"Verified" or "Partially verified."{% else %}"Verified."{% endif %} ![Verified commit](/assets/images/help/commits/verified-commit.png) +{% ifversion ghes or ghae %} +If a commit or tag has a signature that can't be verified, {% data variables.product.product_name %} marks the commit or tag "Unverified." +{% endif %} + +{% ifversion ssh-commit-verification %} +For most individual users, GPG or SSH will be the best choice for signing commits. S/MIME signatures are usually required in the context of a larger organization. SSH signatures are the simplest to generate. You can even upload your existing authentication key to {% data variables.product.product_name %} to also use as a signing key. Generating a GPG signing key is more involved than generating an SSH key, but GPG has features that SSH does not. A GPG key can expire or be revoked when no longer used. {% data variables.product.product_name %} shows commits that were signed with such a key as "Verified" unless the key was marked as compromised. SSH keys don't have this capability. +{% endif %} + {% ifversion fpt or ghec %} Commits and tags have the following verification statuses, depending on whether you have enabled vigilant mode. By default vigilant mode is not enabled. For information on how to enable vigilant mode, see "[Displaying verification statuses for all of your commits](/github/authenticating-to-github/displaying-verification-statuses-for-all-of-your-commits)." @@ -47,10 +55,9 @@ For more information, see "[Rebasing and merging your commits](/repositories/con {% data reusables.identity-and-permissions.vigilant-mode-verification-statuses %} -{% else %} -If a commit or tag has a signature that can't be verified, {% data variables.product.product_name %} marks the commit or tag "Unverified." {% endif %} + Repository administrators can enforce required commit signing on a branch to block all commits that are not signed and verified. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-signed-commits)." {% data reusables.identity-and-permissions.verification-status-check %} @@ -59,7 +66,7 @@ Repository administrators can enforce required commit signing on a branch to blo {% ifversion ghes %}If a site administrator has enabled web commit signing, {% data variables.product.product_name %} will automatically use GPG to sign commits you make using the web interface. Commits signed by {% data variables.product.product_name %} will have a verified status. You can verify the signature locally using the public key available at `https://HOSTNAME/web-flow.gpg`. For more information, see "[Configuring web commit signing](/admin/configuration/configuring-your-enterprise/configuring-web-commit-signing)." {% else %}{% data variables.product.prodname_dotcom %} will automatically use GPG to sign commits you make using the web interface. Commits signed by {% data variables.product.prodname_dotcom %} will have a verified status. You can verify the signature locally using the public key available at https://github.com/web-flow.gpg. The full fingerprint of the key is `5DE3 E050 9C47 EA3C F04A 42D3 4AEE 18F8 3AFD EB23`. -You can optionally choose to have {% data variables.product.prodname_dotcom %} sign commits you make in {% data variables.product.prodname_github_codespaces %}. For more information about enabling GPG verification for your codespaces, see "[Managing GPG verification for {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)."{% endif %} +You can optionally choose to have {% data variables.product.prodname_dotcom %} GPG sign commits you make in {% data variables.product.prodname_github_codespaces %}. For more information about enabling GPG verification for your codespaces, see "[Managing GPG verification for {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)."{% endif %} {% endif %} ## GPG commit signature verification @@ -77,6 +84,26 @@ To sign commits using GPG and have those commits verified on {% data variables.p 5. [Sign commits](/articles/signing-commits) 6. [Sign tags](/articles/signing-tags) +{% ifversion ssh-commit-verification %} +## SSH commit signature verification + +You can use SSH to sign commits with an SSH public key that you generate yourself. If you already use an SSH key to authenticate with {% data variables.product.product_name %}, +you can also upload that same key again for use as a signing key. There's no limit on the number of signing keys you can add to your account. + +{% data variables.product.product_name %} uses [ssh_data](https://github.com/github/ssh_data), an open source Ruby library, to confirm that your locally signed commits and tags are cryptographically verifiable against a public key you have added to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. + +{% data reusables.gpg.ssh-git-version %} + +To sign commits using SSH and have those commits verified on {% data variables.product.product_name %}, follow these steps: + +1. [Check for existing SSH keys](/articles/checking-for-existing-ssh-keys) +2. [Generate a new SSH key](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) +3. [Add a SSH signing key to your GitHub account](/articles/adding-a-new-ssh-key-to-your-github-account) +4. [Tell Git about your signing key](/articles/telling-git-about-your-signing-key) +5. [Sign commits](/articles/signing-commits) +6. [Sign tags](/articles/signing-tags) + +{% endif %} ## S/MIME commit signature verification You can use S/MIME to sign commits with an X.509 key issued by your organization. diff --git a/translations/es-ES/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md b/translations/es-ES/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md index 27205863ec..3e6af65879 100644 --- a/translations/es-ES/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md +++ b/translations/es-ES/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md @@ -19,7 +19,7 @@ redirect_from: Cuando trabajas localmente en tu computadora, Git te permite configurar el autor de tus cambios y la identidad del confirmante. Esto, potencialmente, dificulta que otras personas tengan la confimansa de que realmente hayas creado tus etiquetas y confirmaciones. Para ayudarte a resolver este problema, puedes firmar tus confirmaciones y etiquetas. Para obtener más información, consulta la sección "[Firmar confirmaciones](/github/authenticating-to-github/signing-commits)" y "[Firmar etiquetas](/github/authenticating-to-github/signing-tags)". {% data variables.product.prodname_dotcom %} marca las etiquetas y confirmaciones firmadas con un estado de verificación. -Predeterminadamente, las confirmaciones y etiquetas se marcan como "Verificadas" si se firman con una llave GPG o S/MIME que se verificó con éxito. Si una confirmación o etiqueta tiene una firma que no puede verificar {% data variables.product.prodname_dotcom %}, la marcaremos como "No verificada". En el resto de los casos, no se muestra un estado de verificación. +By default commits and tags are marked "Verified" if they are signed with a GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME key that was successfully verified. Si una confirmación o etiqueta tiene una firma que no puede verificar {% data variables.product.prodname_dotcom %}, la marcaremos como "No verificada". En el resto de los casos, no se muestra un estado de verificación. Sin embargo, puedes proporcionar aún más confianza a otros usuarios sobre la identidad que se atribuye a tus confirmaciones y etiquetas si habilitas el modo vigilanten en tu configuración de {% data variables.product.prodname_dotcom %}. Cuando tienes habilitado el modo vigilante, todas tus confirmaciones y etiquetas se marcan con uno de tres estados de verificación. diff --git a/translations/es-ES/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md b/translations/es-ES/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md index 63ddd127e8..e86df4c351 100644 --- a/translations/es-ES/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md +++ b/translations/es-ES/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md @@ -29,11 +29,11 @@ topics: {% data reusables.command_line.open_the_multi_os_terminal %} 3. Genera un par de la llave GPG. Ya que existen varias versiones de GPG, puede que necesites consultar la [_página man_](https://en.wikipedia.org/wiki/Man_page) relevante para encontrar el comando adecuado para la generación de llaves. Tu llave debe utilizar RSA. - Si estás usando una versión 2.1.17 o superior, copia el siguiente texto para generar un par de la llave GPG. - ```shell + ```shell{:copy} $ gpg --full-generate-key ``` - Si no estás usando la versión 2.1.17 ni una superior, el comando `gpg --full-generate-key` no funciona. Copia el siguiente texto y continúa con el paso 6. - ```shell + ```shell{:copy} $ gpg --default-new-key-algo rsa4096 --gen-key ``` 4. En el prompt, especifica la clase de llave que quieres, o presiona `Enter` para aceptar lo predeterminado. @@ -52,10 +52,10 @@ topics: {% data reusables.gpg.list-keys-with-note %} {% data reusables.gpg.copy-gpg-key-id %} 10. Pega el siguiente texto sustituyendo el ID de la llave GPG que deseas usar. En este ejemplo, el ID de la llave GPG es `3AA5C34371567BD2`: - ```shell - $ gpg --armor --export 3AA5C34371567BD2 - # Prints the GPG key ID, in ASCII armor format - ``` + ```shell{:copy} + $ gpg --armor --export 3AA5C34371567BD2 + # Prints the GPG key ID, in ASCII armor format + ``` 11. Copia tu llave GPG, comenzando con `-----BEGIN PGP PUBLIC KEY BLOCK-----` y terminando con `-----END PGP PUBLIC KEY BLOCK-----`. 12. [Agrega la llave GPG a tu cuenta de GitHub](/articles/adding-a-gpg-key-to-your-github-account). diff --git a/translations/es-ES/content/authentication/managing-commit-signature-verification/index.md b/translations/es-ES/content/authentication/managing-commit-signature-verification/index.md index cc874bcb11..f081788d36 100644 --- a/translations/es-ES/content/authentication/managing-commit-signature-verification/index.md +++ b/translations/es-ES/content/authentication/managing-commit-signature-verification/index.md @@ -1,6 +1,6 @@ --- title: Administrar la verificación de firma de confirmación de cambios -intro: 'Puedes firmar tu trabajo localmente utilizando GPG o S/MIME. {% data variables.product.product_name %} verificará estas firmas para que otras personas sepan que tus confirmaciones de cambios provienen de una fuente confiable.{% ifversion fpt %} {% data variables.product.product_name %} firmará de forma automática las confirmaciones de cambios que realices utilizando la interfaz web {% data variables.product.product_name %}.{% endif %}' +intro: '{% data variables.product.product_name %} verificará las firmas GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} o S/MIME para que otras personas sepan que tus confirmaciones vienen de una fuente confiable.{% ifversion fpt %} {% data variables.product.product_name %} firmará automáticamente las confirmaciones que realices utilizando la interfaz web de {% data variables.product.product_name %}.{% endif %}' redirect_from: - /articles/generating-a-gpg-key - /articles/signing-commits-with-gpg diff --git a/translations/es-ES/content/authentication/managing-commit-signature-verification/signing-commits.md b/translations/es-ES/content/authentication/managing-commit-signature-verification/signing-commits.md index 912baf0ee2..e3f02babc3 100644 --- a/translations/es-ES/content/authentication/managing-commit-signature-verification/signing-commits.md +++ b/translations/es-ES/content/authentication/managing-commit-signature-verification/signing-commits.md @@ -1,6 +1,6 @@ --- title: Firmar confirmaciones -intro: Puedes firmar las confirmaciones localmente utilizando GPG o S/MIME. +intro: 'Puedes firmar las confirmaciones localmente utilizando GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} o S/MIME.' redirect_from: - /articles/signing-commits-and-tags-using-gpg - /articles/signing-commits-using-gpg @@ -52,9 +52,5 @@ Si tienes múltiples llaves o estás intentando firmar confirmaciones o etiqueta ## Leer más -* "[Comprobar llaves GPG existentes](/articles/checking-for-existing-gpg-keys)" -* "[Generar una llave GPG nueva](/articles/generating-a-new-gpg-key)" -* "[Agregar una llave GPG a tu cuenta de GitHub](/articles/adding-a-gpg-key-to-your-github-account)" * "[Informar a Git sobre tu llave de firma](/articles/telling-git-about-your-signing-key)" -* "[Asociar un correo electrónico con tu llave GPG](/articles/associating-an-email-with-your-gpg-key)" * "[Firmar etiquetas](/articles/signing-tags)" diff --git a/translations/es-ES/content/authentication/managing-commit-signature-verification/signing-tags.md b/translations/es-ES/content/authentication/managing-commit-signature-verification/signing-tags.md index cafb07beec..576223480e 100644 --- a/translations/es-ES/content/authentication/managing-commit-signature-verification/signing-tags.md +++ b/translations/es-ES/content/authentication/managing-commit-signature-verification/signing-tags.md @@ -1,6 +1,6 @@ --- title: Firmar etiquetas -intro: Puedes firmar las etiquetas localmente utilizando GPG o S/MIME. +intro: 'You can sign tags locally using GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME.' redirect_from: - /articles/signing-tags-using-gpg - /articles/signing-tags @@ -32,9 +32,6 @@ topics: ## Leer más - [Ver las etiquetas de tu repositorio](/articles/viewing-your-repositorys-tags)" -- "[Comprobar llaves GPG existentes](/articles/checking-for-existing-gpg-keys)" -- "[Generar una llave GPG nueva](/articles/generating-a-new-gpg-key)" -- "[Agregar una llave GPG a tu cuenta de GitHub](/articles/adding-a-gpg-key-to-your-github-account)" - "[Informar a Git sobre tu llave de firma](/articles/telling-git-about-your-signing-key)" - "[Asociar un correo electrónico con tu llave GPG](/articles/associating-an-email-with-your-gpg-key)" - "[Firmar confirmaciones](/articles/signing-commits)" diff --git a/translations/es-ES/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md b/translations/es-ES/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md index 426c771f8d..6fd5e87f3b 100644 --- a/translations/es-ES/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md +++ b/translations/es-ES/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md @@ -1,6 +1,6 @@ --- title: Informarle a Git acerca de tu clave de firma -intro: 'Para firmar las confirmaciones localmente, necesitas informar a Git que hay una llave de GPG o X.509 que quieres utilizar.' +intro: 'To sign commits locally, you need to inform Git that there''s a GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or X.509 key you''d like to use.' redirect_from: - /articles/telling-git-about-your-gpg-key - /articles/telling-git-about-your-signing-key @@ -52,8 +52,6 @@ Si tienes múltiples llaves GPG, le debes decir a Git cuál utilizar. $ killall gpg-agent ``` -{% data reusables.gpg.x-509-key %} - {% endmac %} {% windows %} @@ -75,8 +73,6 @@ Si tienes múltiples llaves GPG, le debes decir a Git cuál utilizar. {% data reusables.gpg.copy-gpg-key-id %} {% data reusables.gpg.paste-gpg-key-id %} -{% data reusables.gpg.x-509-key %} - {% endwindows %} {% linux %} @@ -101,15 +97,25 @@ Si tienes múltiples llaves GPG, le debes decir a Git cuál utilizar. ```bash $ [ -f ~/.bashrc ] && echo 'export GPG_TTY=$(tty)' >> ~/.bashrc ``` - {% endlinux %} +{% ifversion ssh-commit-verification %} +## Telling Git about your SSH key + +You can use an existing SSH key to sign commits and tags, or generate a new one specifically for signing. Para obtener más información, consulta "[Generar una nueva llave SSH y agregarla a ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." + +{% data reusables.gpg.ssh-git-version %} + +{% data reusables.command_line.open_the_multi_os_terminal %} +{% data reusables.gpg.configure-ssh-signing %} +{% data reusables.gpg.copy-ssh-public-key %} +{% data reusables.gpg.paste-ssh-public-key %} + +{% endif %} + +{% data reusables.gpg.x-509-key %} ## Leer más -- "[Comprobar llaves GPG existentes](/articles/checking-for-existing-gpg-keys)" -- "[Generar una llave GPG nueva](/articles/generating-a-new-gpg-key)" -- "[Utilizar una dirección de correo electrónico verificada en tu llave GPG](/articles/using-a-verified-email-address-in-your-gpg-key)" -- "[Agregar una llave GPG a tu cuenta de GitHub](/articles/adding-a-gpg-key-to-your-github-account)" -- "[Asociar un correo electrónico con tu llave GPG](/articles/associating-an-email-with-your-gpg-key)" +- "[Adding a new SSH key to your GitHub account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)." - "[Firmar confirmaciones](/articles/signing-commits)" - "[Firmar etiquetas](/articles/signing-tags)" diff --git a/translations/es-ES/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md b/translations/es-ES/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md index 93de4440ac..9902de28a0 100644 --- a/translations/es-ES/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md +++ b/translations/es-ES/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md @@ -22,7 +22,10 @@ shortTitle: Verificar el estado de verificación 1. En {% data variables.product.product_name %}, desplázate hasta la solicitud de extracción. {% data reusables.repositories.review-pr-commits %} 3. Junto al hash de confirmación abreviado de tu confirmación, hay una casilla que te muestra si tu firma de confirmación se verificó{% ifversion fpt or ghec %}, se verificó parcialmente,{% endif %} o si no se verificó. ![Confirmación firmada](/assets/images/help/commits/gpg-signed-commit-verified-without-details.png) -4. Para ver información más detallada sobre la firma de confirmación, haz clic en **Verificada**{% ifversion fpt or ghec %}, **Verificada parcialmente**,{% endif %} o **Sin verificar**. ![Confirmación firmada verificada](/assets/images/help/commits/gpg-signed-commit_verified_details.png) +4. Para ver información más detallada sobre la firma de confirmación, haz clic en **Verificada**{% ifversion fpt or ghec %}, **Verificada parcialmente**,{% endif %} o **Sin verificar**. GPG signed commits will show the ID of the key that was used. ![Verified GPG signed commit](/assets/images/help/commits/gpg-signed-commit_verified_details.png) +{% ifversion ssh-commit-verification %} + SSH signed commits will show the signature of the public key that was used. ![Verified SSH signed commit](/assets/images/help/commits/ssh-signed-commit-verified-details.png) +{% endif %} ## Comprobar el estado de verificación de firma de la etiqueta diff --git a/translations/es-ES/content/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot.md b/translations/es-ES/content/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot.md index 9722449988..816c27b417 100644 --- a/translations/es-ES/content/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot.md +++ b/translations/es-ES/content/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot.md @@ -18,4 +18,4 @@ Before starting a paid subscription, you can set up a one-time 60-day trial to e The {% data variables.product.prodname_copilot %} subscription is available on a monthly or yearly cycle. If you choose a monthly billing cycle, you will be billed $10 per calendar month. If you choose a yearly billing cycle, you will be billed $100 per year. You can modify your billing cycle at any time, and the modification will be reflected from the start of your next billing cycle. -A free subscription for {% data variables.product.prodname_copilot %} is available to verified students, and maintainers of popular open-source repositories on {% data variables.product.company_short %}. If you meet the criteria as an open source maintainer, you will be automatically notified when you visit the {% data variables.product.prodname_copilot %} subscription page. As a student, if you currently receive the {% data variables.product.prodname_student_pack %}, you will also be offered a free subscription when you visit the {% data variables.product.prodname_copilot %} subscription page. For more information about the {% data variables.product.prodname_student_pack %}, see "[Apply to {% data variables.product.prodname_global_campus %} as a student](/free-pro-team@latest/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student)." +A free subscription for {% data variables.product.prodname_copilot %} is available to verified students, and maintainers of popular open-source repositories on {% data variables.product.company_short %}. If you meet the criteria as an open source maintainer, you will be automatically notified when you visit the {% data variables.product.prodname_copilot %} subscription page. As a student, if you currently receive the {% data variables.product.prodname_student_pack %}, you will also be offered a free subscription when you visit the {% data variables.product.prodname_copilot %} subscription page. Para obtener más información sobre el {% data variables.product.prodname_student_pack %}, consulta la sección "[Solicitar ingresar al {% data variables.product.prodname_global_campus %} como alumno](/free-pro-team@latest/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student)". diff --git a/translations/es-ES/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md b/translations/es-ES/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md index 7dbda8a14b..0a0aa5a1df 100644 --- a/translations/es-ES/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md +++ b/translations/es-ES/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md @@ -50,9 +50,9 @@ Todos los datos de transferencia saliente, cuando se desencadenan mediante {% da El uso de almacenamiento se comparte con los artefactos de compilación que produce {% data variables.product.prodname_actions %} para los repositorios que pertenecen a tu cuenta. Para obtener más información, consulta "[Acerca de la facturación para {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)". -{% data variables.product.prodname_dotcom %} cobra el uso a la cuenta a la que pertenece el repositorio en donde se publica el paquete. Si tu uso de cuenta sobrepasa estos límites y configuraste un límite de gastos mayor a $0 USD, pagarás $0.25 USD por GB de almacenamiento por día y $0.50 USD por GB de transferencia de datos. +{% data variables.product.prodname_dotcom %} cobra el uso a la cuenta a la que pertenece el repositorio en donde se publica el paquete. Si tu uso de cuenta sobrepasa estos límites y configuraste un límite de gastos mayor a $0 USD, pagarás $0.008 USD por GB de almacenamiento por día y $0.50 USD por GB de transferencia de datos. -Por ejemplo, si tu organización utiliza {% data variables.product.prodname_team %}, permite los gastos ilimitados, utiliza 150GB de almacenamiento, y tiene 50GB de transferencia de datos durante un mes, ésta tendrá un excedente de 148GB en el almacenamiento y de 40GB en transferencia de datos para ese mes. El excedente de almacenamiento costaría $0.25 USD por GB por día o $37 USD. El excedente para transferencia de datos costaría $0.50 USD por GB, o $20 USD. +Por ejemplo, si tu organización utiliza {% data variables.product.prodname_team %}, permite los gastos ilimitados, utiliza 150GB de almacenamiento, y tiene 50GB de transferencia de datos durante un mes, ésta tendrá un excedente de 148GB en el almacenamiento y de 40GB en transferencia de datos para ese mes. El almacenamiento excedente costaría $0.008 USD por GB por día o, aproximadamente, $37 USD por un mes de 31 días. El excedente para transferencia de datos costaría $0.50 USD por GB, o $20 USD. {% data reusables.dotcom_billing.pricing_calculator.pricing_cal_packages %} diff --git a/translations/es-ES/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md b/translations/es-ES/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md index 3d0dd9028a..3e14720e63 100644 --- a/translations/es-ES/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md +++ b/translations/es-ES/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md @@ -1,6 +1,6 @@ --- -title: Troubleshooting license usage for GitHub Enterprise -intro: You can troubleshoot license usage for your enterprise by auditing license reports. +title: Solucionar problemas de uso de licencia para GitHub Enterprise +intro: Puedes solucionar los problemas con el uso de licencia para tu empresa si auditas los reportes de licencia. permissions: 'Enterprise owners can review license usage for {% data variables.product.prodname_enterprise %}.' versions: ghec: '*' @@ -9,26 +9,26 @@ type: how_to topics: - Enterprise - Licensing -shortTitle: Troubleshoot license usage +shortTitle: Solucionar el uso de licencia --- -## About unexpected license usage +## Acerca del uso de licencia inesperado -If the number of consumed licenses for your enterprise is unexpected, you can review your consumed license report to audit your license usage across all your enterprise deployments and subscriptions. For more information, see "[Viewing license usage for GitHub Enterprise](/billing/managing-your-license-for-github-enterprise/viewing-license-usage-for-github-enterprise)" and "[Viewing the subscription and usage for your enterprise account](/billing/managing-billing-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account)." +Si la cantidad de licencias consumidas para tu empresa es inesperada, puedes revisar tu reporte de licencias consumidas para auditar tu uso de licencia en todos los despliegues y suscripciones de tu empresa. Para obtener más información, consulta la sección "[Ver el uso de licencia para GitHub Enterprise](/billing/managing-your-license-for-github-enterprise/viewing-license-usage-for-github-enterprise)" y "[Ver la suscripción y el uso de tu cuenta empresarial](/billing/managing-billing-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account)". -If you find errors, you can try troubleshooting steps. +Si encuentras errores, puedes intentar solucionar los problemas de los pasos. -For privacy reasons, enterprise owners cannot directly access the details of user accounts unless you use {% data variables.product.prodname_emus %}. +Por razones de privacidad, los propietarios de las empresas no pueden acceder directamente a los detalles de las cuentas de usuario a menos de que utilices {% data variables.product.prodname_emus %}. -## About the calculation of consumed licenses +## Acerca del cálculo de licencias consumidas -{% data variables.product.company_short %} bills for each person who uses deployments of {% data variables.product.prodname_ghe_server %}, is a member of one of your organizations on {% data variables.product.prodname_ghe_cloud %}, or is a {% data variables.product.prodname_vs_subscriber %}. For more information about the people in your enterprise who consume a license, see "[About per-user pricing](/billing/managing-billing-for-your-github-account/about-per-user-pricing)." +{% data variables.product.company_short %} factura por cada persona que utilice despliegues de {% data variables.product.prodname_ghe_server %}, que sea miembro de una de tus organizaciones en {% data variables.product.prodname_ghe_cloud %} o que sea un {% data variables.product.prodname_vs_subscriber %}. Para obtener más información sobre las personas de tu empresa que consumen licencias, consulta la sección "[Acerca de los precios por usuario](/billing/managing-billing-for-your-github-account/about-per-user-pricing)". -For each user to consume a single seat regardless of how many deployments they use, you must synchronize license usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}. Para obtener más información, consulta la sección "[Sincronizar el uso de licencia entre {% data variables.product.prodname_ghe_server %} y {% data variables.product.prodname_ghe_cloud %}](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)". +Para que cada usuario consuma una sola plaza sin importar cuántos despliegues utilicen, debes sincronizar el uso de licencias entre {% data variables.product.prodname_ghe_server %} y {% data variables.product.prodname_ghe_cloud %}. Para obtener más información, consulta la sección "[Sincronizar el uso de licencia entre {% data variables.product.prodname_ghe_server %} y {% data variables.product.prodname_ghe_cloud %}](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)". -After you synchronize license usage, {% data variables.product.prodname_dotcom %} matches user accounts on {% data variables.product.prodname_ghe_server %} with user accounts on {% data variables.product.prodname_ghe_cloud %} by email address. +Después de que sincronizas el uso de licencia, {% data variables.product.prodname_dotcom %} empata las cuentas de usuario en {% data variables.product.prodname_ghe_server %} con las cuentas de usuario en {% data variables.product.prodname_ghe_cloud %} por dirección de correo electrónico. -First, we first check the primary email address of each user on {% data variables.product.prodname_ghe_server %}. Then, we attempt to match that address with the email address for a user account on {% data variables.product.prodname_ghe_cloud %}. If your enterprise uses SAML SSO, we first check the following SAML attributes for email addresses. +Primero, revisa la dirección de correo electrónico principal de cada usuario en {% data variables.product.prodname_ghe_server %}. Después, intenta empatar dicha dirección con la de correo electrónico para una cuenta de usuario de {% data variables.product.prodname_ghe_cloud %}. Si tu empresa utiliza el SSO de SAML, primero hay que verificar los siguientes atributos de SAML para las direcciones de correo electrónco. - `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name` - `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` @@ -36,64 +36,64 @@ First, we first check the primary email address of each user on {% data variable - `ID del nombre` - `emails` -If no email addresses found in these attributes match the primary email address on {% data variables.product.prodname_ghe_server %}, or if your enterprise doesn't use SAML SSO, we then check each of the user's verified email addresses on {% data variables.product.prodname_ghe_cloud %}. Para obtener más información sobre la verificación de las direcciones de correo electrónico de {% data variables.product.prodname_dotcom_the_website %}, consulta la sección "[Verificar tu dirección de correo electrónico](/enterprise-cloud@latest/get-started/signing-up-for-github/verifying-your-email-address){% ifversion not ghec %}" en la documentación de {% data variables.product.prodname_ghe_cloud %}.{% else %}".{% endif %} +Si no hay ninguna dirección de correo electrónico en estos atributos que empate con la dirección primaria en {% data variables.product.prodname_ghe_server %} o si tu empresa no utiliza el SSO de SAML, entonces podemos verificar cada una de las direcciones de correo electrónico verificadas de los usuarios en {% data variables.product.prodname_ghe_cloud %}. Para obtener más información sobre la verificación de las direcciones de correo electrónico de {% data variables.product.prodname_dotcom_the_website %}, consulta la sección "[Verificar tu dirección de correo electrónico](/enterprise-cloud@latest/get-started/signing-up-for-github/verifying-your-email-address){% ifversion not ghec %}" en la documentación de {% data variables.product.prodname_ghe_cloud %}.{% else %}".{% endif %} -## Fields in the consumed license files +## Campos en los archivos de licencia consumidos -The {% data variables.product.prodname_dotcom_the_website %} license usage report and {% data variables.product.prodname_ghe_server %} exported license usage file include a variety of fields to help you troubleshoot license usage for your enterprise. +El reporte de uso de licencia en {% data variables.product.prodname_dotcom_the_website %} y el archivo de uso de licencia exportado de {% data variables.product.prodname_ghe_server %} incluyen varios campos para ayudarte a solucionar los problemas de uso de licencia para tu empresa. -### {% data variables.product.prodname_dotcom_the_website %} license usage report (CSV file) +### Reporte de uso de licencia de {% data variables.product.prodname_dotcom_the_website %} (archivo CSV) -The license usage report for your enterprise is a CSV file that contains the following information about members of your enterprise. Some fields are specific to your {% data variables.product.prodname_ghe_cloud %} (GHEC) deployment, {% data variables.product.prodname_ghe_server %} (GHES) connected environments, or your {% data variables.product.prodname_vs %} subscriptions (VSS) with GitHub Enterprise. +El reporte de uso de licencia para tu empresa es un archivo CSV que contiene la siguiente información sobre los miembros de tu empresa. Algunos campos son específicos para tu despliegue de {% data variables.product.prodname_ghe_cloud %} (GHEC), ambientes conectados de {% data variables.product.prodname_ghe_server %} (GHES) o para tus suscripciones de {% data variables.product.prodname_vs %} (VSS) con GitHub Enterprise. -| Campo | Descripción | -| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| github_com_login | The username for the user's GHEC account | -| github_com_name | The display name for the user's GHEC account | -| github_com_profile | The URL for the user's profile page on GHEC | -| github_com_user | Whether or not the user has an account on GHEC | -| github_com_member_roles | For each of the organizations the user belongs to on GHEC, the organization name and the user's role in that organization (`Owner` or `Member`) separated by a colon

    Organizations delimited by commas | -| github_com_enterprise_role | Can be one of: `Owner`, `Member`, or `Outside collaborator` | -| github_com_verified_domain_emails | All email addresses associated with the user's GHEC account that match your enterprise's verified domains | -| github_com_saml_name_id | The SAML username | -| github_com_orgs_with_pending_invites | All pending invitations for the user's GHEC account to join organizations within your enterprise | -| license_type | Can be one of: `Visual Studio subscription` or `Enterprise` | -| enterprise_server_user | Whether or not the user has at least one account on GHES | -| enterprise_server_primary_emails | The primary email addresses associated with each of the user's GHES accounts | -| enterprise_server_user_ids | For each of the user's GHES accounts, the account's user ID | -| total_user_accounts | The total number of accounts the person has across both GHEC and GHES | -| visual_studio_subscription_user | Whether or not the user is a {% data variables.product.prodname_vs_subscriber %} -| visual_studio_subscription_email | The email address associated with the user's VSS | -| visual_studio_license_status | Whether the Visual Studio license has been matched to a {% data variables.product.company_short %} user | +| Campo | Descripción | +| ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| github_com_login | El nombre de usuario para la cuenta de GHEC del usuario | +| github_com_name | El nombre para mostrar de la cuenta de GHEC del usuario | +| github_com_profile | La URL para la página de perfil del usuario en GHEC | +| github_com_user | Si el usuario tiene una cuenta en GHEC o no | +| github_com_member_roles | Para cada una de las organizaciones a las cuales pertenece el usuario en GHEC, el nombre de organización y el rol del usuario en dicha organización (`Owner` o `Member`) separado por dos puntos

    Las organizaciones se delimitan con comas | +| github_com_enterprise_role | Puede ser una de entre: `Owner`, `Member`, o `Outside collaborator` | +| github_com_verified_domain_emails | Todas las direcciones de correo electrónico asociadas con la cuenta de GHEC del usuario que empaten con los dominios verificados de tu empresa | +| github_com_saml_name_id | El nombre de usuario de SAML | +| github_com_orgs_with_pending_invites | Todas las invitaciones pendientes para que la cuenta de GHEC del usuario se una a organizaciones dentro de tu empresa | +| license_type | Puede ser una de entre: `Visual Studio subscription` o `Enterprise` | +| enterprise_server_user | Si el usuario tiene por lo menos una cuenta en GHES o no | +| enterprise_server_primary_emails | Las direcciones de correo electrónico principales asociadas con cada una de las cuentas de GHES del usuario | +| enterprise_server_user_ids | La ID de usuario de cada una de las cuentas de GHES del usuario | +| total_user_accounts | La cantidad total de cuentas que tiene la persona tanto en GHEC como en GHES | +| visual_studio_subscription_user | Si el usuario es un {% data variables.product.prodname_vs_subscriber %} o no | +| visual_studio_subscription_email | La dirección de correo electrónico asociada con el VSS del usuario | +| visual_studio_license_status | Si la licencia de Visual Studio empató con un usuario de {% data variables.product.company_short %} o no | -{% data variables.product.prodname_vs_subscriber %}s who are not yet members of at least one organization in your enterprise will be included in the report with a pending invitation status, and will be missing values for the "Name" or "Profile link" field. +Los {% data variables.product.prodname_vs_subscriber %}es que aún no son miembros de por lo menos una organización en tu empresa se incluirán en el reporte con un estado de invitación pendiente y serán valores faltantes para el campo de "Nombre" o "Enlace de perfil". -### {% data variables.product.prodname_ghe_server %} exported license usage (JSON file) +### Uso de licencia de {% data variables.product.prodname_ghe_server %} exportada (archivo JSON) -Your {% data variables.product.prodname_ghe_server %} license usage is a JSON file that is typically used when performing a manual sync of user licenses between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} deployments. The file contains the following information specific to your {% data variables.product.prodname_ghe_server %} environment. +Tu uso de licencia de {% data variables.product.prodname_ghe_server %} es un archivo de JSON que se utiliza habitualmente al realizar una sincronización manual de licencias de usuario entre despliegues de {% data variables.product.prodname_ghe_server %} y de {% data variables.product.prodname_ghe_cloud %}. El archivo contiene la siguiente información específica para tu ambiente de {% data variables.product.prodname_ghe_server %}. -| Campo | Descripción | -| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Características | The {% data variables.product.prodname_github_connect %} features that are enabled on your {% data variables.product.prodname_ghe_server %} instance, and the date and time of enablement. | -| Host name | The hostname of your {% data variables.product.prodname_ghe_server %} instance. | -| HTTP only | Whether Transport Layer Security (TLS) is enabled and configured on your {% data variables.product.prodname_ghe_server %} instance. Can be one of: `True` or `False`. | -| Licencia | Un hash de tu licencia {% data variables.product.prodname_ghe_server %}. | -| Public key | La parte pública de la clave de tu licencia {% data variables.product.prodname_ghe_server %}. | -| Server ID | UUID generated for your {% data variables.product.prodname_ghe_server %} instance. | -| Versión | The version of your {% data variables.product.prodname_ghe_server %} instance. | +| Campo | Descripción | +| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Características | Las características de {% data variables.product.prodname_github_connect %} que están habilitadas en tu instancia de {% data variables.product.prodname_ghe_server %} y la fecha y hora de la habilitación. | +| Host name | El nombre de host de tu instancia de {% data variables.product.prodname_ghe_server %}. | +| HTTP only | Si se habilitó y configuró la Seguridad de Capa de Transporte (TLS) en tu instancia de {% data variables.product.prodname_ghe_server %}. Puede ser uno de entre: `True` o `False`. | +| Licencia | Un hash de tu licencia {% data variables.product.prodname_ghe_server %}. | +| Public key | La parte pública de la clave de tu licencia {% data variables.product.prodname_ghe_server %}. | +| Server ID | La UUID generada para tu instancia de {% data variables.product.prodname_ghe_server %}. | +| Versión | La versión de tu instancia de {% data variables.product.prodname_ghe_server %}. | -## Troubleshooting consumed licenses +## Solucionar problemas de las licencias consumidas -To ensure that the each user is only consuming a single seat for different deployments and subscriptions, try the following troubleshooting steps. +Para garantizar que cada usuario solo consume una sola plaza para los diversos despliegues y suscripciones, intenta tomas los siguientes pasos. -1. To help identify users that are consuming multiple seats, if your enterprise uses verified domains for {% data variables.product.prodname_ghe_cloud %}, review the list of enterprise members who do not have an email address from a verified domain associated with their account on {% data variables.product.prodname_dotcom_the_website %}. Often, these are the users who erroneously consume more than one licensed seat. Para obtener más información, consulta la sección "[Ver a los miembros sin un a dirección de correo electrónico desde un dominio verificado](/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise#viewing-members-without-an-email-address-from-a-verified-domain)". +1. Para ayudar a identificar a los usuarios que están consumiendo varias plazas, si tu empresa utiliza los dominios verificados para {% data variables.product.prodname_ghe_cloud %}, revisa la lista de miembros empresariales que no tienen una dirección de correo electrónico de un dominio verificado y asociado con su cuenta en {% data variables.product.prodname_dotcom_the_website %}. A menudo, estos son los usuarios que consumen más de una plaza con licencia por error. Para obtener más información, consulta la sección "[Ver a los miembros sin un a dirección de correo electrónico desde un dominio verificado](/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise#viewing-members-without-an-email-address-from-a-verified-domain)". {% note %} - **Note:** To make troubleshooting easier, we recommend using verified domains with your enterprise account on {% data variables.product.prodname_dotcom_the_website %}. Para obtener más información, consulta la sección "[Verificar o aprobar un dominio para tu empresa](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)". + **Nota:** Para facilitar la solución de problemas, te recomendamos utilizar dominios verificados con tu cuenta empresarial en {% data variables.product.prodname_dotcom_the_website %}. Para obtener más información, consulta la sección "[Verificar o aprobar un dominio para tu empresa](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)". {% endnote %} -1. After you identify users who are consuming multiple seats, make sure that the same email address is associated with all of the user's accounts. For more information about which email addresses must match, see "[About the calculation of consumed licenses](#about-the-calculation-of-consumed-licenses)." -1. If an email address was recently updated or verified to correct a mismatch, view the timestamp of the last license sync job. If a job hasn't run since the correction was made, manually trigger a new job. For more information, see "[Syncing license usage between GitHub Enterprise Server and GitHub Enterprise Cloud](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)." +1. Después de que identifiques a los usuarios que están consumiendo varias plazas, asegúrate de que la misma dirección de correo electrónico esté asociada con todas las cuentas de usuario. Para obtener más información sobre qué direcciones de correo electrónico deben coincidir, consulta la sección "[Acerca del cálculo de las licencias consumidas](#about-the-calculation-of-consumed-licenses)". +1. Si se actualizó o verificó recientemente una dirección de correo electrónico para corregir un desajuste, ve la marca de tiempo del último job de sincronización de licencia. Si un job no se ha ejecutado desde que se realizó la corrección, activa un job nuevo manualmente. Para obtener más información, consulta la sección "[Sincronizar el uso de licencia entre GitHub Enterprise Server y GitHub Enterprise Cloud](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)". -If you still have questions about your consumed licenses after reviewing the troubleshooting information above, you can contact {% data variables.contact.github_support %} through the {% data variables.contact.contact_enterprise_portal %}. +Si aún tienes preguntas sobre tus licencias consumidas después de revisar la información de solución de problemas anterior, puedes contactar a {% data variables.contact.github_support %} a través del {% data variables.contact.contact_enterprise_portal %}. diff --git a/translations/es-ES/content/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md b/translations/es-ES/content/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md index fa57403bd2..62c798ddf3 100644 --- a/translations/es-ES/content/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md +++ b/translations/es-ES/content/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md @@ -19,7 +19,7 @@ Este artículo es parte de una serie de cómo adoptar la {% data variables.produ ### Habilitar el escaneo de código -Using the data you collated in [Phase 2](/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale), you can begin to enable GHAS and then {% data variables.product.prodname_code_scanning %} on your repositories, one language at a time. The step-by-step process for enabling GHAS should look like this: +Utilizando los datos que recolectaste en la [Fase 2](/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale), puedes comenzar a habilitar la GHAS y luego el {% data variables.product.prodname_code_scanning %} en tus repositorios, un lenguaje a la vez. The step-by-step process for enabling GHAS should look like this: 1. Enable GHAS on the repository. Para obtener más información, consulta la sección "[Administrar la configuración de seguridad y análisis para tu repositorio](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)". 1. Create a pull request against the repository's default branch with a `codeql-analysis.yml` file containing an example of how to run CodeQL for that language. Para obtener más información, consulta la sección"[Crear una solicitud de extracción](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)." diff --git a/translations/es-ES/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md b/translations/es-ES/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md index 50befdcdf2..94c550f211 100644 --- a/translations/es-ES/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md +++ b/translations/es-ES/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md @@ -32,7 +32,7 @@ There are a few approaches for tackling newly committed credentials, but one exa {% note %} - **Note:** You can automate this step. For large enterprises and organizations with hundreds of repositories, manually following up is unsustainable. You could incorporate automation into the webhook process defined in the first step. The webhook payload contains repository and organization information about the leaked secret. Using this information, you can contact the current maintainers on the repository and create a email/message to the responsible people or open an issue. + **Note:** You can automate this step. For large enterprises and organizations with hundreds of repositories, manually following up is unsustainable. You could incorporate automation into the webhook process defined in the first step. The webhook payload contains repository and organization information about the leaked secret. Using this information, you can contact the current maintainers on the repository and create an email/message to the responsible people or open an issue. {% endnote %} 3. **Educate**: Create an internal training document assigned to the developer who committed the secret. Within this training document, you can explain the risks created by committing secrets and direct them to your best practice information about using secrets securely in development. If the a developer doesn't learn from the experience and continues to commit secrets, you could create an escalation process, but education usually works well. diff --git a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md index a5948aba46..23e20a25a3 100644 --- a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md +++ b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md @@ -43,8 +43,8 @@ By default, the code scanning alerts page is filtered to show alerts for the def ![Summary of alerts](/assets/images/help/repository/code-scanning-click-alert.png) {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %} - {% data reusables.code-scanning.alert-default-branch %} - ![The "Affected branches" section in an alert](/assets/images/help/repository/code-scanning-affected-branches.png){% endif %} + {% data reusables.code-scanning.alert-default-branch %} + ![The "Affected branches" section in an alert](/assets/images/help/repository/code-scanning-affected-branches.png){% endif %} 1. Optionally, if the alert highlights a problem with data flow, click **Show paths** to display the path from the data source to the sink where it's used. {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %} ![The "Show paths" link on an alert](/assets/images/help/repository/code-scanning-show-paths.png) diff --git a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md index a9fa55f11d..7cd2cdcc90 100644 --- a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md +++ b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md @@ -32,6 +32,12 @@ Si estás configurando el {% data variables.product.prodname_code_scanning %} pa Debes ejecutar a {% data variables.product.prodname_codeql %} dentro del mismo contenedor en el que compilaste tu código. Esto aplica a cuando utilizas el {% data variables.product.prodname_codeql_cli %}{% ifversion codeql-runner-supported %}, el {% data variables.product.prodname_codeql_runner %},{% endif %} o {% data variables.product.prodname_actions %}. Para el {% data variables.product.prodname_codeql_cli %} {% ifversion codeql-runner-supported %}o el {% data variables.product.prodname_codeql_runner %}{% endif %}, consulta la sección "[Instalar el {% data variables.product.prodname_codeql_cli %} en tu sistema de IC](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)"{% ifversion codeql-runner-supported %} o "[Ejecutar el {% data variables.product.prodname_codeql_runner %} en tu sistema de IC](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)"{% endif %} para obtener más información. Si estás utilizando {% data variables.product.prodname_actions %}, configura tu flujo de trabajo para ejecutar todas las acciones en el mismo contenedor. Para obtener más información, consulta la sección "[Ejemplo de flujo de trabajo](#example-workflow)". +{% note %} + +**Nota:** {% data reusables.code-scanning.non-glibc-linux-support %} + +{% endnote %} + ## Dependencias Es posible que tengas alguna dificultad para ejecutar el {% data variables.product.prodname_code_scanning %} si el contenedor que estás utilizando carece de ciertas dependencias (Por ejemplo, Git debe instalarse y agregarse a la variable PATH). Si encuentras propuestas de dependencias, revisa la lista de software que habitualmente se incluye en las imágenes de los ejecutores de {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta los archivos `readme` específicos de la versión en estas ubicaciones: diff --git a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md index 52e0b98fd3..32cea9db26 100644 --- a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md +++ b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md @@ -151,25 +151,29 @@ The names of the {% data variables.product.prodname_code_scanning %} analysis ch ![{% data variables.product.prodname_code_scanning %} pull request checks](/assets/images/help/repository/code-scanning-pr-checks.png) -When the {% data variables.product.prodname_code_scanning %} jobs complete, {% data variables.product.prodname_dotcom %} works out whether any alerts were added by the pull request and adds the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" entry to the list of checks. After {% data variables.product.prodname_code_scanning %} has been performed at least once, you can click **Details** to view the results of the analysis. If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion fpt or ghes > 3.2 or ghae or ghec %}an "Analysis not found"{% else %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check. +When the {% data variables.product.prodname_code_scanning %} jobs complete, {% data variables.product.prodname_dotcom %} works out whether any alerts were added by the pull request and adds the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" entry to the list of checks. After {% data variables.product.prodname_code_scanning %} has been performed at least once, you can click **Details** to view the results of the analysis. -{% ifversion fpt or ghes > 3.2 or ghae or ghec %} - ![Analysis not found for commit message](/assets/images/help/repository/code-scanning-analysis-not-found.png) +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-7095 %} + +{% elsif ghes < 3.5 or ghae %} +If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion ghes > 3.2 or ghae %}an "Analysis not found"{% elsif ghes = 3.2 %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check. + +{% ifversion ghes > 3.2 or ghae %} + ![Analysis not found for commit message](/assets/images/enterprise/3.4/repository/code-scanning-analysis-not-found.png) The table lists one or more categories. Each category relates to specific analyses, for the same tool and commit, performed on a different language or a different part of the code. For each category, the table shows the two analyses that {% data variables.product.prodname_code_scanning %} attempted to compare to determine which alerts were introduced or fixed in the pull request. For example, in the screenshot above, {% data variables.product.prodname_code_scanning %} found an analysis for the merge commit of the pull request, but no analysis for the head of the main branch. -{% else %} - ![Missing analysis for commit message](/assets/images/enterprise/3.2/repository/code-scanning-missing-analysis.png) -{% endif %} -{% ifversion fpt or ghes > 3.2 or ghae or ghec %} ### Reasons for the "Analysis not found" message -{% else %} + +{% elsif ghes = 3.2 %} + ![Missing analysis for commit message](/assets/images/enterprise/3.2/repository/code-scanning-missing-analysis.png) + ### Reasons for the "Missing analysis" message {% endif %} -After {% data variables.product.prodname_code_scanning %} has analyzed the code in a pull request, it needs to compare the analysis of the topic branch (the branch you used to create the pull request) with the analysis of the base branch (the branch into which you want to merge the pull request). This allows {% data variables.product.prodname_code_scanning %} to compute which alerts are newly introduced by the pull request, which alerts were already present in the base branch, and whether any existing alerts are fixed by the changes in the pull request. Initially, if you use a pull request to add {% data variables.product.prodname_code_scanning %} to a repository, the base branch has not yet been analyzed, so it's not possible to compute these details. In this case, when you click through from the results check on the pull request you will see the {% ifversion fpt or ghes > 3.2 or ghae or ghec %}"Analysis not found"{% else %}"Missing analysis for base commit SHA-HASH"{% endif %} message. +After {% data variables.product.prodname_code_scanning %} has analyzed the code in a pull request, it needs to compare the analysis of the topic branch (the branch you used to create the pull request) with the analysis of the base branch (the branch into which you want to merge the pull request). This allows {% data variables.product.prodname_code_scanning %} to compute which alerts are newly introduced by the pull request, which alerts were already present in the base branch, and whether any existing alerts are fixed by the changes in the pull request. Initially, if you use a pull request to add {% data variables.product.prodname_code_scanning %} to a repository, the base branch has not yet been analyzed, so it's not possible to compute these details. In this case, when you click through from the results check on the pull request you will see the {% ifversion ghes > 3.2 or ghae %}"Analysis not found"{% elsif ghes = 3.2 %}"Missing analysis for base commit SHA-HASH"{% endif %} message. There are other situations where there may be no analysis for the latest commit to the base branch for a pull request. These include: @@ -177,7 +181,7 @@ There are other situations where there may be no analysis for the latest commit To check whether a branch has been scanned, go to the {% data variables.product.prodname_code_scanning_capc %} page, click the **Branch** drop-down and select the relevant branch. -![Choose a branch from the Branch drop-down menu](/assets/images/help/repository/code-scanning-branch-dropdown.png) + ![Choose a branch from the Branch drop-down menu](/assets/images/help/repository/code-scanning-branch-dropdown.png) The solution in this situation is to add the name of the base branch to the `on:push` and `on:pull_request` specification in the {% data variables.product.prodname_code_scanning %} workflow on that branch and then make a change that updates the open pull request that you want to scan. @@ -189,6 +193,8 @@ There are other situations where there may be no analysis for the latest commit Merge a trivial change into the base branch to trigger {% data variables.product.prodname_code_scanning %} on this latest commit, then push a change to the pull request to retrigger {% data variables.product.prodname_code_scanning %}. +{% endif %} + ## Next steps After setting up {% data variables.product.prodname_code_scanning %}, and allowing its actions to complete, you can: diff --git a/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md index daeb17e483..74df7049d2 100644 --- a/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md +++ b/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md @@ -45,9 +45,15 @@ If you upload a second SARIF file for a commit with the same category and from t If you're new to SARIF and want to learn more, see Microsoft's [`SARIF tutorials`](https://github.com/microsoft/sarif-tutorials) repository. -## Preventing duplicate alerts using fingerprints +## Providing data to track {% data variables.product.prodname_code_scanning %} alerts across runs -Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the right line of code when files are edited. +Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the correct line of code when files are edited. The `ruleID` for a result has to be the same across analysis. + +### Reporting consistent filepaths + +The filepath has to be consistent across the runs to enable a computation of a stable fingerprint. If the filepaths differ for the same result, each time there is a new analysis a new alert will be created, and the old one will be closed. This will cause having multiple alerts for the same result. + +### Including data for fingerprint generation {% data variables.product.prodname_dotcom %} uses the `partialFingerprints` property in the OASIS standard to detect when two results are logically identical. For more information, see the "[partialFingerprints property](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" entry in the OASIS documentation. @@ -77,6 +83,12 @@ You can check a SARIF file is compatible with {% data variables.product.prodname If you use a code analysis engine other than {% data variables.product.prodname_codeql %}, you can review the supported SARIF properties to optimize how your analysis results will appear on {% data variables.product.prodname_dotcom %}. +{% note %} + +**Note:** You must supply an explicit value for any property marked as "required". The empty string is not supported for required properties. + +{% endnote %} + Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.product.prodname_code_scanning %} will only use the following supported properties. ### `sarifLog` object @@ -138,7 +150,7 @@ Each `result` object contains details for one alert in the codebase. Within the | `level`| **Optional.** The severity of the result. This level overrides the default severity defined by the rule. {% data variables.product.prodname_code_scanning_capc %} uses the level to filter results by severity on {% data variables.product.prodname_dotcom %}. | `message.text`| **Required.** A message that describes the result. {% data variables.product.prodname_code_scanning_capc %} displays the message text as the title of the result. Only the first sentence of the message will be displayed when visible space is limited. | `locations[]`| **Required.** The set of locations where the result was detected up to a maximum of 10. Only one location should be included unless the problem can only be corrected by making a change at every specified location. **Note:** At least one location is required for {% data variables.product.prodname_code_scanning %} to display a result. {% data variables.product.prodname_code_scanning_capc %} will use this property to decide which file to annotate with the result. Only the first value of this array is used. All other values are ignored. -| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Preventing duplicate alerts using fingerprints](#preventing-duplicate-alerts-using-fingerprints)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. +| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Providing data to track code scanning alerts across runs](#providing-data-to-track-code-scanning-alerts-across-runs)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. | `codeFlows[].threadFlows[].locations[]`| **Optional.** An array of `location` objects for a `threadFlow` object, which describes the progress of a program through a thread of execution. A `codeFlow` object describes a pattern of code execution used to detect a result. If code flows are provided, {% data variables.product.prodname_code_scanning %} will expand code flows on {% data variables.product.prodname_dotcom %} for the relevant result. For more information, see the [`location` object](#location-object). | `relatedLocations[]`| A set of locations relevant to this result. {% data variables.product.prodname_code_scanning_capc %} will link to related locations when they are embedded in the result message. For more information, see the [`location` object](#location-object). @@ -204,7 +216,7 @@ These example SARIF output files show supported properties and example values. ### Example with minimum required properties -This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties or don't include values, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. +This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties, omit values, or use an empty string, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. ```json { diff --git a/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md b/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md index 1e03a239f3..193ee54f5a 100644 --- a/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md +++ b/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md @@ -58,7 +58,7 @@ For more information see the [`upload-sarif` action](https://github.com/github/c The `upload-sarif` action can be configured to run when the `push` and `scheduled` event occur. For more information about {% data variables.product.prodname_actions %} events, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#preventing-duplicate-alerts-using-fingerprints)." +If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#providing-data-to-track-code-scanning-alerts-across-runs)." {% data reusables.code-scanning.upload-sarif-alert-limit %} diff --git a/translations/es-ES/content/code-security/dependabot/dependabot-alerts/about-dependabot-alerts.md b/translations/es-ES/content/code-security/dependabot/dependabot-alerts/about-dependabot-alerts.md index 5ae22f1621..48afabe62d 100644 --- a/translations/es-ES/content/code-security/dependabot/dependabot-alerts/about-dependabot-alerts.md +++ b/translations/es-ES/content/code-security/dependabot/dependabot-alerts/about-dependabot-alerts.md @@ -103,5 +103,5 @@ También puedes ver todas las {% data variables.product.prodname_dependabot_aler ## Leer más - "[Acerca de las {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)" -- "[Viewing and updating {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts)"{% endif %} +- "[Ver y actualizar las {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts)"{% endif %} {% ifversion fpt or ghec %}- "[Privacidad en {% data variables.product.prodname_dotcom %}](/get-started/privacy-on-github)"{% endif %} diff --git a/translations/es-ES/content/code-security/dependabot/dependabot-alerts/browsing-security-advisories-in-the-github-advisory-database.md b/translations/es-ES/content/code-security/dependabot/dependabot-alerts/browsing-security-advisories-in-the-github-advisory-database.md index e4b621210d..983eb8443d 100644 --- a/translations/es-ES/content/code-security/dependabot/dependabot-alerts/browsing-security-advisories-in-the-github-advisory-database.md +++ b/translations/es-ES/content/code-security/dependabot/dependabot-alerts/browsing-security-advisories-in-the-github-advisory-database.md @@ -74,7 +74,7 @@ El {% data variables.product.prodname_dependabot %} no crea {% data variables.pr ## About information in security advisories -Each security advisory contains information about the vulnerability{% ifversion GH-advisory-db-supports-malware %} or malware,{% endif %} which may include the description, severity, affected package, package ecosystem, affected versions and patched versions, impact, and optional information such as references, workarounds, and credits. Adicionalmente, las asesorías de la National Vulnerability Database contiene un enlace al registro de CVE, en donde puedes leer más sobre los detalles de la vulnerabilidad, su puntuación de CVSS y su nivel de severidad cualitativo. Para obtener más información, consulta la "[National Vulnerability Database](https://nvd.nist.gov/)" del Instituto Nacional de Estándares y Tecnología. +Cada asesoría de seguridad contiene información sobre la vulnerabilidad{% ifversion GH-advisory-db-supports-malware %} o malware,{% endif %} lo cual podría incluir la descripción, gravedad, paquete afectado, ecosistema del paquete, versiones afectadas y parchadas, impacto e información opcional tal como las referencias, soluciones alternativas y créditos. Adicionalmente, las asesorías de la National Vulnerability Database contiene un enlace al registro de CVE, en donde puedes leer más sobre los detalles de la vulnerabilidad, su puntuación de CVSS y su nivel de severidad cualitativo. Para obtener más información, consulta la "[National Vulnerability Database](https://nvd.nist.gov/)" del Instituto Nacional de Estándares y Tecnología. El nivel de gravedad es uno de cuatro niveles posibles que se definen en el [Sistema de clasificación de vulnerabilidades comunes (CVSS), Sección 5](https://www.first.org/cvss/specification-document)". - Bajo diff --git a/translations/es-ES/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md b/translations/es-ES/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md index a717245b25..fadd3dd370 100644 --- a/translations/es-ES/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md +++ b/translations/es-ES/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md @@ -1,7 +1,7 @@ --- -title: Configuring Dependabot alerts -intro: 'Enable {% data variables.product.prodname_dependabot_alerts %} to be generated when a new vulnerable dependency {% ifversion GH-advisory-db-supports-malware %}or malware {% endif %}is found in one of your repositories.' -shortTitle: Configure Dependabot alerts +title: Configurar las alertas del Dependabot +intro: 'Habilita las {% data variables.product.prodname_dependabot_alerts %} para que se generen cuando una dependencia vulnerable nueva {% ifversion GH-advisory-db-supports-malware %}o malware {% endif %}se encuentre en uno de tus repositorios.' +shortTitle: Configurar las alertas del Dependabot versions: fpt: '*' ghes: '*' @@ -17,89 +17,89 @@ topics: - Repositories --- -## About {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies{% ifversion GH-advisory-db-supports-malware %} and malware{% endif %} +## Acerca de las {% data variables.product.prodname_dependabot_alerts %} para las dependencias vulnerables{% ifversion GH-advisory-db-supports-malware %} y el malware{% endif %} {% data reusables.repositories.a-vulnerability-is %} -{% data variables.product.prodname_dependabot %} scans code when a new advisory is added to the {% data variables.product.prodname_advisory_database %} or the dependency graph for a repository changes. When vulnerable dependencies{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %} are detected, {% data variables.product.prodname_dependabot_alerts %} are generated. Para obtener más información, consulta la sección "[Acerca de las {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)". +{% data variables.product.prodname_dependabot %} escanea el código cuando una asesoría nueva se agrega a la {% data variables.product.prodname_advisory_database %} o a la gráfica de dependencias para los cambios a un repositorio. Cuando se detectan dependencias vulnerables{% ifversion GH-advisory-db-supports-malware %} o el malware{% endif %}, se generan {% data variables.product.prodname_dependabot_alerts %}. Para obtener más información, consulta la sección "[Acerca de las {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)". -You can enable or disable {% data variables.product.prodname_dependabot_alerts %} for: -* Your personal account -* Your repository -* Your organization +Puedes habilitar o inhabilitar las {% data variables.product.prodname_dependabot_alerts %} para: +* Tu cuenta personal +* Tu repositorio +* Tu organización -## Managing {% data variables.product.prodname_dependabot_alerts %} for your personal account +## Adminsitrar las {% data variables.product.prodname_dependabot_alerts %} para tu cuenta personal {% ifversion fpt or ghec %} -You can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories owned by your personal account. +Puedes habilitar o inhabilitar las {% data variables.product.prodname_dependabot_alerts %} para todos los repositorios que le pertenecen a tu cuenta personal. -### Enabling or disabling {% data variables.product.prodname_dependabot_alerts %} for existing repositories +### Habilitar o inhabilitar las {% data variables.product.prodname_dependabot_alerts %} para los repositorios existentes {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.security-analysis %} -3. Debajo de "Análisis y seguridad del código", a la derecha de las {% data variables.product.prodname_dependabot_alerts %}, haz clic en **Inhabilitar todas** o **Habilitar todas**. ![Screenshot of "Configure security and analysis" features with "Enable all" or "Disable all" buttons emphasized](/assets/images/help/dependabot/dependabot-alerts-disable-or-enable-all.png) -4. Optionally, enable {% data variables.product.prodname_dependabot_alerts %} by default for new repositories that you create. ![Screenshot of "Enable Dependabot alerts" with "Enable by default for new private repositories" checkbox emphasized](/assets/images/help/dependabot/dependabot-alerts-enable-by-default.png) -5. Click **Disable {% data variables.product.prodname_dependabot_alerts %}** or **Enable {% data variables.product.prodname_dependabot_alerts %}** to disable or enable {% data variables.product.prodname_dependabot_alerts %} for all the repositories you own. ![Screenshot of "Enable Dependabot alerts" with "Enable Dependabot alerts" button emphasized](/assets/images/help/dependabot/dependabot-alerts-enable-dependabot-alerts.png) +3. Debajo de "Análisis y seguridad del código", a la derecha de las {% data variables.product.prodname_dependabot_alerts %}, haz clic en **Inhabilitar todas** o **Habilitar todas**. ![Captura de pantalla de las características de "Configurar el análisis y la seguridad" con énfasis en los botones "Habilitar todo" o "Inhabilitar todo"](/assets/images/help/dependabot/dependabot-alerts-disable-or-enable-all.png) +4. Opcionalmente, habilita las {% data variables.product.prodname_dependabot_alerts %} predeterminadamente para los repositorios nuevos que crees. ![Captura de pantalla de "Habilitar las alertas del Dependabot" con énfasis en la casilla de verificación "Habilitar predeterminadamente para los repositorios privados nuevos"](/assets/images/help/dependabot/dependabot-alerts-enable-by-default.png) +5. Haz clic en **Inhabilitar las {% data variables.product.prodname_dependabot_alerts %}** o **Habilitar las {% data variables.product.prodname_dependabot_alerts %}** para inhabilitar o habilitar las {% data variables.product.prodname_dependabot_alerts %} para todos los repositorios que te pertenezcan. ![Captura de pantalla de "Habilitar las alertas del Dependabot" con énfasis en el botón "Habilitar las alertas del Dependabot"](/assets/images/help/dependabot/dependabot-alerts-enable-dependabot-alerts.png) -When you enable {% data variables.product.prodname_dependabot_alerts %} for existing repositories, you will see any results displayed on GitHub within minutes. +Cuando habilitas las {% data variables.product.prodname_dependabot_alerts %} para los repositorios existentes, verás todos los resultados mostrados en GitHub en cuestión de minutos. -### Enabling or disabling {% data variables.product.prodname_dependabot_alerts %} for new repositories +### Habilitar o inhabilitar las {% data variables.product.prodname_dependabot_alerts %} para los repositorios nuevos {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.security-analysis %} -3. Under "Code security and analysis", to the right of {% data variables.product.prodname_dependabot_alerts %}, enable or disable {% data variables.product.prodname_dependabot_alerts %} by default for new repositories that you create. ![Screenshot of "Configure security and analysis" with "Enable for all new private repositories" check emphasized](/assets/images/help/dependabot/dependabot-alerts-enable-for-all-new-repositories.png) +3. Debajo de "Análisis y seguridad del código", a la derecha de las {% data variables.product.prodname_dependabot_alerts %}, habilita o inhabilita las {% data variables.product.prodname_dependabot_alerts %} predeterminadas para los repositorios nuevos que crees. ![Captura de pantalla de "Configurar el análisis y la seguridad" con énfasis en la casilla de verificación "Habilitar para todos los repositorios privados nuevos"](/assets/images/help/dependabot/dependabot-alerts-enable-for-all-new-repositories.png) {% else %} -{% data variables.product.prodname_dependabot_alerts %} for your repositories can be enabled or disabled by your enterprise owner. Para obtener más información, consulta la sección "[Habilitar al Dependabot para tu empresa](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)". +Tu propietario de empresa puede habilitar o inhabilitar las {% data variables.product.prodname_dependabot_alerts %} para tus repositorios. Para obtener más información, consulta la sección "[Habilitar al Dependabot para tu empresa](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)". {% endif %} ## Administrar las {% data variables.product.prodname_dependabot_alerts %} para tu repositorio -{% ifversion fpt or ghec %}You can manage {% data variables.product.prodname_dependabot_alerts %} for your public, private or internal repository. +{% ifversion fpt or ghec %}Puedes adminsitrar las {% data variables.product.prodname_dependabot_alerts %} para tu repositorio público, privado o interno. -Predeterminadamente, notificamos a las personas con permisos administrativos en los repositorios afectados sobre las {% data variables.product.prodname_dependabot_alerts %} nuevas. {% data variables.product.product_name %} never publicly discloses insecure dependencies for any repository. También puedes hacer que las {% data variables.product.prodname_dependabot_alerts %} sean visibles para más personas o equipos que trabajen en los repositorios que te pertenecen o para los cuales tienes permisos administrativos. +Predeterminadamente, notificamos a las personas con permisos administrativos en los repositorios afectados sobre las {% data variables.product.prodname_dependabot_alerts %} nuevas. {% data variables.product.product_name %} jamás divulga públicamente las dependencias inseguras de ningún repositorio. También puedes hacer que las {% data variables.product.prodname_dependabot_alerts %} sean visibles para más personas o equipos que trabajen en los repositorios que te pertenecen o para los cuales tienes permisos administrativos. {% data reusables.security.security-and-analysis-features-enable-read-only %} -### Enabling or disabling {% data variables.product.prodname_dependabot_alerts %} for a repository +### Habilitar o inhabilitar las {% data variables.product.prodname_dependabot_alerts %} para un repositorio {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-code-security-and-analysis %} -1. Under "Code security and analysis", to the right of {% data variables.product.prodname_dependabot_alerts %}, click **Enable** to enable alerts or **Disable** to disable alerts. ![Screenshot of "Code security and analysis" section with button to enable {% data variables.product.prodname_dependabot_security_updates %}](/assets/images/help/repository/security-and-analysis-disable-or-enable-fpt-private.png) +1. Debajo de "Análisis y seguridad del código", a la derecha de las {% data variables.product.prodname_dependabot_alerts %}, haz clic en **Habilitar** para habilitar las alertas o en **Inhabilitar** para inhabilitarlas. ![Captura de pantalla de la sección "Análisis y seguridad del código" con el botón para habilitar las {% data variables.product.prodname_dependabot_security_updates %}](/assets/images/help/repository/security-and-analysis-disable-or-enable-fpt-private.png) {% endif %}{% ifversion ghes or ghae %} -{% data variables.product.prodname_dependabot_alerts %} for your repository can be enabled or disabled by your enterprise owner. Para obtener más información, consulta la sección "[Habilitar al Dependabot para tu empresa](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)". +Tu propietario de empresa puede habilitar o inhabilitar las {% data variables.product.prodname_dependabot_alerts %} para tu repositorio. Para obtener más información, consulta la sección "[Habilitar al Dependabot para tu empresa](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)". {% endif %} ## Administrar las {% data variables.product.prodname_dependabot_alerts %} para tu organización -{% ifversion fpt or ghec %}You can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories owned by your organization. Your changes affect all repositories. +{% ifversion fpt or ghec %}Puedes habilitar o inhabilitar las {% data variables.product.prodname_dependabot_alerts %} para todos los repositorios que le pertenecen a tu organización. Tus cambios afectan a todos los repositorios. -### Enabling or disabling {% data variables.product.prodname_dependabot_alerts %} for all existing repositories +### Habilitar o inhabilitar las {% data variables.product.prodname_dependabot_alerts %} para todos los repositorios existentes {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security-and-analysis %} 2. Debajo de "Análisis y seguridad del código", a la derecha de las {% data variables.product.prodname_dependabot_alerts %}, haz clic en **Inhabilitar todas** o **Habilitar todas**. {% ifversion fpt or ghec %} - ![Screenshot of "Configure security and analysis" features with the "Enable all" or "Disable all" button emphasized for Dependabot alerts](/assets/images/help/dependabot/dependabot-alerts-disable-or-enable-fpt.png) + ![Captura de pantalla de las características de "Configurar el análisis y la seguridad" con énfasis en el botón "Habilitar todo" o "Inhabilitar todo" para las alertas del Dependabot](/assets/images/help/dependabot/dependabot-alerts-disable-or-enable-fpt.png) {% endif %} {% ifversion ghae %} ![Botón de "Habilitar todo" o "Inhabilitar todo" para las características de "Configurar la seguridad y el análisis"](/assets/images/enterprise/github-ae/organizations/security-and-analysis-disable-or-enable-all-ghae.png) {% endif %} {% ifversion fpt or ghec %} -3. Optionally, enable {% data variables.product.prodname_dependabot_alerts %} by default for new repositories in your organization. +3. Opcionalmente, habilita las {% data variables.product.prodname_dependabot_alerts %} predeterminadas para los repositorios en tu organización. {% ifversion fpt or ghec %} - ![Screenshot of "Enable by default" option for new repositories](/assets/images/help/dependabot/dependabot-alerts-enable-by-default-organizations.png) + ![Captura de pantalla de la opción "Habilitar predeterminadamente" para los repositorios nuevos](/assets/images/help/dependabot/dependabot-alerts-enable-by-default-organizations.png) {% endif %} {% endif %} {% ifversion fpt or ghec %} -4. Click **Disable {% data variables.product.prodname_dependabot_alerts %}** or **Enable {% data variables.product.prodname_dependabot_alerts %}** to disable or enable {% data variables.product.prodname_dependabot_alerts %} for all the repositories in your organization. +4. Haz clic en **Inhabilitar las {% data variables.product.prodname_dependabot_alerts %}** o **Habilitar las {% data variables.product.prodname_dependabot_alerts %}** para inhabilitar o habilitar las {% data variables.product.prodname_dependabot_alerts %} para todos los repositorios de tu organización. {% ifversion fpt or ghec %} - ![Screenshot of "Enable Dependabot alerts" modal with button to disable or enable feature emphasized](/assets/images/help/dependabot/dependabot-alerts-enable-dependabot-alerts-organizations.png) + ![Captura de pantalla del modal "Habilitar las alertas del dependabot" con énfasis en el botón de la característica de inhabilitar o habilitar](/assets/images/help/dependabot/dependabot-alerts-enable-dependabot-alerts-organizations.png) {% endif %}{% endif %}{% endif %}{% ifversion ghes or ghae %} -{% data variables.product.prodname_dependabot_alerts %} for your organization can be enabled or disabled by your enterprise owner. For more information, see "[About Dependabot for GitHub Enterprise Server](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)." +El propietario de tu empresa puede habilitar o inhabilitar las {% data variables.product.prodname_dependabot_alerts %} para tu organización. Para obtener más información, consulta la sección "[Acerca del Dependabot para GitHub Enterprise Server](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)". {% endif %} diff --git a/translations/es-ES/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md b/translations/es-ES/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md index 2b57a905c0..8532527057 100644 --- a/translations/es-ES/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md +++ b/translations/es-ES/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md @@ -58,7 +58,7 @@ Puedes configurar los ajustes de notificaciones para ti mismo o para tu organiza ## Cómo reducir el ruido de las notificacines para las {% data variables.product.prodname_dependabot_alerts %} -Si te preocupa recibir demasiadas notificaciones para las {% data variables.product.prodname_dependabot_alerts %}, te recomendamos que te unas al resumen semanal por correo electrónico o que apagues las notificaciones mientras mantienes habilitadas las {% data variables.product.prodname_dependabot_alerts %}. Aún puedes navegar para ver tus {% data variables.product.prodname_dependabot_alerts %} en la pestaña de seguridad de tu repositorio. For more information, see "[Viewing and updating {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts)." +Si te preocupa recibir demasiadas notificaciones para las {% data variables.product.prodname_dependabot_alerts %}, te recomendamos que te unas al resumen semanal por correo electrónico o que apagues las notificaciones mientras mantienes habilitadas las {% data variables.product.prodname_dependabot_alerts %}. Aún puedes navegar para ver tus {% data variables.product.prodname_dependabot_alerts %} en la pestaña de seguridad de tu repositorio. Para obtener más información, consulta la sección "[Ver y actualizar las {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts)". ## Leer más diff --git a/translations/es-ES/content/code-security/dependabot/dependabot-alerts/editing-security-advisories-in-the-github-advisory-database.md b/translations/es-ES/content/code-security/dependabot/dependabot-alerts/editing-security-advisories-in-the-github-advisory-database.md index 5cd9122f6f..23d0c12c15 100644 --- a/translations/es-ES/content/code-security/dependabot/dependabot-alerts/editing-security-advisories-in-the-github-advisory-database.md +++ b/translations/es-ES/content/code-security/dependabot/dependabot-alerts/editing-security-advisories-in-the-github-advisory-database.md @@ -22,7 +22,7 @@ shortTitle: Editar la base de datos de asesorías ## Acerca de editar las asesorías en la {% data variables.product.prodname_advisory_database %} Las asesorías de seguridad en la {% data variables.product.prodname_advisory_database %} en [github.com/advisories](https://github.com/advisories) se consideran asesorías globales. Cualquiera puede sugerir mejoras en cualquier asesoría de seguridad en la {% data variables.product.prodname_advisory_database %}. Puedes editar o agregar cualquier detalle, incluyendo los ecosistemas adicionales afectados, el nivel de severidad o la descripción de quién se vio impactado. El equipo de selección de {% data variables.product.prodname_security %} revisará las mejoras enviadas y las publicará en la {% data variables.product.prodname_advisory_database %} en caso de que se acepten. {% ifversion fpt or ghec %} -Solo los propietarios y adminsitradores de repositorios pueden editar las asesorías de seguridad a nivel de repositorio. For more information, see "[Editing a repository security advisory](/code-security/security-advisories/editing-a-security-advisory)."{% endif %} +Solo los propietarios y adminsitradores de repositorios pueden editar las asesorías de seguridad a nivel de repositorio. Para obtener más información, consulta la sección "[Editar una asesoría de seguridad de un repositorio](/code-security/security-advisories/editing-a-security-advisory)".{% endif %} ## Editar las asesorías en la base de datos de asesorías de GitHub @@ -36,12 +36,12 @@ Solo los propietarios y adminsitradores de repositorios pueden editar las asesor También puedes abrir una solicitud de cambios directamente en un archivo de asesoría en el repositorio [github/advisory-database](https://github.com/github/advisory-database). Para obtener más información, consulta los [lineamientos de contribución](https://github.com/github/advisory-database/blob/main/CONTRIBUTING.md). {% ifversion security-advisories-ghes-ghae %} -## Editing advisories from {% data variables.product.product_location %} +## Editar asesorías desde {% data variables.product.product_location %} -If you have {% data variables.product.prodname_github_connect %} enabled for {% data variables.product.product_location %}, you will be able to see advisories by adding `/advisories` to the instance url. +Si tienes habilitado {% data variables.product.prodname_github_connect %} para {% data variables.product.product_location %}, podrás ver asesorías si agregas `/advisories` a la url de la instancia. 1. Navega a `https://HOSTNAME/advisories`. 2. Selecciona la asesoría de seguridad a la cual te gustaría contribuir. -3. On the right-hand side of the page, click the **Suggest improvements for this vulnerability on Github.com.** link. A new tab opens with the same security advisory on {% data variables.product.prodname_dotcom_the_website %}. ![Enlace para sugerir mejoras](/assets/images/help/security/suggest-improvements-to-advisory-on-github-com.png) -4. Edit the advisory, following steps four through six in "[Editing advisories in the GitHub Advisory Database](#editing-advisories-in-the-github-advisory-database)" above. +3. En el lado derecho de la página, haz clic en el enlace de **Sugerir mejoras para esta vulnerabilidad en GitHub.com.**. Se abrirá una pestaña nueva con la misma asesoría de seguridad en {% data variables.product.prodname_dotcom_the_website %}. ![Enlace para sugerir mejoras](/assets/images/help/security/suggest-improvements-to-advisory-on-github-com.png) +4. Edita la asesoría siguiendo los pasos del cuatro al seis en la sección anterior "[Editar asesorías en la base de datos de asesorías de GitHub](#editing-advisories-in-the-github-advisory-database)". {% endif %} diff --git a/translations/es-ES/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md b/translations/es-ES/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md index 674b51df5b..4a5b64cab5 100644 --- a/translations/es-ES/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md +++ b/translations/es-ES/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md @@ -37,20 +37,40 @@ Puedes habilitar las alertas de seguridad automáticas para cualquier repositori {% data variables.product.product_name %} genera {% data variables.product.prodname_dependabot_alerts %} cuando detectamos que tu base de còdigo està utilizando dependencias con riesgos de seguridad conocidos. Para los repositorios en donde se habilitan las {% data variables.product.prodname_dependabot_security_updates %} cuando {% data variables.product.product_name %} detecta una dependencia vulnerable en la rama predeterminada, {% data variables.product.prodname_dependabot %} crea una solicitud de cambios para arreglarla. La solicitud de extracción mejorará la dependencia a la versión segura mínima que sea posible y necesaria para evitar la vulnerabilidad. -{% ifversion dependabot-most-important-sort-option %} Predeterminadamente, las {% data variables.product.prodname_dependabot_alerts %} se muestran en la pestaña de {% data variables.product.prodname_dependabot_alerts %} según su importancia, pero puedes ordenarlas por otros criterios. {% endif %}{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5638 %}Puedes ordenar y filtrar las {% data variables.product.prodname_dependabot_alerts %} con los menús desplegables en la pestaña de {% data variables.product.prodname_dependabot_alerts %} o escribiendo filtros como pares de `key:value` en la barra de búsqueda. Los filtros disonibles son repositorio (por ejemplo, `repo:my-repository`), paquete (por ejemplo, `package:django`), ecosistema (por ejemplo, `ecosystem:npm`), manifiesto (por ejemplo, `manifest:webwolf/pom.xml`), estado (por ejemplo, `is:open`) y ya sea si una asesorìa tiene un parche o no (por ejemplo, `has: patch`).{% ifversion dependabot-alerts-development-label %} También puedes filtrar las alertas con datos de alcance de dependencias utilizando `scope`, por ejemplo: `scope:development` o `scope:runtime`. Con `scope:development`, la lista de alertas solo mostrará a las dependencias que se utilizaron durante el desarrolo y no durante la producción.{% endif %} - Cada alerta del {% data variables.product.prodname_dependabot %} tiene un identificador numérico único y la pestaña de {% data variables.product.prodname_dependabot_alerts %} lista una alerta por cada vulnerabilidad detectada. Las {% data variables.product.prodname_dependabot_alerts %} tradicionales agrupan vulnerabilidades por dependencia y generan una sola alerta por dependencia. Si navegas a una alerta tradicional del {% data variables.product.prodname_dependabot %}, se te redirigirá a una pestaña de {% data variables.product.prodname_dependabot_alerts %} filtradas para este paquete. {% endif %} + +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5638 %} +Puedes filtrar y clasificar las {% data variables.product.prodname_dependabot_alerts %} utilizando diversos filtros y opciones de clasificación disponibles en la interfaz de usuario. Para obtener más información, consulta la sección "[Priorizar las {% data variables.product.prodname_dependabot_alerts %}](#prioritizing-across--data-variablesproductprodname_dependabot_alerts-)" a continuación. + +## Priorizar las {% data variables.product.prodname_dependabot_alerts %} + +{% data variables.product.company_short %} te ayuda a priorizar la corrección de las {% data variables.product.prodname_dependabot_alerts %}. {% ifversion dependabot-most-important-sort-option %} Predeterminadamente, las {% data variables.product.prodname_dependabot_alerts %} se clasifican por importancia. El orden de clasificación de "más importante" te ayuda a priorizar en qué {% data variables.product.prodname_dependabot_alerts %} debes enfocarte primero. Las alertas se clasifican con base en su impacto potencial, capacidad de acción y relevancia. Nuestro cálculo de priorización se está mejorando constantemente e incluye factores como la puntuación de CVSS, alcance de dependencia y si las llamadas a la función vulnerable se encuentran en la alerta. + +![Captura de pantalla del menú desplegable de clasificación con una clasificación de "Más importante"](/assets/images/help/dependabot/dependabot-alerts-sort-dropdown.png) {% endif %} +{% data reusables.dependabot.dependabot-alerts-filters %} + +Adicionalmente a los filtros disponibles a través de la barra de búsqueda, puedes clasificar y filtrar las {% data variables.product.prodname_dependabot_alerts %} utilizando los menús desplegables en la parte superior de la lista de alertas. La barra de búsqueda también permite que busques por el texto completo de las alertas y por las asesorías de seguridad relacionadas. Puedes buscar por parte de un nombre de una asesoría de seguridad o descripción para que se devuelvan las alertas en tu repositorio que se relacionan con eta asesoría de seguridad. Por ejemplo, el buscar por `yaml.load() API could execute arbitrary code` devolverá las {% data variables.product.prodname_dependabot_alerts %} vinculadas con "[PyYAML insecurely deserializes YAML strings leading to arbitrary code execution](https://github.com/advisories/GHSA-rprw-h62v-c2w7)" ya que la secuencia de búsqueda se muestra en la descripción de la asesoría. + +{% endif %} + +{% ifversion dependabot-bulk-alerts %} + ![Captura de pantalla del filtro y menús de clasificación en la pestaña de las {% data variables.product.prodname_dependabot_alerts %}](/assets/images/help/graphs/dependabot-alerts-filters-checkbox.png){% elsif ghes = 3.5 %} +Puedes seleccionar un filtro en un menú desplegable en la parte superior de la lista y luego hacer clic en aquél que te gustaría aplicar. ![Screenshot of the filter and sort menus in the {% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/enterprise/3.5/dependabot/dependabot-alerts-filters.png){% endif %} + {% ifversion dependabot-alerts-development-label %} ## Ecosistemas y manifiestos compatibles para el alcance de las dependencias - {% data reusables.dependabot.dependabot-alerts-dependency-scope %} -Las alertas para los paquetes que se listan como dependencias de desarrollo se marcan con la etiqueta `Development` en la página de {% data variables.product.prodname_dependabot_alerts %} y también están disponibles para filtrarse mediante el filtro `scope`. ![Captura de pantalla que muestra la etiqueta "Development" en la lista de alertas](/assets/images/help/repository/dependabot-alerts-development-label.png) +Las alertas para los paquetes que se listan como dependencias de desarrollo se marcan con la etiqueta `Development` en la página de {% data variables.product.prodname_dependabot_alerts %} y también están disponibles para filtrarse mediante el filtro `scope`. -La página de detalles de la alerta en los pquetes con alcance de desarrollo muestra una sección de "Etiquetas" que contiene una etiqueta de `Development`. ![Captura de pantalla que muestra la sección "Tags" en la página de detalles de la alerta](/assets/images/help/repository/dependabot-alerts-tags-section.png) +![Captura de pantalla que muestra la etiqueta "Development" en la lista de alertas](/assets/images/help/repository/dependabot-alerts-development-label.png) + +La página de detalles de la alerta en los pquetes con alcance de desarrollo muestra una sección de "Etiquetas" que contiene una etiqueta de `Development`. + +![Captura de pantalla que muestra la sección "Tags" en la página de detalles de la alerta](/assets/images/help/repository/dependabot-alerts-tags-section.png) {% endif %} @@ -90,23 +110,10 @@ Para obtener más información, consulta la sección "[revisar y corregir las al {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-dependabot-alerts %} -1. Opcionalmente, para filtrar alertas, selecciona el menú desplegable de **Repositorio**, l **Paquete**, **Ecosistema** o **Manifiesto** y luego haz clic en el filtro que te gustaría aplicar. También puedes teclear filtros en la barra de búsqueda. Por ejemplo, `ecosystem:npm`{% ifversion ghes < 3.7 or ghae-issue-5638 %} o `has:patch`{% endif %}{% ifversion dependabot-alerts-development-label %}, `has:patch` o `scope:development`{% endif %}. Para ordenar las alertas, selecciona el menú desplegable de **Ordenar** y luego haz clic en la opción por la cual te gustaría ordenarlas o escribe `sort:` en la barra de búsqueda y elige una opción de entre las sugerencias (por ejemplo, `sort:newest`). - - {% ifversion dependabot-most-important-sort-option %} - {% note %} - - **Nota:** Predeterminadamente, las {% data variables.product.prodname_dependabot_alerts %} se ordenan por importancia. El ordenar por "Más importante" te permite priorizar en qué {% data variables.product.prodname_dependabot_alerts %} te enfocarás primero. Las alertas se clasifican con base en su impacto potencial, capacidad de acción y relevancia. Nuestro cálculo de priorización se está mejorando constantemente e incluye factores como la puntuación de CVSS, alcance de dependencia y si las llamadas a la función vulnerable se encuentran en la alerta. - {% endnote %} - - ![Captura de pantalla del menú desplegable de clasificación con una clasificación de "Más importante"](/assets/images/help/dependabot/dependabot-alerts-sort-dropdown.png) - {% endif %} - - También puedes hacer clic en una etiqueta de una alerta para que solo muestre las alertas de ese tipo.{% ifversion dependabot-alerts-development-label %} Por ejemplo, el hacer clic en la etiqueta `Development` en la lista de alertas solo mostrará aquellas que se relacionen con las dependencias que se utilizan en desarrollo y no en producción. Para obtener más información sobre la lista de ecosistemas compatibles, consulta la sección "[Ecosistemas y manifiestos compatibles para el alcance de dependencias ](#supported-ecosystems-and-manifests-for-dependency-scope)". - -{% endif %} +1. Opcionalmente, para filtrar las alertas, selecciona un filtro en un menú desplegable y haz clic en el que te gustaría aplicar. También puedes teclear filtros en la barra de búsqueda. Para obtener más información sobre cómo filtrar y clasificar alertas, consulta la sección "[Priorizar las {% data variables.product.prodname_dependabot_alerts %}](#prioritizing-across--data-variablesproductprodname_dependabot_alerts-)". {%- ifversion dependabot-bulk-alerts %} ![Captura de pantalla del filtro y menús de clasificación en la pestaña de las {% data variables.product.prodname_dependabot_alerts %}](/assets/images/help/graphs/dependabot-alerts-filters-checkbox.png){% else %} - ![Screenshot of the filter and sort menus in the {% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/enterprise/3.5/dependabot/dependabot-alerts-filters.png){% endif %} +![Screenshot of the filter and sort menus in the {% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/enterprise/3.5/dependabot/dependabot-alerts-filters.png){% endif %} 1. Haz clic en la alerta que te gustaría ver.{% ifversion dependabot-bulk-alerts %} ![Alert selected in list of alerts](/assets/images/help/graphs/click-alert-in-alerts-list-checkbox.png){% else %} ![Alert selected in list of alerts](/assets/images/enterprise/3.5/dependabot/click-alert-in-alerts-list-ungrouped.png){% endif %} @@ -156,7 +163,12 @@ Para los lenguajes compatibles, el {% data variables.product.prodname_dependabot Si programas mucho trabajo para actualizar una dependencias o decides que una alerta no necesita corregirse, puedes descartar la alerta. El descartar alertas que ya valoraste facilita clasificar las nuevas que aparecen. 1. Ver los detalles de una alerta. Para obtener más información, consulta la sección "[Ver las dependencias vulnerables](#viewing-dependabot-alerts)" (anteriormente). -1. Selecciona el menú desplegable de "Descartar" y haz clic en una razón para descartar la alerta.{% ifversion reopen-dependabot-alerts %} Las alertas descartadas sin fijar pueden volverse a abrir posteriormente.{% endif %} ![Elegir una razón para descartar la alerta a través del menú desplegable de "Descartar"](/assets/images/help/repository/dependabot-alert-dismiss-drop-down-ungrouped.png) +1. Selecciona el menú desplegable de "Descartar" y haz clic en una razón para descartar la alerta.{% ifversion reopen-dependabot-alerts %} Las alertas descartadas sin fijar pueden volverse a abrir posteriormente.{% endif %} +{% ifversion dependabot-alerts-dismissal-comment %}1. Optionally, add a dismissal comment. The dismissal comment will be added to the alert timeline and can be used as justification during auditing and reporting. You can retrieve or set a comment by using the GraphQL API. El comentario se contiene en el campo `dismissComment`. Para obtener más información, consulta la sección "[{% data variables.product.prodname_dependabot_alerts %}](/graphql/reference/objects#repositoryvulnerabilityalert)" en la documentación de la API de GraphQL. + ![Captura de pantalla que muestra cómo descartar una alerta a través del menú desplegable de "Descartar" con la opción para agregar un comentario de destitución](/assets/images/help/repository/dependabot-alerts-dismissal-comment.png) +1. Haz clic en **Descargar alerta**. +{% else %} + ![Elegir una razón para descartar la alerta a través del menú desplegable de "Descartar"](/assets/images/help/repository/dependabot-alert-dismiss-drop-down-ungrouped.png){% endif %} {% ifversion dependabot-bulk-alerts %} ### Descartar varias alertas al mismo tiempo @@ -173,24 +185,24 @@ Si programas mucho trabajo para actualizar una dependencias o decides que una al ## Ver y actualziar las alertas cerradas -You can view all open alerts, and you can reopen alerts that have been previously dismissed. Las alertas cerradas que ya se hayan corregido no se pueden volver a abrir. +Puedes ver todas las alertas abiertas y puedes volver a abrir las que hayas descartado previamente. Las alertas cerradas que ya se hayan corregido no se pueden volver a abrir. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-dependabot-alerts %} -1. To just view closed alerts, click **Closed**. +1. Para ver únicamente las alertas cerradas, haz clic en **Cerradas**. {%- ifversion dependabot-bulk-alerts %} - ![Screenshot showing the "Closed" option](/assets/images/help/repository/dependabot-alerts-closed-checkbox.png) + ![Captura de pantalla que muestra la opción "Cerradas"](/assets/images/help/repository/dependabot-alerts-closed-checkbox.png) {%- else %} - ![Screenshot showing the "Closed" option](/assets/images/help/repository/dependabot-alerts-closed.png) + ![Captura de pantalla que muestra la opción "Cerradas"](/assets/images/help/repository/dependabot-alerts-closed.png) {%- endif %} -1. Click the alert that you would like to view or update. +1. Haz clic en la alerta que te gustaría ver o actualizar. {%- ifversion dependabot-bulk-alerts %} - ![Screenshot showing a highlighted dependabot alert](/assets/images/help/repository/dependabot-alerts-select-closed-alert-checkbox.png) + ![Captura de pantalla que muestra una alerta del dependabot resaltada](/assets/images/help/repository/dependabot-alerts-select-closed-alert-checkbox.png) {%- else %} - ![Screenshot showing a highlighted dependabot alert](/assets/images/help/repository/dependabot-alerts-select-closed-alert.png) {%- endif %} + ![Captura de pantalla que muestra una alerta del dependabot resaltada](/assets/images/help/repository/dependabot-alerts-select-closed-alert.png) {%- endif %} 2. Opcionalmente, si se descartó la alerta y quieres volver a abrirla, haz clic en **Reabrir**. Las alertas que ya se hayan corregido no pueden volverse a abrir. {% indented_data_reference reusables.enterprise.3-5-missing-feature spaces=3 %} diff --git a/translations/es-ES/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md b/translations/es-ES/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md index 4d9ad218d8..ff3e91456d 100644 --- a/translations/es-ES/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md +++ b/translations/es-ES/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md @@ -416,7 +416,7 @@ updates: ### `open-pull-requests-limit` -Predeterminadamente, {% data variables.product.prodname_dependabot %} abre un máximo de cinco solicitudes de extracción para las actualizaciones de versión. Una vez que hayan cinco solicitudes de cambio abiertas, las solicitudes nuevas se bloquearán hasta que fusiones o cierres algunas de las sollicitudes abiertas, después de lo cual, las solicitudes de cambiso nuevas pueden abrirse en actualizaciones subsecuentes. Utiliza `open-pull-requests-limit` para cambiar este límite. Esto también proporciona una forma simple de inhabilitar temporalmente las actualizaciones de versión para un administrador de paquete. +Predeterminadamente, {% data variables.product.prodname_dependabot %} abre un máximo de cinco solicitudes de extracción para las actualizaciones de versión. Once there are five open pull requests from {% data variables.product.prodname_dependabot %}, {% data variables.product.prodname_dependabot %} will not open any new requests until some of those open requests are merged or closed. Utiliza `open-pull-requests-limit` para cambiar este límite. Esto también proporciona una forma simple de inhabilitar temporalmente las actualizaciones de versión para un administrador de paquete. Esta opción no tiene impacto en las actualizaciones de seguridad que tienen un límite separado e interno de diez solicitudes de extracción abiertas. @@ -777,7 +777,7 @@ registries: {% note %} -**Note:** We don't support the Azure Container Registry (ACR). +**Nota:** No tenemos compatibilidad para el Registro de Contenedores de Azure (ACR). {% endnote %} diff --git a/translations/es-ES/content/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions.md b/translations/es-ES/content/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions.md index 23ca9599b3..efff6a2476 100644 --- a/translations/es-ES/content/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions.md +++ b/translations/es-ES/content/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions.md @@ -43,7 +43,7 @@ Las siguientes restricciones aplican para los flujos de trabajo que inicia el {% Para los flujos de trabajo que inicia el {% data variables.product.prodname_dependabot %} (`github.actor == 'dependabot[bot]'`) y que utilizan el evento `pull_request_target`, si el {% data variables.product.prodname_dependabot %} (`github.actor == 'dependabot[bot]'`) creó la referencia base de la solicitud de cambios, el `GITHUB_TOKEN` será de solo lectura y los secretos no estarán disponibles. {% endif %} -{% ifversion actions-stable-actor-ids %}These restrictions apply even if the workflow is re-run by a different actor.{% endif %} +{% ifversion actions-stable-actor-ids %}Estas restricciones aplican incluso si un actor diferente vuelve a ejecutar el flujo de trabajo.{% endif %} Para obtener màs informaciòn, consulta la secciòn "[Mantener seguras tus GitHub Actions y flujos de trabajo: Prevenir solicitudes de tipo pwn](https://securitylab.github.com/research/github-actions-preventing-pwn-requests/)". @@ -228,7 +228,7 @@ jobs: {% ifversion actions-stable-actor-ids %} -When you manually re-run a Dependabot workflow, it will run with the same privileges as before even if the user who initiated the rerun has different privileges. Para obtener más información, consulta la sección "[Re-ejecución de flujos de trabajo y jobs](/actions/managing-workflow-runs/re-running-workflows-and-jobs)". +Cuando vuelves a ejecutar un flujo de trabajo del Dependabot manualmente, este se ejecutará con los mismos privilegios que antes, incluso si el usuario que inició la re-ejecución tiene privilegios diferentes. Para obtener más información, consulta la sección "[Re-ejecución de flujos de trabajo y jobs](/actions/managing-workflow-runs/re-running-workflows-and-jobs)". {% else %} diff --git a/translations/es-ES/content/code-security/secret-scanning/about-secret-scanning.md b/translations/es-ES/content/code-security/secret-scanning/about-secret-scanning.md index 481ec138e4..0110c45c23 100644 --- a/translations/es-ES/content/code-security/secret-scanning/about-secret-scanning.md +++ b/translations/es-ES/content/code-security/secret-scanning/about-secret-scanning.md @@ -39,7 +39,7 @@ Service providers can partner with {% data variables.product.company_short %} to {% ifversion secret-scanning-push-protection %} -You can also enable {% data variables.product.prodname_secret_scanning %} as a push protection for a repository or an organization. When you enable this feature, {% data variables.product.prodname_secret_scanning %} prevents contributors from pushing code with a detected secret. To proceed, contributors must either remove the secret(s) from the push or, if needed, bypass the protection. For more information, see "[Protecting pushes with {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." +You can also enable {% data variables.product.prodname_secret_scanning %} as a push protection for a repository or an organization. When you enable this feature, {% data variables.product.prodname_secret_scanning %} prevents contributors from pushing code with a detected secret. To proceed, contributors must either remove the secret(s) from the push or, if needed, bypass the protection. {% ifversion push-protection-custom-link-orgs %}Admins can also specify a custom link that is displayed to the contributor when a push is blocked; the link can contain resources specific to the organization to aid contributors. {% endif %}For more information, see "[Protecting pushes with {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." {% endif %} diff --git a/translations/es-ES/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md b/translations/es-ES/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md index d7f7ba9122..bfa80cfbc5 100644 --- a/translations/es-ES/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md +++ b/translations/es-ES/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md @@ -13,7 +13,7 @@ topics: - Advanced Security - Alerts - Repositories -shortTitle: Enable push protection +shortTitle: Habilitar la protección de subida --- {% data reusables.secret-scanning.beta %} @@ -30,7 +30,7 @@ Si un contribuyente omite un bloque de protección de subida para un secreto, {% - agrega un evento de omisión en la bitácora de auditoría.{% ifversion secret-scanning-push-protection-email %} - envía una alerta por correo electrónico a los propietarios de la organización, administradores de seguridad y administradores de repositorio con un enlace al secreto relacionado y con la razón por la cual se permitió.{% endif %} -For information on the secrets and service providers supported for push protection, see "[{% data variables.product.prodname_secret_scanning_caps %} patterns](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-push-protection)." +Para obtener información sobre los proveedores de servicios y secretos compatibles para la protección contra subida, consulta la sección "[patrones de {% data variables.product.prodname_secret_scanning_caps %}](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-push-protection)". ## Habilitar el {% data variables.product.prodname_secret_scanning %} como una protección contra subidas @@ -54,17 +54,29 @@ Los propietarios de las organizaciones, administradores de seguridad y administr {% data reusables.repositories.navigate-to-ghas-settings %} {% data reusables.advanced-security.secret-scanning-push-protection-repo %} -## Using secret scanning as a push protection from the command line +## Utilizar el escaneo de secretos como protección contra subida desde la línea de comandos {% data reusables.secret-scanning.push-protection-command-line-choice %} Se mostrarán hasta cinco secretos detectados a la vez en la línea de comandos. Si ya se detectó un secreto en particular en el repositorio y la alerta ya existe, {% data variables.product.prodname_dotcom %} no lo bloqueará. +{% ifversion push-protection-custom-link-orgs %} + +Los administradores de las organizaciones pueden proporcionar un enlace personalizado que se mostrará cuando se bloquee una subida de información. Este enlace personalizado puede contener consejos y recursos específicos para la organización, tal como las instrucciones para utilizar una bóveda de secretos recomendada o a quién contactar para hacer preguntas relacionadas con el secreto bloqueado. + +{% ifversion push-protection-custom-link-orgs-beta %}{% data reusables.advanced-security.custom-link-beta %}{% endif %} + +![Captura de pantalla que muestra que una subida está bloqueada cuando un usuario intenta subir un secreto a un repositorio](/assets/images/help/repository/secret-scanning-push-protection-with-custom-link.png) + +{% else %} + ![Captura de pantalla que muestra que una subida está bloqueada cuando un usuario intenta subir un secreto a un repositorio](/assets/images/help/repository/secret-scanning-push-protection-with-link.png) -{% data reusables.secret-scanning.push-protection-remove-secret %} For more information about remediating blocked secrets, see "[Pushing a branch blocked by push protection](/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection#resolving-a-blocked-push-on-the-command-line)." +{% endif %} -Si confirmas que un secreto es real y que pretendes corregirlo después, debes intentar remediarlo tan pronto como sea posible. Por ejemplo, podrías revocar el secreto y eliminarlo del historial de confirmaciones del repositorio. Real secrets that have been exposed must be revoked to avoid unauthorized access. You might consider first rotating the secret before revoking it. Para obtener más información, consulta la sección "[Eliminar datos confidenciales de un repositorio](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)". +{% data reusables.secret-scanning.push-protection-remove-secret %} Para obtener más información sobre los secretos de remediación bloqueados, consulta la sección "[Subir una rama que se bloqueó por una protección contra subida](/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection#resolving-a-blocked-push-on-the-command-line)". + +Si confirmas que un secreto es real y que pretendes corregirlo después, debes intentar remediarlo tan pronto como sea posible. Por ejemplo, podrías revocar el secreto y eliminarlo del historial de confirmaciones del repositorio. Los secretos reales que se expusieron deben revocarse para evitar un acceso no autorizado. Podrías considerar rotar el secreto primero antes de revocarlo. Para obtener más información, consulta la sección "[Eliminar datos confidenciales de un repositorio](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)". {% data reusables.secret-scanning.push-protection-multiple-branch-note %} @@ -88,13 +100,21 @@ Si {% data variables.product.prodname_dotcom %} bloquea un secreto que piensas s {% data variables.product.prodname_dotcom %} solo mostrará un secreto detectado a la vez en la IU web. Si ya se detectó un secreto en particular en el repositorio y la alerta ya existe, {% data variables.product.prodname_dotcom %} no lo bloqueará. +{% ifversion push-protection-custom-link-orgs %} + +Los administradores de las organizaciones pueden proporcionar un enlace personalizado que se mostrará cuando se bloquee una subida de información. Este enlace personalizado puede contener recursos y consejos específicos para tu organización. Por ejemplo, el enlace personalizado puede apuntar a un archivo README con información sobre la bóveda de secretos de la organización, a qué individuos y equipos escalar las preguntas o la política aprobada de la organización para trabajar con secretos y reescribir el historial de confirmaciones. + +{% ifversion push-protection-custom-link-orgs-beta %}{% data reusables.advanced-security.custom-link-beta %}{% endif %} + +{% endif %} + Puedes eliminar el secreto del archivo utilizando la IU web. Una vez que elimines el secreto, el letrero en la parte superior de la página cambiará y te dirá que ahora puedes confirmar tus cambios. ![Captura de pantalla que muestra la confirmación en la Iu web después de que se corrigió un secreto](/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-allowed.png) ### Saltar la protección contra subidas para un secreto -{% data reusables.secret-scanning.push-protection-remove-secret %} For more information about remediating blocked secrets, see "[Pushing a branch blocked by push protection](/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection#resolving-a-blocked-push-in-the-web-ui)." +{% data reusables.secret-scanning.push-protection-remove-secret %} Para obtener más información sobre los secretos de remediación bloqueados, consulta la sección "[Subir una rama que se bloqueó por una protección contra subida](/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection#resolving-a-blocked-push-in-the-web-ui)". Si confirmas que un secreto es real y que pretendes corregirlo después, debes intentar remediarlo tan pronto como sea posible. Para obtener más información, consulta la sección "[Eliminar datos confidenciales de un repositorio](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)". diff --git a/translations/es-ES/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md b/translations/es-ES/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md index 14981705dd..1add514681 100644 --- a/translations/es-ES/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md +++ b/translations/es-ES/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md @@ -16,16 +16,24 @@ shortTitle: Push a blocked branch ## About push protection for {% data variables.product.prodname_secret_scanning %} -The push protection feature of {% data variables.product.prodname_secret_scanning %} helps to prevent security leaks by scanning for secrets before you push changes to your repository. {% data reusables.secret-scanning.push-protection-overview %} For information on the secrets and service providers supported for push protection, see "[{% data variables.product.prodname_secret_scanning_caps %} patterns](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-push-protection)." +The push protection feature of {% data variables.product.prodname_secret_scanning %} helps to prevent security leaks by scanning for secrets before you push changes to your repository. {% data reusables.secret-scanning.push-protection-overview %} Para obtener más información sobre los secretos y proveedores de servicios compatibles para la protección contra subida de información, consulta la sección "[Patrones de los {% data variables.product.prodname_secret_scanning_caps %}](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-push-protection)". {% data reusables.secret-scanning.push-protection-remove-secret %} {% tip %} -**Tip** If {% data variables.product.prodname_dotcom %} blocks a secret that you believe is safe to push, you can allow the secret and specify the reason why it should be allowed. For more information about bypassing push protection for a secret, see "[Allowing a blocked secret to be pushed](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#allowing-a-blocked-secret-to-be-pushed)" and "[Bypassing push protection for a secret](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#bypassing-push-protection-for-a-secret)" for the command line and the web UI, respectively. +**Tip** If {% data variables.product.prodname_dotcom %} blocks a secret that you believe is safe to push, you can allow the secret and specify the reason why it should be allowed. Para obtener más información sobre cómo omitir la protección contra subida de información para un secreto, consulta las secciones "[Permitir que se suba un secreto bloqueado](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#allowing-a-blocked-secret-to-be-pushed)" y "[Omitir la protección contra subida de información para un secreto](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#bypassing-push-protection-for-a-secret)" para la línea de comandos y la IU web, respectivamente. {% endtip %} +{% ifversion push-protection-custom-link-orgs %} + +Organization admins can provide a custom link that will be included in the message from {% data variables.product.product_name %} when your push is blocked. This custom link can contain resources and advice specific to your organization and its policies. + +{% ifversion push-protection-custom-link-orgs-beta %}{% data reusables.advanced-security.custom-link-beta %}{% endif %} + +{% endif %} + ## Resolving a blocked push on the command line {% data reusables.secret-scanning.push-protection-command-line-choice %} diff --git a/translations/es-ES/content/code-security/secret-scanning/secret-scanning-patterns.md b/translations/es-ES/content/code-security/secret-scanning/secret-scanning-patterns.md index d6797c26cd..793062014e 100644 --- a/translations/es-ES/content/code-security/secret-scanning/secret-scanning-patterns.md +++ b/translations/es-ES/content/code-security/secret-scanning/secret-scanning-patterns.md @@ -21,10 +21,10 @@ redirect_from: {% ifversion fpt or ghec %} ## Acerca de los patrones del {% data variables.product.prodname_secret_scanning %} -{% data variables.product.product_name %} maintains these different sets of {% data variables.product.prodname_secret_scanning %} patterns: +{% data variables.product.product_name %} mantiene estos diversos conjuntos de patrones del {% data variables.product.prodname_secret_scanning %}: 1. **Patrones socios.** Se utilizan para detectar secretos potenciales en todos los repositorios públicos. Para obtener más detalles, consulta la sección "[Secretos compatibles para los patrones asociados](#supported-secrets-for-partner-patterns)". -2. **Patrones de seguridad avanzada.** Se utilizan para detectar secretos potenciales en los repositorios que tienen habilitado el {% data variables.product.prodname_secret_scanning %}. {% ifversion ghec %} For details, see "[Supported secrets for advanced security](#supported-secrets-for-advanced-security)."{% endif %}{% ifversion secret-scanning-push-protection %} +2. **Patrones de seguridad avanzada.** Se utilizan para detectar secretos potenciales en los repositorios que tienen habilitado el {% data variables.product.prodname_secret_scanning %}. {% ifversion ghec %} Para obtener más detalles, consulta la sección "[Secretos compatibles para la seguridad avanzada](#supported-secrets-for-advanced-security)".{% endif %}{% ifversion secret-scanning-push-protection %} 3. **Push protection patterns.** Used to detect potential secrets in repositories with {% data variables.product.prodname_secret_scanning %} as a push protection enabled. For details, see "[Supported secrets for push protection](#supported-secrets-for-push-protection)."{% endif %} {% ifversion fpt %} diff --git a/translations/es-ES/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md b/translations/es-ES/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md index 679346062d..b8e4e66171 100644 --- a/translations/es-ES/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md +++ b/translations/es-ES/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md @@ -12,25 +12,25 @@ shortTitle: Registro de imagen privado ## Acerca de los registros de imagen y {% data variables.product.prodname_github_codespaces %} privados -Un registro es un espacio seguro para almacenar, administrar y recuperar imágenes de contenedor privadas. Puedes utilizar uno para almacenar una o más imágenes. Hay muchos ejemplos de registros, tales como el Registro de Contenedores de {% data variables.product.prodname_dotcom %}, Registro de Contenedores de Azure o DockerHub. +Un registro es un espacio seguro para almacenar, administrar y recuperar imágenes de contenedor privadas. Puedes utilizar uno para almacenar una o más imágenes. There are many examples of registries, such as {% data variables.product.prodname_container_registry %}, {% data variables.product.prodname_npm_registry %}, Azure Container Registry, or DockerHub. -El Registro de Contenedores de {% data variables.product.prodname_dotcom %} puede configurarse para extraer imágenes de contenedor sin problemas, sin tener que proporcionar credenciales de autenticación a {% data variables.product.prodname_github_codespaces %}. Para otros registros de imágenes, debes crear secretos en {% data variables.product.prodname_dotcom %} para almacenar los detalles de acceso, los cuales permitirán que los {% data variables.product.prodname_codespaces %} accedan a las imágenes almacenadas en dicho registro. +{% data variables.product.prodname_ghcr_and_npm_registry %} can be configured to allow container images to be pulled seamlessly into {% data variables.product.prodname_github_codespaces %} during codespace creation, without having to provide any authentication credentials. Para otros registros de imágenes, debes crear secretos en {% data variables.product.prodname_dotcom %} para almacenar los detalles de acceso, los cuales permitirán que los {% data variables.product.prodname_codespaces %} accedan a las imágenes almacenadas en dicho registro. -## Acceder a las imágenes almacenadas en el Registro de Contenedores de {% data variables.product.prodname_dotcom %} +## Accessing images stored in {% data variables.product.prodname_ghcr_and_npm_registry %} -El Registro de Contenedores de {% data variables.product.prodname_dotcom %} es la manera más fácil de que {% data variables.product.prodname_codespaces %} consuma imágenes de contenedor de devcontainer. +{% data variables.product.prodname_ghcr_and_npm_registry %} provide the easiest way for {% data variables.product.prodname_codespaces %} to consume dev container images. -Para obtener más información, consulta la sección "[Trabajar con el registro de contenedores](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)". +For more information, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)" and "[Working with the npm registry](/packages/working-with-a-github-packages-registry/working-with-the-npm-registry)". ### Acceder a una imagen publicada en el mismo repositorio que el codespace -Si publicas una imagen de contenedor en el Registro de Contenedores de {% data variables.product.prodname_dotcom %} en el mismo repositorio que el codespace en el cuál se lanzará, automáticamente podrás recuperar esta imagen cuando crees el codespace. No tendrás que proporcionar credenciales adicionales, a menos de que la opción **heredar acceso del repositorio** se haya deseleccionado cuando se publique la imagen de contenedor. +If you publish a container image to {% data variables.product.prodname_ghcr_or_npm_registry %} in the same repository that the codespace is being launched in, you will automatically be able to fetch that image on codespace creation. No tendrás que proporcionar credenciales adicionales, a menos de que la opción **heredar acceso del repositorio** se haya deseleccionado cuando se publique la imagen de contenedor. #### Heredar el acceso del repositorio desde el cual se publicó la imagen -Predeterminadamente, cuando publicas una imagen de contenedor en el Registro de Contenedores de {% data variables.product.prodname_dotcom %}, esta hereda la configuración de acceso del repositorio desde el cual se publicó. Por ejemplo, si el repositorio es público, la imagen también es pública. Si el repositorio es privado, la imagen también es privada, pero es accesible desde el repositorio. +By default, when you publish a container image to {% data variables.product.prodname_ghcr_or_npm_registry %}, the image inherits the access setting of the repository from which the image was published. Por ejemplo, si el repositorio es público, la imagen también es pública. Si el repositorio es privado, la imagen también es privada, pero es accesible desde el repositorio. -Este comportamiento se controla mediante la opción **heredar acceso desde el repositorio**. La opción **heredar acceso desde el repositorio** se encuentra seleccionada predeterminadamente cuando publicas a través de {% data variables.product.prodname_actions %}, pero no cuando se publica directamente al Registro de Contenedores de {% data variables.product.prodname_dotcom %} utilizando un token de acceso personal (PAT). +Este comportamiento se controla mediante la opción **heredar acceso desde el repositorio**. **Inherit access from repo** is selected by default when publishing via {% data variables.product.prodname_actions %}, but not when publishing directly to {% data variables.product.prodname_ghcr_or_npm_registry %} using a Personal Access Token (PAT). Si la opción de **heredar acceso desde el repositorio** no se seleccionó cuando se publicó la imagen, puedes agregar el repositorio manualmente a los controles de acceso de la imagen del contenedor publicado. Para obtener más información, consulta la sección "[Configurar el control de accesos y la visibilidad de un paquete](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#inheriting-access-for-a-container-image-from-a-repository)". @@ -46,13 +46,13 @@ Si quieres permitir que un subconjunto de repositorios de una organización acce ### Publicar una imagen de contenedor desde un codespace -El acceso fácil desde un codespace hasta el Registrod de Contenedores de {% data variables.product.prodname_dotcom %} se limita a las imágenes de contenedor que se extraen. Si quieres publicar una imagen de contenedor desde dentro de un codespace, debes utilizar un token de acceso personal (PAT) con el alcance `write:packages`. +Seamless access from a codespace to {% data variables.product.prodname_ghcr_or_npm_registry %} is limited to pulling container images. Si quieres publicar una imagen de contenedor desde dentro de un codespace, debes utilizar un token de acceso personal (PAT) con el alcance `write:packages`. -Te recomendamos publicar imágenes a través de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Publicar imágenes de Docker](/actions/publishing-packages/publishing-docker-images)". +Te recomendamos publicar imágenes a través de {% data variables.product.prodname_actions %}. For more information, see "[Publishing Docker images](/actions/publishing-packages/publishing-docker-images)" and "[Publishing Node.js packages](/actions/publishing-packages/publishing-nodejs-packages)." ## Acceder a las imágenes almacenadas en otros registros de contenedor -Si estás accediendo a una imagen de contenedor desde un registro diferente al Registro de Contenedores de {% data variables.product.prodname_dotcom %}, {% data variables.product.prodname_codespaces %} verifica la presencia de tres secretos, los cuales definen el nombre del servidor, nombre de usuario y token de acceso personal (PAT) de un registro de contenedores. Si se encuentran estos secretos, {% data variables.product.prodname_github_codespaces %} hará que el registro esté disponible dentro de tu codespace. +If you are accessing a container image from a registry that isn't {% data variables.product.prodname_ghcr_or_npm_registry %}, {% data variables.product.prodname_codespaces %} checks for the presence of three secrets, which define the server name, username, and personal access token (PAT) for a container registry. Si se encuentran estos secretos, {% data variables.product.prodname_github_codespaces %} hará que el registro esté disponible dentro de tu codespace. - `<*>_CONTAINER_REGISTRY_SERVER` - `<*>_CONTAINER_REGISTRY_USER` diff --git a/translations/es-ES/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md b/translations/es-ES/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md index 83abd07f1e..ffe2c1964a 100644 --- a/translations/es-ES/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md +++ b/translations/es-ES/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md @@ -88,15 +88,13 @@ Puedes agregar más scripts, preferencias o archivos de configuración a tu repo Si tu codespace no puede recoger los ajustes de configuración de los dotfiles, consulta la sección "[Solucionar problemas de dotfiles para {% data variables.product.prodname_codespaces %}](/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces)". -## Otros ajustes disponibles - También puedes personalizar los {% data variables.product.prodname_codespaces %} utilizando [ajustes de {% data variables.product.prodname_codespaces %}](https://github.com/settings/codespaces) adicionales: -- Para configurar tu región predeterminada, consulta la sección "[Configurar tu región predeterminada para los {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces)". -- Para configurar tu editor, consulta la sección "[Configurar tu editor predeterminado para los {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces)". -- Para agregar secretos cifrados, consulta la sección "[Administrar secretos cifrados para {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces)". - Para habilitar la verificación de GPG, consulta la sección "[Administrar la verificación de GPG para los {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)". -- To allow your codespaces to access other repositories, see "[Managing repository access for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces)." +- Para configurar tu editor, consulta la sección "[Configurar tu editor predeterminado para los {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces)". +- To set how long a codespace can remain unused before it is automatically stopped, see "[Setting your timeout period for GitHub Codespaces](/codespaces/customizing-your-codespace/setting-your-timeout-period-for-github-codespaces)." +- To set the period for which your unused codespaces are retained, see "[Configuring automatic deletion of your codespaces](/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces)." +- Para configurar tu región predeterminada, consulta la sección "[Configurar tu región predeterminada para los {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces)". ## Leer más diff --git a/translations/es-ES/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/translations/es-ES/content/codespaces/developing-in-codespaces/creating-a-codespace.md index 5e5378d571..f626933523 100644 --- a/translations/es-ES/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ b/translations/es-ES/content/codespaces/developing-in-codespaces/creating-a-codespace.md @@ -46,23 +46,20 @@ If you want to use Git hooks for your codespace, then you should set up hooks us When you have access to {% data variables.product.prodname_github_codespaces %}, you'll see a "Codespaces" tab within the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu when you view a repository. -You'll have access to codespaces under the following conditions: +You'll have access to {% data variables.product.prodname_github_codespaces %} under the following conditions: -* You are a member of an organization that has enabled {% data variables.product.prodname_codespaces %} and set a spending limit. -* An organization owner has granted you access to {% data variables.product.prodname_codespaces %}. -* The repository is owned by the organization that has enabled {% data variables.product.prodname_codespaces %}. +Either all of these are true: +* You are a member, or outside collaborator, of an organization that has enabled {% data variables.product.prodname_codespaces %} and set a spending limit. +* The organization owner has allowed you to create codespaces at the organization's expense. +* The repository for which you want to create a codespace is owned by this organization. -{% note %} - -**Note:** Individuals who have already joined the beta with their personal {% data variables.product.prodname_dotcom %} account will not lose access to {% data variables.product.prodname_codespaces %}, however {% data variables.product.prodname_codespaces %} for individuals will continue to remain in beta. - -{% endnote %} - -Organization owners can allow all members of the organization to create codespaces, limit codespace creation to selected organization members, or disable codespace creation. For more information about managing access to codespaces within your organization, see "[Enable Codespaces for users in your organization](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization#enable-codespaces-for-users-in-your-organization)." +Or both of these are true: +* You are participating in the beta of {% data variables.product.prodname_codespaces %} for individual users. +* Either you own the repository for which you want to create a codespace, or it is owned by an organization of which you are either a member or an outside collaborator. Before {% data variables.product.prodname_codespaces %} can be used in an organization, an owner or billing manager must have set a spending limit. For more information, see "[About spending limits for Codespaces](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces#about-spending-limits-for-codespaces)." -If you would like to create a codespace for a repository owned by your personal account or another user, and you have permission to create repositories in an organization that has enabled {% data variables.product.prodname_github_codespaces %}, you can fork user-owned repositories to that organization and then create a codespace for the fork. +Organization owners can specify who can create and use codespaces at the organization's expense. Organization owners can also prevent any codespace usage being charged to the organization. For more information, see "[Enabling {% data variables.product.prodname_github_codespaces %} for your organization](/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization#choose-who-can-create-codespaces-that-are-billed-to-your-organization)." ## Creating a codespace diff --git a/translations/es-ES/content/codespaces/developing-in-codespaces/renaming-a-codespace.md b/translations/es-ES/content/codespaces/developing-in-codespaces/renaming-a-codespace.md index 519f365f11..0f3f410883 100644 --- a/translations/es-ES/content/codespaces/developing-in-codespaces/renaming-a-codespace.md +++ b/translations/es-ES/content/codespaces/developing-in-codespaces/renaming-a-codespace.md @@ -27,7 +27,9 @@ To find the display name of a codespace: ![Screenshot of the Remote Explorer in VS Code](/assets/images/help/codespaces/codespaces-remote-explorer.png) +{% indented_data_reference reusables.codespaces.remote-explorer spaces=2 %} - In a terminal window on your local machine, use this {% data variables.product.prodname_cli %} command: `gh codespace list`. + ### Permanent codespace names In addition to the display name, when you create a codespace, a permanent name is also assigned to the codespace. The name is a combination of your {% data variables.product.company_short %} handle, the repository name, and some random characters. Por ejemplo: `octocat-myrepo-gmc7`. You can't change this name. diff --git a/translations/es-ES/content/codespaces/guides.md b/translations/es-ES/content/codespaces/guides.md index fa7003a120..a1942c39b8 100644 --- a/translations/es-ES/content/codespaces/guides.md +++ b/translations/es-ES/content/codespaces/guides.md @@ -40,7 +40,6 @@ includeGuides: - /codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization - /codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization - /codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces - - /codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces - /codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types - /codespaces/managing-codespaces-for-your-organization/retricting-the-idle-timeout-period - /codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces diff --git a/translations/es-ES/content/codespaces/index.md b/translations/es-ES/content/codespaces/index.md index 889b9861e6..42316a4dc5 100644 --- a/translations/es-ES/content/codespaces/index.md +++ b/translations/es-ES/content/codespaces/index.md @@ -7,11 +7,11 @@ introLinks: quickstart: /codespaces/getting-started/quickstart featuredLinks: guides: - - /billing/managing-billing-for-github-codespaces/about-billing-for-codespaces - /codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization - - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project - - /codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces - /codespaces/developing-in-codespaces/codespaces-lifecycle + - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project + - /codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces + - /billing/managing-billing-for-github-codespaces/about-billing-for-codespaces popular: - /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces - /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces diff --git a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md index cf0f73c0a3..477aff088e 100644 --- a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md +++ b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md @@ -1,9 +1,9 @@ --- title: Enabling GitHub Codespaces for your organization -shortTitle: Habilitar Codespaces -intro: 'Puedes controlar qué usuarios de tu organización pueden utilizar {% data variables.product.prodname_github_codespaces %}.' +shortTitle: 'Habilitar el {% data variables.product.prodname_codespaces %}' +intro: 'You can control which users in your organization can use {% data variables.product.prodname_github_codespaces %} at the organization''s expense.' product: '{% data reusables.gated-features.codespaces %}' -permissions: 'To manage user permissions for {% data variables.product.prodname_github_codespaces %} for an organization, you must be an organization owner.' +permissions: 'To alter an organization''s billing settings, you must be an organization owner.' redirect_from: - /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization - /codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization @@ -13,25 +13,23 @@ versions: type: how_to topics: - Codespaces - - Permissions + - Billing - Administrator --- - ## Acerca de cómo habilitar los {% data variables.product.prodname_github_codespaces %} para tu organización -Los propietarios de organización pueden controlar qué usuarios de tu organización pueden crear y utilizar codespaces. +Organization owners can control which users in your organization can create and use codespaces at the organization's expense. -Para utilizar codespaces en tu organización, debes hacer lo siguiente: +Only people who can clone a repository can create a codespace for that repository. To allow people to create codespaces for repositories owned by your organization, you must: + +- Ensure that users have at least write access to the repositories where they want to use a codespace. Para obtener más información, consulta la sección "[Administrar los equipos y personas con acceso a tu repositorio](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)". +- Asegúrate de que tu organización no tenga habilitada una lista de direcciones IP permitidas. Para obtener más información, consulta la sección "[Administrar las direcciones IP permitidas para tu organización](/{% ifversion fpt %}enterprise-cloud@latest/{% endif %}organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization){% ifversion fpt %}" en la documentación de {% data variables.product.prodname_ghe_cloud %}.{% else %}".{% endif %} + +To allow people to create codespaces for which your organization will be billed, you must: -- Asegurarte de que los usuarios tengan [por lo menos acceso de escritura](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization) en los repositorios en donde quieren utilizar un codespace. -- [Habilitar los {% data variables.product.prodname_github_codespaces %} para los usuarios en tu organización](#enable-codespaces-for-users-in-your-organization). Puedes elegir permitir los {% data variables.product.prodname_codespaces %} para los usuarios seleccionados o solo para algunos específicos. - [Configurar un límite de gastos](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces) -- Asegúrate de que tu organización no tenga habilitada una lista de direcciones IP permitidas. Para obtener más información, consulta la sección "[Administrar las direcciones IP permitidas para tu organización](/{% ifversion fpt %}enterprise-cloud@latest/{% endif %}organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list){% ifversion fpt %}" en la documentación de {% data variables.product.prodname_ghe_cloud %}.{% else %}".{% endif %} - -Predeterminadamente, un codespace solo puede acceder al repositorio desde el cual se creó. Si quieres que los codespaces de tu organización puedan acceder a otros repositorios de organización a los que puede acceder el creador de dichos codespaces, consulta la sección "[Administrar el acceso y la seguridad de los {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)". - -## Habilitar los {% data variables.product.prodname_codespaces %} para los usuarios en tu organización +- [Choose who can create codespaces that are billed to your organization](#choose-who-can-create-codespaces-that-are-billed-to-your-organization) {% ifversion fpt %} {% note %} @@ -40,31 +38,44 @@ Predeterminadamente, un codespace solo puede acceder al repositorio desde el cua {% endnote %} {% endif %} + +Predeterminadamente, un codespace solo puede acceder al repositorio desde el cual se creó. Si quieres que los codesapces en tu organización puedan acceder a otros repositorios en ella a los cuales tenga acceso el creador del codespace, consulta la sección "[Administrar el acceso de los repositorios a los codespaces de tu organización](/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces)". + +## Choose who can create codespaces that are billed to your organization + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.click-codespaces %} -1. Debajo de "Permisos de usuario", selecciona una de las siguientes opciones: +1. Under "Billing," select one of the following options: - * **Usuarios selectos** para seleccionar miembros específicos de la organización que puedan utilizar {% data variables.product.prodname_codespaces %}. - * **Permitir para todos los miembros** para permitir que todos los miembros de tu organización utilicen {% data variables.product.prodname_codespaces %}. - * **Permitir para todos los miembros y colaboradores externos** para permitir que todos los miembros de tu organización, así como los colaboradores externos, utilicen {% data variables.product.prodname_codespaces %}. + * **Disabled** - Your organization will not be charged for codespace usage. {% data variables.product.prodname_codespaces %} created for your organization's repositories will be billed to the individual users who create them. + * **Selected members** - {% data variables.product.prodname_codespaces %} created for your organization's repositories by selected members will be billed to the organization. + * **All members** - {% data variables.product.prodname_codespaces %} created for your organization's repositories by members of your organization will be billed to the organization. + * **All members and outside collaborators** - {% data variables.product.prodname_codespaces %} created for your organization's repositories by organization members and outside collaborators will be billed to the organization. - ![Botones radiales de "Permisos de usuario"](/assets/images/help/codespaces/org-user-permission-settings-outside-collaborators.png) + ![Radio buttons for "Billing"](/assets/images/help/codespaces/codespaces-org-billing-settings.png) {% note %} - **Nota:** Cuando seleccionas **Permitir para todos los miembros y colaboradores externos**, todos los colaboradores externos que hayan agregado información a repositorios específicos podrán crear y utilizar {% data variables.product.prodname_codespaces %}. Se le facturará a tu organización por todo el uso en el que incurrieron los colaboradores externos. Para obtener más información sobre cómo administrar colaboradores externos, consulta la sección "[Acerca de los colaboradores externos](/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization#about-outside-collaborators)". + **Nota:** Cuando seleccionas **Todos los miembros y colaboradores externos**, todos los colaboradores externos que se hayan agregado a los repositorios específicos pueden crear y utilizar {% data variables.product.prodname_codespaces %} para dichos repositorios y se facturará a tu organización por dicho uso. Para obtener más información sobre cómo administrar colaboradores externos, consulta la sección "[Acerca de los colaboradores externos](/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization#about-outside-collaborators)". {% endnote %} 1. Haz clic en **Save ** (guardar). +1. If you chose **Selected members**, an input box is displayed for you to enter the names of users you want to select. + + ![Input box for selecting users](/assets/images/help/codespaces/codespaces-org-billing-add-users.png) ## Inhabilitar los {% data variables.product.prodname_codespaces %} para tu organización +You can prevent the creation and use of codespaces billable to your organization. + +{% data reusables.codespaces.codespaces-disabling-org-billing %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.click-codespaces %} -1. Debajo de "Permisos de usuario", selecciona **Inhabilitado**. +1. Under "Billing," select **Disabled**. ## Configurar un límite de gastos diff --git a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-github-codespaces-in-your-organization.md b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-github-codespaces-in-your-organization.md index 25a9ee47ce..e1870c7457 100644 --- a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-github-codespaces-in-your-organization.md +++ b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-github-codespaces-in-your-organization.md @@ -35,11 +35,15 @@ Puedes configurar el límite de uso de los codespaces en tu organización o repo ## Inhabilitar o limitar los {% data variables.product.prodname_codespaces %} -Puedes inhabilitar el uso de los {% data variables.product.prodname_codespaces %} en tu organización o repositorio. Para obtener más información, consulta la sección "[Administrar el acceso de un repositorio a los codespces de tu organización](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)". +You can disable all use of {% data variables.product.prodname_github_codespaces %} that would be billed to your organization. Alternatively, you can specify which organization members or collaborators can use {% data variables.product.prodname_codespaces %} at your organization's expense. Para obtener más información, consulta la sección "[Habilitar los {% data variables.product.prodname_github_codespaces %} para tu organización](/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization)". -También puedes limitar a los usuarios individuales que pueden utilizar {% data variables.product.prodname_codespaces %}. Para obtener más información, consulta la sección "[Administrar los permisos de los usuarios para tu organización](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)". +{% data reusables.codespaces.codespaces-disabling-org-billing %} -Puedes limitar la elección de tipos de máquina que se encuentra disponible para los repositorios que pertenecen a tu organización. Esto te permite prevenir que las personas utilicen máquinas con recursos excedidos para sus codespaces. Para obtener más información, consulta la sección "[Restringir el acceso a los tipos de máquina](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types)". +You can configure which repositories can be accessed from codespaces created for a particular repository. Si necesitas más información, consulta la sección "[Administrar el acceso a otros repositorios dentro de tu codespace](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)". + +You can limit the choice of types of machine that are available for codespaces created from repositories owned by your organization. This allows you to prevent people using overly resourced machines for their codespaces, and incurring unnecessary charges. Para obtener más información, consulta la sección "[Restringir el acceso a los tipos de máquina](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types)". + +You can also restrict how long a codespace can remain unused before it is automatically deleted. This can help to reduce storage costs for {% data variables.product.prodname_codespaces %}. Para obtener más información, consulta la sección "[Restringir el periodo de retención para codespaces](/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces)". ## Borrar los codespaces sin utilizar @@ -47,6 +51,6 @@ Tus usuarios pueden borrar sus codespaces en https://github.com/codespaces y des {% note %} -**Nota:** Solo la persona que creó un codespace podrá borrarlo. Actualmente no hay forma de que los propietarios de las organizaciones borren los codespaces que se crearon dentro de su organización. +**Note:** Codespaces are automatically deleted after they have been stopped and have remained inactive for a defined number of days. Para obtener más información, consulta la sección "[Restringir el periodo de retención para codespaces](/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces)". A codespace can only be manually deleted by the person who created the codespace. {% endnote %} diff --git a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md index 25cc68e82c..e64a1eeb9b 100644 --- a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md +++ b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md @@ -20,7 +20,7 @@ redirect_from: {% warning %} -**Aviso de obsolesencia**: El acceso y ajuste de seguridad que se describen anteriormente ahora son obsoletos y solo se documentan aquí como referencia. Para habilitar un acceso expandido a otros repositorios, agrega los permisos solicitados a tu definición de contenedor dev. Si necesitas más información, consulta la sección "[Administrar el acceso a otros repositorios dentro de tu codespace](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)". +**Aviso de obsolesencia**: El acceso y ajuste de seguridad que se describen anteriormente ahora son obsoletos y solo se documentan aquí como referencia. Para habilitar el acceso expandido a otros repositorios, agrega los permisos solicitados a tu archivo de configuración de `devcontainer.json`. Si necesitas más información, consulta la sección "[Administrar el acceso a otros repositorios dentro de tu codespace](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)". {% endwarning %} diff --git a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md index 44dfc3af19..2995884dcf 100644 --- a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md +++ b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md @@ -43,6 +43,8 @@ Por ejemplo, podrías crear una política en toda la organización, la cual rest Si agregas una política a nivel organizacional, deberías configurarla en la elección de tipos de máquina más grande que deberá estar disponible para cualquier repositorio de tu organización. Entonces podrás agregar las políticas específicas para los repositorios y así restringir aún más la elección. +{% data reusables.codespaces.codespaces-org-policies-note %} + ## Agregar una política para limitar los tipos de máquina disponibles {% data reusables.profile.access_org %} diff --git a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md index 0423976756..bef735a58a 100644 --- a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md +++ b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md @@ -36,10 +36,12 @@ If someone sets the default idle timeout to 90 minutes in their personal setting ### Configurar políticas específicas para los repositorios y a lo largo de la organización -When you create a policy, you choose whether it applies to all repositories in your organization, or only to specified repositories. If you create an organization-wide policy with a timeout constraint, then the timeout constraints in any policies that are targeted at specific repositories must fall within the restriction configured for the entire organization. The shortest timeout period - in an organization-wide policy, a policy targeted at specified repositories, or in someone's personal settings - is applied. +Cuando creas una política, eliges si esta aplica a todos los repositorios de tu organización o solo a algunos específicos. If you create an organization-wide policy with a timeout constraint, then the timeout constraints in any policies that are targeted at specific repositories must fall within the restriction configured for the entire organization. The shortest timeout period - in an organization-wide policy, a policy targeted at specified repositories, or in someone's personal settings - is applied. If you add an organization-wide policy with a timeout constraint, you should set the timeout to the longest acceptable period. You can then add separate policies that set the maximum timeout to a shorter period for specific repositories in your organization. +{% data reusables.codespaces.codespaces-org-policies-note %} + ## Adding a policy to set a maximum idle timeout period {% data reusables.profile.access_org %} @@ -51,7 +53,7 @@ If you add an organization-wide policy with a timeout constraint, you should set 1. Haz clic en {% octicon "pencil" aria-label="The edit icon" %} para editar la restricción. - ![Edit the timeout constraint](/assets/images/help/codespaces/edit-timeout-constraint.png) + ![Editar la restricción de tiempo de espera](/assets/images/help/codespaces/edit-timeout-constraint.png) 1. Enter the maximum number of minutes codespaces can remain inactive before they time out, then click **Save**. @@ -65,9 +67,9 @@ The policy will be applied to all new codespaces that are created, and to existi ## Editar una política -You can edit an existing policy. Por ejemplo, puede que quieras agregar o eliminar restricciones hacia o desde una política. +Puedes editar una política existente. Por ejemplo, puede que quieras agregar o eliminar restricciones hacia o desde una política. -1. Muestra la página de "Políticas del Codespace". For more information, see "[Adding a policy to set a maximum idle timeout period](#adding-a-policy-to-set-a-maximum-idle-timeout-period)." +1. Muestra la página de "Políticas del Codespace". Para obtener más información, consulta la sección "[Agregar una política para configurar un periodo de tiempo de inactividad máximo](#adding-a-policy-to-set-a-maximum-idle-timeout-period)". 1. Haz clic en el nombre de la política que quieres editar. 1. Haz los cambios requeridos y luego haz clic en **Guardar**. diff --git a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md index 9cea136f11..9ba1e7cc4a 100644 --- a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md +++ b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md @@ -16,9 +16,9 @@ topics: {% data variables.product.prodname_codespaces %} are automatically deleted after they have been stopped and have remained inactive for a defined number of days. The retention period for each codespace is set when the codespace is created and does not change. -Everyone who has access to {% data variables.product.prodname_github_codespaces %} can configure a retention period for the codespaces they create. The initial setting for this default retention period is 30 days. Individual users can set this period within the range 0-30 days. For more information, see "[Configuring automatic deletion of your codespaces](/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces)." +Everyone who has access to {% data variables.product.prodname_github_codespaces %} can configure a retention period for the codespaces they create. The initial setting for this default retention period is 30 days. Individual users can set this period within the range 0-30 days. Para obtener más información, consulta la sección "[Configurar el borrado automático de tus codespaces](/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces)". -As an organization owner, you may want to configure constraints on the maximum retention period for codespaces created for the repositories owned by your organization. This can help you to limit the storage costs associated with codespaces that are stopped and then left unused until they are automatically deleted. For more information about storage charges, see "[About billing for {% data variables.product.prodname_github_codespaces %}](/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#codespaces-pricing)." You can set a maximum retention period for all, or for specific, repositories owned by your organization. +As an organization owner, you may want to configure constraints on the maximum retention period for codespaces created for the repositories owned by your organization. This can help you to limit the storage costs associated with codespaces that are stopped and then left unused until they are automatically deleted. Para obtener más información sobre los cargos de almacenamiento, consulta la sección "[Acerca de la facturación para {% data variables.product.prodname_github_codespaces %}](/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#codespaces-pricing)". You can set a maximum retention period for all, or for specific, repositories owned by your organization. ### Configurar políticas específicas para los repositorios y a lo largo de la organización @@ -26,6 +26,8 @@ Cuando creas una política, eliges si esta aplica a todos los repositorios de tu If you add an organization-wide policy with a retention constraint, you should set the retention period to the longest acceptable period. You can then add separate policies that set the maximum retention to a shorter period for specific repositories in your organization. +{% data reusables.codespaces.codespaces-org-policies-note %} + ## Adding a policy to set a maximum codespace retention period {% data reusables.profile.access_org %} @@ -54,7 +56,7 @@ If you add an organization-wide policy with a retention constraint, you should s {% data reusables.codespaces.codespaces-policy-targets %} 1. Si quieres agregar otra restricción a la política, haz clic en **Agregar restricción** y elige otra de ellas. Para obtener información sobre otras restricciones, consulta las secciones "[Restringir el acceso a los tipos de máquina](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types)", "[Restringir la visibilidad de los puertos reenviados](/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports)" y "[Restringir el periodo de inactividad](/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period)". -1. After you've finished adding constraints to your policy, click **Save**. +1. Después de que termines de agregar restricciones a tu política, haz clic en **Guardar**. The policy will be applied to all new codespaces that are created. @@ -64,7 +66,7 @@ Puedes editar una política existente. Por ejemplo, puede que quieras agregar o The retention period constraint is only applied to codespaces when they are created. Editing a policy has no effect on existing codespaces. -1. Muestra la página de "Políticas del Codespace". For more information, see "[Adding a policy to set a maximum codespace retention period](#adding-a-policy-to-set-a-maximum-codespace-retention-period)." +1. Muestra la página de "Políticas del Codespace". Para obtener más información, consulta la sección "[Agregar una política para configurar un periodo de retención máximo de codespaces](#adding-a-policy-to-set-a-maximum-codespace-retention-period)". 1. Haz clic en el nombre de la política que quieres editar. 1. Haz los cambios requeridos y luego haz clic en **Guardar**. diff --git a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md index c3d4d390f1..c44c93e3df 100644 --- a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md +++ b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md @@ -36,6 +36,8 @@ Por ejemplo, podrías crear una política en toda la organización que restrinja Si agregas una política de toda la organización, deberías configurarla para que tenga la opción de visibilidad más indulgente disponible para cualquier repositorio en tu organización. Entonces podrás agregar las políticas específicas para los repositorios y así restringir aún más la elección. +{% data reusables.codespaces.codespaces-org-policies-note %} + ## Agregar una política para limitar las opciones de visibilidad de puerto {% data reusables.profile.access_org %} diff --git a/translations/es-ES/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md b/translations/es-ES/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md index 199a6e4554..689293eaff 100644 --- a/translations/es-ES/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md +++ b/translations/es-ES/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md @@ -132,7 +132,3 @@ When you enable access and security for a repository owned by your personal acco 1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories you own. Repeat for all repositories whose codespaces you want to access other repositories you own. !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) - -## Further reading - -- "[Managing repository access for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces)" diff --git a/translations/es-ES/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md b/translations/es-ES/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md index 16112fefc9..13c69ceb0c 100644 --- a/translations/es-ES/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md +++ b/translations/es-ES/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md @@ -40,43 +40,43 @@ Antes de que configures las precompilaciones para tu proyecto, se debe cumplir c {% note %} - **Note**: Any branches created from a prebuild-enabled base branch will typically also get prebuilds for the same dev container configuration. For example, if you enable prebuilds for a dev container configuration file on the default branch of the repository, branches based on the default branch will, in most cases, also get prebuilds for the same dev container configuration. + **Nota**: Cualquier rama que se cree de una rama base habilitada para precompilaciones habitualmente también obtendrá precompilaciones para la misma configuración de contenedor dev. Por ejemplo, si habilitas precompilaciones para un archivo de configuración de contenedor dev en la rama predeterminada del repositorio, las ramas basadas en la predeterminada también obtendrán precompilaciones para la misma configuración del contenedor dev en la mayoría de los casos. {% endnote %} -1. Optionally, in the **Configuration file** drop-down menu that's displayed, choose the `devcontainer.json` configuration file that you want to use for this prebuild. Para obtener más información, consulta la sección "[Introducción a los contenedores dev](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers#devcontainerjson)." +1. Opcionalmente, en el menú desplegable de **Archivo de configuración** que se muestra, elige el archivo de configuración `devcontainer.json` que quieras utilizar para esta precompilación. Para obtener más información, consulta la sección "[Introducción a los contenedores dev](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers#devcontainerjson)." - ![The configuration file drop-down menu](/assets/images/help/codespaces/prebuilds-choose-configfile.png) + ![El menú desplegable de archivo de configuración](/assets/images/help/codespaces/prebuilds-choose-configfile.png) -1. Choose how you want to automatically trigger updates of the prebuild. +1. Elige cómo quieres activar actualizaciones automáticamente para la precompilación. - * **Cada subida** (el ajuste predeterminado) - Con este ajuste, las configuraciones de precompilación se actualizarán en cada subida que se haga a la rama predeterminada. This will ensure that codespaces generated from a prebuild always contain the latest codespace configuration, including any recently added or updated dependencies. - * **En el cambio de configuración** - Con este ajuste, as configuraciones de precompilación se actualizarán cada que lo hagan los archivos de configuración asociados para cada repositorio y rama en cuestión. This ensures that changes to the dev container configuration files for the repository are used when a codespace is generated from a prebuild. The Actions workflow that updates the prebuild will run less often, so this option will use fewer Actions minutes. Sin embargo, esta opción no garantiza que los cdespaces siempre incluyan dependencias recientemente actualizadas o agregadas, así que estas podrían tener que agregarse o actualizarse manualmente después de que un codespace se haya creado. + * **Cada subida** (el ajuste predeterminado) - Con este ajuste, las configuraciones de precompilación se actualizarán en cada subida que se haga a la rama predeterminada. Esto garantizará que los codespaces que se generen de una precompilación siempre contengan la configuración de codespace más reciente, incluyendo cualquier dependencia que se haya actualizado o agregado recientemente. + * **En el cambio de configuración** - Con este ajuste, as configuraciones de precompilación se actualizarán cada que lo hagan los archivos de configuración asociados para cada repositorio y rama en cuestión. Esto garantiza que los cambios a los archivos de configuración del contenedor dev para el repositorio se utilicen cuando se genera un codespace desde una precompilación. El flujo de trabajo de acciones que actualiza la precompilación se ejecutará con menor frecuencia, así que esta opción utilizará menos minutos de las acciones. Sin embargo, esta opción no garantiza que los cdespaces siempre incluyan dependencias recientemente actualizadas o agregadas, así que estas podrían tener que agregarse o actualizarse manualmente después de que un codespace se haya creado. * **Programado** - Con este ajuste, puedes hacer que tus configuraciones de precompilación se actualicen en un itinerario personalizado que tú defines. Esto puede reducir el consumo de minutos de acciones, sin embargo, con esta opción, pueden crearse codespaces que no utilicen los últimos cambios de configuración de contenedores dev. ![Las opciones de activación de precompilación](/assets/images/help/codespaces/prebuilds-triggers.png) -1. Optionally, select **Reduce prebuild available to only specific regions** to limit access to your prebuild, then select which regions you want it to be available in. Los desarrolladores solo pueden crear condespaces desde una precompilación si estos se ubican en una región que selecciones. By default, your prebuild is available to all regions where codespaces is available and storage costs apply for each region. +1. Opcionalmente, selecciona **reducir la precompilación disponible para solo las regiones específicas** para limitar el acceso a tu precompilación y luego selecciona en qué regiones quieres que esté disponible. Los desarrolladores solo pueden crear condespaces desde una precompilación si estos se ubican en una región que selecciones. Predeterminadamente, tu precompilación está disponible para todas las regiones en donde los codespaces estén disponibles y los costos de almacenamiento aplican para cada región. ![Las opciones de selección de región](/assets/images/help/codespaces/prebuilds-regions.png) {% note %} **Notas**: - * The prebuild for each region will incur individual charges. Por lo tanto, solo deberías habilitar las precompilaciones para las regiones en las que sabes que se utilizarán. Para obtener más información, consulta la sección "[Acerca de las precompilaciones de {% data variables.product.prodname_github_codespaces %}](/codespaces/prebuilding-your-codespaces/about-github-codespaces-prebuilds#about-billing-for-codespaces-prebuilds)". + * La precompilación para cada región incurrirá en cargos individuales. Por lo tanto, solo deberías habilitar las precompilaciones para las regiones en las que sabes que se utilizarán. Para obtener más información, consulta la sección "[Acerca de las precompilaciones de {% data variables.product.prodname_github_codespaces %}](/codespaces/prebuilding-your-codespaces/about-github-codespaces-prebuilds#about-billing-for-codespaces-prebuilds)". * Los desarrolladores pueden configurar su región predeterminada para {% data variables.product.prodname_codespaces %}, lo que te puede permitir habilitar las precompilaciones para menos regiones. Para obtener más información, consulta la sección "[Configurar tu región predeterminada para {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces)". {% endnote %} -1. Optionally, set the number of prebuild versions to be retained. Puedes ingresar cualquier número entre 1 y 5. La cantidad predeterminada de versiones guardadas es de 2, lo que significa que solo la versión de plantilla más reciente y la versión previa se guardan. +1. Opcionalmente, establezca el número de versiones de precompilación que se deban retener. Puedes ingresar cualquier número entre 1 y 5. La cantidad predeterminada de versiones guardadas es de 2, lo que significa que solo la versión de plantilla más reciente y la versión previa se guardan. - Depending on your prebuild trigger settings, your prebuild could change with each push or on each dev container configuration change. Retaining older versions of prebuilds enables you to create a prebuild from an older commit with a different dev container configuration than the current prebuild. Since there is a storage cost associated with retaining prebuild versions, you can choose the number of versions to be retained based on the needs of your team. Para obtener más información sobre la facturación, consulta la sección "[Acerca de la facturación para los {% data variables.product.prodname_github_codespaces %}](/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#codespaces-pricing)". + Dependiendo de los ajustes de activación de la precompilación, esta podría cambiar con cada subida o en cada cambio de configuración de contenedor dev. El retener versiones anteriores de precompilaciones te permite crear una precompilación desde una confirmación más antigua con una configuración de contenedor dev diferente que la de la precompilación actual. Ya que existe un costo de almacenamiento asociado con la retención de versiones de precompilación, puedes elegir la cantidad de versiones a retener con base en las necesidades de tu equipo. Para obtener más información sobre la facturación, consulta la sección "[Acerca de la facturación para los {% data variables.product.prodname_github_codespaces %}](/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#codespaces-pricing)". - If you set the number of prebuild versions to save to 1, {% data variables.product.prodname_codespaces %} will only save the latest version of the prebuild and will delete the older version each time the template is updated. Esto significa que no obtendrás un codespace precompilado si regresas a una configuración de contenedor dev antigua. + Si configuras la cantidad de versiones de precompilación a guardar en 1, {% data variables.product.prodname_codespaces %} solo guardará la última versión de la precompilación y borrará la versión antigua cada que se actualice la plantilla. Esto significa que no obtendrás un codespace precompilado si regresas a una configuración de contenedor dev antigua. - ![The prebuild history setting](/assets/images/help/codespaces/prebuilds-template-history-setting.png) + ![El ajuste de historial de precompilación](/assets/images/help/codespaces/prebuilds-template-history-setting.png) -1. Optionally, add users or teams to notify when the prebuild workflow run fails for this configuration. Puedes comenzar a escribir un nombre de usuario, de equipo o nombre completo y luego hacer clic en el nombre una vez que aparezca para agregarlos a la lista. Los usuarios o equipos que agregues recibirán un correo electrónico cuando ocurran fallas en la precompilación, los cuales contienen un enlace a las bitácoras de ejecución de flujo de trabajo para ayudar con las investigaciones subsecuentes. +1. Opcionalmente, agrega usuarios o equipos para notificarles cuando una ejecución de flujo de trabajo de precompilación falle para esta configuración. Puedes comenzar a escribir un nombre de usuario, de equipo o nombre completo y luego hacer clic en el nombre una vez que aparezca para agregarlos a la lista. Los usuarios o equipos que agregues recibirán un correo electrónico cuando ocurran fallas en la precompilación, los cuales contienen un enlace a las bitácoras de ejecución de flujo de trabajo para ayudar con las investigaciones subsecuentes. ![El ajuste de notificación de falla de precompilación](/assets/images/help/codespaces/prebuilds-failure-notification-setting.png) @@ -84,27 +84,27 @@ Antes de que configures las precompilaciones para tu proyecto, se debe cumplir c {% data reusables.codespaces.prebuilds-permission-authorization %} -After you create a prebuild configuration it is listed on the {% data variables.product.prodname_codespaces %} page of your repository settings. A {% data variables.product.prodname_actions %} workflow is queued and then run to create prebuilds in the regions you specified, based on the branch and dev container configuration file you selected. +Después crear una configuración de precompilación, esta se lista en la página de {% data variables.product.prodname_codespaces %} de tus ajustes de repositorio. Un flujo de trabajo de {% data variables.product.prodname_actions %} se pone en cola y luego se ejecuta para crear precompilaciones en las regiones que especificaste, con base en la rama y archivo de configuración de contenedor dev que seleccionaste. -![Screenshot of the list of prebuild configurations](/assets/images/help/codespaces/prebuild-configs-list.png) +![Captura de pantalla de la lista de configuraciones de precompilación](/assets/images/help/codespaces/prebuild-configs-list.png) -For information about editing and deleting prebuild configurations, see "[Managing prebuilds](/codespaces/prebuilding-your-codespaces/managing-prebuilds)." +Para obtener más información sobre cómo editar y borrar configuraciones de precompilación, consulta la sección "[Administrar las precompilaciones](/codespaces/prebuilding-your-codespaces/managing-prebuilds)". ## Configurar variables de ambiente Para permitir que el proceso de precompilación acceda a las variables de ambiente que se requieren para crear tu ambiente de desarrollo, puedes configurarlas ya sea como secretos de repositorio de {% data variables.product.prodname_codespaces %} o como secretos de organización de {% data variables.product.prodname_codespaces %}. Para obtener más información, consulta las secciones "[Agregar secretos para un repositorio](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces#adding-secrets-for-a-repository)" y "[Agregar secretos para una organización](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces#adding-secrets-for-an-organization)". -Secrets that you create in this way will be accessible by anyone who creates a codespace from this repository. Si no quieres esto, como alternativa, puedes configurar el secreto `CODESPACES_PREBUILD_TOKEN`. El secreto `CODESPACES_PREBUILD_TOKEN` solo se utiliza para precompilar y no se puede acceder a su valor en los codespaces de los usuarios. +Cualquiera que cree un codespace desde este repositorio podrá acceder a los secretos de que crees de esta forma. Si no quieres esto, como alternativa, puedes configurar el secreto `CODESPACES_PREBUILD_TOKEN`. El secreto `CODESPACES_PREBUILD_TOKEN` solo se utiliza para precompilar y no se puede acceder a su valor en los codespaces de los usuarios. -Prebuilds cannot use any user-level secrets while building your environment, because these are not available until after the codespace has been created. +Las precompilaciones no pueden utilizar secretos a nivel de usuario al compilar tu ambiente nuevo, ya que estos no están disponibles sino hasta después de que se haya creado el codespace. ## Configurar tareas que llevan mucho tiempo para que se incluyan en la precompilación -You can use the `onCreateCommand` and `updateContentCommand` commands in your `devcontainer.json` to include time-consuming processes as part of the prebuild creation. Para obtener más información, consulta la documentación de {% data variables.product.prodname_vscode %} "[referencia de devcontainer.json](https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_lifecycle-scripts)". +Puedes utilizar los comandos `onCreateCommand` y `updateContentCommand` en tu `devcontainer.json` para incluir los procesos que llevan mucho tiempo como parte de la creación de la precompilación. Para obtener más información, consulta la documentación de {% data variables.product.prodname_vscode %} "[referencia de devcontainer.json](https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_lifecycle-scripts)". -`onCreateCommand` is run only once, when the prebuild is created, whereas `updateContentCommand` is run at template creation and at subsequent template updates. Incremental builds should be included in `updateContentCommand` since they represent the source of your project and need to be included for every prebuild update. +`onCreateCommand` solo se ejecuta una vez, cuando se crea la precompilación, mientras que `updateContentCommand` se ejecuta cuando se crea la plantilla y en las actualizaciones de plantilla posteriores. Las compilaciones incrementales deben incluirse en `updateContentCommand`, ya que estas representan el origen de tu proyecto y necesitan incluirse para cada actualización de precompilación. ## Leer más -- "[Allowing a prebuild to access other repositories](/codespaces/prebuilding-your-codespaces/allowing-a-prebuild-to-access-other-repositories)" +- "[Permitir que una precompilación acceda a otros repositorios](/codespaces/prebuilding-your-codespaces/allowing-a-prebuild-to-access-other-repositories)" - "[Solucionar problemas de las compilaciones previas](/codespaces/troubleshooting/troubleshooting-prebuilds)" diff --git a/translations/es-ES/content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md b/translations/es-ES/content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md index 43418c6692..f76eb3e497 100644 --- a/translations/es-ES/content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md +++ b/translations/es-ES/content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md @@ -16,7 +16,7 @@ miniTocMaxHeadingLevel: 3 Las precompilaciones que configures para un repositorio se crean y actualizan utilizando un flujo de trabajo de {% data variables.product.prodname_actions %}, que administra el servicio de {% data variables.product.prodname_github_codespaces %}. -Depending on the settings in a prebuild configuration, the workflow to update the prebuild may be triggered by these events: +Dependiendo de los ajustes en una configuración de precompilación, el flujo de trabajo para actualizar la precompilación podría activarse con estos eventos: * Crear o actualizar la configuración de precompilación * Subir una confirmación o una solicitud de cambios a una rama que está configurada para tener precompilaciones @@ -24,7 +24,7 @@ Depending on the settings in a prebuild configuration, the workflow to update th * Un itinerario que definiste en la configuración de la precompilación * Activar el flujo de trabajo manualmente -The settings in the prebuild configuration determine which events automatically trigger an update of the prebuild. Para obtener más información, consulta la sección "[Configurar las precompilaciones](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-a-prebuild)". +Los ajustes en la configuración de precompilación determinan qué eventos activan automáticamente una actualización de la precompilación. Para obtener más información, consulta la sección "[Configurar las precompilaciones](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-a-prebuild)". Las personas con acceso administrativo a un repositorio pueden verificar el progreso de las precompilaciones, así como editar y borrar las configuraciones de estas. @@ -61,7 +61,7 @@ Esto muestra el historial de ejecución de flujo de trabajo para las precompilac ### Inhabilitar una configuración de precompilación -To pause the update of prebuilds for a configuration, you can disable workflow runs for the configuration. Disabling the workflow runs for a prebuild configuration does not delete any previously created prebuilds for that configuration and, as a result, codespaces will continue to be generated from an existing prebuild. +Para pausar la actualización de las precompilaciones de una configuración, puedes inhabilitar las ejecuciones de flujo de trabajo para dicha configuración. El inhabilitar las ejecuciones de flujo de trabajo para una configuración de precompilación no borra ninguna de estas que se haya creado anteriormente para dicha configuración y, como resultado, los codespaces seguirán generándose desde una precompilación existente. El inhabilitar las ejecuciones de flujos de trabajo para una configuración precompilada es útil si necesitas investigar los fallos en la creación de plantillas. @@ -74,7 +74,7 @@ El inhabilitar las ejecuciones de flujos de trabajo para una configuración prec ### Borrar una configuración de precompilación -Deleting a prebuild configuration also deletes all previously created prebuilds for that configuration. Como resultado, poco después de que borres una configuración, las precompilaciones generadas por dicha configuración ya no estarán disponibles cuando crees un codespace nuevo. +El borrar una configuración de preocmpilación también borrar todas las precompilaciones que se hayan creado previamente para dicha configuración. Como resultado, poco después de que borres una configuración, las precompilaciones generadas por dicha configuración ya no estarán disponibles cuando crees un codespace nuevo. Después de que borras una configuración de precompilación, todavía se ejecutarán las ejecuciones de flujo de trabajo de dicha configuración que se hayan puesto en cola o que hayan iniciado. Se listarán en el historial de ejecución de flujo de trabajo junto con las ejecuciones de flujo de trabajo que se hayan completado previamente. diff --git a/translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md b/translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md index 449d120e5d..937403d0bf 100644 --- a/translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md +++ b/translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md @@ -53,7 +53,7 @@ Para obtener más información sobre cómo elegir tu configuración preferida de Es útil pensar que el archivo `devcontainer.json` sirve para proporcionar "adaptación" en vez de "personalización". Solo debes incluir las cosas que necesiten todos los que trabajan en tus codespaces como elementos estándar del ambiente de desarrollo, no las que son preferencias personales. Las cosas como los limpiadores son buenas para estandarizar y para requerir que todos las tengan instaladas, así que es bueno incluirlas en tu archivo `devcontainer.json`. Las cosas como los decoradores de interfaz de usuario o los temas son elecciones personales que no deberían ponerse en el archivo `devcontainer.json`. -Puedes personalizar tus codespaces utilizando dotfiles y la sincronización de ajustes. For more information, see "[Personalizing {% data variables.product.prodname_github_codespaces %} for your account](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account)." +Puedes personalizar tus codespaces utilizando dotfiles y la sincronización de ajustes. Para obtener más información, consulta la sección "[Personalizar {% data variables.product.prodname_github_codespaces %} para tu cuenta](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account)". ### Dockerfile @@ -114,7 +114,7 @@ Para obtener más información sobre cómo utilizar un Dockerfile en una configu ## Utilizar la configuración de contenedor dev predeterminada -Si no defines una configuración en tu repositorio, {% data variables.product.prodname_dotcom %} creará un codespace utilizando una imagen de Linux predeterminada. This Linux image includes a number of runtime versions for popular languages like Python, Node, PHP, Java, Go, C++, Ruby, and .NET Core/C#. The latest or LTS releases of these languages are used. There are also tools to support data science and machine learning, such as JupyterLab and Conda. The image also includes other developer tools and utilities like Git, GitHub CLI, yarn, openssh, and vim. Para ver todos los lenguajes, tiempos de ejecución y herramientas que se incluyen, utiliza el comando `devcontainer-info content-url` dentro de tu terminal del codespace y sigue la URL que este produce. +Si no defines una configuración en tu repositorio, {% data variables.product.prodname_dotcom %} creará un codespace utilizando una imagen de Linux predeterminada. La imagen de Linux incluye varias versiones de tiempo de ejecución para los lenguajes populares como Python, Node, PHP, Java, Go, C++ y .NET Core/C#. Se utilizan los lanzamientos más recientes o de LTS de estos lenguajes. También existen herramientas para apoyar la ciencia de datos y el aprendizaje automático, tal como JupyterLab y Conda. La imagen también incluye otras herramientas y utilidades de desarrollador como Git, el CLI de GitHub, yarn, openssh y vim. Para ver todos los lenguajes, tiempos de ejecución y herramientas que se incluyen, utiliza el comando `devcontainer-info content-url` dentro de tu terminal del codespace y sigue la URL que este produce. Como alternativa, para obtener más información sobre todo lo que incluye la imagen predeterminada de Linux, consulta el archivo más reciente del repositorio [`microsoft/vscode-dev-containers`](https://github.com/microsoft/vscode-dev-containers/tree/main/containers/codespaces-linux). @@ -161,7 +161,7 @@ Puedes agregar algunas de las características más comunes seleccionándolas cu 1. Actualiza tus selecciones de características y luego haz clic en **OK**. - ![The select additional features menu during container configuration](/assets/images/help/codespaces/select-additional-features.png) + ![El menú para seleccionar características adicionales durante la configuración del contenedor](/assets/images/help/codespaces/select-additional-features.png) 1. Para aplicar los cambios, en la esquina inferior derecha de la pantalla, haz clic en **Reconstruir ahora**. Para obtener más información sobre cómo reconstruir tu contenedor, consulta la sección "[Aplicar los cambios a tu configuración](#applying-configuration-changes-to-a-codespace)". @@ -182,41 +182,41 @@ Si ninguna de las configuraciones predefinidas satisface tus necesidades, puedes Si se encuentran archivos `devcontainer.json` múltiples en el repositorio, estos se listarán en la página de opciones de creación de codespaces. Para obtener más información, consulta la sección "[Crear un codespace](/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace)". - ![A choice of configuration files](/assets/images/help/codespaces/configuration-file-choice.png) + ![Una elección de archivos de configuración](/assets/images/help/codespaces/configuration-file-choice.png) ### Selección de configuración predeterminada durante la creación de codespaces Si existe el archivo `.devcontainer/devcontainer.json` o `.devcontainer.json`, este será la selección predeterminada en la lista de archivos de configuración disponibles cuando crees un codespace. Si no existe ninguno de ellos, se seleccionará la configuración de contenedor dev predefinida. -![The default configuration choice selected](/assets/images/help/codespaces/configuration-file-choice-default.png) +![La elección de configuración predeterminada seleccionada](/assets/images/help/codespaces/configuration-file-choice-default.png) ### Editar el archivo devcontainer.json -You can add and edit the supported configuration keys in the `devcontainer.json` file to specify aspects of the codespace's environment, like which {% data variables.product.prodname_vscode_shortname %} extensions will be installed. {% data reusables.codespaces.more-info-devcontainer %} +Puedes agregar y editar las llaves de configuración compatibles en el archivo `devcontainer.json` para especificar los aspectos del ambiente del codespace, como qué extensiones de {% data variables.product.prodname_vscode_shortname %} se instalarán. {% data reusables.codespaces.more-info-devcontainer %} -El archivo de `devcontainer.json` se escribe utilizando el formato JSONC. Esto te permite incluir comentarios dentro del archivo de configuración. For more information, see "[Editing JSON with {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/docs/languages/json#_json-with-comments)" in the {% data variables.product.prodname_vscode_shortname %} documentation. +El archivo de `devcontainer.json` se escribe utilizando el formato JSONC. Esto te permite incluir comentarios dentro del archivo de configuración. Para obtener más información, consulta la sección "[Editar JSON con {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/docs/languages/json#_json-with-comments)" en la documentación de {% data variables.product.prodname_vscode_shortname %}. {% note %} -**Note**: If you use a linter to validate the `devcontainer.json` file, make sure it is set to JSONC and not JSON or comments will be reported as errors. +**Nota**: Si utilizas un limpiador de código para validar el archivo `devcontainer.json`, asegúrate de que esté configurado en JSONC y no en JSON, de lo contrario, los comentarios se reportarán como errores. {% endnote %} -### Editor settings for {% data variables.product.prodname_vscode_shortname %} +### Ajustes de editor para {% data variables.product.prodname_vscode_shortname %} {% data reusables.codespaces.vscode-settings-order %} -You can define default editor settings for {% data variables.product.prodname_vscode_shortname %} in two places. +Puedes definir los ajustes de editor para {% data variables.product.prodname_vscode_shortname %} en dos lugares. -* Editor settings defined in the `.vscode/settings.json` file in your repository are applied as _Workspace_-scoped settings in the codespace. -* Editor settings defined in the `settings` key in the `devcontainer.json` file are applied as _Remote [Codespaces]_-scoped settings in the codespace. +* Los ajustes de editor que se definen en el archivo `.vscode/settings.json` de tu repositorio se aplican como ajustes con alcance de _Workspace_ en el codespace. +* Los ajustes de editor que se definen en la clave `settings` en el archivo `devcontainer.json` están aplicados como ajustes con alcance de _Remote [Codespaces]_ en el codespace. -## Applying configuration changes to a codespace +## Aplicar los cambios de configuración a un codespace {% data reusables.codespaces.apply-devcontainer-changes %} {% data reusables.codespaces.rebuild-command %} -1. {% data reusables.codespaces.recovery-mode %} Fix the errors in the configuration. +1. {% data reusables.codespaces.recovery-mode %} Corrige los errores en la configuración. ![Mensaje de error sobre el modo de recuperación](/assets/images/help/codespaces/recovery-mode-error-message.png) diff --git a/translations/es-ES/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md b/translations/es-ES/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md index 032e738980..20e456106e 100644 --- a/translations/es-ES/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md +++ b/translations/es-ES/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md @@ -31,6 +31,7 @@ El nombre del codespace también se incluye en muchos otros archivos de bitácor Cada codespace también tiene un ID (identificador). Este no se muestra predeterminadamente en {% data variables.product.prodname_vscode %}, así que podrías tener que actualizar los ajustes para la extensión de {% data variables.product.prodname_github_codespaces %} antes de que puedas acceder a la ID. 1. En {% data variables.product.prodname_vscode %}, ya sea la versión de buscador o de escritorio, en la barra de actividad a la izquierda, haz clic en **Explorador remoto** para que se muestren los detalles del codespace. -2. Si la barra lateral incluye una sección de "Rendimiento del Codespace", pasa el puntero del mouse sobre "ID del Codespace" y haz clic en el icono de portapapeles para copiar la ID. -3. Si no se muestra la información, haz clic en {% octicon "gear" aria-label="The gear icon" %} en la esquina inferior izquierda de la barra de actividad para mostrar la pestaña de "Ajustes". -4. Expande las **Extensiones** y haz clic en **{% data variables.product.prodname_github_codespaces %}** para mostrar los ajustes de la extensión. Entonces, habilita el **Explorador para mostrar el rendmiento** para mostrar la sección de "Rendimiento del Codespace" en la barra lateral. ![ID y ajustes del codespace requeridos para mostrar la información de rendimiento](/assets/images/help/codespaces/find-codespace-id.png) +{% indented_data_reference reusables.codespaces.remote-explorer spaces=3 %} +1. Si la barra lateral incluye una sección de "Rendimiento del Codespace", pasa el puntero del mouse sobre "ID del Codespace" y haz clic en el icono de portapapeles para copiar la ID. +1. Si no se muestra la información, haz clic en {% octicon "gear" aria-label="The gear icon" %} en la esquina inferior izquierda de la barra de actividad para mostrar la pestaña de "Ajustes". +1. Expande las **Extensiones** y haz clic en **{% data variables.product.prodname_github_codespaces %}** para mostrar los ajustes de la extensión. Entonces, habilita el **Explorador para mostrar el rendmiento** para mostrar la sección de "Rendimiento del Codespace" en la barra lateral. ![ID y ajustes del codespace requeridos para mostrar la información de rendimiento](/assets/images/help/codespaces/find-codespace-id.png) diff --git a/translations/es-ES/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md b/translations/es-ES/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md index 56b67bd32b..694a347d89 100644 --- a/translations/es-ES/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md +++ b/translations/es-ES/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md @@ -539,7 +539,7 @@ En los errores con `body` se utilizará el prefijo `body[i]`, en donde `i` repre ### Ejemplo -``` +```yaml body: - type: dropdown attributes: @@ -552,7 +552,7 @@ body: El error puede corregirse si garantizas que no habrán elecciones duplicadas en el arreglo `options`. -``` +```yaml body: - type: dropdown attributes: @@ -570,7 +570,7 @@ En los errores con `body` se utilizará el prefijo `body[i]`, en donde `i` repre ### Ejemplo -``` +```yaml body: - type: dropdown attributes: @@ -585,7 +585,7 @@ body: El error puede corregirse si se elimina "None" de las opciones. Si quieres que un contribuyente pueda indicar que no le parece ninguno de esos tipos de tarta, puedes eliminar adicionalmente la validación `required`. -``` +```yaml body: - type: dropdown attributes: @@ -605,7 +605,7 @@ En los errores con `body` se utilizará el prefijo `body[i]`, en donde `i` repre ### Ejemplo -``` +```yaml body: - type: dropdown attributes: @@ -618,7 +618,7 @@ body: El error puede corregirse si pones cada opción infractora entre comillas, para prevenir que se procesen como valores booleanos. -``` +```yaml body: - type: dropdown attributes: @@ -629,6 +629,36 @@ body: - Maybe ``` +## Body cannot be empty + +The template body `key:value` pair can not be empty. For more information about which top-level keys are required, see "[Syntax for issue forms](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax)." + +El error se puede corregir agregando la sección `body:`. + +### Ejemplo + +```yaml +name: Support Request +description: Something went wrong and you need help? +--- +body: +- type: textarea + attributes: + label: "What's wrong?" +``` + +En este ejemplo, el error se puede corregir borrando el `---` (separador de documentos) entre los encabezados y la sección `body`. + +```yaml +name: Support Request +description: Something went wrong and you need help? + +body: +- type: textarea + attributes: + label: "What's wrong?" +``` + ## Leer más - [YAML](https://yaml.org/) diff --git a/translations/es-ES/content/copilot/overview-of-github-copilot/about-github-copilot.md b/translations/es-ES/content/copilot/overview-of-github-copilot/about-github-copilot.md index 3e905ad422..d91817fa96 100644 --- a/translations/es-ES/content/copilot/overview-of-github-copilot/about-github-copilot.md +++ b/translations/es-ES/content/copilot/overview-of-github-copilot/about-github-copilot.md @@ -22,7 +22,7 @@ You can see real-world examples of {% data variables.product.prodname_copilot %} GitHub Copilot offers suggestions from a model that OpenAI built from billions of lines of open source code. As a result, the training set for {% data variables.product.prodname_copilot %} may contain insecure coding patterns, bugs, or references to outdated APIs or idioms. When {% data variables.product.prodname_copilot %} produces suggestions based on this training data, those suggestions may also contain undesirable patterns. -You are responsible for ensuring the security and quality of your code. We recommend you take the same precautions when using code generated by {% data variables.product.prodname_copilot %} that you would when using any code you didn't write yourself. These precautions include rigorous testing, IP scanning, and tracking for security vulnerabilities. {% data variables.product.company_short %} provides a number of features to help you monitor and improve code quality, such as {% data variables.product.prodname_actions %}, {% data variables.product.prodname_dependabot %}, {% data variables.product.prodname_codeql %} and {% data variables.product.prodname_code_scanning %}. All these features are free to use in public repositories. For more information, see "[Understanding {% data variables.product.prodname_actions %}](/actions/learn-github-actions/understanding-github-actions)" and "[{% data variables.product.company_short %} security features](/code-security/getting-started/github-security-features)." +You are responsible for ensuring the security and quality of your code. We recommend you take the same precautions when using code generated by {% data variables.product.prodname_copilot %} that you would when using any code you didn't write yourself. These precautions include rigorous testing, IP scanning, and tracking for security vulnerabilities. {% data variables.product.company_short %} proporciona varias características para ayudarte a monitorear y mejorar la calidad del código, tales como las {% data variables.product.prodname_actions %}, el {% data variables.product.prodname_dependabot %}, {% data variables.product.prodname_codeql %} y el {% data variables.product.prodname_code_scanning %}. All these features are free to use in public repositories. For more information, see "[Understanding {% data variables.product.prodname_actions %}](/actions/learn-github-actions/understanding-github-actions)" and "[{% data variables.product.company_short %} security features](/code-security/getting-started/github-security-features)." {% data variables.product.prodname_copilot %} uses filters to block offensive words in the prompts and avoid producing suggestions in sensitive contexts. We are committed to constantly improving the filter system to more intelligently detect and remove offensive suggestions generated by {% data variables.product.prodname_copilot %}, including biased, discriminatory, or abusive outputs. If you see an offensive suggestion generated by {% data variables.product.prodname_copilot %}, please report the suggestion directly to copilot-safety@github.com so that we can improve our safeguards. diff --git a/translations/es-ES/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop.md b/translations/es-ES/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop.md index c143eadd38..eceb516fc6 100644 --- a/translations/es-ES/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop.md +++ b/translations/es-ES/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop.md @@ -10,7 +10,7 @@ versions: {% data variables.product.prodname_desktop %} displays the status of checks that have run in your pull request branches. The checks badge next to the branch name will display the *pending, passing,* or *failing* state of the checks. You can also re-run all, failed, or individual checks when viewing the status of the checks in {% data variables.product.prodname_desktop %}. For more information on setting up checks in your repository, see "[About status checks](/github/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." -{% data variables.product.prodname_desktop %} will also show a system notification when checks fail. For more information on enabling notifications, see "[Configuring notifications in GitHub Desktop](/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/configuring-notifications-in-github-desktop)." +{% data variables.product.prodname_desktop %} will also show a system notification when checks fail. Para obtener más información sobre cómo habilitar las notificaciones, consulta la sección "[Configurar las notificaciones en GitHub Desktop](/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/configuring-notifications-in-github-desktop)". ## Ver y volver a ejecutar las verificaciones diff --git a/translations/es-ES/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md b/translations/es-ES/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md index 829fd77ed8..ea9fca1b45 100644 --- a/translations/es-ES/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md +++ b/translations/es-ES/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md @@ -23,6 +23,8 @@ Cuando una organización tiene una lista de direcciones permitidas, se negará e ## Agrega una lista de direcciones IP permitidas a una {% data variables.product.prodname_github_app %} +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.apps.settings-step %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} diff --git a/translations/es-ES/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md b/translations/es-ES/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md index badb34d08c..b367c46466 100644 --- a/translations/es-ES/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md +++ b/translations/es-ES/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md @@ -47,7 +47,7 @@ Las {% data variables.product.prodname_github_apps %} que hagan solicitudes de s {% ifversion fpt or ghec %} -Las {% data variables.product.prodname_github_apps %} que se instalan en una organización o repositrio dentro de una empresa en {% data variables.product.product_location %} están sujetas a un límite de 15,000 solicitudes por hora. +{% data variables.product.prodname_github_apps %} that are installed on an organization within an enterprise on {% data variables.product.product_location %} are subject to a limit of 15,000 requests per hour per organization that has installed the app. {% endif %} diff --git a/translations/es-ES/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md b/translations/es-ES/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md index 866da1b7b6..f7b42c35d6 100644 --- a/translations/es-ES/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/translations/es-ES/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -77,11 +77,11 @@ X-Accepted-OAuth-Scopes: user |  `write:gpg_key` | Crea, lista, y visualiza los detalles de las llaves GPG. | |  `read:gpg_key` | Lista y visualiza los detalles de las llaves GPG.{% ifversion fpt or ghec %} | **`codespace`** | Otorga la capacidad de crear y administrar codespaces. Los codespaces pueden exponer un GITHUB_TOKEN que puede tener un conjunto de alcances diferente. Para obtener más información, consulta la sección "[Seguridad en {% data variables.product.prodname_github_codespaces %}](/codespaces/codespaces-reference/security-in-github-codespaces#authentication)".{% endif %} -| **`flujo de trabajo`** | Otorga la capacidad de agregar y actualizar archivos del flujo de trabajo de las {% data variables.product.prodname_actions %}. Los archivos de flujo de trabajo pueden confirmarse sin este alcance en caso de que el mismo archivo (con la misma ruta y el mismo contenido) exista en otra rama en el mismo repositorio. Los archivos de flujo de trabajo pueden exponer al `GITHUB_TOKEN`, el cual puede tener un conjunto diferente de alcances. For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)."{% ifversion not fpt %} -| **`admin:enterprise`** | Gives full control of enterprise functionality. For more information, see "[Managing enterprise accounts](/graphql/guides/managing-enterprise-accounts)" in the GraphQL API documentation.

    Includes `manage_runners:enterprise`{% ifversion ghec or ghes > 3.3 %}, `manage_billing:enterprise`,{% endif %} and `read:enterprise`. | -|  `manage_runners:enterprise` | Gives full control over self-hosted runners within the enterprise. Para obtener más información, consulta "[Acerca de los ejecutores autoalojados](/actions/hosting-your-own-runners/about-self-hosted-runners)." {% ifversion ghec or ghes > 3.3 %} -|  `manage_billing:enterprise` | Read and write enterprise billing data. For more information, see "[Billing](/rest/billing)" in the REST API documentation. {% endif %} -|  `read:enterprise` | Read all data on an enterprise profile. Does not include profile data of enterprise members or organizations.{% endif %} +| **`flujo de trabajo`** | Otorga la capacidad de agregar y actualizar archivos del flujo de trabajo de las {% data variables.product.prodname_actions %}. Los archivos de flujo de trabajo pueden confirmarse sin este alcance en caso de que el mismo archivo (con la misma ruta y el mismo contenido) exista en otra rama en el mismo repositorio. Los archivos de flujo de trabajo pueden exponer al `GITHUB_TOKEN`, el cual puede tener un conjunto diferente de alcances. Para obtener más información, consulta la sección "[Autenticación en un flujo de trabajo](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)".{% ifversion not fpt %} +| **`admin:enterprise`** | Proporciona control total de la funcionalidad empresarial. Para obtener más información, consulta la sección "[Administrar cuentas empresariales](/graphql/guides/managing-enterprise-accounts)" en la documentación de la API de GraphQL.

    Incluye a `manage_runners:enterprise`{% ifversion ghec or ghes > 3.3 %}, `manage_billing:enterprise`{% endif %} y `read:enterprise`. | +|  `manage_runners:enterprise` | Proporciona control total sobre los ejecutores auto-hospedados dentro de la empresa. Para obtener más información, consulta "[Acerca de los ejecutores autoalojados](/actions/hosting-your-own-runners/about-self-hosted-runners)." {% ifversion ghec or ghes > 3.3 %} +|  `manage_billing:enterprise` | Lee y escribe los datos de facturación de la empresa. Para obtener más información, consulta la sección "[Facturación](/rest/billing)" en la documentación de la API de REST. {% endif %} +|  `read:enterprise` | Lee todos los datos en el perfile de una empresa. No incluye datos de perfil de miembros de la empresa o de organizaciones.{% endif %} {% note %} **Nota:** Tu App de OAuth puede solicitar los alcances en la redirección inicial. Puedes especificar alcances múltiples si los separas con un espacio utilizando `%20`: diff --git a/translations/es-ES/content/developers/index.md b/translations/es-ES/content/developers/index.md index 7d4aaf78a1..a06888d9fa 100644 --- a/translations/es-ES/content/developers/index.md +++ b/translations/es-ES/content/developers/index.md @@ -1,6 +1,29 @@ --- title: Desarrolladores -intro: 'Saca más provecho de {% data variables.product.prodname_dotcom %} integrándote con nuestras API, personalizando tu flujo de trabajo de {% data variables.product.prodname_dotcom %}, y creando y compartiendo apps con la comunidad.' +intro: 'Saca más provecho con {% data variables.product.prodname_dotcom %} integrándote con nuestras API y webhooks, personalizando tu flujo de trabajo de {% data variables.product.prodname_dotcom %} y creando y compartiendo apps con la comunidad.' +introLinks: + About apps: /developers/apps/getting-started-with-apps/about-apps +layout: product-landing +featuredLinks: + guides: + - /developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps + - /developers/apps/building-github-apps/creating-a-github-app + - /developers/apps/building-github-apps/authenticating-with-github-apps + - /developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps + popular: + - /developers/webhooks-and-events/webhooks/webhook-events-and-payloads + - /developers/apps/building-github-apps/creating-a-github-app + - /developers/apps/building-github-apps/authenticating-with-github-apps + - /developers/webhooks-and-events/webhooks/about-webhooks + - /developers/apps/building-oauth-apps/creating-an-oauth-app + - /developers/apps/building-oauth-apps/authorizing-oauth-apps + - /developers/github-marketplace/github-marketplace-overview/about-github-marketplace + guideCards: + - /developers/webhooks-and-events/webhooks/creating-webhooks + - /developers/apps/guides/using-the-github-api-in-your-app + - /developers/apps/guides/creating-ci-tests-with-the-checks-api +changelog: + label: apps versions: fpt: '*' ghes: '*' diff --git a/translations/es-ES/content/developers/overview/about-githubs-apis.md b/translations/es-ES/content/developers/overview/about-githubs-apis.md index 7bf834d9c7..7393f32fea 100644 --- a/translations/es-ES/content/developers/overview/about-githubs-apis.md +++ b/translations/es-ES/content/developers/overview/about-githubs-apis.md @@ -15,17 +15,3 @@ topics: --- Hay dos versiones estables de la API de GitHub: la [API de REST](/rest) y la [API de GraphQL](/graphql). - -## Versiones obsoletas - -### beta - -Se hizo obsoleta la API beta el 22 de abril de 2014. - -### v2 - -Eliminamos el soporte para la API v2 en el 12 de junio de 2012. - -### v1 - -Eliminamos el soporte para la API v1 en el 12 de junio de 2012. diff --git a/translations/es-ES/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md b/translations/es-ES/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md index 53b6f12b04..d9452630a0 100644 --- a/translations/es-ES/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md +++ b/translations/es-ES/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md @@ -37,12 +37,12 @@ $ export SECRET_TOKEN=your_token ## Validar cargas útiles de GitHub -Cuando se configura tu token secreto, {% data variables.product.product_name %} lo utiliza para crear una firma de hash con cada carga útil. Esta firma de hash se incluye con los encabezados de cada solicitud como `X-Hub-Signature-256`. +Cuando se configura tu token secreto, {% data variables.product.product_name %} lo utiliza para crear una firma de hash con cada carga útil. This hash signature is included with the headers of each request as `x-hub-signature-256`. {% ifversion fpt or ghes or ghec %} {% note %} -**Nota:** Para tener compatibilidad en versiones anteriores, también incluimos el encabezado `X-Hub-Signature` que se genera utilizando la función de hash SHA-1. De ser posible, te recomendamos que utilices el encabezado de `X-Hub-Signature-256` para mejorar la seguridad. El ejemplo siguiente demuestra cómo utilizar el encabezado `X-Hub-Signature-256`. +**Note:** For backward-compatibility, we also include the `x-hub-signature` header that is generated using the SHA-1 hash function. If possible, we recommend that you use the `x-hub-signature-256` header for improved security. The example below demonstrates using the `x-hub-signature-256` header. {% endnote %} {% endif %} diff --git a/translations/es-ES/content/education/contribute-with-github-community-exchange/getting-started-with-github-community-exchange.md b/translations/es-ES/content/education/contribute-with-github-community-exchange/getting-started-with-github-community-exchange.md index 96cd5b3478..da0d92b40a 100644 --- a/translations/es-ES/content/education/contribute-with-github-community-exchange/getting-started-with-github-community-exchange.md +++ b/translations/es-ES/content/education/contribute-with-github-community-exchange/getting-started-with-github-community-exchange.md @@ -10,7 +10,7 @@ versions: {% data reusables.education.about-github-community-exchange-intro %} {% data variables.product.prodname_community_exchange %} can help you make your first open source contribution or grow your own open source project. -For more information about how {% data variables.product.prodname_community_exchange %} can help you as a student, see "[About {% data variables.product.prodname_community_exchange %}](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/about-github-community-exchange)." +Para obtener más información sobre cómo {% data variables.product.prodname_community_exchange %} puede ayudarte como alumno, consulta la sección "[Acerca de {% data variables.product.prodname_community_exchange %}](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/about-github-community-exchange)". ## Accessing {% data variables.product.prodname_community_exchange %} @@ -38,7 +38,7 @@ To star a repository: Go to your {% data variables.product.prodname_community_ex The {% data variables.product.prodname_community_exchange %} community moderates repository submissions. You can report abusive repositories, spammy, or disruptive content at any time. -To report an abusive repository: Go to your {% data variables.product.prodname_community_exchange %} home page, find the repository you want to report, click the {% octicon "kebab-horizontal" aria-label="The edit icon" %} drop-down right by its name, then click {% octicon "report" aria-label="The report symbol" %} **Report abuse**. +Para reportar un repositorio ofensivo: Dirígete a tu página principal de {% data variables.product.prodname_community_exchange %}, encuentra el repositorio que quieras reportar, haz clic en el menú desplegable de {% octicon "kebab-horizontal" aria-label="The edit icon" %} justo en su nombre y luego haz clic en {% octicon "report" aria-label="The report symbol" %} **Reportar abuso**. ## Leer más diff --git a/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students.md b/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students.md index 2021ebcd36..4633256b83 100644 --- a/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students.md +++ b/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students.md @@ -14,11 +14,11 @@ shortTitle: Para alumnos Usar {% data variables.product.prodname_dotcom %} para tus proyectos escolares es un modo práctico de colaborar con otros y crear un portfolio que exhiba experiencia práctica. -Cualquiera con una cuenta de {% data variables.product.prodname_dotcom %} puede colaborar en repositorios públicos y privados ilimitados con {% data variables.product.prodname_free_user %}. As a student, you can also apply for {% data variables.product.prodname_education %} student benefits. Your {% data variables.product.prodname_education %} student benefits and resources are all included in {% data variables.product.prodname_global_campus %}, a portal that allows you to access your education benefits, all in one place. For more information, see "[Apply to GitHub Global Campus as a student](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student)" and [{% data variables.product.prodname_education %}](https://education.github.com/). +Cualquiera con una cuenta de {% data variables.product.prodname_dotcom %} puede colaborar en repositorios públicos y privados ilimitados con {% data variables.product.prodname_free_user %}. As a student, you can also apply for {% data variables.product.prodname_education %} student benefits. Your {% data variables.product.prodname_education %} student benefits and resources are all included in {% data variables.product.prodname_global_campus %}, a portal that allows you to access your education benefits, all in one place. Para obtener más información, consulta las secciones "[Solicitar entrar a GitHub Global Campus como alumno](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student)" y [{% data variables.product.prodname_education %}](https://education.github.com/). Before applying for Global Campus, check if your learning community is already partnered with us as a {% data variables.product.prodname_campus_program %} school. Para obtener más información, consulta la sección "[Acerca de la {% data variables.product.prodname_campus_program %}](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/about-github-campus-program)". -If you're a member of a school club, a teacher can apply for {% data variables.product.prodname_global_campus %} so your team can collaborate using {% data variables.product.prodname_team %}, which allows unlimited users and private repositories, for free. For more information, see "[Apply to {% data variables.product.prodname_global_campus %} as a teacher](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)." +If you're a member of a school club, a teacher can apply for {% data variables.product.prodname_global_campus %} so your team can collaborate using {% data variables.product.prodname_team %}, which allows unlimited users and private repositories, for free. Para obtener más información, consulta la sección "[Solicitar ingresar al {% data variables.product.prodname_global_campus %} como docente](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)". Once you are a verified {% data variables.product.prodname_global_campus %} student, you can access {% data variables.product.prodname_global_campus %} anytime by going to the [{% data variables.product.prodname_education %} website](https://education.github.com). diff --git a/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student.md b/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student.md index 067bb88907..1bffa421f5 100644 --- a/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student.md +++ b/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student.md @@ -32,7 +32,7 @@ Es posible que se te pida periódicamente que vuelvas a verificar tu estado acad {% endnote %} -For information about renewing your {% data variables.product.prodname_global_campus %} access, see "[Expiration and renewals](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student/#expiration-and-renewals)." +Para obtener información sobre cómo renovar tu acceso al {% data variables.product.prodname_global_campus %}, consulta la sección "[Vencimiento y renovaciones](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student/#expiration-and-renewals)". ## Applying to {% data variables.product.prodname_global_campus %} diff --git a/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/about-github-global-campus-for-teachers.md b/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/about-github-global-campus-for-teachers.md index 29c16366bd..1e920fcaa4 100644 --- a/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/about-github-global-campus-for-teachers.md +++ b/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/about-github-global-campus-for-teachers.md @@ -25,7 +25,7 @@ Antes de solicitar un descuento individual, comprueba si tu comunidad de aprendi {% data variables.product.prodname_global_campus %} is a portal from which you can access your {% data variables.product.prodname_education %} benefits and resources, all in one place. On the {% data variables.product.prodname_global_campus %} portal, teachers of all levels can: {% data reusables.education.apply-for-team %} - View an overview of your active [{% data variables.product.prodname_classroom %}](https://classroom.github.com), including recent assignments and your class's progress at a glance, as well as links to {% data variables.product.prodname_classroom %}. - - View and interact with [{% data variables.product.prodname_discussions %}](https://github.com/orgs/community/discussions/categories/github-education) posted by your peers from around the world to discuss current trends in technology education, and see the latest posts from our [{% data variables.product.prodname_education %} blog](https://github.blog/category/education/). + - Ve e interactúa con los [{% data variables.product.prodname_discussions %}](https://github.com/orgs/community/discussions/categories/github-education) que publican tus compañeros de todo el mundo para debatir las tendencias actuales en la educación tecnológica y mira las publicaciones más recientes de nuestro [blog de {% data variables.product.prodname_education %}](https://github.blog/category/education/). - See student events curated by {% data variables.product.prodname_education %} and student leaders. - Stay in the know on what the student community is interested in by rewatching recent [Campus TV](https://www.twitch.tv/githubeducation) episodes. Campus TV is created by {% data variables.product.prodname_dotcom %} and student community leaders and can be watched live or on demand. - Request a {% data variables.product.prodname_dotcom %} swag bag with educational materials and goodies for your students. diff --git a/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/index.md b/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/index.md index 7f26718d4f..d0a7ad8682 100644 --- a/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/index.md +++ b/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/index.md @@ -9,8 +9,8 @@ redirect_from: versions: fpt: '*' children: - - /use-github-at-your-educational-institution - /github-global-campus-for-students - /github-global-campus-for-teachers + - /use-github-at-your-educational-institution --- diff --git a/translations/es-ES/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md b/translations/es-ES/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md index b8d58ab579..a5ac6d80f7 100644 --- a/translations/es-ES/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md +++ b/translations/es-ES/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md @@ -30,7 +30,7 @@ The {% data variables.product.prodname_codespaces %} Education benefit gives ver {% data reusables.classroom.free-limited-codespaces-for-verified-teachers-beta-note %} -To become a verified teacher, you need to be approved for an educator or teacher benefit. For more information, see "[Apply to {% data variables.product.prodname_global_campus %} as a teacher](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)." +To become a verified teacher, you need to be approved for an educator or teacher benefit. Para obtener más información, consulta la sección "[Solicitar ingresar al {% data variables.product.prodname_global_campus %} como docente](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)". After you have confirmation that you are a verified teacher, visit [{% data variables.product.prodname_global_campus %} for Teachers](https://education.github.com/globalcampus/teacher) to upgrade the organization to GitHub Team. For more information, see [GitHub's products](/get-started/learning-about-github/githubs-products#github-team). diff --git a/translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md b/translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md index 4a39811e9e..bf7d11e742 100644 --- a/translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md +++ b/translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md @@ -54,7 +54,7 @@ For a group assignment, {% data variables.product.prodname_classroom %} names re ### Choosing an assignment type -Under "Individual or group assignment", select the drop-down menu, then click **Group assignment**. You can't change the assignment type after you create the assignment. If you'd rather create a individual assignment, see "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)." +Under "Individual or group assignment", select the drop-down menu, then click **Group assignment**. You can't change the assignment type after you create the assignment. If you'd rather create an individual assignment, see "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)." ### Defining teams for an assignment diff --git a/translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment.md b/translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment.md index 46598b60cb..5b0acf5237 100644 --- a/translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment.md +++ b/translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment.md @@ -9,48 +9,48 @@ shortTitle: Rechazar una tarea ## Acerca de reutilizar tareas -Puedes reutilizar una tarea grupal o individual existente en cualquier otra aula a la cual tengas acceso, incluyendo aquellas en una organización distinta. También puedes reutilizar tareas múltiples a la vez desde un aula. Si eliges reutilizar una tarea, {% data variables.product.prodname_classroom %} la copiará al aula que elijas. If the assignment uses a template repository and you choose to reuse it in a classroom from a different organization, {% data variables.product.prodname_classroom %} will create a copy of the repository and its contents in the target organization. +Puedes reutilizar una tarea grupal o individual existente en cualquier otra aula a la cual tengas acceso, incluyendo aquellas en una organización distinta. También puedes reutilizar tareas múltiples a la vez desde un aula. Si eliges reutilizar una tarea, {% data variables.product.prodname_classroom %} la copiará al aula que elijas. Si la tarea utiliza un repositorio en borrador y eliges reutilizarlo en un aula desde una organización diferente, {% data variables.product.prodname_classroom %} creará una copia del repositorio y de su contenido en la organización destino. -The copied assignment includes assignment details such as the name, source repository, autograding test, and preferred editor. You can edit the assignment after it has been copied to make changes. You cannot make changes to the preferred editor. +La tarea copiada incluye detalles de esta, tales como el nombre, el repositorio origen, pruebas de autoevaluación y el editor preferido. Puedes editar esta tarea después de que se copió para realizar cambios. No puedes hacer cambios al editor preferido. -## Reusing an assignment +## Reutilizar una tarea 1. Inicia sesión en {% data variables.product.prodname_classroom_with_url %}. -1. Navigate to the classroom that has the assignment that you want to reuse. +1. Navega al aula que tiene la tarea que quieras reutilizar. ![Aula en la lista de aulas de una organización](/assets/images/help/classroom/click-classroom-in-list.png) -1. In the list of assignments, click the assignment you want to reuse. +1. En la lista de tareas, haz clic en aquella que quieras reutilizar. ![Lista de tareas para las tareas de un aula](/assets/images/help/classroom/click-assignment-in-list.png) -1. Select the **{% octicon "pencil" aria-label="The pencil icon" %} Edit** dropdown menu in the top right of the page, then click **{% octicon "sync" aria-label="The sync icon" %} Reuse assignment**. +1. Selecciona el menú desplegable de **{% octicon "pencil" aria-label="The pencil icon" %} Editar** en la parte superior derecha de la página y luego haz clic en **{% octicon "sync" aria-label="The sync icon" %} Reutilizar tarea**. - ![Reuse assignment button](/assets/images/help/classroom/reuse-assignment-button.png) + ![Botón de reutilizar tarea](/assets/images/help/classroom/reuse-assignment-button.png) -1. In the "Reuse assignment" modal, use the **Choose an organization** dropdown menu to select the organization you want the assignment to be in. Then use the **Choose a classroom** dropdown menu to select the classroom within that organization that you want to copy the assignment to. +1. En el modl de "Reutilizar tarea", utiliza el menú desplegable **Elegir una organización** para seleccionar aquella en la cual quieras que esté la tarea. Luego, utiliza el menú desplegable **Elegir un aula** para seleccionar el aula dentro de la organización en la que quieres copiar la tarea. - ![Reuse assignment modal](/assets/images/help/classroom/reuse-assignment-modal.png) + ![Modal de reutilizar tarea](/assets/images/help/classroom/reuse-assignment-modal.png) -1. Click **Create assignment**. -1. The assignment is copied to the selected classroom, and a confirmation message is shown. If you chose to reuse an assignment with a template repository, the copying process may take a few minutes to complete, and you may need to refresh the page to see the completed message. +1. Haz clic en **Crear tarea**. +1. La tarea se copiará al aula seleccionada y se mostrará un mensaje de confirmación. Si eliges reutilizar una tarea con una plantilla de repositorio, el proceso de copiado podría llevar unos minutos para completarse y podrías necesitar actualizar la página para ver el mensaje de completado. - ![Completed message for reused assignment](/assets/images/help/classroom/reuse-assignment-completed-message.png) + ![Mensaje completado para la tarea reutilizada](/assets/images/help/classroom/reuse-assignment-completed-message.png) -## Reusing multiple assignments from a classroom +## Reutilizar tareas múltiples de un aula 1. Inicia sesión en {% data variables.product.prodname_classroom_with_url %}. -2. To the right of a classroom's name, select the {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} drop-down menu, then click **Reuse assignment**. +2. A la derecha del nombre del aula, selecciona el menú desplegable de {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} y haz clic en **Reutilizar tarea**. - ![Screenshot of classroom overview page with dropdown emphasized](/assets/images/help/classroom/classroom-reuse-assignment-modal.png) + ![Captura de pantalla de la página de resumen del aula con énfasis en el menú desplegable](/assets/images/help/classroom/classroom-reuse-assignment-modal.png) -3. In the "Reuse assignments" modal, use the **Choose an organization** dropdown menu to select the organization you want the assignments to be in. Then use the **Choose a classroom** dropdown menu to select the classroom within that organization that you want to copy the assignments to. +3. En el modal de "Reutilizar tareas", utiliza el menú desplegable **Elige una organización** para seleccionar aquella en la que quieres que estén las tareas. Luego, utiliza el menú desplegable **Elegir un aula** para seleccionar el aula dentro de la organización en la que quieres copiar la tarea. - ![Screenshot of reuse assignments modal](/assets/images/help/classroom/reuse-multiple-assignments-modal.png) + ![Captura de pantalla del modal de reutilización de tareas](/assets/images/help/classroom/reuse-multiple-assignments-modal.png) -4. To the left of each assignment, select the assignment you want to reuse. +4. A la izquierda de cada tarea, selecciona aquella que quieras reutilizar. - ![Screenshot of multiple selected assignments](/assets/images/help/classroom/multiple-assignments-selected.png) + ![Captura de pantalla de múltiples tareas seleccionadas](/assets/images/help/classroom/multiple-assignments-selected.png) -5. Click **Create assignments**. -6. The assignments are copied to the selected classroom. If you chose to reuse an assignment with a template repository, the copying process may take a few minutes to complete. +5. Haz clic en **Crear tareas**. +6. Las tareas se copiarán al aula seleccionada. Si eliges reutilizar una tarea con un repositorio de plantilla, el proceso de copiado podrá tomar unos cuantos minutos en completarse. diff --git a/translations/es-ES/content/get-started/exploring-projects-on-github/following-organizations.md b/translations/es-ES/content/get-started/exploring-projects-on-github/following-organizations.md index fbcb4c8cb0..d3bd49710a 100644 --- a/translations/es-ES/content/get-started/exploring-projects-on-github/following-organizations.md +++ b/translations/es-ES/content/get-started/exploring-projects-on-github/following-organizations.md @@ -7,15 +7,11 @@ topics: - Profile --- -{% note %} - -**Nota:** La capacidad de seguir organizaciones se encuentra actualmente en beta público y está sujeta a cambios. - -{% endnote %} +{% data reusables.organizations.follow-organizations-beta %} ## Aceca de los seguidores en {% data variables.product.product_name %} -Cuando sigues organizaciones, puedes ver su actividad pública en tu tablero personal. Para obtener más información, consulta "[Acerca de tu tablero personal](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community)". +{% data reusables.organizations.about-following-organizations %} For more information, see "[About your personal dashboard](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community)." Puedes dejar de seguir a una organización si no quieres ver su actividad {% ifversion fpt or ghec %}pública{% endif %} en {% data variables.product.product_name %}. diff --git a/translations/es-ES/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md b/translations/es-ES/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md index 78176f43ab..dcc1431bc8 100644 --- a/translations/es-ES/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md +++ b/translations/es-ES/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md @@ -57,11 +57,21 @@ Si tienes repositorios o código fuente existentes que se almacenan localmente e 1. [Crear un repositorio nuevo](/repositories/creating-and-managing-repositories/creating-a-new-repository) en {% data variables.product.product_location %}. Para evitar errores, no inicialices el nuevo repositorio con archivos *README* licencia o `gitingnore`. Puedes agregar estos archivos después de que tu proyecto se haya subido a {% data variables.product.product_name %}. ![Desplegable Create New Repository (Crear nuevo repositorio)](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Cambiar el directorio de trabajo actual en tu proyecto local. -4. Inicializar el directorio local como un repositorio de Git. - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. Agregar los archivos a tu nuevo repositorio local. Esto representa la primera confirmación. + ```shell $ git add . # Agrega el archivo en el repositorio local y lo presenta para la confirmación. {% data reusables.git.unstage-codeblock %} @@ -92,10 +102,19 @@ Si tienes repositorios o código fuente existentes que se almacenan localmente e 1. [Crear un repositorio nuevo](/articles/creating-a-new-repository) en {% data variables.product.product_location %}. Para evitar errores, no inicialices el nuevo repositorio con archivos *README* licencia o `gitingnore`. Puedes agregar estos archivos después de que tu proyecto se haya subido a {% data variables.product.product_name %}. ![Desplegable Create New Repository (Crear nuevo repositorio)](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Cambiar el directorio de trabajo actual en tu proyecto local. -4. Inicializar el directorio local como un repositorio de Git. - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. Agregar los archivos a tu nuevo repositorio local. Esto representa la primera confirmación. ```shell $ git add . @@ -127,10 +146,19 @@ Si tienes repositorios o código fuente existentes que se almacenan localmente e 1. [Crear un repositorio nuevo](/articles/creating-a-new-repository) en {% data variables.product.product_location %}. Para evitar errores, no inicialices el nuevo repositorio con archivos *README* licencia o `gitingnore`. Puedes agregar estos archivos después de que tu proyecto se haya subido a {% data variables.product.product_name %}. ![Desplegable Create New Repository (Crear nuevo repositorio)](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Cambiar el directorio de trabajo actual en tu proyecto local. -4. Inicializar el directorio local como un repositorio de Git. - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. Agregar los archivos a tu nuevo repositorio local. Esto representa la primera confirmación. ```shell $ git add . diff --git a/translations/es-ES/content/get-started/quickstart/be-social.md b/translations/es-ES/content/get-started/quickstart/be-social.md index 9938fad6cb..27cfae157f 100644 --- a/translations/es-ES/content/get-started/quickstart/be-social.md +++ b/translations/es-ES/content/get-started/quickstart/be-social.md @@ -57,7 +57,23 @@ From your dashboard, click the drop down menu of your username on the left side ![Switch account context dropdown](/assets/images/help/overview/dashboard-contextswitcher.png) -### Exploring other projects on {% data variables.product.prodname_dotcom %} +{% ifversion for-you-feed %} + +## Following organizations + +{% data reusables.organizations.follow-organizations-beta %} + +{% data reusables.organizations.about-following-organizations %} + +To follow an organization, in the header of the organization's page, click **Follow**. + +![Screenshot of the organization header, with the follow button highlighted](/assets/images/help/profile/organization-profile-following.png) + +For more information, see "[Following organizations](/get-started/exploring-projects-on-github/following-organizations)." + +{% endif %} + +## Exploring other projects on {% data variables.product.prodname_dotcom %} You can discover new and interesting projects on {% data variables.product.prodname_dotcom %}'s Explore page. You can star interesting projects to make them easy to find again later. Visit your stars page to see all your starred projects. For more information about stars, see "[Saving repositories with stars](/get-started/exploring-projects-on-github/saving-repositories-with-stars)." diff --git a/translations/es-ES/content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md b/translations/es-ES/content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md index 2a404f1e2f..620920c60d 100644 --- a/translations/es-ES/content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md +++ b/translations/es-ES/content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md @@ -1,18 +1,17 @@ --- -title: 'Cambiar la visibilidad de los {% data variables.product.prodname_project_v1 %}' -intro: 'Como propietario de organización o administrador de {% data variables.projects.projects_v1_board %}, puedes hacer un {% data variables.projects.projects_v1_board %} {% ifversion ghae %}interno{% else %}público{% endif %} o privado.' +title: Changing {% data variables.product.prodname_project_v1 %} visibility +intro: 'As an organization owner or {% data variables.projects.projects_v1_board %} admin, you can make a {% data variables.projects.projects_v1_board %} {% ifversion ghae %}internal{% else %}public{% endif %} or private.' redirect_from: - /github/managing-your-work-on-github/managing-project-boards/changing-project-board-visibility - /articles/changing-project-board-visibility - /github/managing-your-work-on-github/changing-project-board-visibility versions: - feature: projects-v1 + feature: "projects-v1" topics: - Pull requests -shortTitle: Cambiar la visibilidad +shortTitle: Change visibility allowTitleToDifferFromFilename: true --- - {% data reusables.projects.project_boards_old %} {% data reusables.project-management.project-board-visibility %} @@ -22,12 +21,12 @@ allowTitleToDifferFromFilename: true **{% ifversion classic-project-visibility-permissions %}Notes{% else %}Note{% endif %}:** {% ifversion classic-project-visibility-permissions %} * {% data reusables.projects.owners-can-limit-visibility-permissions %} -* {% endif %}When you make your {% data variables.projects.projects_v1_board %} {% ifversion ghae %}internal{% else %}public{% endif %}, organization members are given read access by default. Puedes otorgar permisos de escritura o administración a miembros específicos de la organización si les das acceso a los equipos en los que se encuentran, agregándolos al {% data variables.projects.projects_v1_board %} como colaborador. Para obtener más información, consulta la sección "[Permisos de los {% data variables.product.prodname_project_v1_caps %} para una organización](/articles/project-board-permissions-for-an-organization)". +* {% endif %}When you make your {% data variables.projects.projects_v1_board %} {% ifversion ghae %}internal{% else %}public{% endif %}, organization members are given read access by default. You can give specific organization members write or admin permissions by giving access to teams they're on or by adding them to the {% data variables.projects.projects_v1_board %} as a collaborator. For more information, see "[{% data variables.product.prodname_project_v1_caps %} permissions for an organization](/articles/project-board-permissions-for-an-organization)." {% endnote %} -1. Navega al tablero del proyecto que quieres hacer {% ifversion ghae %}interno{% else %}público{% endif %} o privado. +1. Navigate to the project board you want to make {% ifversion ghae %}internal{% else %}public{% endif %} or private. {% data reusables.project-management.click-menu %} {% data reusables.project-management.access-collaboration-settings %} {% data reusables.project-management.choose-visibility %} -1. Haz clic en **Save ** (guardar). +1. Click **Save**. diff --git a/translations/es-ES/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md b/translations/es-ES/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md index a0a5c21c5d..d39c4e42b9 100644 --- a/translations/es-ES/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md +++ b/translations/es-ES/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md @@ -24,7 +24,7 @@ Para transferir una propuesta abierta a otro repositorio, debes tener acceso de {% endnote %} -Cuando transfieres una propuesta, los comentarios, etiquetas y asignados se retienen. Los hitos de la propuesta no se retienen. Esta propuesta se mantendrá en cualquier tablero de proyecto que pertenezca al usuario o que se encuentre en la organización y se eliminará de cualquier tablero de proyecto de los repositorios. Para obtener más información, consulta "[Acerca de los tableros de proyectos](/articles/about-project-boards)." +Cuando transfieres un informe de problemas, se retendrá tanto los comentarios como las personas asignadas. Labels and milestones are also retained if they're present in the target repository, with labels matching by name and milestones matching by both name and due date. Esta propuesta se mantendrá en cualquier tablero de proyecto que pertenezca al usuario o que se encuentre en la organización y se eliminará de cualquier tablero de proyecto de los repositorios. Para obtener más información, consulta "[Acerca de los tableros de proyectos](/articles/about-project-boards)." Las personas o equipos que se mencionan en la propuesta recibirán una notificación que les haga saber que la propuesta se transfirió a un repositorio nuevo. La URL original se redirige a la URL nueva de la propuesta. Las personas que no tengan permisos de lectura en el repositorio nuevo verán un anuncio que les hará saber que la propuesta se transfirió a un repositorio nuevo al que no pueden acceder. diff --git a/translations/es-ES/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md b/translations/es-ES/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md index dffbe6224a..15cb0d21cd 100644 --- a/translations/es-ES/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md +++ b/translations/es-ES/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md @@ -36,15 +36,22 @@ También puedes configurar las direcciones IP permitidas para las organizaciones ## Agregar una dirección IP permitida +{% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} + +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} {% data reusables.identity-and-permissions.ip-allow-lists-add-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-add-description %} {% data reusables.identity-and-permissions.ip-allow-lists-add-entry %} +{% data reusables.identity-and-permissions.check-ip-address %} ## Habilitar direcciones IP permitidas +{% data reusables.identity-and-permissions.about-enabling-allowed-ip-addresses %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} @@ -69,6 +76,8 @@ Para obtener más información sobre cómo crear una lista de direcciones permit ## Editar una dirección IP permitida +{% data reusables.identity-and-permissions.about-editing-ip-allow-list-entries %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} @@ -76,6 +85,18 @@ Para obtener más información sobre cómo crear una lista de direcciones permit {% data reusables.identity-and-permissions.ip-allow-lists-edit-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-description %} 1. Da clic en **Actualizar**. +{% data reusables.identity-and-permissions.check-ip-address %} + +{% ifversion ip-allow-list-address-check %} +## Verificar si se permite una dirección IP + +{% data reusables.identity-and-permissions.about-checking-ip-address %} + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +{% data reusables.organizations.security %} +{% data reusables.identity-and-permissions.check-ip-address-step %} +{% endif %} ## Eliminar una dirección IP permitida diff --git a/translations/es-ES/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md b/translations/es-ES/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md index 591f5ee6ff..7b668c8fea 100644 --- a/translations/es-ES/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md +++ b/translations/es-ES/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md @@ -741,7 +741,7 @@ Para obtener más información, consulta la sección "[Administrar la publicaci | Acción | Descripción | | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `create (crear)` | Se activa cuando un propietario de una organización crea un rol de repositorio personalizado nuevo. Para obtener más información, consulta la sección "[Administrar los roles personalizados de repositorio en una organización](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". | -| `destroy (destruir)` | Se activa cuando el propietario de una organización borra un rol de repositorio personalizado. Para obtener más información, consulta la sección "[Administrar los roles personalizados de repositorio en una organización](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". | +| `destroy (destruir)` | Se activa cuando un propietario de organización borra un rol de repositorio personalizado. Para obtener más información, consulta la sección "[Administrar los roles personalizados de repositorio en una organización](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". | | `actualización` | Se activa cuando un propietario de una organización edita un rol de repositorio personalizado existente. Para obtener más información, consulta la sección "[Administrar los roles personalizados de repositorio en una organización](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". | {% endif %} diff --git a/translations/es-ES/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md b/translations/es-ES/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md index 12cf639d3e..f974194597 100644 --- a/translations/es-ES/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md +++ b/translations/es-ES/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md @@ -1,6 +1,6 @@ --- title: Habilitar o inhabilitar los debates de GitHub para una organización -intro: 'Puedes utilizar {% data variables.product.prodname_discussions %} en una organización como un lugar en el que esta pueda tener conversaciones que no sean específicas para un solo repositorio dentro de ella.' +intro: 'You can use {% data variables.product.prodname_discussions %} in an organization as a place for your organization to have conversations that aren''t specific to a single repository within your organization.' permissions: 'Organization owners can enable {% data variables.product.prodname_discussions %} for their organization.' versions: feature: discussions diff --git a/translations/es-ES/content/packages/index.md b/translations/es-ES/content/packages/index.md index a486e6d606..3b87646850 100644 --- a/translations/es-ES/content/packages/index.md +++ b/translations/es-ES/content/packages/index.md @@ -18,6 +18,7 @@ featuredLinks: guideCards: - '{% ifversion docker-ghcr-enterprise-migration %}/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry{% endif %}' - '{% ifversion fpt or ghec or ghes > 3.4 %}/packages/working-with-a-github-packages-registry/working-with-the-container-registry{% else %}/packages/working-with-a-github-packages-registry/working-with-the-docker-registry{% endif %}' + - '{% ifversion packages-npm-v2 %}/packages/working-with-a-github-packages-registry/working-with-the-npm-registry{% endif %}' - /packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry changelog: label: packages diff --git a/translations/es-ES/content/packages/learn-github-packages/about-permissions-for-github-packages.md b/translations/es-ES/content/packages/learn-github-packages/about-permissions-for-github-packages.md index 504c1ca13a..06f4205897 100644 --- a/translations/es-ES/content/packages/learn-github-packages/about-permissions-for-github-packages.md +++ b/translations/es-ES/content/packages/learn-github-packages/about-permissions-for-github-packages.md @@ -18,20 +18,22 @@ Los permisos de los paquetes pueden ser con alcance de repositorio o de usuario/ Un paquete con alcance de repositorio hereda los permisos y la visibilidad del repositorio al que pertenece el paquete. Puedes encontrar un paquete con alcance de un repositorio específico si vas a la página principal de este y haces clic en el enlace de **Paquetes** a la derecha de la página. {% ifversion fpt or ghec %}Para obtener más información, consulta la sección "[Conectar un repositorio con un paquete](/packages/learn-github-packages/connecting-a-repository-to-a-package)".{% endif %} -Los registros del {% data variables.product.prodname_registry %} que se mencionan a continuación utilizan permisos con alcance de repositorio: +The {% data variables.product.prodname_registry %} registries below **only** use repository-scoped permissions: {% ifversion not fpt or ghec %}- Docker registry (`docker.pkg.github.com`){% endif %} - - Registro de npm + {% ifversion packages-npm-v2 %}{% else %}- npm registry{% endif %} - Registro de RubyGems - Registro de Apache maven - Registro de NuGet +{% ifversion packages-npm-v2 %}For {% data variables.product.prodname_ghcr_and_npm_registry %}, you can choose to allow packages to be scoped to a user, an organization, or linked to a repository.{% endif %} + {% ifversion fpt or ghec %} ## Permisos granulares para paquetes con alcance de organización/usuario Los paquetes con permisos granulares tienen un alcance de una cuenta personal o de organización. Puedes cambiar el control de accesos y la visibilidad del paquete de forma separada desde un repositorio que esté conectado (o enlazado) a un paquete. -Actualmente, solo el {% data variables.product.prodname_container_registry %} ofrece permisos granulares para tus paquetes de imagen de contenedor. +Currently, the {% data variables.product.prodname_ghcr_and_npm_registry %} offer granular permissions for your container image packages. ## Permisos de visibilidad y acceso para las imágenes de contenedor diff --git a/translations/es-ES/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md b/translations/es-ES/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md index f1b170aa60..015ef76cff 100644 --- a/translations/es-ES/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md +++ b/translations/es-ES/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md @@ -16,7 +16,7 @@ shortTitle: Visibilidad & control de accesos Los paquetes con permisos granulares tienen un alcance de una cuenta personal o de organización. Puedes cambiar la visibilidad y el control de accesos de un paquete por separado desde el repositorio al cual está conectado (o enlazado). -Actualmente, solo puedes utilizar permisos granulares con el {% data variables.product.prodname_container_registry %}. Los permisos granulares no son compatibles en nuestros otros registros de paquete, tales como el registro de npm.{% ifversion docker-ghcr-enterprise-migration %} Para obtener más información sobre la migración del {% data variables.product.prodname_container_registry %}, consulta la sección "[Migrarse al {% data variables.product.prodname_container_registry %} desde el registro de Docker](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)".{% endif %} +Actualmente, solo puedes utilizar permisos granulares con el {% data variables.product.prodname_ghcr_and_npm_registry %}. Granular permissions are not supported in our other package registries, such as the RubyGems registry.{% ifversion docker-ghcr-enterprise-migration %} For more information about migration to the {% data variables.product.prodname_container_registry %}, see "[Migrating to the {% data variables.product.prodname_container_registry %} from the Docker registry](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)."{% endif %} Para obtener más información sobre los permisos de los paquetes con alcance de repositorio, los alcances relacionados con paquetes para los PAT o para administrar permisos para los flujos de trabajo de tus acciones, consulta la sección "[Acerca de los permisos para los Paquetes de GitHub](/packages/learn-github-packages/about-permissions-for-github-packages)". @@ -95,7 +95,7 @@ Para personalizar aún más el acceso a tu imagen de contenedor, consulta la sec {% ifversion fpt or ghec %} ## Asegurarse de que {% data variables.product.prodname_codespaces %} puede acceder a tu paquete -Predeterminadamente, un codespace puede acceder sin problema a algunos paquetes en el Registro de Contenedores de {% data variables.product.prodname_dotcom %}, tales como aquellos que se publican en el mismo repositorio con la opción de **Heredar acceso** seleccionada. Para obtener más información sobre qué tipo de acceso se configura automáticamente, consulta la sección "[Acceder a las imágenes almacenadas en el Registro de Contenedores de {% data variables.product.prodname_dotcom %}](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-images-stored-in-github-container-registry)". +By default, a codespace can seamlessly access certain packages in the {% data variables.product.prodname_ghcr_and_npm_registry %}, such as those published in the same repository with the **Inherit access** option selected. For more information on which access is automatically configured, see "[Allowing your codespace to access a private image registry](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-images-stored-in-container-registry-and-npm-registry)." De otra manera, para asegurarte de que un codespace tiene acceso a tu paquete, debes otorgar acceso al repositorio en donde se esté lanzando dicho codespace. diff --git a/translations/es-ES/content/packages/learn-github-packages/deleting-and-restoring-a-package.md b/translations/es-ES/content/packages/learn-github-packages/deleting-and-restoring-a-package.md index d4e95b8159..456eca2565 100644 --- a/translations/es-ES/content/packages/learn-github-packages/deleting-and-restoring-a-package.md +++ b/translations/es-ES/content/packages/learn-github-packages/deleting-and-restoring-a-package.md @@ -23,12 +23,12 @@ On {% data variables.product.prodname_dotcom %} if you have the required access, - an entire private package - an entire public package, if there's not more than 5000 downloads of any version of the package - a specific version of a private package -- a specific version of a public package, if the package version doesn't have more than 5000 downloads +- a specific version of a public package, if the package version doesn't have more than 5,000 downloads {% note %} **Note:** -- You cannot delete a public package if any version of the package has more than 5000 downloads. In this scenario, contact [GitHub support](https://support.github.com/contact?tags=docs-packages) for further assistance. +- You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact [GitHub support](https://support.github.com/contact?tags=docs-packages) for further assistance. - When deleting public packages, be aware that you may break projects that depend on your package. {% endnote %} @@ -46,7 +46,7 @@ You can use the REST API to manage your packages. For more information, see the {% endif %} -For packages that inherit their permissions and access from repositories, you can use GraphQL to delete a specific package version.{% ifversion fpt or ghec %} The {% data variables.product.prodname_registry %} GraphQL API does not support containers or Docker images that use the package namespace `https://ghcr.io/OWNER/PACKAGE-NAME`.{% endif %} For more information about GraphQL support, see "[Deleting a version of a repository-scoped package with GraphQL](#deleting-a-version-of-a-repository-scoped-package-with-graphql)." +For packages that inherit their permissions and access from repositories, you can use GraphQL to delete a specific package version.{% data reusables.package_registry.no-graphql-to-delete-packages %} For more information about GraphQL support, see "[Deleting a version of a repository-scoped package with GraphQL](#deleting-a-version-of-a-repository-scoped-package-with-graphql)." {% endif %} @@ -54,18 +54,19 @@ For packages that inherit their permissions and access from repositories, you ca For packages that inherit their access permissions from repositories, you can delete a package if you have admin permissions to the repository. -Repository-scoped packages on {% data variables.product.prodname_registry %} include these packages: -- npm -- RubyGems -- maven -- Gradle -- NuGet -{% ifversion not fpt or ghec %}- Docker images at `docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`{% endif %} +The {% data variables.product.prodname_registry %} registries below **only** use repository-scoped permissions: + + {% ifversion not fpt or ghec %}- Docker images at `docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`{% endif %} + {% ifversion packages-npm-v2 %}{% else %}- npm{% endif %} + - RubyGems registry + - Apache Maven registry + - NuGet registry + +{% ifversion packages-npm-v2 %}For {% data variables.product.prodname_ghcr_and_npm_registry %}, you can choose to allow packages to be scoped to a user, an organization, or linked to a repository.{% endif %} {% ifversion fpt or ghec %} -To delete a package that has granular permissions separate from a repository, such as container images stored at `https://ghcr.io/OWNER/PACKAGE-NAME`, you must have admin access to the package. -For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." +To delete a package that has granular permissions separate from a repository, such as container images stored at `https://ghcr.io/OWNER/PACKAGE-NAME` or `https://npm.pkg.github.com/OWNER/PACKAGE-NAME`, you must have admin access to the package. For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." {% endif %} @@ -89,9 +90,7 @@ To delete a version of a repository-scoped package, you must have admin permissi For packages that inherit their permissions and access from repositories, you can use the GraphQL to delete a specific package version. -{% ifversion fpt or ghec %} -For containers or Docker images at `ghcr.io`, GraphQL is not supported but you can use the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." -{% endif %} +{% data reusables.package_registry.no-graphql-to-delete-packages %}{% ifversion fpt or ghec %} You can however use the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)."{% endif %} Use the `deletePackageVersion` mutation in the GraphQL API. You must use a token with the `read:packages`, `delete:packages`, and `repo` scopes. For more information about tokens, see "[About {% data variables.product.prodname_registry %}](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)." diff --git a/translations/es-ES/content/packages/learn-github-packages/introduction-to-github-packages.md b/translations/es-ES/content/packages/learn-github-packages/introduction-to-github-packages.md index fc5090006e..5450ffcff9 100644 --- a/translations/es-ES/content/packages/learn-github-packages/introduction-to-github-packages.md +++ b/translations/es-ES/content/packages/learn-github-packages/introduction-to-github-packages.md @@ -51,7 +51,7 @@ For more information about the configuration of {% data variables.product.prodna | | | |--------------------|--------------------| -| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_container_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

    For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | +| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_ghcr_and_npm_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

    For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | | Visibility | {% data reusables.package_registry.public-or-private-packages %} | For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." @@ -101,7 +101,9 @@ For more information about Docker and the {% data variables.product.prodname_con ## Managing packages {% ifversion fpt or ghec %} -You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." +You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." + +{% data reusables.package_registry.no-graphql-to-delete-packages %} {% endif %} {% ifversion ghes %} @@ -112,7 +114,9 @@ You can delete a private or public package in the {% data variables.product.prod You can delete a version of a package in the {% data variables.product.product_name %} user interface or using the GraphQL API. {% endif %} -When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and "[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." +When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. + +For more information, see {% ifversion ghes or ghae %}"[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and {% endif %}"[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "[`package` webhook event](/webhooks/event-payloads/#package)." diff --git a/translations/es-ES/content/packages/learn-github-packages/viewing-packages.md b/translations/es-ES/content/packages/learn-github-packages/viewing-packages.md index 1fe540bc95..bf14b2ab7c 100644 --- a/translations/es-ES/content/packages/learn-github-packages/viewing-packages.md +++ b/translations/es-ES/content/packages/learn-github-packages/viewing-packages.md @@ -23,15 +23,15 @@ versions: Tu capacidad de ver un paquete depende de varios factores. Predeterminadamente, puedes ver todos los paquetes que hayas publicado. -Los paquetes con alcance de repositorio heredan sus permisos y visibilidad desde el repositorio al que pertenece el paquete. Los siguientes registros utilizan este tipo de permisos:{% ifversion not fpt or ghec %} +Los paquetes con alcance de repositorio heredan sus permisos y visibilidad desde el repositorio al que pertenece el paquete. The registries below **only** use this type of permissions:{% ifversion not fpt or ghec %} - Registro de Docker (`docker.pkg.github.com`){% endif %} -- Registro de npm +{% ifversion packages-npm-v2 %}{% else %}- npm registry{% endif %} - Registro de RubyGems - Registro de Apache maven - Registro de NuGet {% ifversion fpt or ghec %} -El registro del contenedor te ofrece la opción de contar con permisos granulares y configuraciones de visibilidad que se pueden personalizar para cada paquete que pertenezca a un usuario personal o a una cuenta de organización. Puedes elegir utilizar permisos granulares o conectar el paquete a un repositorio y heredar sus permisos. Para obtener más información, consulta la sección "[Conectar un repositorio a un paquete](/packages/learn-github-packages/connecting-a-repository-to-a-package)". +The {% data variables.product.prodname_ghcr_and_npm_registry %} offer you the option of granular permissions and visibility settings that can be customized for each package owned by a personal user or organization account. Puedes elegir utilizar permisos granulares o conectar el paquete a un repositorio y heredar sus permisos. Para obtener más información, consulta la sección "[Conectar un repositorio a un paquete](/packages/learn-github-packages/connecting-a-repository-to-a-package)". {% endif %} Para obtener más información, consulta las secciones "[Acerca de los permisos para GitHub Packages](/packages/learn-github-packages/about-permissions-for-github-packages){% ifversion fpt or ghec %}" y "[Configurar el control de accesos y la visibilidad de un paquete](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility){% endif %}". diff --git a/translations/es-ES/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md b/translations/es-ES/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md index 83da88a908..530258476f 100644 --- a/translations/es-ES/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md +++ b/translations/es-ES/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md @@ -24,9 +24,9 @@ shortTitle: Publicar & instalar con acciones Puedes ampliar las capacidades de CI y CD de tu repositorio publicando o instalando paquetes como parte de tu flujo de trabajo. {% ifversion fpt or ghec %} -### Autenticarse en el {% data variables.product.prodname_container_registry %} +### Authenticating to the {% data variables.product.prodname_ghcr_and_npm_registry %} -{% data reusables.package_registry.authenticate_with_pat_for_container_registry %} +{% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} {% endif %} @@ -40,7 +40,7 @@ Puedes hacer referencia al `GITHUB_TOKEN` en tu archivo de flujo de trabajo medi {% note %} -**Nota:** Los paquetes que pertenecen a repositorios incluyen RubyGems, npm, Apache Maven, NuGet, {% ifversion fpt or ghec %}y Gradle. {% else %}Los paquetes de Gradle y de Docker que utilizan el designador de nombre del paquete `docker.pkg.github.com`.{% endif %} +**Note:** Some registries, such as RubyGems, {% ifversion packages-npm-v2 %}{% else %}npm, {% endif %}Apache Maven, NuGet, {% ifversion fpt or ghec %}and Gradle{% else %}Gradle, and Docker packages that use the package namespace `docker.pkg.github.com`{% endif %}, only allow repository-owned packages. With {% data variables.product.prodname_ghcr_and_npm_registry_full %} you can choose to allow packages to be owned by a user, an organization, or linked to a repository. {% endnote %} @@ -49,11 +49,11 @@ Cuando habilitas las Acciones de GitHub, GitHub instala una App GitHub en tu rep El {% data variables.product.prodname_registry %} te permite subir y extraer paquetes mediante el `GITHUB_TOKEN` que está disponible para un flujo de trabajo de {% data variables.product.prodname_actions %}. {% ifversion fpt or ghec %} -## Acerca de los permisos y el acceso de paquetes para el {% data variables.product.prodname_container_registry %} +## About permissions and package access for {% data variables.product.prodname_ghcr_and_npm_registry %} -El {% data variables.product.prodname_container_registry %} (`ghcr.io`) permite a los usuarios crear y administrar contenedores como recursos independientes a nivel organizacional. Los contenedores pueden pertenecerle a una cuenta personal o de organización y puedes personalizar el acceso a cada uno de ellos por separado desde los permisos de repositorio. +The {% data variables.product.prodname_ghcr_and_npm_registry_full %} allows users to create and administer packages as free-standing resources at the organization level. Packages can be owned by an organization or personal account and you can customize access to each of your packages separately from repository permissions. -Todos los flujos de trabajo que accedan al {% data variables.product.prodname_container_registry %} deben utilizar el `GITHUB_TOKEN` en vez de un token de acceso personal. Para obtener más información acerca de las mejores prácticas de seguridad, consulta la sección "[Fortalecimiento de seguridad para las GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)". +All workflows accessing the {% data variables.product.prodname_ghcr_and_npm_registry %} should use the `GITHUB_TOKEN` instead of a personal access token. Para obtener más información acerca de las mejores prácticas de seguridad, consulta la sección "[Fortalecimiento de seguridad para las GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)". ## Configuración de acceso y permisos predeterminados para los contenedores que se modifican a través de los flujos de trabajo @@ -484,9 +484,9 @@ El instalar los paquetes que hospeda el {% data variables.product.prodname_regis {% data reusables.package_registry.actions-configuration %} {% ifversion fpt or ghec %} -## Actualizar un flujo de trabajo que tiene acceso a `ghcr.io` +## Upgrading a workflow that accesses a registry using a PAT -El {% data variables.product.prodname_container_registry %} es compatible con el `GITHUB_TOKEN` para una autenticación más fácil y segura en tus flujos de trabajo. Si tu flujo de trabajo está utilizando un token de acceso personal (PAT) para autenticarse en `ghcr.io`, entonces te recomendamos ampliamente que actualices tu flujo de trabajo para utilizar el `GITHUB_TOKEN`. +The {% data variables.product.prodname_ghcr_and_npm_registry %} support the `GITHUB_TOKEN` for easy and secure authentication in your workflows. If your workflow is using a personal access token (PAT) to authenticate to the registry, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. Para obtener más información sobre el `GITHUB_TOKEN`, consulta la sección "[Autenticación en un flujo de trabajo](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)". @@ -501,9 +501,9 @@ El utilizar el `GITHUB_TOKEN` en vez de un PAT, el cual incluya el alcance de `r {% endnote %} 1. Opcionalmente, utiliza el menú desplegable de "rol", selecciona el nivel de acceso predeterminado que te gustaría que tuviera el repositorio en tu imagen de contenedor. ![Niveles de acceso de permisos para otorgar a los repositorios](/assets/images/help/package-registry/repository-permission-options-for-package-access-through-actions.png) -1. Abre tu archivo de flujo de trabajo. En la línea en donde ingresas a `ghcr.io`, reemplaza tu PAT con {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. +1. Abre tu archivo de flujo de trabajo. On the line where you log in to the registry, replace your PAT with {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. -Por ejemplo, este flujo de trabajo publica una imagen de Docker utilizando {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} para autenticarse. +For example, this workflow publishes a Docker image to the {% data variables.product.prodname_container_registry %} and uses {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} to authenticate. ```yaml{:copy} name: Demo Push diff --git a/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md b/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md index 6a866421ce..e7957852a6 100644 --- a/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md +++ b/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md @@ -42,7 +42,9 @@ Cuando instalas o publicas una imagen de Docker, el {% data variables.product.pr ## Autenticarse en el {% data variables.product.prodname_container_registry %} -{% data reusables.package_registry.authenticate_with_pat_for_container_registry %} +{% ifversion fpt or ghec or ghes > 3.4 %} +To authenticate to the {% data variables.product.prodname_container_registry %} (`ghcr.io`) within a {% data variables.product.prodname_actions %} workflow, use the `GITHUB_TOKEN` for the best security and experience. {% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} +{% endif %} {% ifversion ghes %}Asegúrate de reemplazar a `HOSTNAME` con el nombre de host o dirección IP de {% data variables.product.product_location_enterprise %} en los siguientes ejemplos.{% endif %} diff --git a/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md index 6714384e4d..8007cd2b6f 100644 --- a/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md +++ b/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -21,6 +21,8 @@ shortTitle: npm registry {% data reusables.package_registry.admins-can-configure-package-types %} +{% ifversion packages-npm-v2 %} +{% else %} ## Limits for published npm versions If you publish over 1,000 npm package versions to {% data variables.product.prodname_registry %}, you may see performance issues and timeouts occur during usage. @@ -28,12 +30,17 @@ If you publish over 1,000 npm package versions to {% data variables.product.prod In the future, to improve performance of the service, you won't be able to publish more than 1,000 versions of a package on {% data variables.product.prodname_dotcom %}. Any versions published before hitting this limit will still be readable. If you reach this limit, consider deleting package versions or contact Support for help. When this limit is enforced, our documentation will be updated with a way to work around this limit. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" or "[Contacting Support](/packages/learn-github-packages/about-github-packages#contacting-support)." +{% endif %} ## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} -{% data reusables.package_registry.authenticate-packages-github-token %} +{% ifversion packages-npm-v2 %} +{% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} + +You can also choose to give access permissions to packages independently for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_actions %}. For more information, see "[Ensuring Codespaces access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-codespaces-access-to-your-package) and [Ensuring workflow access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package)." +{% endif %} ### Authenticating with a personal access token @@ -94,12 +101,24 @@ $ npm login --scope=@OWNER --registry=https://HOSTNAME/_regist {% endnote %} -By default, {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the name field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. You can add a summary for the package listing page by including a *README.md* file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. +{% ifversion packages-npm-v2 %} +The {% data variables.product.prodname_registry %} registry stores npm packages within your organization or personal account, and allows you to associate a package with a repository. You can choose whether to inherit permissions from a repository, or set granular permissions independently of a repository. +{% endif %} + +By default, {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the name field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. If you're running [npm v8.5.3](https://github.com/npm/cli/releases/tag/v8.5.3) or later, you can add a summary for the package listing page by including a *README.md* file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. You can publish multiple packages to the same {% data variables.product.prodname_dotcom %} repository by including a `URL` field in the *package.json* file. For more information, see "[Publishing multiple packages to the same repository](#publishing-multiple-packages-to-the-same-repository)." +{% ifversion fpt or ghec %} +When a package is published, it isn't automatically linked to a repository. You can however choose to link your published package to a repository using the user interface or command line. For more information, see "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)." +{% endif %} + You can set up the scope mapping for your project using either a local *.npmrc* file in the project or using the `publishConfig` option in the *package.json*. {% data variables.product.prodname_registry %} only supports scoped npm packages. Scoped packages have names with the format of `@owner/name`. Scoped packages always begin with an `@` symbol. You may need to update the name in your *package.json* to use the scoped name. For example, `"name": "@codertocat/hello-world-npm"`. +{% ifversion packages-npm-v2 %} +When you first publish a package, the default visibility is private. When a package is linked to repository, the package visibility is dependent on the repository's visibility. To change the visibility or set access permissions, see "[Configuring a package's access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." +{% endif %} + {% data reusables.package_registry.viewing-packages %} ### Publishing a package using a local *.npmrc* file diff --git a/translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index b844e2251b..05e0b384b9 100644 --- a/translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -47,7 +47,7 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl {% data reusables.pages.sidebar-pages %} 4. Under "Custom domain", type your custom domain, then click **Save**. If you are publishing your site from a branch, this will create a commit that adds a `CNAME` file to the root of your source branch. If you are publishing your site with a custom {% data variables.product.prodname_actions %} workflow , no `CNAME` file is created. For more information about your publishing source, see "[Configuring a publishing source for your GitHub Pages site](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." ![Save custom domain button](/assets/images/help/pages/save-custom-subdomain.png) -5. Navigate to your DNS provider and create a `CNAME` record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `www.example.com` for your user site, create a `CNAME` record that points `www.example.com` to `.github.io`. If you want to use the subdomain `www.anotherexample.com` for your organization site, create a `CNAME` record that points `www.anotherexample.com` to `.github.io`. The `CNAME` record should always point to `.github.io` or `.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} +5. Navigate to your DNS provider and create a `CNAME` record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `www.example.com` for your user site, create a `CNAME` record that points `www.example.com` to `.github.io`. If you want to use the subdomain `another.example.com` for your organization site, create a `CNAME` record that points `another.example.com` to `.github.io`. The `CNAME` record should always point to `.github.io` or `.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} {% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %} {% data reusables.command_line.open_the_multi_os_terminal %} diff --git a/translations/es-ES/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md b/translations/es-ES/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md deleted file mode 100644 index 2bc9b70a38..0000000000 --- a/translations/es-ES/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Agregar un tema a tu sitio de Páginas de GitHub con el selector de tema -intro: 'Puedes añadir un tema a tu sitio de {% data variables.product.prodname_pages %} para personalizar la apariencia de tu sitio.' -redirect_from: - - /articles/creating-a-github-pages-site-with-the-jekyll-theme-chooser - - /articles/adding-a-jekyll-theme-to-your-github-pages-site-with-the-jekyll-theme-chooser - - /articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser - - /github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser -product: '{% data reusables.gated-features.pages %}' -versions: - fpt: '*' - ghec: '*' -topics: - - Pages -shortTitle: Agregar un tema al sitio de Páginas -permissions: 'People with admin permissions for a repository can use the theme chooser to add a theme to a {% data variables.product.prodname_pages %} site.' ---- - -## Acerca del selector de temas - -{% ifversion pages-custom-workflow %} - -{% note %} - -**Nota**: El selector de tema de Jekyll no es compatible para los sitios de {% data variables.product.prodname_pages %} que se publican con un flujo de trabajo de {% data variables.product.prodname_actions %} personalizado. Si compilas tu sitio con Jekyll y lo publicas con un flujo de trabajo de {% data variables.product.prodname_actions %} personalizado, puedes agregar un tema editando el archivo `_config.yml`. Para obtener más información, consulta "[Agregar un tema a tu sitio de GitHub Pages con Jekyll](/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll)". - -{% endnote %} - -{% endif %} - -El selector de temas agrega un tema de Jekyll a tu repositorio. Para obtener más información acerca de Jekyll, consulta "[Acerca de las {% data variables.product.prodname_pages %} y Jekyll](/articles/about-github-pages-and-jekyll)". - -La forma en que funciona el selector de temas depende de si tu repositorio es público o privado. - - Si las {% data variables.product.prodname_pages %} ya están habilitadas para tu repositorio, el selector de temas agregará tu tema a la fuente de publicación actual. - - Si tu repositorio es público y {% data variables.product.prodname_pages %} se encuentra inhabilitado para éste, mediante el selector de temas podrás habilitar {% data variables.product.prodname_pages %} y configurar la rama predeterminada como tu fuente de publicación. - - Si tu repositorio es público, y las {% data variables.product.prodname_pages %} están inhabilitadas para tu repositorio, debes habilitar las {% data variables.product.prodname_pages %} configurando una fuente de publicación antes de poder usar el selector de temas. - -Para obtener más información acerca de las fuentes de publicación, consulta "[Acerca de las {% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)". - -Si antes agregaste manualmente un tema de Jekyll a tu repositorio, puede que esos archivos se apliquen incluso después de que uses el selector de temas. Para evitar conflictos, elimina todas las carpetas y archivos de temas agregados manualmente antes de usar el selector de temas. Para obtener más información, consulta "[Agregar un tema a tu sitio de {% data variables.product.prodname_pages %} con Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)". - -## Agregar un tema con el selector de temas - -{% data reusables.pages.navigate-site-repo %} -{% data reusables.repositories.sidebar-settings %} -{% data reusables.pages.sidebar-pages %} -3. Debajo de "{% data variables.product.prodname_pages %}", haz clic en **Choose a theme** (Elegir un tema) o **Change theme** (Cambiar tema). ![Elija un botón del tema](/assets/images/help/pages/choose-a-theme.png) -4. Para elegir un tema, haz clic en el tema que quieras y luego haz clic en **Select theme** (Seleccionar tema). ![Opciones de temas y botón Select theme (Seleccionar tema)](/assets/images/help/pages/select-theme.png) -5. Puede que se te solicite que edites el archivo *README.md* de tu sitio. - - Para editar el archivo más tarde, haz clic en **Cancel** (Cancelar). ![Enlace de cancelación al editar un archivo](/assets/images/help/pages/cancel-edit.png) - - Para editar el archivo ahora, consulta la sección "[Editar archivos](/repositories/working-with-files/managing-files/editing-files)". - -El tema elegido se aplicará automáticamente a los archivos markdown de tu repositorio. Para aplicar el tema a los archivos HTML de tu repositorio, debes agregar el texto preliminar de YAML que especifica un diseño para cada archivo. Para obtener más información, consulta "[Texto preliminar](https://jekyllrb.com/docs/front-matter/)" en el sitio de Jekyll. - -## Leer más - -- [Temas](https://jekyllrb.com/docs/themes/) en el sitio de Jekyll diff --git a/translations/es-ES/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md b/translations/es-ES/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md index ac69466cb7..48bb45c952 100644 --- a/translations/es-ES/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md +++ b/translations/es-ES/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md @@ -59,9 +59,9 @@ shortTitle: Crear un sitio de GitHub Pages Puedes agregar más páginas a tu sitio creando más archivos nuevos. Cada archivo estará disponible en tu sitio en la misma estructura de directorios que tu fuente de publicación. Por ejemplo, si la fuente de publicación para tu sitio de proyectos es la rama `gh-pages`, y creas un archivo nuevo denominado `/about/contact-us.md` en la rama `gh-pages`, el archivo estará disponible en {% ifversion fpt or ghec %}`https://.github.io//{% else %}`http(s):///pages///{% endif %}about/contact-us.html`. -También puedes agregar un tema para personalizar la apariencia de tu sitio. Para obtener más información, consulta {% ifversion fpt or ghec %}"[Agregar un tema a tu sitio de {% data variables.product.prodname_pages %} con el selector de temas](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser){% else %}"[Agregar un tema a tu sitio de {% data variables.product.prodname_pages %} con Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll){% endif %}". +También puedes agregar un tema para personalizar la apariencia de tu sitio. Para obtener más información, consulta la sección "[Agregar un tema a tu sitio de {% data variables.product.prodname_pages %} utilizando Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)". -Para personalizar aún más tu sitio, puedes usar Jekyll, un generador de sitio estático con soporte integrado para {% data variables.product.prodname_pages %}. Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_pages %} y de Jekyll](/articles/about-github-pages-and-jekyll)". +Para personalizar aún más tu sitio, puedes usar Jekyll, un generador de sitio estático con soporte integrado para {% data variables.product.prodname_pages %}. Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_pages %} y Jekyll](/articles/about-github-pages-and-jekyll)". ## Leer más diff --git a/translations/es-ES/content/pages/getting-started-with-github-pages/index.md b/translations/es-ES/content/pages/getting-started-with-github-pages/index.md index e2f19aaac2..8747764d67 100644 --- a/translations/es-ES/content/pages/getting-started-with-github-pages/index.md +++ b/translations/es-ES/content/pages/getting-started-with-github-pages/index.md @@ -17,7 +17,6 @@ topics: children: - /about-github-pages - /creating-a-github-pages-site - - /adding-a-theme-to-your-github-pages-site-with-the-theme-chooser - /configuring-a-publishing-source-for-your-github-pages-site - /changing-the-visibility-of-your-github-pages-site - /creating-a-custom-404-page-for-your-github-pages-site diff --git a/translations/es-ES/content/pages/index.md b/translations/es-ES/content/pages/index.md index 4327272784..a2128ea31f 100644 --- a/translations/es-ES/content/pages/index.md +++ b/translations/es-ES/content/pages/index.md @@ -12,7 +12,6 @@ featuredLinks: - '{% ifversion fpt or ghec %}/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site{% endif %}' - '{% ifversion ghes or ghae %}/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll{% endif %}' - '{% ifversion ghec %}/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site{% endif %}' - - '{% ifversion fpt %}/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser{% endif %}' - '{% ifversion ghes or ghae %}/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll{% endif %}' popular: - '{% ifversion fpt or ghec %}/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages{% endif %}' diff --git a/translations/es-ES/content/pages/quickstart.md b/translations/es-ES/content/pages/quickstart.md index 501a5ab00b..8577fc1f8e 100644 --- a/translations/es-ES/content/pages/quickstart.md +++ b/translations/es-ES/content/pages/quickstart.md @@ -26,11 +26,12 @@ Esta guía te mostrará cómo crear un sitio de usuario en `username.github.io`. 1. Ingresa `username.github.io` como nombre de repositorio. Reemplaza a `username` con tu nombre de usuario de {% data variables.product.prodname_dotcom %}. Por ejemplo, si tu nombre de usuario es `octocat`, el nombre de repositorio debería ser `octocat.github.io`. ![Campo de nombre de repositorio](/assets/images/help/pages/create-repository-name-pages.png) {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -1. Haz clic en **Elige un tema**. ![Elija un botón del tema](/assets/images/help/pages/choose-theme.png) -2. Se abrirá el selector de temas. Busca en los temas disponibles y luego haz clic en **Seleccionar tema** para seleccionar alguno de ellos. Puedes cambiar tu tema más adelante sin problema, así que, si no estás seguro, solo elige uno para comenzar. ![Opciones de temas y botón Select theme (Seleccionar tema)](/assets/images/help/pages/select-theme.png) -3. Después de que seleccionas un tema, el archivo `README.md` de tu repositorio se abrirá en el editor de archivos. El archivo `README.md` es donde escribirás el contenido de tu sitio. Puedes editar el archivo o mantener el contenido predeterminado por el momento. -4. Cuando terminas de editar el archivo, haz clic en **Confirmar los cambios**. -5. Visita `username.github.io` para ver tu sitio web nuevo. **Nota:** Es posible que tome hasta 20 minutos la publicación de los cambios en tu sitio luego de que subes los cambios a {% data variables.product.product_name %}. +1. Debajo de "Compilación y despliegue", debajo de "Fuente", selecciona **Desplegar desde una rama**. +1. Debajo de "Compilación y despliegue", debajo de "Rama", utiliza los menús desplegables de **Ninguna** o de **Rama** y selecciona una fuente de publicación. + + ![Menú desplegable para seleccionar una fuente de publicación](/assets/images/help/pages/publishing-source-drop-down.png) +1. Opcionalmente, abre el archivo `README.md` de tu repositorio. El archivo `README.md` es donde escribirás el contenido de tu sitio. Puedes editar el archivo o mantener el contenido predeterminado por el momento. +1. Visita `username.github.io` para ver tu sitio web nuevo. **Nota:** Es posible que tome hasta 10 minutos la publicación de los cambios en tu sitio luego de que subes los cambios a {% data variables.product.product_name %}. ## Cambiar el título y la descripción diff --git a/translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md b/translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md index ee586b6c37..63282ba886 100644 --- a/translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md +++ b/translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md @@ -75,9 +75,9 @@ Puedes añadir `site.github` a una publicación o página para añadir cualquier {% data reusables.pages.add-jekyll-theme %} Para obtenerr más información, consulta "[Temas](https://jekyllrb.com/docs/themes/)" en la documentación de Jekyll. {% ifversion fpt or ghec %} -Puedes agregar un tema soportado a tu sitio en {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta "[Temas soportados](https://pages.github.com/themes/)" en el sitio {% data variables.product.prodname_pages %} y "[Agregar un tema a tu sitio de {% data variables.product.prodname_pages %} con el selector de temas](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser)." +Puedes agregar un tema soportado a tu sitio en {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta la sección "[Temas compatibles](https://pages.github.com/themes/)" en el sitio de {% data variables.product.prodname_pages %} y [Agregar un tema a tu sitio de {% data variables.product.prodname_pages %} utilizando Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll). -Para utilizar cualquier otro tema de código abierto de Jekyll en {% data variables.product.prodname_dotcom %}, puedes agregarlo manualmente.{% else %} Puedes agregar un tema a tu sitio manualmente.{% endif %} Para obtener más información, consulta los {% ifversion fpt or ghec %} [temas hospedados en {% data variables.product.prodname_dotcom %}](https://github.com/topics/jekyll-theme) y los{% else %} "[temas compatibles](https://pages.github.com/themes/)" en el sitio de {% data variables.product.prodname_pages %} y la sección {% endif %} "[Agregar un tema a tu sitio de {% data variables.product.prodname_pages %} utilizando Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)". +Para utilizar cualquier otro tema de código abierto de Jekyll hospedado en {% data variables.product.prodname_dotcom %}, puedes agregarlo manualmente.{% else %} Puedes agregar un tema a tu sitio manualmente.{% endif %} Para obtener más información, consulta la sección{% ifversion fpt or ghec %} [temas hospedados en {% data variables.product.prodname_dotcom %}](https://github.com/topics/jekyll-theme) y {% else %} "[Temas compatibles](https://pages.github.com/themes/)" en el sitio de {% data variables.product.prodname_pages %} y{% endif %} "[Agergar un tema a tu sitio de {% data variables.product.prodname_pages %} utilziando Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)". Puedes sobrescribir cualquiera de los valores por defecto de tu tema editando los archivos del tema. Para obtener más información, consulta la documentación de tu tema y "[Sobrescribir los valores predeterminados del tema](https://jekyllrb.com/docs/themes/#overriding-theme-defaults)" en la documentación de Jekyll. diff --git a/translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md b/translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md index 9e84172aa2..8579be29e2 100644 --- a/translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md +++ b/translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md @@ -26,7 +26,7 @@ shortTitle: Jekyll build errors for Pages {% note %} -**Note:** It can take up to 20 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}. +**Note:** It can take up to 10 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}. {% endnote %} diff --git a/translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md b/translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md index 0048e68c58..19bdb7e143 100644 --- a/translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md +++ b/translations/es-ES/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md @@ -6,6 +6,7 @@ redirect_from: - /articles/adding-a-jekyll-theme-to-your-github-pages-site - /articles/adding-a-theme-to-your-github-pages-site-using-jekyll - /github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-using-jekyll + - /pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser product: '{% data reusables.gated-features.pages %}' versions: fpt: '*' diff --git a/translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md b/translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md index ae796d2654..b491c6f510 100644 --- a/translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md +++ b/translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md @@ -27,7 +27,7 @@ redirect_from: 1. En la lista de "Solicitudes de cambios", haz clic en la solicitud de cambios que te gustaría agregar a una cola de fusión. 1. Haz clic en **Fusionar cuando esté lista** para agregar la solicitud de cambios a la cola de fusión. Como alternativa, si eres un administrador, puedes: - - Directly merge the pull request by checking **Merge without waiting for requirements to be met ({% ifversion bypass-branch-protections %}bypass branch protections{% else %}administrators only{% endif %})**, if allowed by branch protection settings, and follow the standard flow. ![Fusionar las opciones de la cola](/assets/images/help/pull_requests/merge-queue-options.png) + - Fusiona la solicitud de cambios directamente seleccionando **Fusionar sin esperar que se cumplan los requisitos ({% ifversion bypass-branch-protections %}omitir protecciones de rama{% else %}solo administradores{% endif %})**, si es que lo permiten los ajustes de protección de rama y sigue el flujo estándar. ![Fusionar las opciones de la cola](/assets/images/help/pull_requests/merge-queue-options.png) {% tip %} diff --git a/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md b/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md index 4ad2640d83..8ed6b48817 100644 --- a/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md +++ b/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md @@ -15,7 +15,7 @@ shortTitle: Configure commit merging {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -1. Under {% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-6069 %}"Pull Requests"{% else %}"Merge button"{% endif %}, select **Allow merge commits**. This allows contributors to merge a pull request with a full history of commits.{% ifversion default-merge-squash-commit-message %} ![Screenshot of Pull Request settings with allow merge commits checkbox emphasized](/assets/images/help/repository/allow-merge-commits.png){% endif %}{% ifversion ghes = 3.6 %} ![Screenshot of Pull Request settings with allow merge commits checkbox emphasized](/assets/images/help/repository/allow-merge-commits-no-dropdown.png){% endif %} +1. Under {% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-6069 %}"Pull Requests"{% else %}"Merge button"{% endif %}, select **Allow merge commits**. Esto permite que los contribuyentes fusionen una solicitud de cambios con un historial completo de confirmaciones.{% ifversion default-merge-squash-commit-message %} ![Screenshot of Pull Request settings with allow merge commits checkbox emphasized](/assets/images/help/repository/allow-merge-commits.png){% endif %}{% ifversion ghes = 3.6 %} ![Screenshot of Pull Request settings with allow merge commits checkbox emphasized](/assets/images/help/repository/allow-merge-commits-no-dropdown.png){% endif %} {% ifversion ghes < 3.6 %} ![allow_standard_merge_commits](/assets/images/help/repository/pr-merge-full-commits.png){% endif %} {% ifversion default-merge-squash-commit-message %} diff --git a/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md b/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md index 172229296f..77efab237f 100644 --- a/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md +++ b/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md @@ -21,7 +21,7 @@ shortTitle: Configurar el rebase de confirmaciones {% data reusables.repositories.sidebar-settings %} 3. Debajo de {% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-6069 %}"Solicitudes de cambios"{% else %}"Botón de fusión"{% endif %}, selecciona **Permitir la fusión por rebase**. Esto permite que los colaboradores fusionen una solicitud de extracción al rebasar sus confirmaciones individuales en la rama base. {% ifversion default-merge-squash-commit-message %} - ![Screenshot of Pull Request settings with allow rebase merging checkbox emphasized](/assets/images/help/repository/allow-rebase-merging.png){% endif %}{% ifversion ghes = 3.6 %} ![Screenshot of Pull Request settings with allow rebase merging checkbox emphasized](/assets/images/help/repository/allow-rebase-merging-no-dropdown.png){% endif %} + ![Captura de pantalla de los ajustes de una solicitud de cambios con énfasis en la casilla de verificación de permitir fusión por rebase](/assets/images/help/repository/allow-rebase-merging.png){% endif %}{% ifversion ghes = 3.6 %} ![Screenshot of Pull Request settings with allow rebase merging checkbox emphasized](/assets/images/help/repository/allow-rebase-merging-no-dropdown.png){% endif %} {% ifversion ghes < 3.6 %} ![Confirmaciones de rebase de solicitudes de extracción](/assets/images/help/repository/pr-merge-rebase.png){% endif %} diff --git a/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md b/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md index c331fbc244..8d06909dd2 100644 --- a/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md +++ b/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md @@ -19,7 +19,7 @@ redirect_from: {% data reusables.pull_requests.merge-queue-overview %} -La cola de fusión crea ramas temporales con un prefijo especial para validad cambios de las solicitudes de cambios. The changes in the pull request are then grouped into a `merge_group` with the latest version of the `base_branch` as well as changes ahead of it in the queue. {% data variables.product.product_name %} fusionará todos estos cambios en la `base_branch` una vez que pasen las verificaciones que requieren las protecciones de rama de la `base_branch`. +La cola de fusión crea ramas temporales con un prefijo especial para validad cambios de las solicitudes de cambios. Los cambios en la solicitud de cambios se agrupan entonces en `merge_group` con la última versión de `base_branch` así como los cambios frente a esta en la cola. {% data variables.product.product_name %} fusionará todos estos cambios en la `base_branch` una vez que pasen las verificaciones que requieren las protecciones de rama de la `base_branch`. Para obtener más información acerca de los métodos de fusión, consulta "[Acerca de la fusión de solicitudes de extracción](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)." @@ -34,11 +34,11 @@ Para obtener más información acerca de los métodos de fusión, consulta "[Ace {% data reusables.pull_requests.merge-queue-reject %} -### Triggering merge group checks with {% data variables.product.prodname_actions %} +### Activar las verificaciones de grupo de fusión con {% data variables.product.prodname_actions %} -You can use the `merge_group` event to trigger your {% data variables.product.prodname_actions %} workflow when a pull request is added to a merge queue. Note that this is a different event from the `pull_request` and `push` events. +Puedes utilizar el evento `merge_group` para activar tu flujo de trabajo de {% data variables.product.prodname_actions %} cuando se agrega una solicitud de cambios a una cola de fusión. Toma en cuenta que este es un evento diferente de los de `pull_request` y `push`. -A workflow that reports a check which is required by the target branch's protections would look like this: +Un flujo de trabajo que reporta una verificación requerida por las protecciones de la rama destino se vería así: ```yaml on: @@ -46,9 +46,9 @@ on: merge_group: ``` -For more information see "[Events that trigger workflows](/actions/using-workflows/events-that-trigger-workflows#merge-group)" +Para obtener más información, consulta la sección "[Eventos que activan flujos de trabajo](/actions/using-workflows/events-that-trigger-workflows#merge-group)" -### Triggering merge group checks with other CI providers +### Activar las verificaciones del grupo de fusión con otros proveedores de IC Con otros proveedores de IC, podrías necesitar actualizar tu configuración de IC para que se ejecute cuando se cree una rama que comienza con el prefijo especial `gh-readonly-queue/{base_branch}`. diff --git a/translations/es-ES/content/rest/actions/permissions.md b/translations/es-ES/content/rest/actions/permissions.md index 9b62bcbf84..80569d139e 100644 --- a/translations/es-ES/content/rest/actions/permissions.md +++ b/translations/es-ES/content/rest/actions/permissions.md @@ -2,7 +2,7 @@ title: GitHub Actions Permissions allowTitleToDifferFromFilename: true shortTitle: Permisos -intro: 'The {% data variables.product.prodname_actions %} Permissions API allows you to set permissions for what enterprises, organizations, and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} are allowed to run.' +intro: 'La API de permisos de {% data variables.product.prodname_actions %} te permite configurar los permisos para cuáles empresas, organizaciones y repositorios pueden ejecutar {% data variables.product.prodname_actions %} y qué acciones{% ifversion actions-workflow-policy %} y flujos de trabajo reutilizables{% endif %} pueden ejecutarse.' topics: - API versions: diff --git a/translations/es-ES/content/rest/actions/self-hosted-runners.md b/translations/es-ES/content/rest/actions/self-hosted-runners.md index c1564250a3..53b9bc0019 100644 --- a/translations/es-ES/content/rest/actions/self-hosted-runners.md +++ b/translations/es-ES/content/rest/actions/self-hosted-runners.md @@ -11,7 +11,7 @@ versions: --- -## About the Self-hosted runners API +## Acerca de la API de ejecutores auto-hospedados La API de ejecutores auto-hospedados te permite registrar, ver y borrar a los ejecutores auto-hospedados. {% data reusables.actions.about-self-hosted-runners %} Para obtener más información, consulta "[Alojar tus propios ejecutores](/actions/hosting-your-own-runners)". diff --git a/translations/es-ES/content/rest/actions/workflow-jobs.md b/translations/es-ES/content/rest/actions/workflow-jobs.md index 42ef772cb9..b7679ff11b 100644 --- a/translations/es-ES/content/rest/actions/workflow-jobs.md +++ b/translations/es-ES/content/rest/actions/workflow-jobs.md @@ -10,8 +10,8 @@ versions: ghec: '*' --- -## About the Workflow jobs API +## Acerca de la API de jobs de flujo de trabajo -The Workflow jobs API allows you to view logs and workflow jobs. {% data reusables.actions.about-workflow-jobs %} Para obtener más información, consulta la sección "[Sintaxis de flujode trabajo para GitHub Actions](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions)". +La API de jobs de flujo de trabajo te permite ver bitácoras y jobs de flujo de trabajo. {% data reusables.actions.about-workflow-jobs %} Para obtener más información, consulta la sección "[Sintaxis de flujode trabajo para GitHub Actions](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions)". {% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} diff --git a/translations/es-ES/content/rest/actions/workflow-runs.md b/translations/es-ES/content/rest/actions/workflow-runs.md index 1bd63a9ca9..77f3b2dcb7 100644 --- a/translations/es-ES/content/rest/actions/workflow-runs.md +++ b/translations/es-ES/content/rest/actions/workflow-runs.md @@ -10,7 +10,7 @@ versions: ghec: '*' --- -## About the Workflow runs API +## Acerca de la API de ejecuciones de flujo de trabajo La API de ejecuciones de flujo de trabajo te permite ver, volver a ejecutar, cancelar y ver las bitácoras de las ejecuciones de los flujos de trabajo. {% data reusables.actions.about-workflow-runs %} Para obtener más información, consulta la sección "[Administrar una ejecución de flujo de trabajo](/actions/automating-your-workflow-with-github-actions/managing-a-workflow-run)". diff --git a/translations/es-ES/content/rest/activity/feeds.md b/translations/es-ES/content/rest/activity/feeds.md index dc6ff2a4ff..b1e7c8de91 100644 --- a/translations/es-ES/content/rest/activity/feeds.md +++ b/translations/es-ES/content/rest/activity/feeds.md @@ -11,9 +11,9 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Feeds API +## Acerca de la API de fuentes -To see what feeds are available to you, use the [Get feeds](#get-feeds) operation. You can then get a feed by sending a request to one of the feed URLs. +Para ver qué fuentes están disponibles para ti, utiliza la operación [Obtener fuentes](#get-feeds). Entonces, podrás obtener una fuente enviando una solicitud a una de las URL de fuentes. ### Ejemplo de obtención de un canal de Atom diff --git a/translations/es-ES/content/rest/activity/notifications.md b/translations/es-ES/content/rest/activity/notifications.md index de88cb71bf..c9a8a99f45 100644 --- a/translations/es-ES/content/rest/activity/notifications.md +++ b/translations/es-ES/content/rest/activity/notifications.md @@ -11,7 +11,7 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Notifications API +## Acerca de la API de notificaciones La API de notificaciones te permite administrar las notificaciones de {% data variables.product.product_name %}. Para obtener más información sobre las notificaciones, consulta la sección "[Acerca de las notificaciones](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)". diff --git a/translations/es-ES/content/rest/activity/watching.md b/translations/es-ES/content/rest/activity/watching.md index c3b3c5bece..63b7ee160f 100644 --- a/translations/es-ES/content/rest/activity/watching.md +++ b/translations/es-ES/content/rest/activity/watching.md @@ -11,6 +11,6 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Watching API +## Acerca de la API de observar -La API de observados permite que los usuarios se suscriban a las notificaciones de la actividad de un repositorio. To bookmark a repository instead, see "[Starring](/rest/reference/activity#starring)." +La API de observados permite que los usuarios se suscriban a las notificaciones de la actividad de un repositorio. Para marcar un repositorio como favorito, en su lugar, utiliza "[Estrellas](/rest/reference/activity#starring)". diff --git a/translations/es-ES/content/rest/apps/apps.md b/translations/es-ES/content/rest/apps/apps.md index 40ee60bdb7..0e4b884b5b 100644 --- a/translations/es-ES/content/rest/apps/apps.md +++ b/translations/es-ES/content/rest/apps/apps.md @@ -1,7 +1,7 @@ --- title: GitHub Apps allowTitleToDifferFromFilename: true -intro: 'The {% data variables.product.prodname_github_apps %} API enables you to retrieve information about {% data variables.product.prodname_github_apps %}.' +intro: 'La API de {% data variables.product.prodname_github_apps %} te permite recuperar información sobre las {% data variables.product.prodname_github_apps %}.' topics: - API miniTocMaxHeadingLevel: 3 @@ -12,7 +12,7 @@ versions: ghec: '*' --- -## About the {% data variables.product.prodname_github_apps %} API +## Acerca de la API de {% data variables.product.prodname_github_apps %} {% data reusables.apps.general-apps-restrictions %} @@ -20,6 +20,6 @@ Esta página lista las terminales a las que puedes acceder mientras te autentica Cuando estás autenticado como una GitHub App, la API de GitHub Apps te habilita para obtener información de alto nivel sobre una GitHub App así como para obtener información específica sobre las instalaciones de éstas. -You can access REST API endpoints while authenticated as a GitHub App. These endpoints have text that says "Works with GitHub Apps." También puedes acceder a estas terminales mientras estás autenticado como un usuario. +Puedes acceder a las terminales de la API de REST mientras estás autenticado como una GitHub App. Estas terminales tienen un texto que dice "Funciona con GitHub Apps". También puedes acceder a estas terminales mientras estás autenticado como un usuario. -A subset of REST API endpoints requires authenticating as a GitHub App installation. Consulta las [Instalaciones](/rest/reference/apps#installations) para obtener una lista de estas terminales. +Un subconjunto de terminales de la API de REST requiere autenticarse como una instalación de GitHub App. Consulta las [Instalaciones](/rest/reference/apps#installations) para obtener una lista de estas terminales. diff --git a/translations/es-ES/content/rest/apps/oauth-applications.md b/translations/es-ES/content/rest/apps/oauth-applications.md index 406e67d4ce..a6b28a1c26 100644 --- a/translations/es-ES/content/rest/apps/oauth-applications.md +++ b/translations/es-ES/content/rest/apps/oauth-applications.md @@ -12,6 +12,6 @@ versions: ghec: '*' --- -## About the {% data variables.product.prodname_oauth_app %} API +## Acerca de la API de {% data variables.product.prodname_oauth_app %} -You can use this API to manage the OAuth tokens an {% data variables.product.prodname_oauth_app %} uses to access people's accounts on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. +Puedes utilizar esta API para administrar los tokens de OAuth que utiliza una {% data variables.product.prodname_oauth_app %} para acceder a las cuentas de las personas en {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. diff --git a/translations/es-ES/content/rest/apps/webhooks.md b/translations/es-ES/content/rest/apps/webhooks.md index 6967cc2fc8..b74e6abe52 100644 --- a/translations/es-ES/content/rest/apps/webhooks.md +++ b/translations/es-ES/content/rest/apps/webhooks.md @@ -1,5 +1,5 @@ --- -title: GitHub App webhooks +title: Webhooks de las GitHub Apps allowTitleToDifferFromFilename: true shortTitle: Webhooks intro: '' @@ -13,6 +13,6 @@ versions: ghec: '*' --- -## About the {% data variables.product.prodname_github_app %} webhooks API +## Acerca de la API de webhooks de {% data variables.product.prodname_github_app %} Un webhook de {% data variables.product.prodname_github_app %} te permite recibir cargas útiles de `POST` por HTTP cada que sucedan ciertos eventos para una app. {% data reusables.webhooks.webhooks-rest-api-links %} diff --git a/translations/es-ES/content/rest/branches/branches.md b/translations/es-ES/content/rest/branches/branches.md index 622c8440a3..073d1e4b05 100644 --- a/translations/es-ES/content/rest/branches/branches.md +++ b/translations/es-ES/content/rest/branches/branches.md @@ -1,6 +1,6 @@ --- title: Ramas -intro: The Branches API allows you to modify branches and their protection settings. +intro: La API de ramas te permite modificar ramas y sus ajustes de protección. versions: fpt: '*' ghes: '*' diff --git a/translations/es-ES/content/rest/code-scanning.md b/translations/es-ES/content/rest/code-scanning.md index 5894ec505c..8d7a3bf1f8 100644 --- a/translations/es-ES/content/rest/code-scanning.md +++ b/translations/es-ES/content/rest/code-scanning.md @@ -1,5 +1,5 @@ --- -title: Code Scanning +title: Escaneo de código intro: 'La API del {% data variables.product.prodname_code_scanning %} te permite recuperar y actualizar las alertas del {% data variables.product.prodname_code_scanning %} desde un repositorio.' versions: fpt: '*' @@ -17,7 +17,7 @@ redirect_from: {% data reusables.code-scanning.beta %} -## About the Code scanning API +## Acerca de la API de escaneo de código La API del {% data variables.product.prodname_code_scanning %} te permite recuperar y actualizar las alertas del {% data variables.product.prodname_code_scanning %} desde un repositorio. Puedes utilizar las terminales para crear reportes automatizados para las alertas del {% data variables.product.prodname_code_scanning %} en una organización o cargar resutlados de análisis que se hayan generado utilizando con herramientas fuera de línea del {% data variables.product.prodname_code_scanning %}. Para obtener más información, consulta la sección "[Encontrar vulnerabilidades de seguridad y errores en tu código](/github/finding-security-vulnerabilities-and-errors-in-your-code)". diff --git a/translations/es-ES/content/rest/codespaces/machines.md b/translations/es-ES/content/rest/codespaces/machines.md index d784ea4430..8606f3b923 100644 --- a/translations/es-ES/content/rest/codespaces/machines.md +++ b/translations/es-ES/content/rest/codespaces/machines.md @@ -1,5 +1,5 @@ --- -title: Codespaces machines +title: Máquinas de codespaces allowTitleToDifferFromFilename: true shortTitle: Máquinas intro: 'La API de máquinas de codespaces permite que un usuario determine qué tipos de máquina están disponibles para crear un codespace, ya sea en un repositorio específico o como un usuario autenticado.' @@ -11,7 +11,7 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Codespaces machines API +## Acerca de la API de máquinas de Codespaces La API de máquinas de codespaces permite que un usuario determine qué tipos de máquina están disponibles para crear un codespace, ya sea en un repositorio específico o como un usuario autenticado. Para obtener más información, consulta la sección "[Acerca de los tipos de máquina](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace#about-machine-types)". diff --git a/translations/es-ES/content/rest/collaborators/collaborators.md b/translations/es-ES/content/rest/collaborators/collaborators.md index 8d7ab7ceea..c8081f76c0 100644 --- a/translations/es-ES/content/rest/collaborators/collaborators.md +++ b/translations/es-ES/content/rest/collaborators/collaborators.md @@ -1,6 +1,6 @@ --- title: Colaboradores -intro: The Collaborators API allows you manage collaborators for a repository. +intro: La API de colaboradores te permite administrar colaboradores para un repositorio. versions: fpt: '*' ghes: '*' diff --git a/translations/es-ES/content/rest/collaborators/invitations.md b/translations/es-ES/content/rest/collaborators/invitations.md index c31fc85b4b..a2ed44ed21 100644 --- a/translations/es-ES/content/rest/collaborators/invitations.md +++ b/translations/es-ES/content/rest/collaborators/invitations.md @@ -1,5 +1,5 @@ --- -title: Repository invitations +title: Invitaciones al repositorio allowTitleToDifferFromFilename: true shortTitle: Invitaciones intro: La API de invitaciones al repositorio te permite ver y administrar las invitaciones para colaborar en un repositorio. @@ -13,10 +13,10 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Repository invitations API +## Acerca de la API de invitaciones al repositorio La API de invitaciones al repositorio te permite ver y administrar las invitaciones para colaborar en un repositorio. Los usuarios invitados (o los servicios externos en nombre de estos) pueden elegir aceptar o rechazar la invitación. -To add a user as a collaborator, use the Collaborators API instead. Para obtener más información, consulta la sección "[Agregar un colaborador del repositorio](/rest/collaborators/collaborators#add-a-repository-collaborator)". +Para agregar a un usuario como colaborador, utiliza la API de colaboradores en su lugar. Para obtener más información, consulta la sección "[Agregar un colaborador del repositorio](/rest/collaborators/collaborators#add-a-repository-collaborator)". Toma en cuenta que el [alcance de OAuth](/developers/apps/scopes-for-oauth-apps) `repo:invite` otorga un acceso dirigido a las invitaciones **sin** otorgar también el acceso al código del repositorio, mientras que el alcance `repo` otorga permisos para el código así como para las invitaciones. diff --git a/translations/es-ES/content/rest/commits/comments.md b/translations/es-ES/content/rest/commits/comments.md index 26d7d26c8f..ec773b1c7a 100644 --- a/translations/es-ES/content/rest/commits/comments.md +++ b/translations/es-ES/content/rest/commits/comments.md @@ -12,7 +12,7 @@ miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true --- -## About the commit comments API +## Acerca de la API de comentarios de confirmaciones La API de comentarios de confirmaciones te permite crear y editar los comentarios que se relacionan con confirmaciones específicas. diff --git a/translations/es-ES/content/rest/commits/commits.md b/translations/es-ES/content/rest/commits/commits.md index fc29bbf412..4406a46536 100644 --- a/translations/es-ES/content/rest/commits/commits.md +++ b/translations/es-ES/content/rest/commits/commits.md @@ -1,6 +1,6 @@ --- title: Confirmaciones -intro: 'The Commits API allows you to list, view, and compare commits in a repository. También puedes interactuar con los comentarios y estados de las confirmaciones.' +intro: 'La API de confirmaciones te permite listar, ver y comparar las confirmaciones de un repositorio. También puedes interactuar con los comentarios y estados de las confirmaciones.' versions: fpt: '*' ghes: '*' diff --git a/translations/es-ES/content/rest/commits/statuses.md b/translations/es-ES/content/rest/commits/statuses.md index ba2ecf3b71..02177927a5 100644 --- a/translations/es-ES/content/rest/commits/statuses.md +++ b/translations/es-ES/content/rest/commits/statuses.md @@ -1,6 +1,6 @@ --- title: Estados de confirmación -intro: 'The Commit status API allows external services to mark commits with a status, which is then reflected in pull requests involving those commits.' +intro: 'La API de estados de las confirmaciones permite que los servicios externos marquen las confirmaciones con estados, lo que se refleja posteriormente en las solicitudes de cambio que involucran dichas confirmaciones.' versions: fpt: '*' ghes: '*' @@ -12,13 +12,13 @@ miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true --- -## About the Commit statuses API +## Acerca de la API de estados de las confirmaciones -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. +La API de estados de confirmaciones permite que los servicios externos marquen las confirmaciones con un estado de `error`, `failure`, `pending` o `success`, lo que se refleja entonces en las solicitudes de cambios que involucran a dichas confirmaciones. Los estados también pueden incluir una `description` y `target_url` opcionales y recomendamos ampliamente proporcionarlas, ya que hacen que los estados sean mucho más útiles en la IU de GitHub. -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. +Como ejemplo, un uso común es que los servicios de integración continua marquen las confirmaciones como compilaciones que pasan o fallan utilizando los estados. La `target_url` será la URL completa para la salida de la compilación y la `description` será el resumen de alto nivel de lo que pasó con la compilación. -Los estados pueden incluir un `context` para indicar qué servicio está proporcionando ese estado. Por ejemplo, puedes hacer que tu servicio de integración continua cargue estados con un contexto de `ci`, y que una herramienta de auditoria de seguridad cargue estados con un contexto de `security`. You can then use the [Get the combined status for a specific reference](/rest/reference/commits#get-the-combined-status-for-a-specific-reference) to retrieve the whole status for a commit. +Los estados pueden incluir un `context` para indicar qué servicio está proporcionando ese estado. Por ejemplo, puedes hacer que tu servicio de integración continua cargue estados con un contexto de `ci`, y que una herramienta de auditoria de seguridad cargue estados con un contexto de `security`. Puedes utilizar entonces la función de [Obtener el estado combinado para una referencia específica](/rest/reference/commits#get-the-combined-status-for-a-specific-reference) para recuperar todo el estado de una confirmación. Toma en cuenta que el [alcance de OAuth](/developers/apps/scopes-for-oauth-apps) de `repo:status` otorga acceso dirigido a los estados **sin** otorgar también el acceso al código del repositorio, mientras que el alcance `repo` otorga permisos para el código y también para los estados. diff --git a/translations/es-ES/content/rest/dependabot/secrets.md b/translations/es-ES/content/rest/dependabot/secrets.md index ce89fb3d75..cb324aeb93 100644 --- a/translations/es-ES/content/rest/dependabot/secrets.md +++ b/translations/es-ES/content/rest/dependabot/secrets.md @@ -1,7 +1,7 @@ --- -title: Dependabot secrets +title: Secretos del Dependabot shortTitle: Secretos -intro: 'With the {% data variables.product.prodname_dependabot %} secrets API, you can manage and control {% data variables.product.prodname_dependabot %} secrets for an organization or repository.' +intro: 'Con la API de secretos del {% data variables.product.prodname_dependabot %}, puedes administrar y controlar los secretos del {% data variables.product.prodname_dependabot %} de una organización o repositorio.' topics: - API versions: @@ -11,8 +11,8 @@ versions: allowTitleToDifferFromFilename: true --- -## About the {% data variables.product.prodname_dependabot %} secrets API +## Acerca de la API de secretos del {% data variables.product.prodname_dependabot %} -The {% data variables.product.prodname_dependabot %} secrets API lets you create, update, delete, and retrieve information about encrypted secrets. {% data reusables.actions.about-secrets %} Para obtener más información, consulta "[Administrar los secretos cifrados para el Dependabot](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot)". +La API de secretos del {% data variables.product.prodname_dependabot %} te permite crear, actualizar, borrar y recuperar información sobre los secretos cifrados. {% data reusables.actions.about-secrets %} Para obtener más información, consulta "[Administrar los secretos cifrados para el Dependabot](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot)". -{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `dependabot_secrets` permission to use this API. Los usuarios autenticados deben tener acceso de colaborador en el repositorio para crear, actualizar o leer los secretos. +La {% data reusables.actions.actions-authentication %} en las {% data variables.product.prodname_github_apps %} debe contar con el permiso de `dependabot_secrets` para utilizar esta API. Los usuarios autenticados deben tener acceso de colaborador en el repositorio para crear, actualizar o leer los secretos. diff --git a/translations/es-ES/content/rest/dependency-graph/dependency-review.md b/translations/es-ES/content/rest/dependency-graph/dependency-review.md index c9602dc122..be53ce4da1 100644 --- a/translations/es-ES/content/rest/dependency-graph/dependency-review.md +++ b/translations/es-ES/content/rest/dependency-graph/dependency-review.md @@ -1,6 +1,6 @@ --- title: Revisión de dependencias -intro: 'The Dependency review API allows you to understand dependency changes, and the security impact of these changes, before you add them to your environment.' +intro: La API de revisión de dependencias te permite entender los cambios a las dependencias y el impacto de seguridad de dichos cambios antes de que los agregues a tu ambiente. versions: fpt: '*' ghes: '>=3.6' @@ -12,8 +12,8 @@ miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true --- -## About the Dependency review API +## Acerca de la API de revisión de dependencias {% data reusables.dependency-review.dependency-review-api-beta-note %} -La API de revisión de dependencias te permite entender los cambios a las dependencias y el impacto de seguridad de estos antes de que los agregues a tu ambiente. You can view the diff of dependencies between two commits of a repository, including vulnerability data for any version updates with known vulnerabilities. Para obtener más información sobre la revisión de dependencias, consulta la sección "[Acerca de la revisión de dependencias](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)". +La API de revisión de dependencias te permite entender los cambios a las dependencias y el impacto de seguridad de estos antes de que los agregues a tu ambiente. Puedes ver el diff de las dependencias entre dos confirmaciones de un repositorio, incluyendo los datos de vulnerabilidades para cualquier actualización de versión con las vulnerabilidades conocidas. Para obtener más información sobre la revisión de dependencias, consulta la sección "[Acerca de la revisión de dependencias](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)". diff --git a/translations/es-ES/content/rest/dependency-graph/index.md b/translations/es-ES/content/rest/dependency-graph/index.md index 8def7f4624..53e715e1b8 100644 --- a/translations/es-ES/content/rest/dependency-graph/index.md +++ b/translations/es-ES/content/rest/dependency-graph/index.md @@ -1,6 +1,6 @@ --- title: Gráfica de dependencias -intro: 'With the Dependency Graph API, you can view dependency changes and their security impact on your repository.' +intro: 'Con la API de gráfica de dependencias, puedes ver los cambios a las dependencias y su impacto de seguridad en tu repositorio.' versions: fpt: '*' ghes: '>=3.6' diff --git a/translations/es-ES/content/rest/deployments/deployments.md b/translations/es-ES/content/rest/deployments/deployments.md index 6e83072a88..531e552807 100644 --- a/translations/es-ES/content/rest/deployments/deployments.md +++ b/translations/es-ES/content/rest/deployments/deployments.md @@ -19,7 +19,7 @@ Los estados de despliegue permiten que los servicios externos marquen estos desp Los estados de despliegue también incluyen una `description` y una `log_url` opcionales, las cuales se recomiendan ampliamente, ya que hacen que los estados de despliegue sean más útiles. La `log_url` es la URL completa para la salida del despliegue, y la `description` es el resumen de alto nivel de lo que pasó con este despliegue. -GitHub envía eventos de `deployment` y `deployment_status` cuando se crean despliegues y estados de despliegue nuevos. Estos eventos permiten que las integraciones de terceros reciban respuesta de las solicitudes de despliegue y actualizan el estado de un despliegue conforme éste progrese. +GitHub envía eventos de `deployment` y `deployment_status` cuando se crean despliegues y estados de despliegue nuevos. These events allow third-party integrations to receive and respond to deployment requests, and update the status of a deployment as progress is made. Debajo encontrarás un diagrama de secuencia simple que explica cómo funcionarían estas interacciones. diff --git a/translations/es-ES/content/rest/deployments/environments.md b/translations/es-ES/content/rest/deployments/environments.md index 327e07682e..1fa057748e 100644 --- a/translations/es-ES/content/rest/deployments/environments.md +++ b/translations/es-ES/content/rest/deployments/environments.md @@ -1,5 +1,5 @@ --- -title: Deployment environments +title: Ambientes de despliegue allowTitleToDifferFromFilename: true shortTitle: Ambientes intro: 'The Deployment environments API allows you to create, configure, and delete deployment environments.' diff --git a/translations/es-ES/content/rest/deployments/index.md b/translations/es-ES/content/rest/deployments/index.md index 3d0ae0be29..a42a60f38c 100644 --- a/translations/es-ES/content/rest/deployments/index.md +++ b/translations/es-ES/content/rest/deployments/index.md @@ -1,6 +1,6 @@ --- title: Implementaciones -intro: 'The deployments API allows you to create and delete deploy keys, deployments, and deployment environments.' +intro: 'La API de despliegues te permite crear y borrar llaves de despliegue, despliegues y ambientes de despliegue.' allowTitleToDifferFromFilename: true versions: fpt: '*' diff --git a/translations/es-ES/content/rest/enterprise-admin/announcement.md b/translations/es-ES/content/rest/enterprise-admin/announcement.md index 1ef49c0939..b0c0da8f8f 100644 --- a/translations/es-ES/content/rest/enterprise-admin/announcement.md +++ b/translations/es-ES/content/rest/enterprise-admin/announcement.md @@ -1,6 +1,6 @@ --- title: Anuncio -intro: The Announcement API allows you to manage the global announcement banner in your enterprise. +intro: La API de anuncios te permite administrar el letrero de anuncios globales en tu empresa. versions: ghes: '*' ghae: '*' diff --git a/translations/es-ES/content/rest/enterprise-admin/org-pre-receive-hooks.md b/translations/es-ES/content/rest/enterprise-admin/org-pre-receive-hooks.md index 5630a14282..ad853ad3f9 100644 --- a/translations/es-ES/content/rest/enterprise-admin/org-pre-receive-hooks.md +++ b/translations/es-ES/content/rest/enterprise-admin/org-pre-receive-hooks.md @@ -1,6 +1,6 @@ --- -title: Organization Pre-receive Hooks -intro: The Organization Pre-receive Hooks API allows you to view and modify enforcement of the pre-receive hooks that are available to an organization. +title: Ganchos de pre-recepción de organización +intro: La API de ganchos de pre-recepción de organización te permite ver y modificar el requisito de tener ganchos de pre-recepción que están disponibles para una organización. versions: ghes: '*' topics: @@ -20,4 +20,4 @@ allowTitleToDifferFromFilename: true Los valores posibles para *enforcement* son `enabled`, `disabled` y `testing`. El valor `disabled` indica que el gancho de pre-recepción no se ejecutará. El valor `enabled` indica que se ejecutará y rechazará cualquier carga que resulte en un estado diferente a zero. El valor `testing` indica que el script va a ejecutarse pero no va a causar que se rechace ninguna carga. -`configuration_url` may be a link to this endpoint or this hook's global configuration. Solo los administradores de sistema pueden acceder a la configuración global. +`configuration_url` podría ser un enlace a esta terminal o a la configuración global de este gancho. Solo los administradores de sistema pueden acceder a la configuración global. diff --git a/translations/es-ES/content/rest/enterprise-admin/pre-receive-environments.md b/translations/es-ES/content/rest/enterprise-admin/pre-receive-environments.md index 3adfadbdd5..295b22e3bd 100644 --- a/translations/es-ES/content/rest/enterprise-admin/pre-receive-environments.md +++ b/translations/es-ES/content/rest/enterprise-admin/pre-receive-environments.md @@ -1,5 +1,5 @@ --- -title: Pre-receive Environments +title: Ambientes de pre-recepción intro: 'La API de Ambientes de Pre-recepción te permite crear, listar, actualizar y borrar ambientes para los ganchos de pre-recepción.' versions: ghes: '*' diff --git a/translations/es-ES/content/rest/enterprise-admin/pre-receive-hooks.md b/translations/es-ES/content/rest/enterprise-admin/pre-receive-hooks.md index 32ec6d3ef6..644022b2bb 100644 --- a/translations/es-ES/content/rest/enterprise-admin/pre-receive-hooks.md +++ b/translations/es-ES/content/rest/enterprise-admin/pre-receive-hooks.md @@ -1,5 +1,5 @@ --- -title: Pre-receive Hooks +title: Ganchos de pre-recepción intro: 'La API de Ganchos Pre-recepción te permite crear, listar, actualizar y borrar los ganchos de pre-recepción.' versions: ghes: '*' diff --git a/translations/es-ES/content/rest/gists/gists.md b/translations/es-ES/content/rest/gists/gists.md index 37dd44d715..aab584797f 100644 --- a/translations/es-ES/content/rest/gists/gists.md +++ b/translations/es-ES/content/rest/gists/gists.md @@ -1,6 +1,6 @@ --- title: Gists -intro: 'The Gists API enables the authorized user to list, create, update and delete the public gists on GitHub.' +intro: 'La API de Gists habilita al usuario habilitado para listar, crear, actualizar y borrar los gists públicos en GitHub.' versions: fpt: '*' ghes: '*' @@ -11,9 +11,9 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Gists API +## Acerca de la API de Gists -The Gist API lets you view and modify gists. For more information about gists, see "[Editing and sharing content with gists](/get-started/writing-on-github/editing-and-sharing-content-with-gists)." +La API de Gists te permite ver y modificar los gists. Para obtener más información sobre los gists, consulta la sección "[Editar y compartir el contenido con los gists](/get-started/writing-on-github/editing-and-sharing-content-with-gists)". ### Autenticación diff --git a/translations/es-ES/content/rest/git/blobs.md b/translations/es-ES/content/rest/git/blobs.md index d71ecb60fa..66777ae4f4 100644 --- a/translations/es-ES/content/rest/git/blobs.md +++ b/translations/es-ES/content/rest/git/blobs.md @@ -1,8 +1,8 @@ --- -title: Git blobs +title: Blobs de Git shortTitle: Blobs allowTitleToDifferFromFilename: true -intro: 'The Git blob API lets you create and get a Git blob (binary large object), the object type used to store the contents of each file in a repository.' +intro: 'La API de blobs de Git te permite crear y obtener un blob de Git (BLOB: Objeto binario grande, por sus siglas en inglés), el cual es el tipo de objeto que se utiliza para almacenar el contenido de cada archivo en un repositorio.' versions: fpt: '*' ghes: '*' @@ -13,7 +13,7 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Git blob API +## Acerca de la API de blobs de Git Un blob (objeto binario grande, por sus siglas en inglés) de Git es el tipo de objeto que se utiliza para almacenar el contenido de cada archivo en un repositorio. El hash SHA-1 del archivo se calcula y almacena en el objeto del blob. Estas terminales te permiten leer y escribir [objetos de blob](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects) en tu base de datos de Git en {% data variables.product.product_name %}. Los blobs aprovechan [estos tipos de medios personalizados](#custom-media-types-for-blobs). Puedes leer más acerca del uso de tipos de medios en la API [aquí](/rest/overview/media-types). diff --git a/translations/es-ES/content/rest/git/tags.md b/translations/es-ES/content/rest/git/tags.md index 23b43248c7..ed8159a146 100644 --- a/translations/es-ES/content/rest/git/tags.md +++ b/translations/es-ES/content/rest/git/tags.md @@ -1,5 +1,5 @@ --- -title: Git tags +title: Etiquetas de Git shortTitle: Etiquetas allowTitleToDifferFromFilename: true intro: 'The Git tags API lets you read and write tag objects to your Git database on {% data variables.product.product_name %}.' diff --git a/translations/es-ES/content/rest/gitignore.md b/translations/es-ES/content/rest/gitignore.md index b8eeb69e0f..1932f57825 100644 --- a/translations/es-ES/content/rest/gitignore.md +++ b/translations/es-ES/content/rest/gitignore.md @@ -13,7 +13,7 @@ redirect_from: - /rest/reference/gitignore --- -## About the Gitignore API +## Acerca de la API de Gitignore Cuando creas un repositorio nuevo en {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} a través de la API, puedes especificar una [plantilla de.gitignore](/github/getting-started-with-github/ignoring-files) para aplicarla al repositorio cuando lo crees. La API de plantillas de .gitignore lista y recupera plantillas del [repositorio de .gitignore](https://github.com/github/gitignore) de {% data variables.product.product_name %}. diff --git a/translations/es-ES/content/rest/guides/getting-started-with-the-checks-api.md b/translations/es-ES/content/rest/guides/getting-started-with-the-checks-api.md index ae540963c2..7c7f888e7c 100644 --- a/translations/es-ES/content/rest/guides/getting-started-with-the-checks-api.md +++ b/translations/es-ES/content/rest/guides/getting-started-with-the-checks-api.md @@ -41,7 +41,7 @@ Una ejecución de verificación es una prueba individual que forma parte de una ![Flujo de trabajo de las ejecuciones de verificación](/assets/images/check_runs.png) -Si una ejecución de verificación permanece en un estado incompleto por más de 14 días, entonces la `conclusion` de ésta se convierte en `stale` y aparece en {% data variables.product.prodname_dotcom %} como quedada con el {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Solo {% data variables.product.prodname_dotcom %} puede marcar las ejecuciones de verificación como `stale`. Para obtener más información acerca de las conclusiones posibles para una ejecución de verificación, consulta el [parámetro de `conclusion`](/rest/reference/checks#create-a-check-run--parameters). +If a check run is in an incomplete state for more than 14 days, then the check run's `conclusion` becomes `stale` and appears on {% data variables.product.prodname_dotcom %} as stale with {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Solo {% data variables.product.prodname_dotcom %} puede marcar las ejecuciones de verificación como `stale`. Para obtener más información acerca de las conclusiones posibles para una ejecución de verificación, consulta el [parámetro de `conclusion`](/rest/reference/checks#create-a-check-run--parameters). Puedes crear la ejecución de verificación tan pronto como recibas el webhook de [`check_suite`](/webhooks/event-payloads/#check_suite), aún si ésta todavía no se completa. Puedes actualizar el `status` de la ejecución de verificación ya que se completa con los valores `queued`, `in_progress`, o `completed`, y puedes actualizar la `output` conforme vayan estando disponibles los detalles adicionales. Una ejecución de verificación puede contener estampas de tiempo, un enlace para encontrar más detalles en tu sitio externo, anotaciones detalladas para líneas de código específcas, e información acerca del análisis que se llevó a cabo. diff --git a/translations/es-ES/content/rest/guides/getting-started-with-the-rest-api.md b/translations/es-ES/content/rest/guides/getting-started-with-the-rest-api.md index 3453491ad2..13bfbea29f 100644 --- a/translations/es-ES/content/rest/guides/getting-started-with-the-rest-api.md +++ b/translations/es-ES/content/rest/guides/getting-started-with-the-rest-api.md @@ -1,9 +1,6 @@ --- title: Iniciar con la API de REST -intro: 'Aprende las bases para utilizar la API de REST, comenzando con la autenticación y algunos ejemplos de las terminales.' -redirect_from: - - /guides/getting-started - - /v3/guides/getting-started +intro: 'Aprende cómo utilizar la API de REST de {% data variables.product.prodname_dotcom %}.' versions: fpt: '*' ghes: '*' @@ -11,418 +8,754 @@ versions: ghec: '*' topics: - API -shortTitle: Introducción - API de REST +shortTitle: Utilizar la API +miniTocMaxHeadingLevel: 3 --- +## Acerca de la API de REST de {% data variables.product.prodname_dotcom %} -Vamos a explicar los conceptos centrales de la API mientras incluímos algunos casos de uso cotidiano. +Este artículo describe cómo utilizar la API de REST de {% data variables.product.prodname_dotcom %} usando el {% data variables.product.prodname_cli %}, JavaScript o cURL. Para encontrar una guía de inicio rápido, consulta la "[Guía de inicio rápido para la API de REST de GitHub](/rest/quickstart)". -{% data reusables.rest-api.dotcom-only-guide-note %} +Cuando haces una solicitud a la API de REST, especificarás un método HTTP y una ruta. Adicionalmente, también podrías especificar encabezados de solicitud y parámetros de ruta, consulta o cuerpo. La API devolverá el código de estado de respuesta, los encabezados de respuesta y, potencialmente, un cuerpo de respuesta. -## Resumen +La documentación de referencia de la API de REST describe el método HTTP, ruta y parámetros para cada operación. También muestra solicitudes y respuestas de ejemplo para cada operación. Para obtener más información, consulta la [documentación de referencia de REST](/rest). -La mayoría de las aplicaciones utilizan una [biblioteca de seguridad][wrappers] en el lenguaje de programación que escojas, pero es importante que te familiarices con los métodos HTTP básicos de la API primero. +## Hacer una solicitud -No hay una forma más fácil de hacerlo que a través de [cURL][curl].{% ifversion fpt or ghec %} Si estás utilizando un cliente alternativo, tioma en cuenta que necesitarás enviar un [encabezado de Agente de Usuario](/rest/overview/resources-in-the-rest-api#user-agent-required) válido en tu solicitud.{% endif %} +Para hacer una solicitud, primero encuentra el método HTTP y la ruta para la operación que quieres utilizar. Por ejemplo, la operación "Get Octocat" utiliza el método `GET` y la ruta `/octocat`. Para encontrar la documentación completa para esta operación, consulta "[Get Octocat](/rest/meta#get-octocat)". -### Hola Mundo +{% cli %} -Comencemos por probar nuestra configuración. Abre una instancia de la línea de comandos e ingresa el siguiente comando: +{% note %} + +**Nota**: Debes instalar el {% data variables.product.prodname_cli %} para poder utilizar los comandos en los ejemplos del {% data variables.product.prodname_cli %}. Para encontrar instrucciones de instalación, consulta el [repositorio de {% data variables.product.prodname_cli %}](https://github.com/cli/cli#installation). + +{% endnote %} + +Si aún no estás autenticado en el {% data variables.product.prodname_cli %}, debes utilizar el subcomando `gh auth login` para autenticarte antes de hacer hacer cualquier tipo de solicitud. For more information, see "[Authenticating](#authenticating)." + +Para hacer una solicitud utilizando el {% data variables.product.prodname_cli %}, utiliza el subcomando `api` junto con la ruta. Utiliza el marcador `--method` o `-X` para especificar el método. ```shell -$ curl https://api.github.com/zen - -> Keep it logically awesome. +gh api /octocat --method GET ``` -La respuesta será una selección aleatoria de nuestra filosofía de diseño. +{% endcli %} -Posteriormente, vamos a hacer `GET` para el [perfil de GitHub][users api] de [Chris Wanstrath][defunkt github]: +{% javascript %} + +{% note %} + +**Nota**: Debes instalar e importar `octokit` para utilizar la librería Octokit.js que se utiliza en los ejemplos de JavaScript. Para obtener más información, consulta [el README de Octokit.js](https://github.com/octokit/octokit.js/#readme). + +{% endnote %} + +Para hacer una solicitud utilizando JavaScript, puedes usar Octokit.js. Para obtener más información, consulta [el README de Octokit.js](https://github.com/octokit/octokit.js/#readme). + +Primero, crea una instancia de `Octokit`.{% ifversion ghes or ghae %} Ajusta la URL base en `{% data variables.product.api_url_code %}`. Reemplaza a `[hostname]` con el nombre de {% data variables.product.product_location %}.{% endif %} + +```javascript +const octokit = new Octokit({ {% ifversion ghes or ghae %} + baseUrl: "{% data variables.product.api_url_code %}", +{% endif %}}); +``` + +Luego, utiliza el método `request` para hacer solilcitudes. Pasa el método HTTP y la ruta como el primer argumento. + +```javascript +await octokit.request("GET /octocat", {}); +``` + +{% endjavascript %} + +{% curl %} + +Antepón la URL base para la API de REST de {% data variables.product.prodname_dotcom %}, `{% data variables.product.api_url_code %}`, a la ruta para obtener la URL completa: `{% data variables.product.api_url_code %}/octocat`.{% ifversion ghes or ghae %} Reemplaza a `[hostname]` con el nombre de {% data variables.product.product_location %}.{% endif %} + +Utiliza el comando `curl` en tu línea de comando. Utiliza el marcador `--request` o `-X` seguido del método HTTP. Utiliza el marcador `--url` seguido de la URL completa. ```shell -# GET /users/defunkt -$ curl https://api.github.com/users/defunkt - -> { -> "login": "defunkt", -> "id": 2, -> "node_id": "MDQ6VXNlcjI=", -> "avatar_url": "https://avatars.githubusercontent.com/u/2?v=4", -> "gravatar_id": "", -> "url": "https://api.github.com/users/defunkt", -> "html_url": "https://github.com/defunkt", -> ... -> } +curl --request GET \ +--url "https://api.github.com/octocat" ``` -Mmmm, sabe a [JSON][json]. Vamos a agregar el marcador `-i` para que incluya los encabezados: +{% note %} + +**Nota**: Si obtienes un mensaje similar a "command not found: curl", puede que necesites descargar e instalar cURL. Para obtener más información, consulta [la página de descarga del proyecto cURL](https://curl.se/download.html). + +{% endnote %} + +{% endcurl %} + +Sigue leyendo para aprender cómo autenticarte, enviar parámetros y utilizar la respuesta. + +## Autenticarse + +Muchas operaciones necesitan autenticación o devuelven información adicional si estás autenticado. Adicionalmente, puedes hacer más solicitudes por hora cuando estás autenticado.{% cli %} Aunque se puede acceder a algunas operaciones de la API de REST sin autenticación, debes autenticar en el {% data variables.product.prodname_cli %} para utilizar el subcomando `api`.{% endcli %} + +### Acerca de los tokens + +Puedes autenticar tu solicitud agregando un token. + +Si quieres utilizar la API de REST de {% data variables.product.company_short %} para uso personal, puedes crear un token de acceso personal (PAT). Las operaciones de la API de REST que se utilizan en este artículo requieren del alcance `repo` para los tokens de acceso personal. Otras operaciones podrían requerir alcances diferentes. Para obtener más información acerca de cómo crear un token de acceso personal, consulta la sección "[Crear un token de acceso personal](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)". + +Si quieres utilizar la API en nombre de una organización o de otro usuario, {% data variables.product.company_short %} recomienda que utilices una {% data variables.product.prodname_github_app %}. Si una operación está disponible para las {% data variables.product.prodname_github_apps %}, la documentación de referencia de REST para dicha operación dirá "Works with GitHub Apps". Las operaciones de la API de REST que se utilizan en este artículo requieren permisos de lectura y escritura de `issues` para las {% data variables.product.prodname_github_apps %}. Otras operaciones podrían requerir permisos diferentes. Para obtener más información, consulta las secciones "[Crear una GitHub App](/developers/apps/building-github-apps/creating-a-github-app)", "[Autenticarte con las GitHub Apps](/developers/apps/building-github-apps/authenticating-with-github-apps)" e "[Identificar y autorizar usuarios para las GitHub Apps](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps)". + +Si quieres utilizar la API en un flujo de trabajo de {% data variables.product.prodname_actions %}, {% data variables.product.company_short %} recomienda que te autentiques con el `GITHUB_TOKEN` integrado en vez de crear un token. Puedes otorgar permisos al `GITHUB_TOKEN` con la clave `permissions`. Para obtener más información, consulta la sección "[Autenticación automática de tokens](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token)". + +### Ejemplo de autenticación + +{% cli %} + +Con el {% data variables.product.prodname_cli %}, no necesitas crear un token de acceso anticipadamente. Utiliza el subcomando `auth login` para autenticarte en el {% data variables.product.prodname_cli %}: ```shell -$ curl -i https://api.github.com/users/defunkt - -> HTTP/2 200 -> server: GitHub.com -> date: Thu, 08 Jul 2021 07:04:08 GMT -> content-type: application/json; charset=utf-8 -> cache-control: public, max-age=60, s-maxage=60 -> vary: Accept, Accept-Encoding, Accept, X-Requested-With -> etag: W/"61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0" -> last-modified: Fri, 01 Nov 2019 21:56:00 GMT -> x-github-media-type: github.v3; format=json -> access-control-expose-headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, Deprecation, Sunset -> access-control-allow-origin: * -> strict-transport-security: max-age=31536000; includeSubdomains; preload -> x-frame-options: deny -> x-content-type-options: nosniff -> x-xss-protection: 0 -> referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin -> content-security-policy: default-src 'none' -> x-ratelimit-limit: 60 -> x-ratelimit-remaining: 53 -> x-ratelimit-reset: 1625731053 -> x-ratelimit-resource: core -> x-ratelimit-used: 7 -> accept-ranges: bytes -> content-length: 1305 -> x-github-request-id: 9F60:7019:ACC5CD5:B03C931:60E6A368 -> -> { -> "login": "defunkt", -> "id": 2, -> "node_id": "MDQ6VXNlcjI=", -> "avatar_url": "https://avatars.githubusercontent.com/u/2?v=4", -> "gravatar_id": "", -> "url": "https://api.github.com/users/defunkt", -> "html_url": "https://github.com/defunkt", -> -> ... -> } +gh auth login ``` -Hay algunas partes interesantes en los encabezados de la respuesta. Como lo esperábamos, el `Content-Type` es `application/json`. +Puedes utilizar el marcador `--scopes` para especificar los alcances que quieres. Si quieres autenticarte con un token que hayas creado, puedes utilizar el marcador `--with-token`. Para obtener más información, consulta la [documentación de `auth login` del {% data variables.product.prodname_cli %}](https://cli.github.com/manual/gh_auth_login). -Cualquier encabezado que comience como `X` se refiere a un encabezado personalizado, y no se incluirá en la especificación de HTTPS. Por ejemplo, toma en cuenta los encabezados `X-RateLimit-Limit` y `X-RateLimit-Remaining`. Este par de encabezados indican [cuántas solicitudes puede hacer un cliente][rate-limiting] en un periodo continuo (habitualmente, una hora) y cuántas de ellas ya ha gastado el cliente. +{% endcli %} -## Autenticación - -Los clientes sin autenticar pueden hacer hasta 60 solicitudes por hora. Para obtener más solicitudes por hora, necesitaremos _autenticarnos_. De hecho, para hacer cualquier cosa interesante con la API de {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} se necesita [autenticación][authentication]. - -### Utilizar tokens de acceso personal - -La forma más fácil y mejor de autenticarte con la API de {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} es utilizando la autenticación básica [mediante tokens de OAuth](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens). Éstos incluyen [tokens de acceso personal][personal token]. - -Utiliza el marcador `-u` para configurar tu nombre de usuario: - -```shell -$ curl -i -u your_username {% data variables.product.api_url_pre %}/users/octocat - -``` - -Cuando se te solicite, puedes ingresar tu token de OAuth, pero te recomendamos que configures una variable para éste: - -Puedes utilizar `-u "your_username:$token"` y configurar una variable para `token` y así evitar que tu token se quede en el historial del shell, lo cual debes evitar. - -```shell -$ curl -i -u your_username:$token {% data variables.product.api_url_pre %}/users/octocat - -``` - -Cuando te autentiques, debes ver como tu límite de tasa sube hasta 5,000 solicitudes por hora, como se indicó en el encabezado `X-RateLimit-Limit`. Adicionalmente a proporcionar más llamadas por hora, la autenticación te permite leer y escribir información privada utilizando la API. - -Puedes [crear un**token de acceso personal**][personal token] fácilmente utilizando tu [página de configuración para tokens de acceso personal][tokens settings]: +{% javascript %} {% warning %} -Para mantener tu información segura, te recomendamos ampliamente que configures un vencimiento para tus tokens de acceso personal. +**Advertencia**: Trata tu token de acceso como si fuera una contraseña. + +Para mantener seguro a tu token, puedes almacenarlo como un secreto y ejecutar tu script mediante {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Secretos cifrados](/actions/security-guides/encrypted-secrets)". + +{% ifversion ghec or fpt %}También puedes almacenar tu token como un secreto de {% data variables.product.prodname_codespaces %} y ejecutar tu script en {% data variables.product.prodname_codespaces %}. Para obtener más información, consulta la sección "[Administrar los secretos cifrados para tus codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)".{% endif %} + +Si estas opciones no son posibles, considera utilizar otro servicio tal como [el 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) para almacenar tu token de forma segura. {% endwarning %} -{% ifversion fpt or ghes or ghec %} -![Selección de token personal](/assets/images/personal_token.png) +Para autenticarte con la librería Octokit.js, puedes pasar tu token cuando crees una instancia de `Octokit`. Reemplaza tu `YOUR-TOKEN` con tu token.{% ifversion ghes or ghae %} Reemplaza `[hostname]` con el nombre de {% data variables.product.product_location %}.{% endif %} + +```javascript +const octokit = new Octokit({ {% ifversion ghes or ghae %} + baseUrl: "{% data variables.product.api_url_code %}",{% endif %} + auth: 'YOUR-TOKEN', +}); +``` + +{% endjavascript %} + +{% curl %} + +{% warning %} + +**Advertencia**: Trata a tu token de acceso como si fuera una contraseña. + +Para ayudarte a mantener segura tu cuenta, puedes utilizar el {% data variables.product.prodname_cli %} en vez de cURL. El {% data variables.product.prodname_cli %} se encargará de la autenticación por ti. Para obtener más información, consulta la versión del {% data variables.product.prodname_cli %} de esta página. + +{% ifversion ghec or fpt %}También puedes almacenar tu token como un secreto de {% data variables.product.prodname_codespaces %} y utilizar la línea de comandos a través de {% data variables.product.prodname_codespaces %}. Para obtener más información, consulta la sección "[Administrar los secretos cifrados para tus codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)".{% endif %} + +Si estas opciones no son posibles, considera utilizar otro servicio tal como [el 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) para almacenar tu token de forma segura. + +{% endwarning %} + +Con cURL, enviarás un encabezado de `Authorization` con tu token. Reemplaza `YOUR-TOKEN` con tu token: + +```shell +curl --request GET \ +--url "https://api.github.com/octocat" \ +--header "Authorization: Bearer YOUR-TOKEN" +``` + +{% note %} + +**Nota:** En la mayoría de los casos, puedes utilizar `Authorization: Bearer` o `Authorization: token`. Los tokens web JSON (JWT) solo funcionarán con `Authorization: Bearer`. + +{% endnote %} + +{% endcurl %} + +### Ejemplo de autenticación para {% data variables.product.prodname_actions %} + +{% cli %} + +También puedes utilizar la palabra clave `run` para ejecutar los comandos del {% data variables.product.prodname_cli %} en tus flujos de trabajo de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Sintaxis de flujo de trabajo para las GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)". + +En vez de utilizar el comando `gh auth login`, pasa tu token como una variable de ambiente llamada `GH_TOKEN`. {% data variables.product.prodname_dotcom %} recomienda que te autentiques con el `GITHUB_TOKEN` integrado en vez de crear un token. Si esto no es posible, almacena tu token como un secreto y reemplaza a `GITHUB_TOKEN` con el nombre de tu secreto en el siguiente ejemplo. Para obtener más información sobre `GITHUB_TOKEN`, consulta la sección "[Autenticación automática de token](/actions/security-guides/automatic-token-authentication)". Para obtener más información sobre los secretos, consulta la sección "[Secretos cifrados](/actions/security-guides/encrypted-secrets)". + +```yaml +jobs: + use_api: + runs-on: ubuntu-latest + permissions: {} + steps: + - env: + GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + gh api /octocat +``` + +{% endcli %} + +{% javascript %} + +También puedes utilizar la palabra clave `run` para ejecutar tus scripts de JavaScript en tus flujos de trabajo de {% data variables.product.prodname_actions %}. Para obtener más información, consultala sección "[Sintaxis de flujo de trabajo para GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)". + +{% data variables.product.prodname_dotcom %} recomienda que te autentiques con el `GITHUB_TOKEN` integrado en vez de crear un token. Si esto es imposible, almacena tu token como un secreto y reemplaza a `GITHUB_TOKEN` por el nombre de tu secreto en el siguiente ejemplo. Para obtener más información sobre el `GITHUB_TOKEN`, consulta ""[Automatic token authentication](/actions/security-guides/automatic-token-authentication)". Para obtener más información sobre los secretos, consulta la sección "[Secretos cifrados](/actions/security-guides/encrypted-secrets)". + +El siguiente flujo de trabajo de ejemplo: + +1. Verifica el contenido del repositorio +1. Configura a Node.js +1. Instala `octokit` +1. Almacena el valor de `GITHUB_TOKEN` como una variable de ambiente llamada `TOKEN` y ejecuta `.github/actions-scripts/use-the-api.mjs`, que puede acceder a esa variable de ambiente como `process.env.TOKEN` + +Flujo de trabajo de ejemplo: + +```yaml +on: + workflow_dispatch: +jobs: + use_api_via_script: + runs-on: ubuntu-latest + permissions: {} + steps: + - name: Check out repo content + uses: {% data reusables.actions.action-checkout %} + + - name: Setup Node + uses: {% data reusables.actions.action-setup-node %} + with: + node-version: '16.15.0' + cache: npm + + - name: Install dependencies + run: npm install octokit + + - name: Run script + env: + TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + node .github/actions-scripts/use-the-api.mjs +``` + +Script de JavaScript de ejemplo con la ruta de archivo `.github/actions-scripts/use-the-api.mjs`: + +```javascript +import { Octokit } from "octokit"; + +const octokit = new Octokit({ {% ifversion ghes or ghae %} + baseUrl: "{% data variables.product.api_url_code %}",{% endif %} + auth: process.env.TOKEN, +}); + +await octokit.request("GET /octocat", {}); +``` + +En vez de almacenar tu script en un archivo por separado y ejecutarlo desde tu flujo de trabajo, puedes utilizar la acción `actions/github-script` para ejecutar un script. Para obtener más información, consulta el [README de actions/github-script](https://github.com/actions/github-script). + +```yaml +jobs: + use_api_via_script: + runs-on: ubuntu-latest + permissions: {} + steps: + - uses: {% data reusables.actions.action-github-script %} + with: + github-token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + script: | + await github.request('GET /octocat', {}) +``` + +{% endjavascript %} + +{% curl %} + +También puedes utilizar la palabra clave `run` para ejecutar comandos de cURL en tus flujos de trabajo de {% data variables.product.prodname_actions %}. Para obtener más información, consultala sección "[Sintaxis de flujo de trabajo para GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)". + +{% data variables.product.prodname_dotcom %} recomienda que te autentiques con el `GITHUB_TOKEN` integrado en vez de crear un token. Si esto es imposible, almacena tu token como un secreto y reemplaza a `GITHUB_TOKEN` por el nombre de tu secreto en el siguiente ejemplo. Para obtener más información sobre el `GITHUB_TOKEN`, consulta ""[Automatic token authentication](/actions/security-guides/automatic-token-authentication)". Para obtener más información sobre los secretos, consulta la sección "[Secretos cifrados](/actions/security-guides/encrypted-secrets)". + +```yaml +jobs: + use_api: + runs-on: ubuntu-latest + permissions: {} + steps: + - env: + GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + curl --request GET \ + --url "https://api.github.com/octocat" \ + --header "Authorization: Bearer $GH_TOKEN" +``` + +{% endcurl %} + +## Utilizar encabezados + +La mayoría de las operaciones especifican que deberías pasar un encabezado de `Accept` con un valor de `application/vnd.github.v3+json`. Otras operaciones podrían especificar que deberías enviar un encabezado diferente de `Accept` o encabezados adicionales. + +{% cli %} + +Para enviar un encabezado con el {% data variables.product.prodname_cli %}, utiliza el marcador `--header` o `-H` seguido del encabezado en el formato `key: value`. + +```shell +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /octocat +``` + +{% endcli %} + +{% javascript %} + +La librería Octokit.js pasa automáticamente el encabezado `Accept: application/vnd.github.v3+json`. Para pasar encabezados adicionales o un encabezado de `Accept` diferente, agrega la propiedad `headers` al objeto que se está pasando como un segundo argumento del método `request`. El valor de la propiedad `headers` es un objeto con los nombres de encabezado como claves y los valores de encabezado como valores. Por ejemplo, para enviar un encabezado de `content-type` con un valor de `text/plain`: + +```javascript +await octokit.request("GET /octocat", { + headers: { + "content-type": "text/plain", + }, +}); +``` + +{% endjavascript %} + +{% curl %} + +Para enviar un encabezado con cURL, utiliza el marcador `--header` o `-H` seguido del encabezado en formato `key: value`. + +```shell +curl --request GET \ +--url "https://api.github.com/octocat" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" +``` + +{% endcurl %} + +## Utilizar parámetros de ruta + +Los parámetros de ruta modifican la ruta de operación. Por ejemplo, la ruta de "Listar propuestas de repositorio" es `/repos/{owner}/{repo}/issues`. Las llaves `{}` denotan parámetros de ruta que necesitas especificar. En este caso, debes especificar el nombre y propietario del repositorio. Para encontrar la documentación de referencia para esta operación, consulta la "[Lista de propuestas de repositorio](/rest/issues/issues#list-repository-issues)". + +{% cli %} + +{% ifversion ghes or ghae %} +{% note %} + +**Nota:** Para que este comando funcione para {% data variables.product.product_location %}, reemplaza `octocat/Spoon-Knife` con un repositorio que le pertenezca a {% data variables.product.product_location %}. De lo contrario, vuelve a ejecutar el comando `gh auth login` para autenticarte en {% data variables.product.prodname_dotcom_the_website %} en vez de en {% data variables.product.product_location %}. + +{% endnote %} {% endif %} -{% ifversion ghae %} -![Selección de token personal](/assets/images/help/personal_token_ghae.png) +Para obtener propuestas del repositorio `octocat/Spoon-Knife`, reemplaza `{owner}` con `octocat` y `{repo}` with `Spoon-Knife`. + +```shell +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues +``` + +{% endcli %} + +{% javascript %} + +{% ifversion ghes or ghae %} +{% note %} + +**Nota:** Para que este ejemplo funcione para {% data variables.product.product_location %}, reemplaza a `octocat/Spoon-Knife` con un repositorio que le pertenezca a {% data variables.product.product_location %}. De lo contrario, crea una nueva instancia de `Octokit` y no especifiques la `baseURL`. + +{% endnote %} {% endif %} -Las solicitudes de la API que utilicen un token de acceso personal con vencimiento devolverán la fecha de vencimiento de dicho token a través del encabezado de `GitHub-Authentication-Token-Expiration`. Puedes utilizar el encabezado en tus scripts para proporcionar un mensaje de advertencia cuando el token esté próximo a vencer. +Cuando hagas una solicitud con Octokit.js, todos los parámetros (incluyendo los de ruta) se pasan en un objeto como el segundo argumento para el método `request`. Para obtener propuestas del repositorio `octocat/Spoon-Knife`, especifica el `owner` como `octocat` y el `repo` como `Spoon-Knife`. -### Obtén tu propio perfil de usuario - -Cuando te autenticas adecuadamente, puedes beneficiarte de los permisos asociados con tu cuenta en {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. Por ejemplo, intenta obtener - -```shell -$ curl -i -u your_username:your_token {% data variables.product.api_url_pre %}/user - -> { -> ... -> "plan": { -> "space": 2516582, -> "collaborators": 10, -> "private_repos": 20, -> "name": "medium" -> } -> ... -> } +```javascript +await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife" +}); ``` -Esta vez, adicionalmente al mismo conjunto de información pública que recuperamos para [@defunkt][defunkt github] anteriormente, también deberías ver la información diferente a la pública para tu perfil de usuario. Por ejemplo, verás un objeto de `plan` en la respuesta, el cual otorga detalles sobre el plan de {% data variables.product.product_name %} que tiene la cuenta. +{% endjavascript %} -### Utiilzar tokens de OAuth para las apps +{% curl %} -Las apps que necesitan leer o escribir información privada utilizando la API en nombre de otro usuario deben utilizar [OAuth][oauth]. +Para obtener propuestas del repositorio `octocat/Spoon-Knife`, reemplaza `{owner}` con `octocat` y `{repo}` with `Spoon-Knife`. Para crear la ruta completa, antepón la URL base para la API de REST de {% data variables.product.prodname_dotcom %}, `https://api.github.com`: `https://api.github.com/repos/octocat/Spoon-Knife/issues`. -OAuth utiliza _tokens_. Los Tokens proporcionan dos características grandes: +{% ifversion ghes or ghae %} +{% note %} -* **Acceso revocable**: los usuarios pueden revocar la autorización a las apps de terceros en cualquier momento -* **Acceso limitado**: los usuarios pueden revisar el acceso específico que proporcionará un token antes de autorizar una app de terceros +**Nota:** Si quieres utilizar {% data variables.product.product_location %} en vez de {% data variables.product.prodname_dotcom_the_website %}, utiliza `{% data variables.product.api_url_code %}` en vez de `https://api.github.com` y reemplaza a `[hostname]` con el nombre de {% data variables.product.product_location %}. Reemplaza a `octocat/Spoon-Knife` con un repositorio que le pertenezca a {% data variables.product.product_location %}. -Los tokens deben crearse mediante un [flujo web][webflow]. Una aplicación envía a los usuarios a {% data variables.product.product_name %} para que inicien sesión. Entonces, {% data variables.product.product_name %} presenta un diálogo que indica el nombre de la app así como el nivel de acceso que ésta tiene una vez que el usuario la autorice. Después de que un usuario autoriza el acceso, {% data variables.product.product_name %} lo redirecciona de vuelta a la aplicación: - -![Diálogo de OAuth de GitHub](/assets/images/oauth_prompt.png) - -**¡Trata a los tokens de OAuth como si fueran contraseñas!** No los compartas con otros usuarios ni los almacenes en lugares inseguros. Los tokens en estos ejemplos son falsos y los nombres se cambiaron para proteger a los inocentes. - -Ahora que ya entendimos cómo hacer llamadas autenticadas, vamos a pasar a la [API de repositorios][repos-api]. - -## Repositorios - -Casi cualquier uso significativo de la API de {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} involucrará algún nivel de información de repositorio. Podemos hacer [`GET` para los detalles de un repositorio][get repo] de la misma forma que recuperamos los detalles del usuario anteriormente: +{% endnote %} +{% endif %} ```shell -$ curl -i {% data variables.product.api_url_pre %}/repos/twbs/bootstrap +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" ``` -De la misma forma, podemos [ver los repositorios del usuario autenticado][user repos api]: +{% endcurl %} + +La operación devuelve una lista de propuestas y datos sobre cada una de ellas. Para obtener más información sobre cómo utilizar la respuesta, consulta la sección "[Utiliza la respuesta](#using-the-response)". + +## Utilizar parámetros de consultas + +Los parámetros de consultas te permiten controlar los datos que se devuelven para una solicitud. Por ejemplo, un parámetro de consulta te permite especificar cuántos elementos se devuelven cuando la respuesta se pagina. + +Predeterminadamente, la operación "List repository issues" devuelve treinta propuestas, ordenadas descendientemente por la fecha en la que se crearon. Puedes utilizar el parámetro `per_page` para devolver dos propuestas en vez de 30. Puedes utilizar el parámetro `sort` para ordenar las propuestas de acuerdo con la fecha en las que se actualizaron por última vez en vez de por la fecha en la que se crearon. Puedes utilizar el parámetro `direction` para ordenar los resultados ascendientemente en vez de descendientemente. + +{% cli %} + +Para el {% data variables.product.prodname_cli %}, utiliza el marcador `-F` para pasar un parámetro que sea un número, booleano o nulo. Utiliza `-f` para pasar los parámetros de secuencias. + +{% note %} + +**Nota**: El {% data variables.product.prodname_cli %} no acepta actualmente parámetros que sean arreglos. Para obtener más información, consulta [esta propuesta](https://github.com/cli/cli/issues/1484). + +{% endnote %} ```shell -$ curl -i -H "Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a" \ - {% data variables.product.api_url_pre %}/user/repos +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 -f sort=updated -f direction=asc ``` -O podemos [listar los repositorios de otro usuario][other user repos api]: +{% endcli %} + +{% javascript %} + +Cuando hagas una solicitud con Octokit.js, todos los parámetros, incluyendo los de las consultas, se pasan en un objeto como el segundo argumento para el método `request`. + +```javascript +await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + per_page: 2, + sort: "updated", + direction: "asc", +}); +``` + +{% endjavascript %} + +{% curl %} + +Para cURL, agrega un `?` al final de la ruta y luego antepón tu nombre de parámetro de consulta y su valor en la forma `parameter_name=value`. Separa los parámetros de consulta múltiples con `&`. ```shell -$ curl -i {% data variables.product.api_url_pre %}/users/octocat/repos +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2&sort=updated&direction=asc" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" ``` -O podemos [listar los repositorios de una organización][org repos api]: +{% endcurl %} + +La operación devuelve una lista de propuestas y datos sobre cada una de ellas. Para obtener más información sobre cómo utilizar la respuesta, consulta la sección "[Utiliza la respuesta](#using-the-response)". + +## Utilizar parámetros de cuerpo + +Los parámetros de cuerpo te permiten pasar datos adicionales a la API. Por ejemplo, la operación "Crear una propuesta" requiere que especifiques un título para la propuesta nueva. También te permite especificar otro tipo de información, tal como el texto a poner en el cuerpo de la propuesta. Para ver toda la documentación de referencia para esta operación, consulta la sección "[Crear una propuesta](/rest/issues/issues#create-an-issue)". + +La operación "Create an issue" utiliza la misma ruta que la operación "List repository issues" en el ejemplo anterior, pero utiliza el método `POST` en vez de un método `GET`. + +{% cli %} + +Para el {% data variables.product.prodname_cli %}, utiliza el marcador `-F` para pasar un parámetro que sea un número, booleano o nulo. Utiliza `-f` para pasar los parámetros de secuencias. + +{% note %} + +**Nota**: El {% data variables.product.prodname_cli %} no acepta actualmente parámetros que sean arreglos. Para obtener más información, consulta [esta propuesta](https://github.com/cli/cli/issues/1484). + +{% endnote %} ```shell -$ curl -i {% data variables.product.api_url_pre %}/orgs/octo-org/repos +gh api --header 'Accept: application/vnd.github.v3+json' --method POST /repos/octocat/Spoon-Knife/issues -f title="Created with the REST API" -f body="This is a test issue created by the REST API" ``` -La información que se devuelve de estas llamadas dependerá de los alcances que tenga nuestrotoken cuando nos autenticamos: +{% endcli %} -{%- ifversion fpt or ghec or ghes %} -* Un token con [alcance][scopes] de `public_repo` devolverá una respuesta que incluye todos los repositorios públicos que podemos ver en {% data variables.product.product_location %}. -{%- endif %} -* Un token con [alcance][scopes] de `repo` devolverá una respuesta que incluirá a todos los repositorios {% ifversion fpt %}públicos o privados{% elsif ghec or ghes %} públicos, privados o internos{% elsif ghae %} privados o internos{% endif %} a los que se tiene acceso para ver en {% data variables.product.product_location %}. +{% javascript %} -Como indican los [docs][repos-api], estos métodos toman un parámetro de `type` que puede filtrar los repositorios que se regresan con base en el tipo de acceso que el usuario tiene en ellos. De esta forma, podemos obtener los solo los repositorios que nos pertenezcan directamente, repositorios de organizacion o repositorios en los que el usuario colabore a través del equipo. +Cuando haces una solicitud con Octokit.js, todos los parámetros, incluyendo los del cuerpo, se pasan en un objeto como el segundo argumento al método `request`. + +```javascript +await octokit.request("POST /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + title: "Created with the REST API", + body: "This is a test issue created by the REST API", +}); +``` + +{% endjavascript %} + +{% curl %} + +Para cURL, utiliza el marcador `--data` para pasar los parámetros del cuerpo en un objeto JSON. ```shell -$ curl -i "{% data variables.product.api_url_pre %}/users/octocat/repos?type=owner" +curl --request POST \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" \ +--data '{ + "title": "Created with the REST API", + "body": "This is a test issue created by the REST API" +}' ``` -En este ejemplo, tomamos únicamente los repositorios que pertenecen a octocat, no aquellos en los que ella colabora. Nota la URL que se cita arriba. Dependiendo de tu configuración de shell, cURL a veces requiere una URL citada, o de lo contrario ignora la secuencia de consulta. +{% endcurl %} -### Crear un repositorio +La operación crea una propuesta y devuelve datos sobre la propuesta nueva. En la respuesta, encuentra la `html_url` de tu propuesta y navega a esta en el buscador. Para obtener más información sobre cómo utilizar la respuesta, consulta la sección "[Utiliza la respuesta](#using-the-response)". -Un caso de común de uso es retribuir información para repositorios existentes, pero la -La API de {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} también es compatible con crear repositorios nuevos. Para [crear un repositorio][create repo], -necesitamos hacer `POST` en algunos JSON que contengan los detalles y las opciones de configuración. +## Utilizar la respuesta + +### Acerca de los encabezados y el código de respuesta + +Cada solicitud devolverá un código de estado HTTP que indica el éxito del a respuesta. Para obtener más información sobre los códigos de respuesta, consulta [la documentación del código de estado de respuesta MDN HTTP](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status). + +Adicionalmente, la respuesta incluirá encabezados que dan más detalles sobre ella. Los encabezados que comienzan con `X-` o `x-` son personalizados para {% data variables.product.company_short %}. Por ejemplo, los encabezados `x-ratelimit-remaining` y `x-ratelimit-reset` te dicen cuántas solicitudes puedes hacer en un tiempo definido. + +{% cli %} + +Para ver los encabezados y el código de estado, utiliza el marcador `--include` o `--i` cuando envías tu solicitud. + +Por ejemplo, esta solicitud: ```shell -$ curl -i -H "Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a" \ - -d '{ - "name": "blog", - "auto_init": true, - "private": true, - "gitignore_template": "nanoc" - }' \ - {% data variables.product.api_url_pre %}/user/repos +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 --include ``` -En este ejemplo mínimo, creamos un repositorio privado nuevo para nuestro blog (que se servirá en [GitHub Pages][pages], probablemente). Aunque el blog {% ifversion not ghae %}será público{% else %}está disponible para todos los miembros de la empresa{% endif %}, hemos hecho el repositorio privado. En este paso, también lo inicializaremos con un README y con una [plantilla de.gitignored][gitignore templates] enriquecida con [nanoc][nanoc]. - -El repositorio que se obtiene como resultado se puede encontrar en `https://github.com//blog`. Para crear un repositorio bajo una organización para la cual eres propietario, solo cambia el método de la API de `/user/repos` a `/orgs//repos`. - -Posteriormente vamos a obtener nuestro repositorio recién creado: +devuelve el código de respuesta y los encabezados como: ```shell -$ curl -i {% data variables.product.api_url_pre %}/repos/pengwynn/blog - -> HTTP/2 404 - -> { -> "message": "Not Found" -> } +HTTP/2.0 200 OK +Access-Control-Allow-Origin: * +Access-Control-Expose-Headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset +Cache-Control: private, max-age=60, s-maxage=60 +Content-Security-Policy: default-src 'none' +Content-Type: application/json; charset=utf-8 +Date: Thu, 04 Aug 2022 19:56:41 GMT +Etag: W/"a63dfbcfdb73621e9d2e89551edcf9856731ced534bd7f1e114a5da1f5f73418" +Link: ; rel="next", ; rel="last" +Referrer-Policy: origin-when-cross-origin, strict-origin-when-cross-origin +Server: GitHub.com +Strict-Transport-Security: max-age=31536000; includeSubdomains; preload +Vary: Accept, Authorization, Cookie, X-GitHub-OTP, Accept-Encoding, Accept, X-Requested-With +X-Accepted-Oauth-Scopes: repo +X-Content-Type-Options: nosniff +X-Frame-Options: deny +X-Github-Api-Version-Selected: 2022-08-09 +X-Github-Media-Type: github.v3; format=json +X-Github-Request-Id: 1C73:26D4:E2E500:1EF78F4:62EC2479 +X-Oauth-Client-Id: 178c6fc778ccc68e1d6a +X-Oauth-Scopes: gist, read:org, repo, workflow +X-Ratelimit-Limit: 15000 +X-Ratelimit-Remaining: 14996 +X-Ratelimit-Reset: 1659645499 +X-Ratelimit-Resource: core +X-Ratelimit-Used: 4 +X-Xss-Protection: 0 ``` -¡Oh no! ¿A dónde se fue? Ya que creamos el repositorio como _privado_, necesitamos autenticarnos para poder verlo. Si eres un usuario experimentado en HTTP, tal vez esperes recibir un código `403` en vez de ésto. Ya que no queremos filtrar información sobre los repositorios privados, la API de {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} devolverá un `404` en este caso para decir "no podemos confirmar ni negar la existencia de este repositorio". +En este ejemplo, el código de respuesta es `200`, lo que indica una solicitud exitosa. -## Problemas +{% endcli %} -La IU de informe de problemas en {% data variables.product.product_name %} pretende proporcionar suficiente flujo de trabajo mientras evita estorbarte. Con la [API de propuestas][issues-api] de {% data variables.product.product_name %}, puedes extraer datos para crear propuestas desde otras herramientas para crear flujos de trabajo que funcionen para tu equipo. +{% javascript %} -Tal como en github.com, la API proporciona algunos cuantos métodos para ver los informes de problemas para el usuario autenticado. Para [ver todas tus propuestas][get issues api], llama a `GET /issues`: +Cuando haces una solicitud con Octokit.js, el método `request` devuelve una promesa. Si la solicitud tuvo éxito, la promesa se resuelve en un objeto que incluye el código de estado HTTP de la respuesta (`estado`) y los encabezados de ella (`headers`). Si ocurre un error, la promesa se resuelve en un objeto que incluye el código de estado HTTP de esta (`status`) y los encabezados de la misma (`response.headers`). + +Puedes utilizar un bloque `try/catch` para detectar un error si es que ocurre. Por ejemplo, si la solicitud en el siguiente script tiene éxito, este registrará el código de estaod y el valor del encabezado `x-ratelimit-remaining`. Si la solicitud no tuvo éxito, el script registrará el código de estado, el valor del encabezado `x-ratelimit-remaining` y el mensaje de error. + +```javascript +try { + const result = await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + per_page: 2, + }); + + console.log(`Success! Status: ${result.status}. Rate limit remaining: ${result.headers["x-ratelimit-remaining"]}`) + +} catch (error) { + console.log(`Error! Status: ${error.status}. Rate limit remaining: ${error.headers["x-ratelimit-remaining"]}. Message: ${error.response.data.message}`) +} +``` + +{% endjavascript %} + +{% curl %} + +Para ver los encabezados y el código de estado, utiliza el marcador `--include` o `--i` cuando envías tu solicitud. + +Por ejemplo, esta solicitud: ```shell -$ curl -i -H "Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a" \ - {% data variables.product.api_url_pre %}/issues +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" \ +--include ``` -Para obtener únicamente las [propuestas bajo alguna de tus organizaciones de {% data variables.product.product_name %}][get issues api], llama a `GET -/orgs//issues`: +devuelve el código de respuesta y los encabezados como: ```shell -$ curl -i -H "Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a" \ - {% data variables.product.api_url_pre %}/orgs/rails/issues +HTTP/2 200 +server: GitHub.com +date: Thu, 04 Aug 2022 20:07:51 GMT +content-type: application/json; charset=utf-8 +cache-control: public, max-age=60, s-maxage=60 +vary: Accept, Accept-Encoding, Accept, X-Requested-With +etag: W/"7fceb7e8c958d3ec4d02524b042578dcc7b282192e6c939070f4a70390962e18" +x-github-media-type: github.v3; format=json +link: ; rel="next", ; rel="last" +access-control-expose-headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset +access-control-allow-origin: * +strict-transport-security: max-age=31536000; includeSubdomains; preload +x-frame-options: deny +x-content-type-options: nosniff +x-xss-protection: 0 +referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin +content-security-policy: default-src 'none' +x-ratelimit-limit: 15000 +x-ratelimit-remaining: 14996 +x-ratelimit-reset: 1659645535 +x-ratelimit-resource: core +x-ratelimit-used: 4 +accept-ranges: bytes +content-length: 4936 +x-github-request-id: 14E0:4BC6:F1B8BA:208E317:62EC2715 ``` -También podemos obtener [todas las propuestas que estén bajo un solo repositorio][repo issues api]: +En este ejemplo, el código de respuesta es `200`, lo que indica una solicitud exitosa. + +{% endcurl %} + +### Acerca del cuerpo de la respuesta + +Muchas operaciones devolverán un cuerpo de la respuesta. A menos de que se especifique lo contrario, el cuerpo de la respuesta estará en formato JSON. Por ejemplo, esta solicitud devuelve una lista de propuestas con datos sobre cada una de ellas: + +{% cli %} ```shell -$ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 ``` -### Paginación +{% endcli %} -Un proyecto con el tamaño de Rails tiene miles de informes de problemas. Necesitaremos [paginar][pagination], haciendo varias llamadas a la API para obtener los datos. Vamos a repetir la última llamada, esta vez tomando nota de los encabezados de respuesta: +{% javascript %} + +```javascript +await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + per_page: 2, +}); +``` + +{% endjavascript %} + +{% curl %} ```shell -$ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues - -> HTTP/2 200 - -> ... -> Link: <{% data variables.product.api_url_pre %}/repositories/8514/issues?page=2>; rel="next", <{% data variables.product.api_url_pre %}/repositories/8514/issues?page=30>; rel="last" -> ... +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" ``` -El [encabezado de `Link`][link-header] proporciona una respuesta para enlazar a los recursos externos, en este caso, a las páginas de datos adicionales. Ya que nuestra llamada encontró más de treinta informes de problemas (el tamaño predeterminado de página), la API no s dice dónde podemos encontrar la siguiente página y la última página de los resultados. +{% endcurl %} -### Crear una propuesta +A diferencia de la API de GraphQL, en donde especificas la información que quieres, la API de REST habitualmente devuelve más información de la que necesitas. Si lo deseas, puedes analizar la respuesta para extraer pedazos de información específica. -Ahora que hemos visto cómo paginar las listas de propuestas, vamos a [crear una propuesta][create issue] desde la API. +{% cli %} -Para crear un informe de problemas, necesitamos estar autenticados, así que pasaremos un token de OAuth en el encabezado. También, pasaremos el título, cuerpo, y etiquetas en el cuerpo de JSON a la ruta `/issues` debajo del repositorio en el cual queremos crear el informe de problemas: +Por ejemplo, puedes utilizar `>` para redirigir la respuesta a un archivo: ```shell -$ curl -i -H 'Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a' \ -$ -d '{ \ -$ "title": "New logo", \ -$ "body": "We should have one", \ -$ "labels": ["design"] \ -$ }' \ -$ {% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/issues - -> HTTP/2 201 -> Location: {% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/issues/17 -> X-RateLimit-Limit: 5000 - -> { -> "pull_request": { -> "patch_url": null, -> "html_url": null, -> "diff_url": null -> }, -> "created_at": "2012-11-14T15:25:33Z", -> "comments": 0, -> "milestone": null, -> "title": "New logo", -> "body": "We should have one", -> "user": { -> "login": "pengwynn", -> "gravatar_id": "7e19cd5486b5d6dc1ef90e671ba52ae0", -> "avatar_url": "https://secure.gravatar.com/avatar/7e19cd5486b5d6dc1ef90e671ba52ae0?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", -> "id": 865, -> "url": "{% data variables.product.api_url_pre %}/users/pengwynn" -> }, -> "closed_at": null, -> "updated_at": "2012-11-14T15:25:33Z", -> "number": 17, -> "closed_by": null, -> "html_url": "https://github.com/pengwynn/api-sandbox/issues/17", -> "labels": [ -> { -> "color": "ededed", -> "name": "design", -> "url": "{% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/labels/design" -> } -> ], -> "id": 8356941, -> "assignee": null, -> "state": "open", -> "url": "{% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/issues/17" -> } +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 > data.json ``` -La respuesta nos entrega un par de sugerencias para el informe de problemas recién creado, tanto en el encabezado de respuesta de `Location` como en el campo de `url` de la respuesta de JSON. - -## Solicitudes condicionales - -Una gran parte de ser un buen ciudadano de la API es respetar los límites de tasa al almacenar información en el caché, la cual no haya cambiado. La API es compatible con las [solicitudes condicionales][conditional-requests] y te ayuda a hacer lo correcto. Considera el primer llamado que hicimos para obtener el perfil de defunkt: +Posteriormente, puedes utilizar jq para obtener el título e ID de autor de cada propuesta: ```shell -$ curl -i {% data variables.product.api_url_pre %}/users/defunkt - -> HTTP/2 200 -> etag: W/"61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0" +jq '.[] | {title: .title, authorID: .user.id}' data.json ``` -Además del cuerpo de JSON, toma nota del código de estado HTTP de `200` y del encabezado `ETag`. La [ETag][etag] es una huella digital de la respuesta. Si la pasamos en llamadas subsecuentes, podemos decirle a la API que nos entregue el recurso nuevamente, únicamente si cambió: +Los dos comandos anteriores devolverán algo similar a: + +``` +{ + "title": "Update index.html", + "authorID": 10701255 +} +{ + "title": "Edit index file", + "authorID": 53709285 +} +``` + +Para obtener más información sobre jq, consulta [the jq documentation](https://stedolan.github.io/jq/) y [jq play](https://jqplay.org/). + +{% endcli %} + +{% javascript %} + +Por ejemplo, puedes obtener el título e ID de autor de cada propuesta: + +```javascript +try { + const result = await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + per_page: 2, + }); + + const titleAndAuthor = result.data.map(issue => {title: issue.title, authorID: issue.user.id}) + + console.log(titleAndAuthor) + +} catch (error) { + console.log(`Error! Status: ${error.status}. Message: ${error.response.data.message}`) +} +``` + +{% endjavascript %} + +{% curl %} + +Por ejemplo, puedes utilizar `>` para redirigir la respuesta a un archivo: ```shell -$ curl -i -H 'If-None-Match: "61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0"' \ -$ {% data variables.product.api_url_pre %}/users/defunkt - -> HTTP/2 304 +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" > data.json ``` -El estado `304` indica que el recurso no ha cambiado desde la última vez que lo solicitamos y que la respuesta no contendrá ningún cuerpo. Como bono, las respuestas de tipo `304` no cuentan en tu [límite de tasa][rate-limiting]. +Posteriormente, puedes utilizar jq para obtener el título e ID de autor de cada propuesta: -¡Ahora conoces lo básico de la API de {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %}! +```shell +jq '.[] | {title: .title, authorID: .user.id}' data.json +``` -* Autenticación básica & de OAuth -* Obtener y crear repositorios e informes de problemas -* Solicitudes condicionales +Los dos comandos anteriores devolverán algo similar a: -Sigue aprendiendo con la siguiente guía de la API ¡[Fundamentos de la Autenticación][auth guide]! +``` +{ + "title": "Update index.html", + "authorID": 10701255 +} +{ + "title": "Edit index file", + "authorID": 53709285 +} +``` -[wrappers]: /libraries/ -[curl]: http://curl.haxx.se/ -[oauth]: /apps/building-integrations/setting-up-and-registering-oauth-apps/ -[webflow]: /apps/building-oauth-apps/authorizing-oauth-apps/ -[scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ -[repos-api]: /rest/reference/repos -[repos-api]: /rest/reference/repos -[pages]: http://pages.github.com -[nanoc]: http://nanoc.ws/ -[gitignore templates]: https://github.com/github/gitignore -[issues-api]: /rest/reference/issues -[link-header]: https://www.w3.org/wiki/LinkHeader -[conditional-requests]: /rest#conditional-requests -[rate-limiting]: /rest/overview/resources-in-the-rest-api#rate-limit-http-headers -[rate-limiting]: /rest/overview/resources-in-the-rest-api#rate-limit-http-headers -[users api]: /rest/reference/users#get-a-user -[defunkt github]: https://github.com/defunkt -[defunkt github]: https://github.com/defunkt -[json]: http://en.wikipedia.org/wiki/JSON -[authentication]: /rest#authentication -[personal token]: /articles/creating-an-access-token-for-command-line-use -[personal token]: /articles/creating-an-access-token-for-command-line-use -[tokens settings]: https://github.com/settings/tokens -[pagination]: /rest#pagination -[get repo]: /rest/reference/repos#get-a-repository -[create repo]: /rest/reference/repos#create-a-repository-for-the-authenticated-user -[create issue]: /rest/reference/issues#create-an-issue -[auth guide]: /guides/basics-of-authentication -[user repos api]: /rest/reference/repos#list-repositories-for-the-authenticated-user -[other user repos api]: /rest/reference/repos#list-repositories-for-a-user -[org repos api]: /rest/reference/repos#list-organization-repositories -[get issues api]: /rest/reference/issues#list-issues-assigned-to-the-authenticated-user -[get issues api]: /rest/reference/issues#list-issues-assigned-to-the-authenticated-user -[repo issues api]: /rest/reference/issues#list-repository-issues -[etag]: http://en.wikipedia.org/wiki/HTTP_ETag +Para obtener más información sobre jq, consulta [the jq documentation](https://stedolan.github.io/jq/) y [jq play](https://jqplay.org/). + +{% endcurl %} + +## Pasos siguientes + +Este artículo demostró cómo listar y crear propuestas en un repositorio. Para practicar más, intenta comentar en una propuesta, edita el título de una propuesta o cierra una propuesta. Para obtener más información sobre estas operaciones, consulta las secciones "[Crear un comentario de propuesta](/rest/issues#create-an-issue-comment)" y "[Actualizar una propuesta](/rest/issues/issues#update-an-issue)". + +Para obtener más información sobre las operaciones que puedes utilizar, consulta la [documentación de referencia de REST](/rest). diff --git a/translations/es-ES/content/rest/index.md b/translations/es-ES/content/rest/index.md index 6653a92ce3..de30dc9f91 100644 --- a/translations/es-ES/content/rest/index.md +++ b/translations/es-ES/content/rest/index.md @@ -3,7 +3,8 @@ title: API de REST de GitHub shortTitle: API de REST intro: 'Para crear integraciones, recuperar datos y automatizar tus flujos de trabajo, compila con la API de REST de {% data variables.product.prodname_dotcom %}.' introLinks: - quickstart: /rest/guides/getting-started-with-the-rest-api + quickstart: /rest/quickstart + overview: /rest/guides/getting-started-with-the-rest-api featuredLinks: guides: - /rest/guides/getting-started-with-the-rest-api @@ -31,6 +32,7 @@ versions: ghae: '*' ghec: '*' children: + - /quickstart - /overview - /guides - /actions diff --git a/translations/es-ES/content/rest/interactions/orgs.md b/translations/es-ES/content/rest/interactions/orgs.md index 321fce5ec0..04d052cdc3 100644 --- a/translations/es-ES/content/rest/interactions/orgs.md +++ b/translations/es-ES/content/rest/interactions/orgs.md @@ -1,5 +1,5 @@ --- -title: Organization interactions +title: Interacciones de organización shortTitle: Organización intro: 'La API de interacciones de organización permite que los propietarios de la organización restrinjan temporalmente qué tipo de usuarios pueden comentar, abrir propuestas o crear solicitudes de cambios en los repositorios públicos de dicha organización.' versions: @@ -11,7 +11,7 @@ miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true --- -## About the Organization interactions API +## Acerca de la API de interacciones de organización La API de interacciones de organización permite que los propietarios de la organización restrinjan temporalmente qué tipo de usuarios pueden comentar, abrir propuestas o crear solicitudes de cambios en los repositorios públicos de dicha organización. {% data reusables.interactions.interactions-detail %} Aquí puedes aprender más sobre los tipos de usuario de {% data variables.product.product_name %}: diff --git a/translations/es-ES/content/rest/interactions/repos.md b/translations/es-ES/content/rest/interactions/repos.md index 9224e9c109..1c5c3d82a4 100644 --- a/translations/es-ES/content/rest/interactions/repos.md +++ b/translations/es-ES/content/rest/interactions/repos.md @@ -1,5 +1,5 @@ --- -title: Repository interactions +title: Interacciones de repositorio shortTitle: Repositorio intro: 'La API de interacciones de repositorio permite a las personas con acceso administrativo o de propietario restringir temporalmente qué tipo de usuario puede comentar, abrir propuestas o crear solicitudes de cambios en un repositorio privado.' versions: @@ -11,7 +11,7 @@ miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true --- -## About the Repository interactions API +## Acerca de la API de interacciones de repositorio La API de interacciones de repositorio permite a las personas con acceso administrativo o de propietario restringir temporalmente qué tipo de usuario puede comentar, abrir propuestas o crear solicitudes de cambios en un repositorio privado. {% data reusables.interactions.interactions-detail %} Aquí puedes aprender más sobre los tipos de usuario de {% data variables.product.product_name %}: diff --git a/translations/es-ES/content/rest/issues/comments.md b/translations/es-ES/content/rest/issues/comments.md index 12e27f497e..79fd142033 100644 --- a/translations/es-ES/content/rest/issues/comments.md +++ b/translations/es-ES/content/rest/issues/comments.md @@ -13,8 +13,8 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Issue comments API +## Acerca de la API de comentarios de propuestas -La API de comentarios en las propuestas es compatible con la administración de comentarios en las propuestas y solicitudes de cambios. {% data reusables.pull_requests.issues-pr-shared-api %} To manage pull request review comments, use the [Pull request review comments API](/rest/pulls/comments) instead. +La API de comentarios en las propuestas es compatible con la administración de comentarios en las propuestas y solicitudes de cambios. {% data reusables.pull_requests.issues-pr-shared-api %} Para administrar los comentarios de revisión de solicitudes de cambio, utiliza la [API de comentarios de revisión en solicitudes de cambio](/rest/pulls/comments) en su lugar. {% data reusables.pull_requests.issues-media-types %} diff --git a/translations/es-ES/content/rest/issues/labels.md b/translations/es-ES/content/rest/issues/labels.md index 9e6dfc84ce..c8a6a2e513 100644 --- a/translations/es-ES/content/rest/issues/labels.md +++ b/translations/es-ES/content/rest/issues/labels.md @@ -11,6 +11,6 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Labels API +## Acerca de la API de etiquetas -The Labels API supports managing labels for a repository and adding or removing labels to issues and pull requests. {% data reusables.pull_requests.issues-pr-shared-api %} +La API de etiquetas es compatible con administrar etiquetas para un repositorio y agregar o eliminar etiquetas para las propuestas y solicitudes de cambio. {% data reusables.pull_requests.issues-pr-shared-api %} diff --git a/translations/es-ES/content/rest/metrics/community.md b/translations/es-ES/content/rest/metrics/community.md index e6e3f7d92f..2064af0ae2 100644 --- a/translations/es-ES/content/rest/metrics/community.md +++ b/translations/es-ES/content/rest/metrics/community.md @@ -1,8 +1,8 @@ --- -title: Community metrics +title: Métricas comunitarias shortTitle: Comunidad allowTitleToDifferFromFilename: true -intro: The Community metrics API lets you get data about your community profile. +intro: La API de métricas comunitarias te permite obtener datos sobre el perfil de tu comunidad. versions: fpt: '*' ghec: '*' diff --git a/translations/es-ES/content/rest/metrics/statistics.md b/translations/es-ES/content/rest/metrics/statistics.md index 4394313801..b4a39356b6 100644 --- a/translations/es-ES/content/rest/metrics/statistics.md +++ b/translations/es-ES/content/rest/metrics/statistics.md @@ -1,5 +1,5 @@ --- -title: Repository statistics +title: Estadísticas de repositorio shortTitle: Estadísticas allowTitleToDifferFromFilename: true intro: 'La API de estadísticas de repositorio te permite recuperar los datos que {% data variables.product.product_name %} utiliza para visualizar tipos diferentes de actividad de repositorio.' @@ -13,7 +13,7 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Repository statistics API +## Acerca de las API de estadísticas de repositorio La API de estadísticas de repositorio te permite recuperar los datos que {% data variables.product.product_name %} utiliza para visualizar tipos diferentes de actividad de repositorio. diff --git a/translations/es-ES/content/rest/metrics/traffic.md b/translations/es-ES/content/rest/metrics/traffic.md index 05d5337041..f10105c24c 100644 --- a/translations/es-ES/content/rest/metrics/traffic.md +++ b/translations/es-ES/content/rest/metrics/traffic.md @@ -1,8 +1,8 @@ --- -title: Repository traffic +title: Tráfico de repositorio shortTitle: Tráfico allowTitleToDifferFromFilename: true -intro: The Repository traffic API provides access to the information provided in your repository graph. +intro: La API de tráfico de repositorio proporciona acceso a la información proporcionada en tu gráfica de repositorio. versions: fpt: '*' ghec: '*' @@ -11,6 +11,6 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Repository traffic API +## Acerca de la API de tráfico de repositorio -For repositories that you have push access to, the Repository traffic API provides access to the information provided in your repository graph. Para obtener más información, consulta la sección "[Ver el tráfico hacia un repositorio](/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository)". +Para los repositorios a los cuales tienes acceso de subida, la API de tráfico de repositorio proporciona acceso a la información que se proporciona en tu gráfica de repositorio. Para obtener más información, consulta la sección "[Ver el tráfico hacia un repositorio](/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository)". diff --git a/translations/es-ES/content/rest/migrations/orgs.md b/translations/es-ES/content/rest/migrations/orgs.md index fd9856ea4b..0eb7f48e9e 100644 --- a/translations/es-ES/content/rest/migrations/orgs.md +++ b/translations/es-ES/content/rest/migrations/orgs.md @@ -1,5 +1,5 @@ --- -title: Organization migrations +title: Migraciones de organización allowTitleToDifferFromFilename: true shortTitle: Organizaciones intro: '' @@ -13,7 +13,7 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Organization migrations API +## Acerca de la API de migraciones de organización La API de Migraciones solo está disponible para los propietarios autenticados de la organización. Para obtener más información, consulta las secciones "[Roles en una organización](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#permission-levels-for-an-organization)" y "[Otros métodos de autenticación](/rest/overview/other-authentication-methods)". diff --git a/translations/es-ES/content/rest/migrations/source-imports.md b/translations/es-ES/content/rest/migrations/source-imports.md index 472648b9bf..5b683c679a 100644 --- a/translations/es-ES/content/rest/migrations/source-imports.md +++ b/translations/es-ES/content/rest/migrations/source-imports.md @@ -9,9 +9,9 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Source imports API +## Acerca de la API de importaciones de código fuente -{% data variables.migrations.source_imports_intro %} A typical source import would start the import and then (optionally) update the authors and/or update the preference for using Git LFS if large files exist in the import. También puedes crear un webhook que escuche al [`RepositoryImportEvent`](/developers/webhooks-and-events/webhook-events-and-payloads#repository_import) para encontrar el estado de la importación. +{% data variables.migrations.source_imports_intro %} Una importación de código fuente habitual iniciaría la importación y después (opcionalmente) actualizaría a los autores o a la preferencia para utilizar LFS de Git si existen archivos grandes en la importación. También puedes crear un webhook que escuche al [`RepositoryImportEvent`](/developers/webhooks-and-events/webhook-events-and-payloads#repository_import) para encontrar el estado de la importación. Se puede ver un ejemplo más detallado en este diagrama: diff --git a/translations/es-ES/content/rest/oauth-authorizations.md b/translations/es-ES/content/rest/oauth-authorizations.md index 3c22e5dd08..ef94233ad5 100644 --- a/translations/es-ES/content/rest/oauth-authorizations.md +++ b/translations/es-ES/content/rest/oauth-authorizations.md @@ -1,6 +1,6 @@ --- -title: OAuth authorizations -intro: The OAuth authorizations lets you manage the access OAuth applications have to your account. +title: Autorizaciones de OAuth +intro: Las autorizaciones de OAuth te permiten administrar el acceso que las aplicaciones de OAuth tienen en tu cuenta. versions: ghes: '*' topics: @@ -10,7 +10,7 @@ redirect_from: - /rest/reference/oauth-authorizations --- -## About the OAuth authorizations API +## Acerca de la API de autorizaciones OAuth Puedes utilizar esta API para administrar el acceso que las aplicaciones de OAuth tienen en tu cuenta. Solo puedes acceder a esta API a través de la [Autenticación Básica](/rest/overview/other-authentication-methods#basic-authentication) utilizando tu nombre de usuario y contraseña, y no los tokens. diff --git a/translations/es-ES/content/rest/orgs/custom-roles.md b/translations/es-ES/content/rest/orgs/custom-roles.md index 748da0f6cc..ae1e5dd230 100644 --- a/translations/es-ES/content/rest/orgs/custom-roles.md +++ b/translations/es-ES/content/rest/orgs/custom-roles.md @@ -1,5 +1,5 @@ --- -title: Custom Repository Roles +title: Roles de repositorio personalizados intro: '' versions: fpt: '*' diff --git a/translations/es-ES/content/rest/orgs/outside-collaborators.md b/translations/es-ES/content/rest/orgs/outside-collaborators.md index 42c4707e72..f6ffa6c21f 100644 --- a/translations/es-ES/content/rest/orgs/outside-collaborators.md +++ b/translations/es-ES/content/rest/orgs/outside-collaborators.md @@ -1,5 +1,5 @@ --- -title: Outside Collaborators +title: Colaboradores externos intro: '' versions: fpt: '*' diff --git a/translations/es-ES/content/rest/projects/columns.md b/translations/es-ES/content/rest/projects/columns.md index d3049358c3..50da2d5df5 100644 --- a/translations/es-ES/content/rest/projects/columns.md +++ b/translations/es-ES/content/rest/projects/columns.md @@ -1,8 +1,8 @@ --- -title: '{% data variables.product.prodname_project_v1_caps %} columns' +title: 'Columnas de {% data variables.product.prodname_project_v1_caps %}' shortTitle: Columnas allowTitleToDifferFromFilename: true -intro: 'The {% data variables.product.prodname_project_v1 %} columns API lets you create and manage columns on a {% data variables.projects.projects_v1_board %}.' +intro: 'La API de columnas de {% data variables.product.prodname_project_v1 %} te permite crear y administrar columnas en un {% data variables.projects.projects_v1_board %}.' versions: fpt: '*' ghes: '*' diff --git a/translations/es-ES/content/rest/projects/projects.md b/translations/es-ES/content/rest/projects/projects.md index 79c2aaa6b1..69c8cbf99f 100644 --- a/translations/es-ES/content/rest/projects/projects.md +++ b/translations/es-ES/content/rest/projects/projects.md @@ -1,8 +1,8 @@ --- title: '{% data variables.product.prodname_projects_v1_caps %}' -shortTitle: Boards +shortTitle: Tableros allowTitleToDifferFromFilename: true -intro: 'The {% data variables.product.prodname_projects_v1 %} API lets you create and manage {% data variables.projects.projects_v1_boards %} in a repository.' +intro: 'La API de {% data variables.product.prodname_projects_v1 %} te permite crear y fusionar {% data variables.projects.projects_v1_boards %} en un repositorio.' versions: fpt: '*' ghes: '*' diff --git a/translations/es-ES/content/rest/pulls/reviews.md b/translations/es-ES/content/rest/pulls/reviews.md index fe739aefdc..77aade526c 100644 --- a/translations/es-ES/content/rest/pulls/reviews.md +++ b/translations/es-ES/content/rest/pulls/reviews.md @@ -13,6 +13,6 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Pull request reviews API +## Acerca de la API de revisiones de solicitudes de cambio -Pull Request Reviews are groups of pull request review comments on a pull request, grouped together with a state and optional body comment. +Las revisiones de solicitudes de cambio son grupos de comentarios en dichas revisiones que se agrupan con un estado y comentario de cuerpo opcional. diff --git a/translations/es-ES/content/rest/quickstart.md b/translations/es-ES/content/rest/quickstart.md new file mode 100644 index 0000000000..7649232acc --- /dev/null +++ b/translations/es-ES/content/rest/quickstart.md @@ -0,0 +1,351 @@ +--- +title: Guía de inicio rápido para la API de REST de GitHub +intro: 'Aprende cómo iniciar con la API de REST de {% data variables.product.prodname_dotcom %}.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +shortTitle: Inicio Rápido +topics: + - API +redirect_from: + - /guides/getting-started + - /v3/guides/getting-started +miniTocMaxHeadingLevel: 3 +--- + +Este artículo describe cómo iniciar rápidamente con la API de REST de {% data variables.product.prodname_dotcom %} utilizando el {% data variables.product.prodname_cli %}, JavaScript o cURL. Para obtener una guía más detallada, consulta la sección "[Iniciar con la API de REST](/rest/guides/getting-started-with-the-rest-api)". + +{% cli %} + +## Iniciar utilizando el {% data variables.product.prodname_cli %} + +### Utilizar el {% data variables.product.prodname_cli %} en la línea de comando + +El {% data variables.product.prodname_cli %} es la forma más fácil de utilizar la API de REST de {% data variables.product.prodname_dotcom %} desde la línea de comandos. + +1. Instala el {% data variables.product.prodname_cli %} si aún no lo has hecho. Para obtener las instrucciones de instalación, consulta el [repositorio del {% data variables.product.prodname_cli %}](https://github.com/cli/cli#installation). +1. Utiliza el subcomando `auth login` para autenticarte en el {% data variables.product.prodname_cli %}. Para obtener más información, consulta la [documentación de `auth login` del {% data variables.product.prodname_cli %}](https://cli.github.com/manual/gh_auth_login). + + ```shell + gh auth login + ``` + +1. Utiliza el subcomando `api` para hacer tu solicitud de la API. Para obtener más información, consulta la [documentación de `api` del {% data variables.product.prodname_cli %}](https://cli.github.com/manual/gh_api). + + ```shell + gh api repos/octocat/Spoon-Knife/issues + ``` + +### Utilizar el {% data variables.product.prodname_cli %} en {% data variables.product.prodname_actions %} + +También puedes utilizar el {% data variables.product.prodname_cli %} en tus flujos de trabajo de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Utilizar el CLI de GitHub en los flujos de trabajo](/actions/using-workflows/using-github-cli-in-workflows)". + +En vez de utilizar el comando `gh auth login`, pasa un token de acceso como una variable de ambiente llamada `GH_TOKEN`. {% data variables.product.prodname_dotcom %} recomienda que utilices el `GITHUB_TOKEN` integrado en vez de crear un token. Si esto es imposible, almacena tu token como un secreto y reemplaza a `GITHUB_TOKEN` por el nombre de tu secreto en el siguiente ejemplo. Para obtener más información sobre el `GITHUB_TOKEN`, consulta ""[Automatic token authentication](/actions/security-guides/automatic-token-authentication)". Para obtener más información sobre los secretos, consulta la sección "[Secretos cifrados](/actions/security-guides/encrypted-secrets)". + +```yaml +on: + workflow_dispatch: +jobs: + use_api: + runs-on: ubuntu-latest + permissions: + issues: read + steps: + - env: + GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + gh api repos/octocat/Spoon-Knife/issues +``` + +Si te estás autenticando con una {% data variables.product.prodname_github_app %}, puedes crear un token de acceso a la instalación dentro de tu flujo de trabajo: + +1. Almacena la ID de tu {% data variables.product.prodname_github_app %} como un secreto. En el siguiente ejemplo, reemplaza `APP_ID` con el nombre del secreto. Puedes encontrar tu ID de app en la página de ajustes de tu app o mediante la API de la misma. Para obtener más información, consulta la sección "[Apps](/rest/apps/apps#get-an-app)". Para obtener más información sobre los secretos, consulta la sección "[Secretos cifrados](/actions/security-guides/encrypted-secrets)". +1. Generar una llave privada para tu app. Almacena el contenido del archivo resultante como un secreto. (Almacena todo el contenido del archivo, incluyendo `-----BEGIN RSA PRIVATE KEY-----` y `-----END RSA PRIVATE KEY-----`.) En el siguiente ejemplo, reemplaza a `APP_PEM` con el nombre del secreto. Para obtener más información, consulta la sección "[Autenticarse con {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)". +1. Agrega un paso para generar un token y utilizarlo en vez de `GITHUB_TOKEN`. Nota que este token expirará después de 60 minutos. Por ejemplo: + +```yaml +{% data reusables.actions.actions-not-certified-by-github-comment %} + +on: + workflow_dispatch: +jobs: + track_pr: + runs-on: ubuntu-latest + steps: + - name: Generate token + id: generate_token + uses: tibdex/github-app-token@36464acb844fc53b9b8b2401da68844f6b05ebb0 + with: + app_id: {% raw %}${{ secrets.APP_ID }}{% endraw %} + private_key: {% raw %}${{ secrets.APP_PEM }}{% endraw %} + + - name: Use API + env: + GH_TOKEN: {% raw %}${{ steps.generate_token.outputs.token }}{% endraw %} + run: | + gh api repos/octocat/Spoon-Knife/issues +``` + +{% endcli %} + +{% javascript %} + +## Comenzar a utilizar JavaScript + +Puedes utilizar Octokit.js para interactuar con la API de REST de {% data variables.product.prodname_dotcom %} en tus scripts de JavaScript. Para obtener más información, consulta [el README de Octokit.js](https://github.com/octokit/octokit.js/#readme). + +### Utilizar Octokit.js + +1. Crear un token de acceso. Por ejemplo, crea un token de acceso personal (PAT) o un token de acceso de usuario a servidor de {% data variables.product.prodname_github_app %}. For more information, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)" or "[Identifying and authorizing users for GitHub Apps](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps)." + + {% warning %} + + **Warning**: Treat your access token like a password. + + To keep your token secure, you can store your token as a secret and run your script through {% data variables.product.prodname_actions %}. For more information, see the "[Using Octokit.js in {% data variables.product.prodname_actions %}](#using-octokitjs-in-github-actions)" section. + + {%- ifversion fpt or ghec %} + + You can also store your token as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} + + If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. + + {% endwarning %} + +1. Install `octokit`. For example, `npm install octokit`. For other ways to install or load `octokit`, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). +1. Import `octokit` in your script. For example, `import { Octokit } from "octokit";`. For other ways to import `octokit`, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). +1. Create an instance of `Octokit` with your token. Replace `YOUR-TOKEN` with your token. + + ```javascript + const octokit = new Octokit({ + auth: 'YOUR-TOKEN' + }); + ``` + +1. Use `octokit.request` to execute your request. Send the HTTP method and path as the first argument. Specify any path, query, and body parameters in an object as the second argument. For example, in the following request the HTTP method is `GET`, the path is `/repos/{owner}/{repo}/issues`, and the parameters are `owner: "octocat"` and `repo: "Spoon-Knife"`. + + ```javascript + await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + }); + ``` + +### Using Octokit.js in {% data variables.product.prodname_actions %} + +You can also execute your JavaScript scripts in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." + +{% data variables.product.prodname_dotcom %} recomienda que utilices el `GITHUB_TOKEN` integrado en vez de crear un token. Si esto es imposible, almacena tu token como un secreto y reemplaza a `GITHUB_TOKEN` por el nombre de tu secreto en el siguiente ejemplo. Para obtener más información sobre el `GITHUB_TOKEN`, consulta ""[Automatic token authentication](/actions/security-guides/automatic-token-authentication)". Para obtener más información sobre los secretos, consulta la sección "[Secretos cifrados](/actions/security-guides/encrypted-secrets)". + +The following example workflow: + +1. Checks out the repository content +1. Sets up Node.js +1. Installs `octokit` +1. Stores the value of `GITHUB_TOKEN` as an environment variable called `TOKEN` and runs `.github/actions-scripts/use-the-api.mjs`, which can access that environment variable as `process.env.TOKEN` + +Example workflow: + +```yaml +on: + workflow_dispatch: +jobs: + use_api_via_script: + runs-on: ubuntu-latest + permissions: + issues: read + steps: + - name: Check out repo content + uses: {% data reusables.actions.action-checkout %} + + - name: Setup Node + uses: {% data reusables.actions.action-setup-node %} + with: + node-version: '16.15.0' + cache: npm + + - name: Install dependencies + run: npm install octokit + + - name: Run script + run: | + node .github/actions-scripts/use-the-api.mjs + env: + TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} +``` + +Example JavaScript script, with the file path `.github/actions-scripts/use-the-api.mjs`: + +```javascript +import { Octokit } from "octokit" + +const octokit = new Octokit({ + auth: process.env.TOKEN +}); + +try { + const result = await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + }); + + const titleAndAuthor = result.data.map(issue => {title: issue.title, authorID: issue.user.id}) + + console.log(titleAndAuthor) + +} catch (error) { + console.log(`Error! Status: ${error.status}. Message: ${error.response.data.message}`) +} +``` + +Si te estás autenticando con una {% data variables.product.prodname_github_app %}, puedes crear un token de acceso a la instalación dentro de tu flujo de trabajo: + +1. Almacena la ID de tu {% data variables.product.prodname_github_app %} como un secreto. En el siguiente ejemplo, reemplaza `APP_ID` con el nombre del secreto. Puedes encontrar tu ID de app en la página de ajustes de tu app o mediante la API de la misma. Para obtener más información, consulta la sección "[Apps](/rest/apps/apps#get-an-app)". Para obtener más información sobre los secretos, consulta la sección "[Secretos cifrados](/actions/security-guides/encrypted-secrets)". +1. Generar una llave privada para tu app. Almacena el contenido del archivo resultante como un secreto. (Almacena todo el contenido del archivo, incluyendo `-----BEGIN RSA PRIVATE KEY-----` y `-----END RSA PRIVATE KEY-----`.) En el siguiente ejemplo, reemplaza a `APP_PEM` con el nombre del secreto. Para obtener más información, consulta la sección "[Autenticarse con {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)". +1. Agrega un paso para generar un token y utilizarlo en vez de `GITHUB_TOKEN`. Nota que este token expirará después de 60 minutos. Por ejemplo: + +```yaml +{% data reusables.actions.actions-not-certified-by-github-comment %} + +on: + workflow_dispatch: +jobs: + use_api_via_script: + runs-on: ubuntu-latest + steps: + - name: Check out repo content + uses: {% data reusables.actions.action-checkout %} + + - name: Setup Node + uses: {% data reusables.actions.action-setup-node %} + with: + node-version: '16.15.0' + cache: npm + + - name: Install dependencies + run: npm install octokit + + - name: Generate token + id: generate_token + uses: tibdex/github-app-token@36464acb844fc53b9b8b2401da68844f6b05ebb0 + with: + app_id: {% raw %}${{ secrets.APP_ID }}{% endraw %} + private_key: {% raw %}${{ secrets.APP_PEM }}{% endraw %} + + - name: Run script + run: | + node .github/actions-scripts/use-the-api.mjs + env: + TOKEN: {% raw %}${{ steps.generate_token.outputs.token }}{% endraw %} +``` + +{% endjavascript %} + +{% curl %} + +## Getting started using cURL + +### Using cURL in the command line + +{% note %} + +**Note:** If you want to make API requests from the command line, {% data variables.product.prodname_dotcom %} recommends that you use {% data variables.product.prodname_cli %}, which simplifies authentication and requests. For more information about getting started with the REST API using {% data variables.product.prodname_cli %}, see the {% data variables.product.prodname_cli %} version of this article. + +{% endnote %} + +1. Install cURL if cURL isn't already installed on your machine. To check if cURL is installed, execute `curl --version` in the command line. If the output is information about the cURL version, cURL is installed. If you get a message similar to `command not found: curl`, you need to download and install cURL. For more information, see [the cURL project download page](https://curl.se/download.html). +1. Crear un token de acceso. Por ejemplo, crea un token de acceso personal (PAT) o un token de acceso de usuario a servidor de {% data variables.product.prodname_github_app %}. For more information, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)" or "[Identifying and authorizing users for GitHub Apps](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps)." + + {% warning %} + + **Warning**: Treat your access token like a password. + + {%- ifversion fpt or ghec %} + + To keep your token secure, you can store your token as a {% data variables.product.prodname_codespaces %} secret and use the command line through {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} + + You can also use {% data variables.product.prodname_cli %} instead of cURL. {% data variables.product.prodname_cli %} will take care of authentication for you. For more information, see the {% data variables.product.prodname_cli %} version of this page. + + If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. + + {% endwarning %} + +1. Use the `cURL` command to make your request. Pass your token in an `Authorization` header. Replace `YOUR-TOKEN` with your token. + + ```shell + curl --request GET \ + --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ + --header "Accept: application/vnd.github.v3+json" \ + --header "Authorization: Bearer YOUR-TOKEN" + ``` + + {% note %} + + **Note:** In most cases, you can use `Authorization: Bearer` or `Authorization: token`. JSON web tokens (JWTs) only work with `Authorization: Bearer`. + + {% endnote %} + +### Using cURL in {% data variables.product.prodname_actions %} + +You can also use cURL in your {% data variables.product.prodname_actions %} workflows. + +{% data variables.product.prodname_dotcom %} recomienda que utilices el `GITHUB_TOKEN` integrado en vez de crear un token. Si esto es imposible, almacena tu token como un secreto y reemplaza a `GITHUB_TOKEN` por el nombre de tu secreto en el siguiente ejemplo. Para obtener más información sobre el `GITHUB_TOKEN`, consulta ""[Automatic token authentication](/actions/security-guides/automatic-token-authentication)". Para obtener más información sobre los secretos, consulta la sección "[Secretos cifrados](/actions/security-guides/encrypted-secrets)". + +```yaml +on: + workflow_dispatch: +jobs: + use_api: + runs-on: ubuntu-latest + permissions: + issues: read + steps: + - env: + GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + curl --request GET \ + --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ + --header "Accept: application/vnd.github.v3+json" \ + --header "Authorization: Bearer $GH_TOKEN" +``` + +Si te estás autenticando con una {% data variables.product.prodname_github_app %}, puedes crear un token de acceso a la instalación dentro de tu flujo de trabajo: + +1. Almacena la ID de tu {% data variables.product.prodname_github_app %} como un secreto. En el siguiente ejemplo, reemplaza `APP_ID` con el nombre del secreto. Puedes encontrar tu ID de app en la página de ajustes de tu app o mediante la API de la misma. Para obtener más información, consulta la sección "[Apps](/rest/apps/apps#get-an-app)". Para obtener más información sobre los secretos, consulta la sección "[Secretos cifrados](/actions/security-guides/encrypted-secrets)". +1. Generar una llave privada para tu app. Almacena el contenido del archivo resultante como un secreto. (Almacena todo el contenido del archivo, incluyendo `-----BEGIN RSA PRIVATE KEY-----` y `-----END RSA PRIVATE KEY-----`.) En el siguiente ejemplo, reemplaza a `APP_PEM` con el nombre del secreto. Para obtener más información, consulta la sección "[Autenticarse con {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)". +1. Agrega un paso para generar un token y utilizarlo en vez de `GITHUB_TOKEN`. Nota que este token expirará después de 60 minutos. Por ejemplo: + +```yaml +{% data reusables.actions.actions-not-certified-by-github-comment %} + +on: + workflow_dispatch: +jobs: + use_api: + runs-on: ubuntu-latest + steps: + - name: Generate token + id: generate_token + uses: tibdex/github-app-token@36464acb844fc53b9b8b2401da68844f6b05ebb0 + with: + app_id: {% raw %}${{ secrets.APP_ID }}{% endraw %} + private_key: {% raw %}${{ secrets.APP_PEM }}{% endraw %} + + - name: Use API + env: + GH_TOKEN: {% raw %}${{ steps.generate_token.outputs.token }}{% endraw %} + run: | + curl --request GET \ + --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ + --header "Accept: application/vnd.github.v3+json" \ + --header "Authorization: Bearer $GH_TOKEN" +``` + +{% endcurl %} + +## Pasos siguientes + +Para obtener una guía más detallada, consulta la sección "[Iniciar con la API de REST](/rest/guides/getting-started-with-the-rest-api)". diff --git a/translations/es-ES/content/rest/rate-limit.md b/translations/es-ES/content/rest/rate-limit.md index b779a8e124..f6f2f8bad1 100644 --- a/translations/es-ES/content/rest/rate-limit.md +++ b/translations/es-ES/content/rest/rate-limit.md @@ -1,6 +1,6 @@ --- title: Limite de tasa -intro: 'With the Rate limit API, you can check the current rate limit status of various REST APIs.' +intro: 'Con la API de límites de tasa, puedes verificar el estado de límite de tasa actual de varias API de REST.' versions: fpt: '*' ghes: '*' @@ -13,7 +13,7 @@ redirect_from: - /rest/reference/rate-limit --- -## About the Rate limit API +## Acerca de la API de límites de tasa La documentación general de la API de REST describe las [reglas de los límites de tasa](/rest/overview/resources-in-the-rest-api#rate-limiting). Puedes revisar tu estado actual de límite de tasa en cualquier momento utilizando la API de Límites de Tasa que se describe a continuación. diff --git a/translations/es-ES/content/rest/releases/releases.md b/translations/es-ES/content/rest/releases/releases.md index 09a0da8dd3..c0b0e14cce 100644 --- a/translations/es-ES/content/rest/releases/releases.md +++ b/translations/es-ES/content/rest/releases/releases.md @@ -1,6 +1,6 @@ --- title: Lanzamientos -intro: 'The Releases API allows you to create, modify, and delete releases and release assets.' +intro: 'La API de lanzamientos te permite crear, modificar y borrar los lanzamientos y activos de lanzamiento.' versions: fpt: '*' ghes: '*' diff --git a/translations/es-ES/content/rest/repos/autolinks.md b/translations/es-ES/content/rest/repos/autolinks.md index 41c8776af2..651b16c462 100644 --- a/translations/es-ES/content/rest/repos/autolinks.md +++ b/translations/es-ES/content/rest/repos/autolinks.md @@ -1,5 +1,5 @@ --- -title: Repository autolinks +title: Autoenlaces de repositorio allowTitleToDifferFromFilename: true shortTitle: Autoenlaces intro: 'Para ayudar a optimizar tu flujo de trabajo, puedes utilizar la API para agregar autoenlaces a los recursos externos como propuestas de JIRA y tickets de Zendesk.' @@ -13,7 +13,7 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Repository autolinks API +## Acerca de la API de autoenlaces de repositorio Para obtener más información, consulta la sección "[Configurar los autoenlaces para referenciar recursos externos](/github/administering-a-repository/configuring-autolinks-to-reference-external-resources)". diff --git a/translations/es-ES/content/rest/secret-scanning.md b/translations/es-ES/content/rest/secret-scanning.md index 9d8864449a..2fd9624093 100644 --- a/translations/es-ES/content/rest/secret-scanning.md +++ b/translations/es-ES/content/rest/secret-scanning.md @@ -1,5 +1,5 @@ --- -title: Escaneo de secretos +title: Secret scanning intro: Use the Secret scanning API to retrieve and update secret alerts from a repository. versions: ghes: '*' @@ -16,9 +16,9 @@ redirect_from: ## About the Secret scanning API -La API del {% data variables.product.prodname_secret_scanning %} te permite : +The {% data variables.product.prodname_secret_scanning %} API lets you: -- Enable or disable {% data variables.product.prodname_secret_scanning %}{% ifversion secret-scanning-push-protection %} and push protection{% endif %} for a repository. Para obtener más información, consulta la sección "[Repositorios](/rest/repos/repos#update-a-repository)" y expande la sección de "Propiedades del objeto `security_and_analysis`" en la documentación de la API de REST. +- Enable or disable {% data variables.product.prodname_secret_scanning %}{% ifversion secret-scanning-push-protection %} and push protection{% endif %} for a repository. For more information, see "[Repositories](/rest/repos/repos#update-a-repository)" and expand the "Properties of the `security_and_analysis` object" section in the REST API documentation. - Retrieve and update {% data variables.product.prodname_secret_scanning_GHAS %} alerts from a repository. For further details, see the sections below. -Para obtener más información acerca de las {% data variables.product.prodname_secret_scanning %}, consulta la sección "[Acerca del {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)". +For more information about {% data variables.product.prodname_secret_scanning %}, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)." diff --git a/translations/es-ES/content/rest/teams/discussion-comments.md b/translations/es-ES/content/rest/teams/discussion-comments.md index 728a28d1f0..10a4ce9b67 100644 --- a/translations/es-ES/content/rest/teams/discussion-comments.md +++ b/translations/es-ES/content/rest/teams/discussion-comments.md @@ -1,8 +1,8 @@ --- -title: Team discussion comments +title: Comentarios de debates de equipo allowTitleToDifferFromFilename: true shortTitle: Comentarios de debate -intro: 'The team discussion comments API allows you to get, create, edit, and delete discussion comments on a [team discussion](/rest/reference/teams#discussions) post.' +intro: 'La API de comentarios de debate de equipo te permite obtener, crear, editar y borrar comentarios de debates en una publicación de un [debate de equipo](/rest/reference/teams#discussions).' versions: fpt: '*' ghes: '*' @@ -13,7 +13,7 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Team discussion comments API +## Acerca de la API de comentarios de debates de equipo Cualquier miembro de la [organización](/rest/reference/orgs) del equipo puede crear y leer los comentarios de un debate público. Para obtener más detalles, consulta la sección "[Acerca de los debates de equipo](/organizations/collaborating-with-your-team/about-team-discussions/)". diff --git a/translations/es-ES/content/rest/teams/external-groups.md b/translations/es-ES/content/rest/teams/external-groups.md index a93b9ddc0b..023babf84b 100644 --- a/translations/es-ES/content/rest/teams/external-groups.md +++ b/translations/es-ES/content/rest/teams/external-groups.md @@ -19,7 +19,7 @@ Para utilizar esta API, el usuario autenticado debe ser un mantenedor del equipo **Notas:** -- La API de grupos externos solo se encuentra disponible para aquellas organizaciones que sean parte de una empresa que utilice {% data variables.product.prodname_emus %}. Para obtener más información, consulta la sección "[Acerca de los Usuarios Empresariales Administrados](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)". +- The external groups API is only available for organizations that are part of an enterprise using {% data variables.product.prodname_emus %}. Para obtener más información, consulta la sección "[Acerca de los Usuarios Empresariales Administrados](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)". - Si tu organización utiliza la sincronización de equipos, puedes usar la API de Sincronización de Equipos. Para obtener más información, consulta la "[API de sincronización de equipos](#team-synchronization)". {% endnote %} diff --git a/translations/es-ES/content/rest/teams/team-sync.md b/translations/es-ES/content/rest/teams/team-sync.md index 0e69b0283c..890e8bfc56 100644 --- a/translations/es-ES/content/rest/teams/team-sync.md +++ b/translations/es-ES/content/rest/teams/team-sync.md @@ -1,6 +1,6 @@ --- title: Sincronización de equipos -intro: 'The Team synchronization API allows you to manage connections between {% data variables.product.product_name %} teams and external identity provider (IdP) groups.' +intro: 'La API de sincronización de equipos te permite administrar las conexiones entre los equipos de {% data variables.product.product_name %} y los grupos de proveedores de identidad (IdP) externos.' versions: fpt: '*' ghec: '*' @@ -10,7 +10,7 @@ miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true --- -## About the Team synchronization API +## Acerca de la API de sincronización Para utilizar esta API, el usuario autenticado debe ser un mantenedor del equipo o un propietario de la organización asociada con éste. El token que utilizas para autenticarte también necesitará autorizarse para su uso con tu proveedor IdP (SSO). Para obtener más información, consulta la sección "[Autorizar un token de acceso personal para su uso con una organización que tiene inicio de sesión único de SAML](/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)". diff --git a/translations/es-ES/content/rest/teams/teams.md b/translations/es-ES/content/rest/teams/teams.md index e86f3a7da3..0336191421 100644 --- a/translations/es-ES/content/rest/teams/teams.md +++ b/translations/es-ES/content/rest/teams/teams.md @@ -1,6 +1,6 @@ --- title: Equipos -intro: 'With the Teams API, you can create and manage teams in your GitHub organization.' +intro: 'Con la API de equipos, puedes crear y administrar equipos en tu organización de GitHub.' versions: fpt: '*' ghes: '*' @@ -11,6 +11,6 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Teams API +## Acerca de la API de equipos {% data reusables.organizations.team-api %} diff --git a/translations/es-ES/content/rest/users/gpg-keys.md b/translations/es-ES/content/rest/users/gpg-keys.md index b768a456ae..1c71c096f3 100644 --- a/translations/es-ES/content/rest/users/gpg-keys.md +++ b/translations/es-ES/content/rest/users/gpg-keys.md @@ -1,5 +1,5 @@ --- -title: GPG Keys +title: Llaves GPG intro: '' versions: fpt: '*' @@ -11,7 +11,7 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the User GPG keys API +## Acerca de la API de llaves GPG de usuario Los datos que se devuelven en el campo de respuesta de `public_key` no son una llave con formato de GPG. Cuando un usuario carga una llave GPG, se interpreta y la llave pública criptográfica se extrae y se almacena. Esta llave criptográfica es lo que devuelven las API en esta página. Esta llave no es apta para utilizarse directamente con programas como GPG. diff --git a/translations/es-ES/content/rest/users/keys.md b/translations/es-ES/content/rest/users/keys.md index 45b91e5947..8c46a7889f 100644 --- a/translations/es-ES/content/rest/users/keys.md +++ b/translations/es-ES/content/rest/users/keys.md @@ -1,5 +1,5 @@ --- -title: Git SSH Keys +title: Llaves SSH de Git intro: '' versions: fpt: '*' @@ -12,6 +12,6 @@ miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true --- -## About the User Git SSH keys API +## Acerca de la API de llaves SSH de usuario de Git {% data reusables.user-settings.user-api %} diff --git a/translations/es-ES/content/rest/webhooks/index.md b/translations/es-ES/content/rest/webhooks/index.md index 939090a9ea..9ce89decaa 100644 --- a/translations/es-ES/content/rest/webhooks/index.md +++ b/translations/es-ES/content/rest/webhooks/index.md @@ -70,9 +70,9 @@ Las solicitudes de PubSubHubbub pueden enviarse varias veces. Si el gancho ya ex #### Parámetros -| Nombre | Tipo | Descripción | -| -------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `hub.mode` | `secuencia` | **Requerido**. Ya sea `subscribe` o `unsubscribe`. | -| `hub.topic` | `secuencia` | **Requerido**. La URI del repositorio de GitHub al cual suscribirse. La ruta debe estar en el formato `/{owner}/{repo}/events/{event}`. | -| `hub.callback` | `secuencia` | La URI para recibir las actualizaciones del tema. | -| `hub.secret` | `secuencia` | Una llave de secreto compartido que genera una firma de hash del contenido saliente del cuerpo. You can verify a push came from GitHub by comparing the raw request body with the contents of the {% ifversion fpt or ghes or ghec %}`X-Hub-Signature` or `X-Hub-Signature-256` headers{% elsif ghae %}`X-Hub-Signature-256` header{% endif %}. Puedes ver [la documentación de PubSubHubbub](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify) para obtener más detalles. | +| Nombre | Tipo | Descripción | +| -------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `hub.mode` | `secuencia` | **Requerido**. Ya sea `subscribe` o `unsubscribe`. | +| `hub.topic` | `secuencia` | **Requerido**. La URI del repositorio de GitHub al cual suscribirse. La ruta debe estar en el formato `/{owner}/{repo}/events/{event}`. | +| `hub.callback` | `secuencia` | La URI para recibir las actualizaciones del tema. | +| `hub.secret` | `secuencia` | Una llave de secreto compartido que genera una firma de hash del contenido saliente del cuerpo. Puedes verificar si una subida de información vino de GitHub cuando comparas el cuerpo de la solicitud sin procesar con el contenido de {% ifversion fpt or ghes or ghec %} los encabezados `X-Hub-Signature` o `X-Hub-Signature-256`{% elsif ghae %}`X-Hub-Signature-256` header{% endif %}. Puedes ver [la documentación de PubSubHubbub](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify) para obtener más detalles. | diff --git a/translations/es-ES/content/rest/webhooks/repo-config.md b/translations/es-ES/content/rest/webhooks/repo-config.md index 889e95cdb8..00cd82c410 100644 --- a/translations/es-ES/content/rest/webhooks/repo-config.md +++ b/translations/es-ES/content/rest/webhooks/repo-config.md @@ -1,5 +1,5 @@ --- -title: Repository Webhook Configuration +title: Configuración de webhook de repositorio intro: '' versions: fpt: '*' diff --git a/translations/es-ES/content/rest/webhooks/repos.md b/translations/es-ES/content/rest/webhooks/repos.md index 55bc892fc3..c53356342f 100644 --- a/translations/es-ES/content/rest/webhooks/repos.md +++ b/translations/es-ES/content/rest/webhooks/repos.md @@ -1,5 +1,5 @@ --- -title: Repository Webhooks +title: Webhooks de repositorio intro: '' versions: fpt: '*' diff --git a/translations/es-ES/content/site-policy/github-terms/github-community-code-of-conduct.md b/translations/es-ES/content/site-policy/github-terms/github-community-code-of-conduct.md index 75c2b26d17..ffdf5505f0 100644 --- a/translations/es-ES/content/site-policy/github-terms/github-community-code-of-conduct.md +++ b/translations/es-ES/content/site-policy/github-terms/github-community-code-of-conduct.md @@ -16,7 +16,7 @@ topics: Millones de desarrolladores en todo el mundo hospedan millones de proyectos, tanto de código propietario como de código libre, en GitHub. Somo afortunados de poder tomar parte en habilitar la colaboración a lo largo de la comunidad de desarrolladores cada día, lo cual es una responsabilidad que no nos tomamos a la ligera. Juntos, tenemos la emocionante oportunidad de hacer de esta una comunidad de la cual podamos estar orgullosos. -GitHub Community, powered by GitHub Discussions, is intended to be a place for further collaboration, support, and brainstorming. Este es un lugar civilizado para conectarse con otros usuarios, aprender nuevas habilidades, compartir comentarios e ideas y encontrar todo el apoyo que necesitas para tus proyectos de GitHub. By participating in GitHub Community, you are agreeing to the same [Terms of Service](/github/site-policy/github-terms-of-service/) and [GitHub Acceptable Use Policies](/github/site-policy/github-acceptable-use-policies) that apply to GitHub.com, as well as this GitHub Community-specific Code of Conduct. +GitHub Community, powered by GitHub Discussions, is intended to be a place for further collaboration, support, and brainstorming. Este es un lugar civilizado para conectarse con otros usuarios, aprender nuevas habilidades, compartir comentarios e ideas y encontrar todo el apoyo que necesitas para tus proyectos de GitHub. Si participas en la Comunidad de GitHub, estás de acuerdo con los mismos [Términos de servicio](/github/site-policy/github-terms-of-service/) y [Políticas de uso aceptable de GitHub](/github/site-policy/github-acceptable-use-policies) que aplican a GitHub.com, así como este Código de Conducta específico de la Comunidad de GitHub. With this Code of Conduct, we hope to help you understand how best to collaborate in GitHub Community, what you can expect from moderators, and what type of actions or content may result in temporary or permanent suspension from community participation. We will investigate any abuse reports and may moderate public content within GitHub Community that we determine to be in violation of either the GitHub Terms of Service or this Code of Conduct. diff --git a/translations/es-ES/content/site-policy/privacy-policies/github-privacy-statement.md b/translations/es-ES/content/site-policy/privacy-policies/github-privacy-statement.md index 3d813c5712..bad3f3d933 100644 --- a/translations/es-ES/content/site-policy/privacy-policies/github-privacy-statement.md +++ b/translations/es-ES/content/site-policy/privacy-policies/github-privacy-statement.md @@ -314,8 +314,8 @@ Tienes derecho a decidir no participar en "ventas" futuras de información perso #### Derecho a la no discriminación. Tienes derecho a que no se te discrimine por ejercer tus derechos bajo la CCPA. No te discriminaremos por ejercer tus derechos de acuerdo con l a CCPA. -Puedes designar, ya sea por escrito o mediante un poder notarial, que un agente autorizado haga solicitudes en tu nombre para ejercer tus derechos bajo la CCPA. Antes de aceptar tal solicitud de un agente, requeriremos que este proporcione pruebas de que lo autorizaste para actuar en tu nombre y podríamos necesitar que verifiques tu identidad directamente con nosotros. Además, para proporcionar o borrar los fragmentos de información personal específicos, necesitaremos verificar tu identidad según el grado de certeza que requiera la ley. Verificaremos tu solicitud pidiéndote que la envíes desde la dirección de correo electrónico asociada con tu cuenta o requiriéndote que proporciones la información necesaria para verificar tu cuenta. [Please note that you may use two-factor authentication with your GitHub account](/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication). -Finally, you have a right to receive notice of our practices at or before collection of personal information. +Puedes designar, ya sea por escrito o mediante un poder notarial, que un agente autorizado haga solicitudes en tu nombre para ejercer tus derechos bajo la CCPA. Antes de aceptar tal solicitud de un agente, requeriremos que este proporcione pruebas de que lo autorizaste para actuar en tu nombre y podríamos necesitar que verifiques tu identidad directamente con nosotros. Además, para proporcionar o borrar los fragmentos de información personal específicos, necesitaremos verificar tu identidad según el grado de certeza que requiera la ley. Verificaremos tu solicitud pidiéndote que la envíes desde la dirección de correo electrónico asociada con tu cuenta o requiriéndote que proporciones la información necesaria para verificar tu cuenta. [Toma en cuenta que podrías utilizar autenticación bifactorial con tu cuenta de GitHub](/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication). +Finalmente, tienes el derecho de recibir avisos de nuestras prácticas durante o antes de la recopilación de información personal. Adicionalmente, bajo la sección 1798.83 del Código Civil de California, también conocida como la ley "Shine the Light", los residentes de California que hayan proporcionado información personal a algún negocio con el que el individuo haya establecido una relación de negocios para propósitos, familiares o del hogar ("Clientes de California") podrán solicitar información sobre si el negocio ha divulgado su información personal a cualquier tercero o no para propósitos de marketing directo de dichos terceros. Considera que no divulgamos información personal a nadie para propósitos de marketing directo, de acuerdo con lo que define esta ley. Los Clientes de California podrán requerir que se les proporcione más información sobre nuestro cumplimiento con esta ley enviando un mensaje por correo electrónico **(privacy [at] github [dot] com)**. Toma en cuenta que se requiere que los negocios respondan a una solicitud por Cliente de California cada año y podría que no se les requiera responder a las solicitudes que se hacen por medios diferentes que la dirección de correo electrónico designada. diff --git a/translations/es-ES/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md b/translations/es-ES/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md index 9e45fd653f..a4e303e98f 100644 --- a/translations/es-ES/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md +++ b/translations/es-ES/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md @@ -18,7 +18,7 @@ Fecha de entrada en vigor: **2 de abril de 2021** {% note %} -**Note:** Changes to the list of cookies on this page are currently pending. +**Nota:** Los cambios a la lista de cookies en esta página están pendientes actualmente. {% endnote %} diff --git a/translations/es-ES/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md b/translations/es-ES/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md index 15580fe9d5..ac7b924155 100644 --- a/translations/es-ES/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md +++ b/translations/es-ES/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md @@ -25,7 +25,7 @@ shortTitle: Patrocina a un contribuyente Puedes patrocinar una cuenta en nombre de tu cuenta personal para invertir en los proyectos de los cuales te beneficies personalmente. Puedes patrocinar una cuenta en nombre de tu organización por varias razones. - Mantener bibliotecas específicas de las cuales dependa el trabajo de tu organización -- Invertir en el ecosistema del cual dependes como organización (tal como blockchain) +- Investing in the ecosystem you rely on as an organization (such as blockchain) - Desarrollar una conciencia de marca como una organización que valora el código abierto - Agradecer a los desarrolladores de código abierto por crear bibliotecas que complementan el producto que ofrece tu organización diff --git a/translations/es-ES/data/features/actions-oidc-hardening-config.yml b/translations/es-ES/data/features/actions-oidc-hardening-config.yml new file mode 100644 index 0000000000..f3048bac8b --- /dev/null +++ b/translations/es-ES/data/features/actions-oidc-hardening-config.yml @@ -0,0 +1,6 @@ +#Reference: #7336 +#General versioning for oidc hardening options +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' diff --git a/translations/es-ES/data/features/actions-reusable-workflow-matrix.yml b/translations/es-ES/data/features/actions-reusable-workflow-matrix.yml new file mode 100644 index 0000000000..6ab9b12b6b --- /dev/null +++ b/translations/es-ES/data/features/actions-reusable-workflow-matrix.yml @@ -0,0 +1,7 @@ +#Reference: #7094 +#Documentation for allowing matrix jobs to call reusable workflows. +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7094' diff --git a/translations/es-ES/data/features/dependabot-alerts-dismissal-comment.yml b/translations/es-ES/data/features/dependabot-alerts-dismissal-comment.yml new file mode 100644 index 0000000000..e2c2294cea --- /dev/null +++ b/translations/es-ES/data/features/dependabot-alerts-dismissal-comment.yml @@ -0,0 +1,6 @@ +#Reference: Issue #7673 - Dependabot alerts: optional comment with dismissal - [GA] +versions: + fpt: '*' + ghec: '*' + ghes: '>3.6' + ghae: 'issue-7673' diff --git a/translations/es-ES/data/features/dependabot-alerts-vulnerable-calls.yml b/translations/es-ES/data/features/dependabot-alerts-vulnerable-calls.yml index 84825c368b..a7f772a7c5 100644 --- a/translations/es-ES/data/features/dependabot-alerts-vulnerable-calls.yml +++ b/translations/es-ES/data/features/dependabot-alerts-vulnerable-calls.yml @@ -3,5 +3,4 @@ versions: fpt: '*' ghec: '*' - ghes: '>3.5' ghae: 'issue-6076' diff --git a/translations/es-ES/data/features/enterprise-namespace-repo-setting.yml b/translations/es-ES/data/features/enterprise-namespace-repo-setting.yml new file mode 100644 index 0000000000..e20549f3ea --- /dev/null +++ b/translations/es-ES/data/features/enterprise-namespace-repo-setting.yml @@ -0,0 +1,6 @@ +#Reference: #7757 +#Setting to disable personal namespace repo creation for EMUs, GHES 3.7+ and GHAE 3.7+ users +versions: + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7757' diff --git a/translations/es-ES/data/features/ip-allow-list-address-check.yml b/translations/es-ES/data/features/ip-allow-list-address-check.yml new file mode 100644 index 0000000000..c4dda87a70 --- /dev/null +++ b/translations/es-ES/data/features/ip-allow-list-address-check.yml @@ -0,0 +1,3 @@ +versions: + ghec: '*' + ghae: 'issue-7818' diff --git a/translations/es-ES/data/features/multiple-accounts-one-workstation.yml b/translations/es-ES/data/features/multiple-accounts-one-workstation.yml new file mode 100644 index 0000000000..9fce93b34e --- /dev/null +++ b/translations/es-ES/data/features/multiple-accounts-one-workstation.yml @@ -0,0 +1,5 @@ +#Issue #7330 +#Documentation for managing multiple GitHub accounts on one workstation +versions: + fpt: '*' + ghec: '*' diff --git a/translations/es-ES/data/features/nested-reusable-workflow.yml b/translations/es-ES/data/features/nested-reusable-workflow.yml new file mode 100644 index 0000000000..95d7cb5a56 --- /dev/null +++ b/translations/es-ES/data/features/nested-reusable-workflow.yml @@ -0,0 +1,7 @@ +#Issues 7093 +#Reusable workflows can call other reusable workflows +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7093' diff --git a/translations/es-ES/data/features/packages-npm-v2.yml b/translations/es-ES/data/features/packages-npm-v2.yml new file mode 100644 index 0000000000..572e412e4a --- /dev/null +++ b/translations/es-ES/data/features/packages-npm-v2.yml @@ -0,0 +1,5 @@ +#Issue 7039 +#npm Package Registry Improvements (v2) GA +versions: + fpt: '*' + ghec: '*' diff --git a/translations/es-ES/data/features/push-protection-custom-link-orgs-beta.yml b/translations/es-ES/data/features/push-protection-custom-link-orgs-beta.yml new file mode 100644 index 0000000000..509caa9fb4 --- /dev/null +++ b/translations/es-ES/data/features/push-protection-custom-link-orgs-beta.yml @@ -0,0 +1,8 @@ +#Issue 7299 +#Push protection custom links beta flags +#See "push-protection-custom-link-orgs" for the feature +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7299' diff --git a/translations/es-ES/data/features/push-protection-custom-link-orgs.yml b/translations/es-ES/data/features/push-protection-custom-link-orgs.yml new file mode 100644 index 0000000000..fce23efa96 --- /dev/null +++ b/translations/es-ES/data/features/push-protection-custom-link-orgs.yml @@ -0,0 +1,8 @@ +#Issue 7299 +#Push protection custom links +#See "push-protection-custom-link-orgs-beta" for the beta flags +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7299' diff --git a/translations/es-ES/data/features/ssh-commit-verification.yml b/translations/es-ES/data/features/ssh-commit-verification.yml new file mode 100644 index 0000000000..7851b1c8b7 --- /dev/null +++ b/translations/es-ES/data/features/ssh-commit-verification.yml @@ -0,0 +1,8 @@ +#Reference: github/docs-content#6709 +#Initial docs for showing SSH signed commits as verified and +#uploading SSH signing keys +versions: + fpt: '*' + ghec: '*' + ghes: '>= 3.7' + ghae: '*' diff --git a/translations/es-ES/data/features/streaming-datadog.yml b/translations/es-ES/data/features/streaming-datadog.yml new file mode 100644 index 0000000000..ab90546c8d --- /dev/null +++ b/translations/es-ES/data/features/streaming-datadog.yml @@ -0,0 +1,4 @@ +#Reference #7495 +#Documentation for audit log streaming to a Datadog endpoint +versions: + ghec: '*' diff --git a/translations/es-ES/data/graphql/ghec/graphql_upcoming_changes.public.yml b/translations/es-ES/data/graphql/ghec/graphql_upcoming_changes.public.yml index d5dcace2e4..99a8c8a2a2 100644 --- a/translations/es-ES/data/graphql/ghec/graphql_upcoming_changes.public.yml +++ b/translations/es-ES/data/graphql/ghec/graphql_upcoming_changes.public.yml @@ -994,6 +994,13 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: breaking owner: lukewar + - + location: ProjectView.groupedItems + description: 'Se eliminará a `groupedItems`. Sigue la guía de ProjectV2 en https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ para encontrar un reemplazo adecuado.' + reason: La API de `ProjectNext` quedará obsoleta para favorecer la API de `ProjectV2`, la cual tiene mayores capacidades. + date: '2022-10-01T00:00:00+00:00' + criticality: breaking + owner: lukewar - location: ProjectView.items description: 'Se eliminará a `items`. Sigue la guía de ProjectV2 en https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ para encontrar un reemplazo adecuado.' diff --git a/translations/es-ES/data/graphql/graphql_upcoming_changes.public.yml b/translations/es-ES/data/graphql/graphql_upcoming_changes.public.yml index d5dcace2e4..99a8c8a2a2 100644 --- a/translations/es-ES/data/graphql/graphql_upcoming_changes.public.yml +++ b/translations/es-ES/data/graphql/graphql_upcoming_changes.public.yml @@ -994,6 +994,13 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: breaking owner: lukewar + - + location: ProjectView.groupedItems + description: 'Se eliminará a `groupedItems`. Sigue la guía de ProjectV2 en https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ para encontrar un reemplazo adecuado.' + reason: La API de `ProjectNext` quedará obsoleta para favorecer la API de `ProjectV2`, la cual tiene mayores capacidades. + date: '2022-10-01T00:00:00+00:00' + criticality: breaking + owner: lukewar - location: ProjectView.items description: 'Se eliminará a `items`. Sigue la guía de ProjectV2 en https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ para encontrar un reemplazo adecuado.' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-1/20.yml b/translations/es-ES/data/release-notes/enterprise-server/3-1/20.yml index e5a8d1f357..a518cef9b1 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-1/20.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-1/20.yml @@ -6,11 +6,11 @@ sections: - 'El cargar nodos en un par con disponibilidad alta con un paquete de mejora pudo haber causado que Elasticsearch ingresara en un estado inconsistente en algunos casos.' - 'En algunas topologías de clúster, no pudieron ejecutarse las utilidades de línea de comandos `ghe-spokesctl` y `ghe-btop`.' - 'Los índices de Elastisearch podrían duplicarse durante la mejora de un paquete debido a que el servicio de `elasticsearch-upgrade` se ejecutó varias veces en paralelo.' - - 'The `maint_host_low` job queues were not processed, resulting in some maintenance tasks failing to run.' + - 'Las colas de job `maint_host_low` no se procesaron y esto dio como resultado que algunas tareas de mantenimiento no se pudieran ejecutar.' - 'Cuando conviertes una cuenta de usuario en una organización, si dicha cuenta fue propietaria de la cuenta empresarial de {% data variables.product.prodname_ghe_server %}, la organización convertida se mostró incorrectamente en la lista de propietarios de la empresa.' - 'El crear un token de OAuth de personificación utilizando la API de REST de administración de empresas dio como resultado un error cuando una integración que coincidió con la ID de aplicación de OAuth ya existía.' changes: - - 'When attempting to cache a value larger than the maximum allowed in Memcached, an error was raised however the key was not reported.' + - 'Cuando se intenta guardar en caché un valor mayor al máximo permitido en memcached, un error se levantó pero la llave no se reportó.' known_issues: - 'El registor de npm del {% data variables.product.prodname_registry %} ya no regresa un valor de tiempo en las respuestas de metadatos. Esto se hizo para permitir mejoras de rendimiento sustanciales. Seguimos teniendo todos los datos necesarios para devolver un valor de tiempo como parte de la respuesta de metadatos y terminaremos de devolver este valor ene l futuro una vez que hayamos resuelto los problemas de rendimiento existentes.' - 'En una instancia recién configurada de {% data variables.product.prodname_ghe_server %} sin ningún usuario, un atacante podría crear el primer usuario adminsitrador.' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-2/12.yml b/translations/es-ES/data/release-notes/enterprise-server/3-2/12.yml index 15273f31a9..59507e58e6 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-2/12.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-2/12.yml @@ -7,11 +7,11 @@ sections: - 'En algunas topologías de clúster, no pudieron ejecutarse las utilidades de línea de comandos `ghe-spokesctl` y `ghe-btop`.' - 'Los índices de Elastisearch podrían duplicarse durante la mejora de un paquete debido a que el servicio de `elasticsearch-upgrade` se ejecutó varias veces en paralelo.' - 'Cuando conviertes una cuenta de usuario en una organización, si dicha cuenta fue propietaria de la cuenta empresarial de {% data variables.product.prodname_ghe_server %}, la organización convertida se mostró incorrectamente en la lista de propietarios de la empresa.' - - 'Creating an impersonation OAuth token using the Enterprise Administration REST API worked incorrectly when an integration matching the OAuth Application ID already existed.' + - 'El crear un token de OAuth de personificación utilizando la API de REST de administración de empresas funcionó de forma incorrecta cuando una integración que coincidió con la ID de aplicación de OAuth ya existía.' changes: - 'Los errores de configuración que detienen una ejecución de aplicación de configuraciones ahora son el producto de la terminal adicionalmente a la bitácora de configuración.' - 'Al intentar almacenar en caché un valor que fuera más grande que el máximo permitido en Memcached, se levantó un error pero la clave no se reportó.' - - 'The {% data variables.product.prodname_codeql %} starter workflow no longer errors even if the default token permissions for {% data variables.product.prodname_actions %} are not used.' + - 'El flujo de trabajo inicial de {% data variables.product.prodname_codeql %} ya no muestra un error, incluso si no se utilizan los permisos del token predeterminado para {% data variables.product.prodname_actions %}.' - 'Si se habilitaron las características de {% data variables.product.prodname_GH_advanced_security %} en tu instancia, el rendimiento de los jobs en segundo plano mejoró al procesar los lotes para las contribuciones de repositorio.' known_issues: - 'En una instancia recién configurada de {% data variables.product.prodname_ghe_server %} sin ningún usuario, un atacante podría crear el primer usuario adminsitrador.' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-2/17.yml b/translations/es-ES/data/release-notes/enterprise-server/3-2/17.yml index 4b357844ba..62417df964 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-2/17.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-2/17.yml @@ -2,11 +2,11 @@ date: '2022-08-11' sections: security_fixes: - | - **CRITICAL**: GitHub Enterprise Server's Elasticsearch container used a version of OpenJDK 8 that was vulnerable to an integer truncation issue when processing malicious XSLT stylesheets. The vulnerability is tracked as [CVE-2022-34169](https://github.com/advisories/GHSA-9339-86wc-4qgf). + **CRÍTICA**: El contenedor de Elasticsearch de GitHub Enterprise Server utilizó una versión de OpenJDK 8 que estuvo vulnerable a un problema de truncamiento de número al procesar hojas de estilo de XSLT malintencionadas. La vulnerabilidad se rastreó como [CVE-2022-34169](https://github.com/advisories/GHSA-9339-86wc-4qgf). - | - **HIGH**: Previously installed apps on user accounts were automatically granted permission to access an organization on scoped access tokens after the user account was transformed into an organization account. This vulnerability was reported via the [GitHub Bug Bounty program](https://bounty.github.com). + **ALTA**: Las aplicaciones instaladas anteriormente en las cuentas de usuario obtuvieron permiso automáticamente para acceder a una organización en los tokens de acceso en el alcance después de que la cuenta de usuario se transformó en una cuenta de organización. Esta vulnerabilidad se reportó a través del [Programa de Recompensas por Errores de GitHub](https://bounty.github.com). bugs: - - When a custom dormancy threshold was set for the instance, suspending all dormant users did not reliably respect the threshold. For more information about dormancy, see "[Managing dormant users](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)." + - Cuando se configuró un umbral de inactividad personalizado para la instancia, el suspender a todos los usuarios inactivos no respetó confiablemente dicho umbral. Para obtener más información sobre la inactividad, consulta la sección "[Administrar a los usuarios inactivos](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)". known_issues: - En una instancia recién configurada de {% data variables.product.prodname_ghe_server %} sin ningún usuario, un atacante podría crear el primer usuario adminsitrador. - Las reglas de cortafuegos personalizadas se eliminan durante el proceso de actualización. diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-3/12.yml b/translations/es-ES/data/release-notes/enterprise-server/3-3/12.yml index 362eff8fbc..caafc57aab 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-3/12.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-3/12.yml @@ -2,13 +2,13 @@ date: '2022-08-11' sections: security_fixes: - | - **CRITICAL**: GitHub Enterprise Server's Elasticsearch container used a version of OpenJDK 8 that was vulnerable to an integer truncation issue when processing malicious XSLT stylesheets. The vulnerability is tracked as [CVE-2022-34169](https://github.com/advisories/GHSA-9339-86wc-4qgf). + **CRÍTICA**: El contenedor de Elasticsearch de GitHub Enterprise Server utilizó una versión de OpenJDK 8 que estuvo vulnerable a un problema de truncamiento de número al procesar hojas de estilo de XSLT malintencionadas. La vulnerabilidad se rastreó como [CVE-2022-34169](https://github.com/advisories/GHSA-9339-86wc-4qgf). - | - **HIGH**: Previously installed apps on user accounts were automatically granted permission to access an organization on scoped access tokens after the user account was transformed into an organization account. This vulnerability was reported via the [GitHub Bug Bounty program](https://bounty.github.com). + **ALTA**: Las aplicaciones instaladas anteriormente en las cuentas de usuario obtuvieron permiso automáticamente para acceder a una organización en los tokens de acceso en el alcance después de que la cuenta de usuario se transformó en una cuenta de organización. Esta vulnerabilidad se reportó a través del [Programa de Recompensas por Errores de GitHub](https://bounty.github.com). bugs: - - When a custom dormancy threshold was set for the instance, suspending all dormant users did not reliably respect the threshold. For more information about dormancy, see "[Managing dormant users](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)." + - Cuando se configuró un umbral de inactividad personalizado para la instancia, el suspender a todos los usuarios inactivos no respetó confiablemente dicho umbral. Para obtener más información sobre la inactividad, consulta la sección "[Administrar a los usuarios inactivos](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)". changes: - - 'The enterprise audit log now includes more user-generated events, such as `project.create`. The REST API also returns additional user-generated events, such as `repo.create`. For more information, see "[Accessing the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)" and "[Using the audit log API for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)."' + - 'La bitácora de auditoría ahora incluye más eventos generados por los usuarios, tal como `project.create`. La API de REST también devuelve eventos generados por el usuario, tal como `repo.create`. Para obtener más información, consulta las secciones "[Acceder a la bitácora de auditoría de tu empresa](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)" y "[Utilizar la API de bitácora de auditoría para tu empresa](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)".' known_issues: - Después de haber actualizado a {% data variables.product.prodname_ghe_server %} 3.3, podría que las {% data variables.product.prodname_actions %} no inicien automáticamente. Para resolver este problema, conéctate al aplicativo a través de SSH y ejecuta el comando `ghe-actions-start`. - En una instancia recién configurada de {% data variables.product.prodname_ghe_server %} sin ningún usuario, un atacante podría crear el primer usuario adminsitrador. diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-3/7.yml b/translations/es-ES/data/release-notes/enterprise-server/3-3/7.yml index d4118e7d0d..c015a20808 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-3/7.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-3/7.yml @@ -9,10 +9,10 @@ sections: - 'Se acumularon los archivos de bitácora rotados con la extensión `.backup` enlos directorios que contenían bitácoras de sistema.' - 'En algunas topologías de clúster, no pudieron ejecutarse las utilidades de línea de comandos `ghe-spokesctl` y `ghe-btop`.' - 'Los índices de Elastisearch podrían duplicarse durante la mejora de un paquete debido a que el servicio de `elasticsearch-upgrade` se ejecutó varias veces en paralelo.' - - 'In the pull request and commit views, rich diffs would fail to load for some files tracked by Git LFS.' + - 'En las vistas de confirmación y solicitud de cambios, las diferencias enriquecidas no pudieron cargar para algunos archivos rastreados por Git LFS.' - 'Cuando conviertes una cuenta de usuario en una organización, si dicha cuenta fue propietaria de la cuenta empresarial de {% data variables.product.prodname_ghe_server %}, la organización convertida se mostró incorrectamente en la lista de propietarios de la empresa.' - 'El crear un token de OAuth de personificación utilizando la API de REST de administración de empresas dio como resultado un error cuando una integración que coincidió con la ID de aplicación de OAuth ya existía.' - - 'The Secret Scanning REST API would return a `500` response code when there were UTF8 characters present in a detected secret.' + - 'La API de REST del escaneo de secretos devolvió un código de respuesta `500` cuando hubo caracteres UTF8 presentes en un secreto detectado.' - 'Los servidores de caché del repositorio pudieron servir datos de ubicaciones fuera del caché, incluso cuando los datos estuvieron disponibles en la ubicación del caché local.' changes: - 'Los errores de configuración que detienen una ejecución de aplicación de configuraciones ahora son el producto de la terminal adicionalmente a la bitácora de configuración.' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-4/2.yml b/translations/es-ES/data/release-notes/enterprise-server/3-4/2.yml index 0e7becdeaf..3e02d47236 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-4/2.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-4/2.yml @@ -11,10 +11,10 @@ sections: - 'Los índices de Elastisearch podrían duplicarse durante la mejora de un paquete debido a que el servicio de `elasticsearch-upgrade` se ejecutó varias veces en paralelo.' - 'Los servidores de caché del repositorio pudieron servir datos de ubicaciones fuera del caché, incluso cuando los datos estuvieron disponibles en la ubicación del caché local.' - 'Cuando conviertes una cuenta de usuario en una organización, si dicha cuenta fue propietaria de la cuenta empresarial de {% data variables.product.prodname_ghe_server %}, la organización convertida se mostró incorrectamente en la lista de propietarios de la empresa.' - - 'The `/stafftools/users/ip_addresses/:address` page responded with a `500 Internal Server Error` when attempting to display the page for an IPv6 address.' + - 'La página `/stafftools/users/ip_addresses/:address` respondió con un `500 Internal Server Error` cuando se intentó mostrar la página para una dirección IPv6.' - 'El crear un token de OAuth de personificación utilizando la API de REST de administración de empresas dio como resultado un error cuando una integración que coincidió con la ID de aplicación de OAuth ya existía.' changes: - - 'Added support for replica domain names that are more than 63 characters.' + - 'Se agregó compatibilidad para los nombres de dominio de réplica que tienen más de 63 caracteres.' - 'Los errores de configuración que detienen una ejecución de aplicación de configuraciones ahora son el producto de la terminal adicionalmente a la bitácora de configuración.' - 'Si se habilitaron las características de {% data variables.product.prodname_GH_advanced_security %} en tu instancia, el rendimiento de los jobs en segundo plano mejoró al procesar los lotes para las contribuciones de repositorio.' known_issues: diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-4/7.yml b/translations/es-ES/data/release-notes/enterprise-server/3-4/7.yml index 87225268ee..cd5d3665fa 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-4/7.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-4/7.yml @@ -2,13 +2,13 @@ date: '2022-08-11' sections: security_fixes: - | - **CRITICAL**: GitHub Enterprise Server's Elasticsearch container used a version of OpenJDK 8 that was vulnerable to an integer truncation issue when processing malicious XSLT stylesheets. The vulnerability is tracked as [CVE-2022-34169](https://github.com/advisories/GHSA-9339-86wc-4qgf). + **CRÍTICA**: El contenedor de Elasticsearch de GitHub Enterprise Server utilizó una versión de OpenJDK 8 que estuvo vulnerable a un problema de truncamiento de número al procesar hojas de estilo de XSLT malintencionadas. La vulnerabilidad se rastreó como [CVE-2022-34169](https://github.com/advisories/GHSA-9339-86wc-4qgf). - | - **HIGH**: Previously installed apps on user accounts were automatically granted permission to access an organization on scoped access tokens after the user account was transformed into an organization account. This vulnerability was reported via the [GitHub Bug Bounty program](https://bounty.github.com). + **ALTA**: Las aplicaciones instaladas anteriormente en las cuentas de usuario obtuvieron permiso automáticamente para acceder a una organización en los tokens de acceso en el alcance después de que la cuenta de usuario se transformó en una cuenta de organización. Esta vulnerabilidad se reportó a través del [Programa de Recompensas por Errores de GitHub](https://bounty.github.com). bugs: - In some cases, GitHub Enterprise Server instances on AWS that used the `r4.4xlarge` instance type would fail to boot. - 'When calculating committers for GitHub Advanced Security, it was not possible to specify individual repositories. For more information, see "[Site admin dashboard](/admin/configuration/configuring-your-enterprise/site-admin-dashboard#advanced-security-committers)."' - - When a custom dormancy threshold was set for the instance, suspending all dormant users did not reliably respect the threshold. For more information about dormancy, see "[Managing dormant users](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)." + - Cuando se configuró un umbral de inactividad personalizado para la instancia, el suspender a todos los usuarios inactivos no respetó confiablemente dicho umbral. Para obtener más información sobre la inactividad, consulta la sección "[Administrar a los usuarios inactivos](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)". changes: - '`pre_receive_hook.rejected_push` events were not displayed in the enterprise audit log.' - Both migration archives for repositories and archive exports for user accounts include release reactions. diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-5/0.yml b/translations/es-ES/data/release-notes/enterprise-server/3-5/0.yml index a0c56a536c..7ffe59353b 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-5/0.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-5/0.yml @@ -116,8 +116,7 @@ sections: heading: La gráfica de dependencias es compatible con GitHub Actions notes: - | - The dependency graph now detects YAML files for GitHub Actions workflows. GitHub Enterprise Server will display the workflow files within the **Insights** tab's dependency graph section. Repositories that publish actions will also be able to see the number of repositories that depend on that action from the "Used By" control on the repository homepage. For more information, see "[About the dependency graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph)." - - **Note**: This feature was unavailable in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3. The feature is available in 3.5.4 and later. [Updated: 2022-08-16] + La gráfica de dependencias ahora detecta archivos YAML para los flujos de trabajo de GitHub Actions. GitHub Enterprise Server mostrará los archivos de flujo de trabajo dentro de la sección de gráfica de dependencias de la pestaña **Perspectivas**. Los repositorios que publiquen acciones también podrán ver la cantidad de repositorios que dependen de esa acción desde el control de "Utilizado por" en la página principal del repositorio. Para obtener más información, consulta la sección "[Acerca de la gráfica de dependencias](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph)". - **Nota**: Esta característica está disponible en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3. La característica está disponible en la versión 3.5.4 y posteriores. [Actualizado: 2022-08-16] - heading: El resumen de seguridad para empresas está en beta público notes: @@ -201,8 +200,8 @@ sections: heading: Volver a abrir las alertas descartadas del Dependabot notes: - | - You can now reopen dismissed Dependabot alerts through the UI page for a closed alert. This does not affect Dependabot pull requests or the GraphQL API. For more information, see "[About Dependabot alerts](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - - **Note**: This feature was unavailable in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3. The feature is available in 3.5.4 and later. [Updated: 2022-08-16] + Ahora puedes volver a abrir las alertas del Dependabot que se descartaron mediante la página de IU en el caso de las alertas cerradas. Esto no afecta a las solicitudes de cambio ni a la API de GraphQL. Para obtener más información, consulta la sección "[Acerca de las alertas del Dependabot](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)". + - **Nota**: Esta característica no estuvo disponible en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3. La característica está disponible en la versión 3.5.4 y posteriores. [Actualizado: 2022-08-16] - heading: La compatibilidad de Pub para las actualizaciones de versión del Dependabot se encuentra en beta público notes: @@ -262,12 +261,12 @@ sections: heading: Más formas de mantener actualizada la rama de tema de una solicitud de cambios notes: - | - The **Update branch** button on the pull request page lets you update your pull request's branch with the latest changes from the base branch. This is useful for verifying your changes are compatible with the current version of the base branch before you merge. Two enhancements now give you more ways to keep your branch up-to-date. + El botón de **Rama actualizada* en la página de la solicitud de cambios te permite actualizar la rama de esta solicitud con los últimos cambios de la rama base. Esto es útil para verificar que tus cambios sean compatibles con la versión actual de la rama base antes de que hagas la fusión. Estas dos mejoras ahora te proporcionan más formas de mantener tu rama actualizada. - - When your pull request's topic branch is out of date with the base branch, you now have the option to update it by rebasing on the latest version of the base branch. Rebasing applies the changes from your branch onto the latest version of the base branch, resulting in a branch with a linear history since no merge commit is created. To update by rebasing, click the drop down menu next to the **Update Branch** button, click **Update with rebase**, and then click **Rebase branch**. Previously, **Update branch** performed a traditional merge that always resulted in a merge commit in your pull request branch. This option is still available, but now you have the choice. For more information, see "[Keeping your pull request in sync with the base branch](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/keeping-your-pull-request-in-sync-with-the-base-branch)." + - Cuando la rama de tema de tu solicitud de cambios está desactualizada con la rama base, ahora tienes la opción de actualizarla rebasándola en la versión más reciente de la rama base. El rebase aplica los cambios de tu rama en la última versión de la rama base, lo que da como resultado una rama con un historial linear, ya que no se crea ninguna confirmación de fusión. Para actualizar por rebase, haz clic en el menú desplegable junto al botón**Actualizar rama**, luego en **Actualizar con rebase** y luego en *Rebasar rama*. Anteriormente, **Actualizar rama** realizaba una fusión tradicional que siembre daba como resultado una confirmación de fusión en la rama de tu solicitud de cambios. Esta opción aún está disponible, pero ahora tienes una elección. Para obtener más información, consulta la sección "[Mantener tu solicitud de cambios sincronizada con la rama base](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/keeping-your-pull-request-in-sync-with-the-base-branch)". - - A new repository setting allows the **Update branch** button to always be available when a pull request's topic branch is not up to date with the base branch. Previously, this button was only available when the **Require branches to be up to date before merging** branch protection setting was enabled. People with admin or maintainer access can manage the **Always suggest updating pull request branches** setting from the **Pull Requests** section in repository settings. For more information, see "[Managing suggestions to update pull request branches](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-suggestions-to-update-pull-request-branches)." - - **Note**: This feature was unavailable in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3. The feature is available in 3.5.4 and later. [Updated: 2022-08-16] + - Un ajuste nuevo de repositorio permite que el botón **Actualizar rama** siempre esté disponible cuando la rama de tema de una solicitud de cambios no esté actualizada con la rama base. Anteriormente, este botón solo estaba disponible cuando estaba habilitado el ajuste de protección de rama **Requerir que las ramas estén actualizadas antes de fusionarlas**. Las personas con acceso de mantenedor o administrador pueden administrar el ajuste de **Siempre sugerir actualizar las ramas de solicitudes de cambios** de la sección **Solicitudes de cambios* en los ajustes de repositorio. Para obtener más información, consulta la sección "[Administrar sugerencias para actualizar las ramas de las solicitudes de cambios](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-suggestions-to-update-pull-request-branches)". + - **Nota**: Esta característica no estuvo disponible en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3. La característica está disponible en la versión 3.5.4 y posterior. [Actualizado: 2022-08-16] - heading: Configurar los encabezados personalizados de HTTP para los sitios de GitHub Pages notes: @@ -282,8 +281,8 @@ sections: heading: El tema claro de contraste alto está disponible en general notes: - | - A light high contrast theme, with greater contrast between foreground and background elements, is now generally available. For more information, see "[Managing your theme settings](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings)." - - **Note**: This feature was unavailable in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3. The feature is available in 3.5.4 and later. [Updated: 2022-08-16] + Ahora hay un tema claro de alto contraste disponible para el público en general, el cual tiene un mayor contraste entre los elementos de fondo y superpuestos. Para obtener más información, consulta la sección "[Administrar los ajustes de tu tema](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings)". + - **Note**: Esta característica no estuvo disponible en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3. La característica está disponible en la versión 3.5.4 y posterior. [Actualizado: 2022-08-16] - heading: Reglas de protección de etiquetas notes: @@ -352,10 +351,10 @@ sections: - 'Deleted repositories will not be purged from disk automatically after the 90-day retention period ends. This issue is resolved in the 3.5.1 patch release. [Updated: 2022-06-10]' - 'La consola de administración podría haberse mostrado atascada en la pantalla de _Starting_ después de mejorar una instancia subaprovisionada para GitHub Enterprise Server 3.5. [Actualizado: 2022-06-20]' - | - The following features were unavailable for users in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3. The features are available in 3.5.4 and later. [Updated: 2022-08-16] + Las siguientes características no estuvieron disponibles para los usuarios en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3. Las características están disponibles en la versión 2.5.4 y posterior. [Actualizado: 2022-08-16] - - Detection of GitHub Actions workflow files for the dependency graph - - Reopening of dismissed Dependabot alerts - - Enabling the **Update branch** button for all pull requests in a repository - - Light high contrast theme + - Detección de archivos de flujo de GitHub Actions para la gráfica de dependencias + - Reapertura de las alertas descartadas del Dependabot + - Habilitar el botón **Actualizar rama** para todas las solicitudes de cambio en un repositorio + - Tema claro de alto contraste - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-5/1.yml b/translations/es-ES/data/release-notes/enterprise-server/3-5/1.yml index 59535991ee..a9f6895423 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-5/1.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-5/1.yml @@ -32,10 +32,10 @@ sections: - 'Los repositorios borrados no se purgarán del disco automáticamente después de que finalice el periodo de retención de 90 días. Esta propuesta se resolvió en el lanzamiento 3.5.1. [Actualizado: 2022-06-10]' - 'La consola de administración podría haberse mostrado atascada en la pantalla de _Starting_ después de mejorar una instancia subaprovisionada para GitHub Enterprise Server 3.5. [Actualizado: 2022-06-20]' - | - The following features were unavailable for users in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3. The features are available in 3.5.4 and later. [Updated: 2022-08-16] + Las siguientes características no estuvieron disponibles para los usuarios en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3. Las características están disponibles en la versión 2.5.4 y posterior. [Actualizado: 2022-08-16] - - Detection of GitHub Actions workflow files for the dependency graph - - Reopening of dismissed Dependabot alerts - - Enabling the **Update branch** button for all pull requests in a repository - - Light high contrast theme + - Detección de archivos de flujo de GitHub Actions para la gráfica de dependencias + - Reapertura de las alertas descartadas del Dependabot + - Habilitar el botón **Actualizar rama** para todas las solicitudes de cambio en un repositorio + - Tema claro de alto contraste - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-5/2.yml b/translations/es-ES/data/release-notes/enterprise-server/3-5/2.yml index a9b35aafae..206837c08f 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-5/2.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-5/2.yml @@ -33,10 +33,10 @@ sections: - Los límites de recursos que son específicos para procesar ganchos de pre-recepción podrían ocasionar que fallen algunos ganchos de pre-recepción. - Los servicios de las acciones necesitan reiniciarse después de restablecer un aplicativo de un respaldo que se llevó a un host diferente. - | - The following features were unavailable for users in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3. The features are available in 3.5.4 and later. [Updated: 2022-08-16] + Las siguientes características no estuvieron disponibles para los usuarios en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3. Las características están disponibles en la versión 3.5.4 y posteriores. [Actualizado: 2022-08-16] - - Detection of GitHub Actions workflow files for the dependency graph - - Reopening of dismissed Dependabot alerts - - Enabling the **Update branch** button for all pull requests in a repository - - Light high contrast theme + - Detección de archivos del flujo de trabajo de GitHub Actions para la gráfica de dependencias + - Reapertura de alertas descartadas del Dependabot + - Habilitar el botón de *Rama actualizada** para todas las solicitudes de cambio en un repositorio + - Tema claro de alto contraste - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-5/3.yml b/translations/es-ES/data/release-notes/enterprise-server/3-5/3.yml index 962af1fb11..08c43001b3 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-5/3.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-5/3.yml @@ -30,5 +30,5 @@ sections: - 'El registor de npm del {% data variables.product.prodname_registry %} ya no regresa un valor de tiempo en las respuestas de metadatos. Esto se hizo para permitir mejoras de rendimiento sustanciales. Seguimos teniendo todos los datos necesarios para devolver un valor de tiempo como parte de la respuesta de metadatos y terminaremos de devolver este valor ene l futuro una vez que hayamos resuelto los problemas de rendimiento existentes.' - 'Los límites de recursos que son específicos para procesar ganchos de pre-recepción podrían ocasionar que fallen algunos ganchos de pre-recepción.' - 'Los servicios de las acciones necesitan reiniciarse después de restablecer un aplicativo de un respaldo que se llevó a un host diferente.' - - "The following features were unavailable for users in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3. The features are available in 3.5.4 and later. [Updated: 2022-08-16]\n\n- Detection of GitHub Actions workflow files for the dependency graph\n- Reopening of dismissed Dependabot alerts\n- Enabling the **Update branch** button for all pull requests in a repository\n- Light high contrast theme\n" + - "Las siguientes características no estuvieron disponibles para los usuarios en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3. Las características están disponibles en la versión 2.5.4 y posterior. [Actualizado: 2022-08-16]\n\n- Detección de archivos de flujo de GitHub Actions para la gráfica de dependencias\n- Reapertura de las alertas descartadas del Dependabot\n- Habilitar el botón **Actualizar rama** para todas las solicitudes de cambio en un repositorio\n- Tema claro de alto contraste\n" - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-5/4.yml b/translations/es-ES/data/release-notes/enterprise-server/3-5/4.yml index 03b028709f..b91d5e3a57 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-5/4.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-5/4.yml @@ -2,9 +2,9 @@ date: '2022-08-11' sections: security_fixes: - | - **CRITICAL**: GitHub Enterprise Server's Elasticsearch container used a version of OpenJDK 8 that was vulnerable to an integer truncation issue when processing malicious XSLT stylesheets. The vulnerability is tracked as [CVE-2022-34169](https://github.com/advisories/GHSA-9339-86wc-4qgf). + **CRÍTICA**: El contenedor de Elasticsearch de GitHub Enterprise Server utilizó una versión de OpenJDK 8 que estuvo vulnerable a un problema de truncamiento de número al procesar hojas de estilo de XSLT malintencionadas. La vulnerabilidad se rastreó como [CVE-2022-34169](https://github.com/advisories/GHSA-9339-86wc-4qgf). - | - **HIGH**: Previously installed apps on user accounts were automatically granted permission to access an organization on scoped access tokens after the user account was transformed into an organization account. This vulnerability was reported via the [GitHub Bug Bounty program](https://bounty.github.com). + **ALTA**: Las aplicaciones instaladas anteriormente en las cuentas de usuario obtuvieron permiso automáticamente para acceder a una organización en los tokens de acceso en el alcance después de que la cuenta de usuario se transformó en una cuenta de organización. Esta vulnerabilidad se reportó a través del [Programa de Recompensas por Errores de GitHub](https://bounty.github.com). bugs: - In some cases, GitHub Enterprise Server instances on AWS that used the `r4.4xlarge` instance type would fail to boot. - In some cases, UI elements within a pull request's **Files changed** tab could overlap. @@ -12,10 +12,10 @@ sections: - 'When calculating committers for GitHub Advanced Security, it was not possible to specify individual repositories. For more information, see "[Site admin dashboard](/admin/configuration/configuring-your-enterprise/site-admin-dashboard#advanced-security-committers)."' - In some cases, Elasticsearch's post-upgrade `es:upgrade` process could crash before completion. - The script for migration to internal repositories failed to convert the visibility for public repositories to internal or private. For more information about the migration, see "[Migrating to internal repositories](/admin/user-management/managing-repositories-in-your-enterprise/migrating-to-internal-repositories)." - - 'Detection of GitHub Actions workflow files for the dependency graph was unavailable in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3, but is now available in 3.5.4. For more information, see "[About the dependency graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph#supported-package-ecosystems)."' - - 'The ability to reopen dismissed Dependabot alerts was unavailable in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3, but is now available in 3.5.4. For more information, see "[Viewing and updating Dependabot alerts](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts#viewing-and-updating-closed-alerts)."' - - The ability to always suggest updates from the base branch to a pull request's HEAD was unavailable in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3, but is now available in 3.5.4. For more information, see "[Managing suggestions to update pull request branches](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-suggestions-to-update-pull-request-branches)." - - The light high contrast theme was unavailable in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3, but is now available in 3.5.4. For more information, see "[Managing your theme settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings)." + - 'La detección de archivos de flujo de trabajo de GitHub Actions para la gráfica de dependencias no estuvo disponible en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3, pero están ahora disponibles en la versión 3.5.4. Para obtener más información, consulta la sección "[Acerca de la gráfica de dependencias](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph#supported-package-ecosystems)".' + - 'La capacidad de reabrir alertas descartadas del Depedabot no estaba disponible en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3, pero ahora está disponible en la versión 3.5.4. Para obtener más información, consulta la sección "[Ver y actualizar las alertas del Dependabot](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts#viewing-and-updating-closed-alerts)".' + - La capacidad de siempre sugerir actualizaciones desde la rama base hacia un ENCABEZADO de una solicitud de cambios no estaba disponible en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3, pero está ahora disponible en la versión 3.5.4. Para obtener más información, consulta la sección "[Administrar las sugerencias para actualizar las ramas de las solicitudes de cambios](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-suggestions-to-update-pull-request-branches)". + - El tema claro de alto contraste no estuvo disponible en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3, pero ahora está disponible en la versión 3.5.4. Para obtener más información, consulta la sección "[Administrar los ajustes de tu tema](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings)". changes: - '`pre_receive_hook.rejected_push` events were not displayed in the enterprise audit log.' known_issues: diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-6/0.yml b/translations/es-ES/data/release-notes/enterprise-server/3-6/0.yml index 31eb9186e8..f9c4824c36 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-6/0.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-6/0.yml @@ -40,7 +40,7 @@ sections: heading: Administrator experience notes: - | - Enterprise owners can join organizations on the instance as a member or owner from the enterprise account's **Organizations** page. For more information, see "[Managing your role in an organization owned by your enterprise](/admin/user-management/managing-organizations-in-your-enterprise/managing-your-role-in-an-organization-owned-by-your-enterprise)." + Los propietarios de las empresas pueden unirse a las organizaciones en la instancia como miembro o propietario desde la página de **Organizaciones* de la cuenta empresarial. Para obtener más información, consulta la sección "[Administrar tu rol en una organización que le pertenece a tu empresa](/admin/user-management/managing-organizations-in-your-enterprise/managing-your-role-in-an-organization-owned-by-your-enterprise)". - | Enterprise owners can allow users to dismiss the configured global announcement banner. For more information, see "[Customizing user messages for your enterprise](/admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)." - @@ -150,12 +150,12 @@ sections: - | Los usuarios pueden bloquear la creación de ramas que coincide con un patrón de nombre configurado con la regla de protección de rama **Restringir subidas que crean ramas coincidentes**. Por ejemplo, si la rama predeterminada de un repositorio cambia de `master` a `main`, un administrador de repositorio puede prevenir cualquier creación o subida subsecuente de la rama `master`. Para obtener más información, consulta la sección "[Acerca de las ramas protegidas](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#restrict-who-can-push-to-matching-branches)" y "[Administrar una regla de protección de rama](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule#creating-a-branch-protection-rule)". - | - Users can create a branch directly from a repository's **Branches** page by clicking the **New branch**. For more information, see "[Creating and deleting branches within your repository](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)." + Los usuarios pueden crear una rama directamente desde la página de **Ramas** de un repositorio haciendo clic en **Rama nueva**. Para obtener más información, consulta la sección "[Crear y borrar ramas dentro de tu repositorio](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)". - | Users can delete a branch that's associated with an open pull request. For more information, see "[Creating and deleting branches within your repository](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)." - | - Repositories with multiple licenses display all of the licenses in the "About" sidebar on the {% octicon "code" aria-label="The code icon" %} **Code** tab. For more information, see "[Licensing a repository](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." - - When a user renames or moves a file to a new directory, if at least half of the file's contents are identical, the commit history indicates that the file was renamed, similar to `git log --follow`. For more information, see the [GitHub Blog](https://github.blog/changelog/2022-06-06-view-commit-history-across-file-renames-and-moves/). + Los repositorios con licencias múltiples muestran todas las licencias en la barra lateral de "Acerca de" en la pestaña de **Código** {% octicon "code" aria-label="The code icon" %}. Para obtener más información, consulta la sección "[Autorizar un repositorio](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)". + - Cuando un usuario renombra o mueve un archivo a un directorio nuevo, si por lo menos la mitad del contenido del archivo es idéntico, el historial de confirmación indican que el archivo se renombró, similar a `git log --follow`. Para obtener más información, consulta el [Blog de GitHub](https://github.blog/changelog/2022-06-06-view-commit-history-across-file-renames-and-moves/). - | Los usuarios pueden requerir un despliegue exitoso de una rama antes de que cualquiera pueda fusionar la solicitud de cambios asociada con ella. Para obtener más información, consulta las secciones "[Acerca de las ramas protegidas](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-deployments-to-succeed-before-merging)" y "[Administrar una regla de protección de rama](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule)". - | @@ -181,7 +181,7 @@ sections: notes: - | When viewing the details for a particular release, users can see the creation date for each release asset. For more information, see "[Viewing your repository's releases and tags](/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags)." - - While creating a release with automatically generated release notes, users can see the tag identified as the previous release, then choose to select a different tag to specify as the previous release. For more information, see "[Automatically generated release notes](/repositories/releasing-projects-on-github/automatically-generated-release-notes)." + - Cuando creas un lanzamiento con notas de lanzamiento generadas automáticamente, los usuarios pueden ver la etiqueta identificada como el lanzamiento anterior y luego elegir seleccionar una etiqueta diferente para especificar como el lanzamiento anterior. Para obtener más información, consulta la sección "[Notas de lanzamiento generadas automáticamente](/repositories/releasing-projects-on-github/automatically-generated-release-notes)". - heading: Markdown notes: @@ -210,3 +210,4 @@ sections: - In a repository's settings, enabling the option to allow users with read access to create discussions does not enable this functionality. - In some cases, users cannot convert existing issues to discussions. - Los patrones personalizados para el escaneo de secretos utilizan `.*` como un delimitador final, específicamente en el campo "Después del secreto". Este delimitador ocasiona inconsistencias en los escaneos que buscan secretos en los repositorios y podrías notar brechas en el historial de un repositorio en donde no hay escaneos completados. Los escaneos en aumento también podrían verse impactados. Para prevenir los problemas con los escaneos, modifica el final del patrón para eliminar el delimitador `.*`. + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/es-ES/data/reusables/accounts/create-personal-access-tokens.md b/translations/es-ES/data/reusables/accounts/create-personal-access-tokens.md new file mode 100644 index 0000000000..54e9e2a2ba --- /dev/null +++ b/translations/es-ES/data/reusables/accounts/create-personal-access-tokens.md @@ -0,0 +1 @@ +1. For each of your accounts, create a dedicated PAT with `repo` scope. Para obtener más información, consulta la sección "[Crear un token de acceso personal](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)". \ No newline at end of file diff --git a/translations/es-ES/data/reusables/actions/contacting-support.md b/translations/es-ES/data/reusables/actions/contacting-support.md index c7378cdaf8..9224419e82 100644 --- a/translations/es-ES/data/reusables/actions/contacting-support.md +++ b/translations/es-ES/data/reusables/actions/contacting-support.md @@ -5,5 +5,5 @@ If you have feedback or feature requests for {% data variables.product.prodname_ Contact {% data variables.contact.contact_support %} for any of the following, whether your use or intended use falls into the usage limit categories: * If you believe your account has been incorrectly restricted -* If you encounter an unexpected error when executing one of your Actions, for example: a unique ID +* If you encounter an unexpected error when executing one of your actions * If you encounter a situation where existing behavior contradicts expected, but not always documented, behavior diff --git a/translations/es-ES/data/reusables/actions/macos-runner-preview.md b/translations/es-ES/data/reusables/actions/macos-runner-preview.md index c9b93aecbe..b1bb2b899c 100644 --- a/translations/es-ES/data/reusables/actions/macos-runner-preview.md +++ b/translations/es-ES/data/reusables/actions/macos-runner-preview.md @@ -1 +1 @@ -The macos-latest YAML workflow label currently uses the macOS 10.15 runner image. +La etiqueta de flujo de trabajo de YAML macos-latest utiliza actualmente la imagen de ejecutor de macOS 10.15. diff --git a/translations/es-ES/data/reusables/actions/pure-javascript.md b/translations/es-ES/data/reusables/actions/pure-javascript.md index cf574fb47a..09e1e36ce5 100644 --- a/translations/es-ES/data/reusables/actions/pure-javascript.md +++ b/translations/es-ES/data/reusables/actions/pure-javascript.md @@ -1 +1 @@ -Para garantizar que tus acciones de JavaScript son compatibles con todos los ejecutores hospedados en GitHub (Ubuntu, Windows, y macOS), el código empaquetado de JavaScript que escribas debe ser puramente JavaScript y no depender de otros binarios. JavaScript actions run directly on the runner and use binaries that already exist in the runner image. +Para garantizar que tus acciones de JavaScript son compatibles con todos los ejecutores hospedados en GitHub (Ubuntu, Windows, y macOS), el código empaquetado de JavaScript que escribas debe ser puramente JavaScript y no depender de otros binarios. Las acciones de JavaScript se ejecutan directamente en el ejecutor y utilizan binarios que ya existen en la imagen ejecutora. diff --git a/translations/es-ES/data/reusables/actions/supported-github-runners.md b/translations/es-ES/data/reusables/actions/supported-github-runners.md index 64c4a3ace3..c53db4b4e8 100644 --- a/translations/es-ES/data/reusables/actions/supported-github-runners.md +++ b/translations/es-ES/data/reusables/actions/supported-github-runners.md @@ -1,7 +1,7 @@ - + @@ -54,7 +54,7 @@ Ubuntu 18.04 [deprecated]ubuntu-18.04 @@ -92,7 +92,7 @@ Migra a macOS-11 o macOS-12. Para obtener más informa {% note %} -**Note:** The `-latest` runner images are the latest stable images that {% data variables.product.prodname_dotcom %} provides, and might not be the most recent version of the operating system available from the operating system vendor. +**Nota:** Las imágenes de ejecutor catalogadas como `-latest` son las imágenes más recientes que proporciona {% data variables.product.prodname_dotcom %} y podrían no ser la versión más reciente del sistema operativo disponible desde el proveedor de este. {% endnote %} diff --git a/translations/es-ES/data/reusables/actions/upgrade-runners-before-upgrade-ghes.md b/translations/es-ES/data/reusables/actions/upgrade-runners-before-upgrade-ghes.md index 0650fa54d8..52c9c5e17c 100644 --- a/translations/es-ES/data/reusables/actions/upgrade-runners-before-upgrade-ghes.md +++ b/translations/es-ES/data/reusables/actions/upgrade-runners-before-upgrade-ghes.md @@ -1 +1 @@ -If you use ephemeral runners and have disabled automatic updates, before you upgrade {% data variables.product.product_location %}, you should first upgrade your self-hosted runners to the version of the runner application that your upgraded instance will run. Upgrading {% data variables.product.product_location %} before you upgrade ephemeral runners may result in your runners going offline. Para obtener más información, consulta "[Actualizar {% data variables.product.product_name %}](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server)." +Si utilizas ejecutores efímeros e inhabilitaste las actualizaciones automáticas, antes de que mejores a {% data variables.product.product_location %}, primero debes mejorar tus ejecutores auto-hospedados a la versión de la aplicación ejecutora que ejecutará tu instancias mejorada. El mejorar {% data variables.product.product_location %} antes de que mejores los ejecutores efímeros podría dar como resultado que estos se queden sin conexión. Para obtener más información, consulta "[Actualizar {% data variables.product.product_name %}](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server)." diff --git a/translations/es-ES/data/reusables/actions/use-request-body-api.md b/translations/es-ES/data/reusables/actions/use-request-body-api.md new file mode 100644 index 0000000000..1d37d0c4f0 --- /dev/null +++ b/translations/es-ES/data/reusables/actions/use-request-body-api.md @@ -0,0 +1 @@ +To apply this configuration, submit a request to the API endpoint and include the required configuration in the request body. For more information, see "[Set the customization template for an OIDC subject claim for an organization](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization)". \ No newline at end of file diff --git a/translations/es-ES/data/reusables/advanced-security/custom-link-beta.md b/translations/es-ES/data/reusables/advanced-security/custom-link-beta.md new file mode 100644 index 0000000000..a79fc22417 --- /dev/null +++ b/translations/es-ES/data/reusables/advanced-security/custom-link-beta.md @@ -0,0 +1,5 @@ +{% note %} + +**Note:** The ability to add resource links to blocked push messages is currently in public beta and subject to change. + +{% endnote %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/advanced-security/secret-scanning-dry-run-select-enterprise-repos.md b/translations/es-ES/data/reusables/advanced-security/secret-scanning-dry-run-select-enterprise-repos.md index ae1e8e39ec..ed0d8a8dbc 100644 --- a/translations/es-ES/data/reusables/advanced-security/secret-scanning-dry-run-select-enterprise-repos.md +++ b/translations/es-ES/data/reusables/advanced-security/secret-scanning-dry-run-select-enterprise-repos.md @@ -1,7 +1,7 @@ {%- ifversion custom-pattern-dry-run-ga %} -1. Search for and select up to 10 repositories where you want to perform the dry run. ![Screenshot showing repositories selected for the dry run](/assets/images/help/repository/secret-scanning-dry-run-custom-pattern-select-repo-only.png) +1. Busca y selecciona hasta 10 repositorios en donde quieras realizar la simulación. ![Screenshot showing repositories selected for the dry run](/assets/images/help/repository/secret-scanning-dry-run-custom-pattern-select-repo-only.png) 1. When you're ready to test your new custom pattern, click **Run**. {%- else %} -1. Search for and select up to 10 repositories where you want to perform the dry run. ![Screenshot showing repositories selected for the dry run](/assets/images/help/repository/secret-scanning-dry-run-custom-pattern-select-repo.png) +1. Busca y selecciona hasta 10 repositorios en donde quieras realizar la simulación. ![Screenshot showing repositories selected for the dry run](/assets/images/help/repository/secret-scanning-dry-run-custom-pattern-select-repo.png) 1. Cuando estés listo para probar tu nuevo patrón personalizado, haz clic en **Simulacro**. {%- endif %} diff --git a/translations/es-ES/data/reusables/advanced-security/secret-scanning-push-protection-org.md b/translations/es-ES/data/reusables/advanced-security/secret-scanning-push-protection-org.md index c6e78d4033..0b25b4d034 100644 --- a/translations/es-ES/data/reusables/advanced-security/secret-scanning-push-protection-org.md +++ b/translations/es-ES/data/reusables/advanced-security/secret-scanning-push-protection-org.md @@ -1,2 +1,6 @@ 1. Debajo de "{% data variables.product.prodname_secret_scanning_caps %}" y debajo de "Protección contra subida", haz clic en **Habilitar todo**. ![Captura de pantalla que muestra cómo habilitar la protección de subida para el {% data variables.product.prodname_secret_scanning %} en una organización](/assets/images/help/organizations/secret-scanning-enable-push-protection.png) -1. Opcionalmente, haz clic en "Habilitar automáticamente para los repositorios privados agregados al {% data variables.product.prodname_secret_scanning %}". +1. Opcionalmente, haz clic en "Habilitar automáticamente los repositorios privados agregados al {% data variables.product.prodname_secret_scanning %}".{% ifversion push-protection-custom-link-orgs %} +1. Opcionalmente, para incluir un enlace personalizado en el mensaje, el cual verán los miembros cuando intenten subir un secreto, selecciona **Agregar un enlace de recurso en el CLI e IU web cuando se bloquee un comentario** y después escribe una URL y haz clic en **Guardar enlace**. + {% ifversion push-protection-custom-link-orgs-beta %}{% indented_data_reference reusables.advanced-security.custom-link-beta spaces=3 %}{% endif %} + + ![Captura de pantalla que muestra la casilla de verificación y campo de texto para habilitar un enlace personalizado](/assets/images/help/organizations/secret-scanning-custom-link.png){% endif %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/audit_log/audit-log-action-categories.md b/translations/es-ES/data/reusables/audit_log/audit-log-action-categories.md index 95ac8b41f7..a106c4569e 100644 --- a/translations/es-ES/data/reusables/audit_log/audit-log-action-categories.md +++ b/translations/es-ES/data/reusables/audit_log/audit-log-action-categories.md @@ -93,51 +93,51 @@ {%- ifversion fpt or ghec %} | `profile_picture` | Contains activities related to an organization's profile picture. {%- endif %} -| `project` | Contains activities related to project boards. | `project_field` | Contains activities related to field creation and deletion in a project board. | `project_view` | Contains activities related to view creation and deletion in a project board. | `protected_branch` | Contains activities related to protected branches. | `public_key` | Contains activities related to SSH keys and deploy keys. | `pull_request` | Contains activities related to pull requests. | `pull_request_review` | Contains activities related to pull request reviews. | `pull_request_review_comment` | Contains activities related to pull request review comments. | `repo` | Contains activities related to the repositories owned by an organization. +| `project` | Contiene actividades relacionadas con los tableros de proyecto. | `project_field` | Contiene actividades relacionadas con la creación y borrado de campos en un tablero de proyecto. | `project_view` | Contiene actividades relacionadas con ver la creación y el borrado de un tablero de proyecto. | `protected_branch` | Contiene actividades relacionadas con ramas protegidas. | `public_key` | Contiene actividades relacionadas con llaves SSH y llaves de despliegue. | `pull_request` | Contiene actividades relacionadas con solicitudes de cambio. | `pull_request_review` | Contiene actividades relacionadas con revisiones de solicitudes de cambios. | `pull_request_review_comment` | Contiene actividades relacionadas con comentarios de revisión en solicitudes de cambio. | `repo` | Contiene actividades relacionadas con los repositorios que le pertenecen a una organización. {%- ifversion fpt or ghec %} -| `repository_advisory` | Contains repository-level activities related to security advisories in the {% data variables.product.prodname_advisory_database %}. Para obtener más información, consulta la sección "[Acerca de las asesorías de seguridad de {% data variables.product.prodname_dotcom %}](/github/managing-security-vulnerabilities/about-github-security-advisories)". | `repository_content_analysis` | Contains activities related to [enabling or disabling data use for a private repository](/articles/about-github-s-use-of-your-data). | `repository_dependency_graph` | Contains repository-level activities related to enabling or disabling the dependency graph for a {% ifversion fpt or ghec %}private {% endif %}repository. Para obtener más información, consulta la sección "[Acerca de la gráfica de dependencias](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)". +| `repository_advisory` | Contiene actividades a nivel de repositorio relacionadas con asesorías de seguridad en la {% data variables.product.prodname_advisory_database %}. Para obtener más información, consulta la sección "[Acerca de las asesorías de seguridad de {% data variables.product.prodname_dotcom %}](/github/managing-security-vulnerabilities/about-github-security-advisories)". | `repository_content_analysis` | Contiene actividades relacionadas con [habilitar o inhabilitar el uso de datos para un repositorio privado](/articles/about-github-s-use-of-your-data). | `repository_dependency_graph` | Contiene actividades a nivel de repositorio relacionadas con habilitar o inhabilitar la gráfica de dependencias para un repositorio {% ifversion fpt or ghec %}privado{% endif %}. Para obtener más información, consulta la sección "[Acerca de la gráfica de dependencias](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)". {%- endif %} -| `repository_image` | Contains activities related to images for a repository. | `repository_invitation` | Contains activities related to invitations to join a repository. | `repository_projects_change` | Contains activities related to enabling projects for a repository or for all repositories in an organization. +| `repository_image` | Contiene actividades relacionadas con imágenes para un repositorio. | `repository_invitation` | Contiene actividades relacionadas con invitaciones para unirse a un repositorio. | `repository_projects_change` | Contiene actividades relacionadas con habilitar proyectos para un repositorio o para todos los repositorios de una organización. {%- ifversion ghec or ghes or ghae %} -| `repository_secret_scanning` | Contains repository-level activities related to secret scanning. Para obtener más información, consulta la sección "[Acerca del escaneo de secretos"](/github/administering-a-repository/about-secret-scanning). +| `repository_secret_scanning` | Contiene actividades a nivel de repositorio relacionadas con el escaneo de secretos. Para obtener más información, consulta la sección "[Acerca del escaneo de secretos"](/github/administering-a-repository/about-secret-scanning). {%- endif %} {%- ifversion secret-scanning-audit-log-custom-patterns %} -| `repository_secret_scanning_custom_pattern` | Contains activities related to secret scanning custom patterns in a repository. Para obtener más información, consulta la sección "[Definir los patrones personalizados para el escaneo de secretos](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)". |{% endif %}{% ifversion secret-scanning-audit-log-custom-patterns %}| | `repository_secret_scanning_push_protection` | Contains activities related to secret scanning custom patterns in a repository. Para obtener más información, consulta la sección "[Proteger las subidas de información con el escaneo de secretos](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)". +| `repository_secret_scanning_custom_pattern` | Contiene actividades relacionadas con el escaneo de secretos en patrones personalizados de un repositorio. Para obtener más información, consulta la sección "[Definir los patrones personalizados para el escaneo de secretos](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)". |{% endif %}{% ifversion secret-scanning-audit-log-custom-patterns %}| | `repository_secret_scanning_push_protection` | Contiene actividades relacionadas con el escaneo de secretos en patrones personalizados en un repositorio. Para obtener más información, consulta la sección "[Proteger las subidas de información con el escaneo de secretos](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)". {%- endif %} {%- ifversion fpt or ghec %} -| `repository_visibility_change` | Contains activities related to allowing organization members to change repository visibilities for the organization. +| `repository_visibility_change` | Contiene actividades relacionadas con permitir que los miembros de una organización cambien las visibilidades de un repositorio para la organización. {%- endif %} -| `repository_vulnerability_alert` | Contains activities related to [{% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts). +| `repository_vulnerability_alert` | Contiene actividades relacionadas con las [{% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts). {%- ifversion fpt or ghec %} -| `repository_vulnerability_alerts` | Contains repository-level configuration activities for {% data variables.product.prodname_dependabot_alerts %}. | `required_status_check` | Contains activities related to required status checks for protected branches. +| `repository_vulnerability_alerts` | Contiene actividades de configuración a nivel de repositorio para las {% data variables.product.prodname_dependabot_alerts %}. | `required_status_check` | Contiene actividades relacionadas con verificaciones de estado requeridas para las ramas protegidas. {%- endif %} {%- ifversion ghec or ghes %} -| `restrict_notification_delivery` | Contains activities related to the restriction of email notifications to approved or verified domains for an enterprise. +| `restrict_notification_delivery` | Contiene actividades relacionadas con la restricción de notificaciones por correo electrónico para dominios verificados o aprobados para una empresa. {%- endif %} {%- ifversion custom-repository-roles %} -| `role` | Contains activities related to [custom repository roles](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization). +| `role` | Contiene actividades relacionadas con los [roles de repositorio personalizados](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization). {%- endif %} {%- ifversion ghec or ghes or ghae %} -| `secret_scanning` | Contains organization-level configuration activities for secret scanning in existing repositories. Para obtener más información, consulta la sección "[Acerca del escaneo de secretos"](/github/administering-a-repository/about-secret-scanning). | `secret_scanning_new_repos` | Contains organization-level configuration activities for secret scanning for new repositories created in the organization. +| `secret_scanning` | Contiene actividades de configuración a nivel organizacional para el escaneo de secretos en los repositorios existentes. Para obtener más información, consulta la sección "[Acerca del escaneo de secretos"](/github/administering-a-repository/about-secret-scanning). | `secret_scanning_new_repos` | Contiene actividades de configuración a nivel organizacional para el escaneo de secretos para los repositorios nuevos creados en la organización. {%- endif %} {%- ifversion ghec or ghes or ghae %} -| `security_key` | Contains activities related to security keys registration and removal. +| `security_key` | Contiene actividades relacionadas con el registro y eliminación de llaves de seguridad. {%- endif %} {%- ifversion fpt or ghec %} -| `sponsors` | Contains events related to sponsor buttons (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"). +| `sponsors` | Contiene eventos relacionados con botones de patrocinio (consulta la sección "[Mostrar un botón de patrocinio en tu repositorio](/articles/displaying-a-sponsor-button-in-your-repository)"). {%- endif %} {%- ifversion ghec or ghes or ghae %} -| `ssh_certificate_authority` | Contains activities related to a SSH certificate authority in an organization or enterprise. | `ssh_certificate_requirement` | Contains activities related to requiring members use SSH certificates to access organization resources. +| `ssh_certificate_authority` | Contiene actividades relacionadas con la autoridad de certificados SSH en una organización o empresa. | `ssh_certificate_requirement` | Contiene actividades relacionadas con requerir que los miembros utilicen certificados SSH para acceder a los recursos de una organización. {%- endif %} -| `staff` | Contains activities related to a site admin performing an action. | `team` | Contains activities related to teams in an organization. | `team_discussions` | Contains activities related to managing team discussions for an organization. +| `staff` | Contiene actividades relacionadas con un administrador de sitio que realiza una acción. | `team` | Contiene actividades relacionadas con los equipos en una organización. | `team_discussions` | Contiene actividades relacionadas con administrar los debates de equipo para una organización. {%- ifversion ghec %} -| `team_sync_tenant` | Contains activities related to team synchronization with an IdP for an enterprise or organization. +| `team_sync_tenant` | Contiene actividades relacionadas con la sincronización de equipo con un IdP para una organización o empresa. {%- endif %} {%- ifversion fpt or ghes %} -| `two_factor_authentication` | Contains activities related to two-factor authentication. +| `two_factor_authentication` | Contiene actividades relacionadas con la autenticación bifactorial. {%- endif %} -| `user` | Contains activities related to users in an enterprise or organization. +| `user` | Contiene actividades relacionadas con los usuarios en una organización o empresa. {%- ifversion ghec or ghes %} -| `user_license` | Contains activities related to a user occupying a licensed seat in, and being a member of, an enterprise. +| `user_license` | Contiene actividades relacionadas con un usuario que ocupa una plaza de licencia en, y es miembro de, una empresa. {%- endif %} -| `workflows` | Contains activities related to {% data variables.product.prodname_actions %} workflows. +| `workflows` | Contiene actividades relacionadas con los flujos de trabajo de {% data variables.product.prodname_actions %}. diff --git a/translations/es-ES/data/reusables/audit_log/audit-log-events-workflows.md b/translations/es-ES/data/reusables/audit_log/audit-log-events-workflows.md index b056200c95..87ae3b4119 100644 --- a/translations/es-ES/data/reusables/audit_log/audit-log-events-workflows.md +++ b/translations/es-ES/data/reusables/audit_log/audit-log-events-workflows.md @@ -1,8 +1,8 @@ | Acción | Descripción | | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `workflows.approve_workflow_job` | A workflow job was approved. Para obtener más información, consulta la sección "[Revisar los despliegues](/actions/managing-workflow-runs/reviewing-deployments)". | -| `workflows.cancel_workflow_run` | A workflow run was cancelled. Para obtener más información, consulta "[Cancelar un flujo de trabajo](/actions/managing-workflow-runs/canceling-a-workflow)". | -| `workflows.delete_workflow_run` | A workflow run was deleted. Para obtener más información, consulta la sección "[Borrar una ejecución de flujo de trabajo](/actions/managing-workflow-runs/deleting-a-workflow-run)". | +| `workflows.approve_workflow_job` | Se aprobó un job de flujo de trabajo. Para obtener más información, consulta la sección "[Revisar los despliegues](/actions/managing-workflow-runs/reviewing-deployments)". | +| `workflows.cancel_workflow_run` | Se canceló una ejecución de flujo de trabajo. Para obtener más información, consulta "[Cancelar un flujo de trabajo](/actions/managing-workflow-runs/canceling-a-workflow)". | +| `workflows.delete_workflow_run` | Se borró una ejecución de flujo de trabajo. Para obtener más información, consulta la sección "[Borrar una ejecución de flujo de trabajo](/actions/managing-workflow-runs/deleting-a-workflow-run)". | | `workflows.disable_workflow` | Se inhabilitó un flujo de trabajo. | | `workflows.enable_workflow` | Se habilitó un flujo de trabajo después de que `disable_workflow` lo inhabilitó previamente. | | `workflows.reject_workflow_job` | Se rechazó un job de un flujo de trabajo. Para obtener más información, consulta la sección "[Revisar los despliegues](/actions/managing-workflow-runs/reviewing-deployments)". | diff --git a/translations/es-ES/data/reusables/classroom/reuse-assignment-link.md b/translations/es-ES/data/reusables/classroom/reuse-assignment-link.md index cad57fd14a..94c4b74335 100644 --- a/translations/es-ES/data/reusables/classroom/reuse-assignment-link.md +++ b/translations/es-ES/data/reusables/classroom/reuse-assignment-link.md @@ -1 +1 @@ -You can reuse existing assignments in any other classroom you have admin access to, including classrooms in a different organization. Para obtener más información, consulta la sección "[Reutilizar una tarea](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment)". +Puedes reutilizar las tareas existentes en cualquier otra aula en la que tengas acceso administrativo, incluyendo aquellas en una organización diferente. Para obtener más información, consulta la sección "[Reutilizar una tarea](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment)". diff --git a/translations/es-ES/data/reusables/code-scanning/licensing-note.md b/translations/es-ES/data/reusables/code-scanning/licensing-note.md index ad0ec0192d..ede099e6be 100644 --- a/translations/es-ES/data/reusables/code-scanning/licensing-note.md +++ b/translations/es-ES/data/reusables/code-scanning/licensing-note.md @@ -1,8 +1,12 @@ {% note %} -**Note:** {% ifversion fpt %} -The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories. The {% data variables.product.prodname_codeql_cli %} is also available in private repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." -{%- elsif ghec %} The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories that are maintained on {% data variables.product.prodname_dotcom_the_website %}, and available to use on private repositories that are owned by customers with an {% data variables.product.prodname_advanced_security %} license. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." -{%- elsif ghes or ghae %}The {% data variables.product.prodname_codeql_cli %} is available to customers with an {% data variables.product.prodname_advanced_security %} license. +**Notes:** {% ifversion fpt %} +- The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories. The {% data variables.product.prodname_codeql_cli %} is also available in private repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." +{%- elsif ghec %} +- The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories that are maintained on {% data variables.product.prodname_dotcom_the_website %}, and available to use on private repositories that are owned by customers with an {% data variables.product.prodname_advanced_security %} license. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." +{%- elsif ghes or ghae %} +- The {% data variables.product.prodname_codeql_cli %} is available to customers with an {% data variables.product.prodname_advanced_security %} license. {% endif %} +- {% data reusables.code-scanning.non-glibc-linux-support %} + {% endnote %} diff --git a/translations/es-ES/data/reusables/code-scanning/non-glibc-linux-support.md b/translations/es-ES/data/reusables/code-scanning/non-glibc-linux-support.md new file mode 100644 index 0000000000..2a1c2a8e53 --- /dev/null +++ b/translations/es-ES/data/reusables/code-scanning/non-glibc-linux-support.md @@ -0,0 +1 @@ +The {% data variables.product.prodname_codeql_cli %} is currently not compatible with non-glibc Linux distributions such as (musl-based) Alpine Linux. \ No newline at end of file diff --git a/translations/es-ES/data/reusables/codespaces/click-remote-explorer-icon-vscode.md b/translations/es-ES/data/reusables/codespaces/click-remote-explorer-icon-vscode.md index 0a1e685eb9..bc6e803d41 100644 --- a/translations/es-ES/data/reusables/codespaces/click-remote-explorer-icon-vscode.md +++ b/translations/es-ES/data/reusables/codespaces/click-remote-explorer-icon-vscode.md @@ -1 +1,5 @@ -1. En {% data variables.product.prodname_vscode_shortname %}, en la barra lateral izquierda, da clic en el icono de Explorador Remoto. ![El icono de explorador remoto en {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png) +1. En {% data variables.product.prodname_vscode_shortname %}, en la barra lateral izquierda, da clic en el icono de Explorador Remoto. + + ![El icono de explorador remoto en {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png) + +{% indented_data_reference reusables.codespaces.remote-explorer spaces=3 %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/codespaces/codespaces-disabling-org-billing.md b/translations/es-ES/data/reusables/codespaces/codespaces-disabling-org-billing.md new file mode 100644 index 0000000000..d3ed8cea21 --- /dev/null +++ b/translations/es-ES/data/reusables/codespaces/codespaces-disabling-org-billing.md @@ -0,0 +1,5 @@ +{% note %} + +**Note**: If you disable billable codespaces use for your organization, anyone who can create codespaces as an individual user, and can clone a repository in your organization, will still be able to create a codespace for that repository. However, this will not incur any charge for your organization. Para obtener más información sobre cómo restringir el acceso a un repositorio, consulta la sección "[Administrar los equipos y personas con acceso a tu repositorio](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)". + +{% endnote %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/codespaces/codespaces-org-policies-note.md b/translations/es-ES/data/reusables/codespaces/codespaces-org-policies-note.md new file mode 100644 index 0000000000..0fa0c763df --- /dev/null +++ b/translations/es-ES/data/reusables/codespaces/codespaces-org-policies-note.md @@ -0,0 +1,5 @@ +{% note %} + +**Note**: Organization policies you define for {% data variables.product.prodname_codespaces %} only apply to codespaces for which your organization will be billed. If an individual user creates a codespace for a repository in your organization, and the organization is not billed, then the codespace will not be bound by these policies. Para obtener más información sobre cómo elegir quién puede crear codespaces que se facturan a tu organización, consulta la sección "[Habilitar a los {% data variables.product.prodname_github_codespaces %} para tu organización](https://docs-internal-29134-ad7bd8.preview.ghdocs.com/en/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization#choose-who-can-create-codespaces-that-are-billed-to-your-organization)". + +{% endnote %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/codespaces/codespaces-spending-limit-requirement.md b/translations/es-ES/data/reusables/codespaces/codespaces-spending-limit-requirement.md index 9ade0dcdaa..dafde78fca 100644 --- a/translations/es-ES/data/reusables/codespaces/codespaces-spending-limit-requirement.md +++ b/translations/es-ES/data/reusables/codespaces/codespaces-spending-limit-requirement.md @@ -1,9 +1,9 @@ {% note %} -**Nota:** Debes configurar un límite de gastos antes de pode utilizar {% data variables.product.prodname_codespaces %}. +**Nota:** Debes configurar un límite de gastos diferente a cero antes de poder utilizar {% data variables.product.prodname_codespaces %}. {% endnote %} -Predeterminadamente, tu organización o empresa tendrá un límite de gastos de {% data variables.product.prodname_github_codespaces %} de $0, lo cual previene que se creen codespaces nuevos o que se abran los existentes. Para permitir que tus usuarios creen codespaces en tu organización, configura el límite a un valor mayor a $0. +Predeterminadamente, tu organización o empresa tendrá un límite de gastos de {% data variables.product.prodname_github_codespaces %} igual a $0. Esto previene que se creen codespaces nuevos o que los existentes se abran en caso de que esto incurra en un costo facturable para tu organización o empresa. Para permitir que tus usuarios creen codespaces en tu organización, configura el límite a un valor mayor a $0. {% data reusables.billing.overages-billed-monthly %} diff --git a/translations/es-ES/data/reusables/codespaces/remote-explorer.md b/translations/es-ES/data/reusables/codespaces/remote-explorer.md new file mode 100644 index 0000000000..c46ed9b539 --- /dev/null +++ b/translations/es-ES/data/reusables/codespaces/remote-explorer.md @@ -0,0 +1,9 @@ +{% note %} + +**Note**: If the Remote Explorer is not displayed in the Activity Bar: + +1. Access the command palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux). +1. Type: `codespaces`. +1. Click **Codespaces: Details**. + +{% endnote %} diff --git a/translations/es-ES/data/reusables/dependabot/dependabot-alerts-filters.md b/translations/es-ES/data/reusables/dependabot/dependabot-alerts-filters.md new file mode 100644 index 0000000000..8b39c698dd --- /dev/null +++ b/translations/es-ES/data/reusables/dependabot/dependabot-alerts-filters.md @@ -0,0 +1,17 @@ +You can sort and filter {% data variables.product.prodname_dependabot_alerts %} by typing filters as `key:value` pairs into the search bar. + +| Opción | Descripción | Ejemplo | +|:------------ |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `ecosistema` | Displays alerts for the selected ecosystem | Use `ecosystem:npm` to show {% data variables.product.prodname_dependabot_alerts %} for npm |{% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-7891 %} +| `has` | Displays alerts meeting the selected filter criteria | Use `has:patch` to show alerts related to advisories that have a patch{% ifversion dependabot-alerts-vulnerable-calls %}
    Use `has:vulnerable-calls` to show alerts relating to calls to vulnerable functions{% endif %} +{% endif %} +| `is` | Displays alerts based on their state | Use `is:open` to show open alerts | +| `manifest` | Displays alerts for the selected manifest | Use `manifest:webwolf/pom.xml` to show alerts on the pom.xml file of the webwolf application | +| `paquete` | Displays alerts for the selected package | Use `package:django` to show alerts for django | +| `resolución` | Displays alerts of the selected resolution status | Use `resolution:no-bandwidth` to show alerts previously parked due to lack of resources or time to fix them | +| `repo` | Displays alerts based on the repository they relate to
    Note that this filter is only available on the security overview. For more information, see "[About the security overview](/code-security/security-overview/about-the-security-overview)" | Use `repo:octocat-repo` to show alerts in the repository called `octocat-repo` |{%- ifversion dependabot-alerts-development-label %} +| `alcance` | Displays alerts based on the scope of the dependency they relate to | Use `scope:development` to show alerts for dependencies that are only used during development +{% endif %} +| `gravedad` | Displays alerts based on their level of severity | Use `severity:high` to show alerts with a severity of High |{%- ifversion dependabot-most-important-sort-option %} +| `clasificar` | Displays alerts according to the selected sort order | The default sorting option for alerts is `sort:most-important`, which ranks alerts by importance
    Use `sort:newest` to show the latest alerts reported by {% data variables.product.prodname_dependabot %} +{% endif %} diff --git a/translations/es-ES/data/reusables/dependency-review/dependency-review-action-beta-note.md b/translations/es-ES/data/reusables/dependency-review/dependency-review-action-beta-note.md index 01b1e2f260..7ad0e01dee 100644 --- a/translations/es-ES/data/reusables/dependency-review/dependency-review-action-beta-note.md +++ b/translations/es-ES/data/reusables/dependency-review/dependency-review-action-beta-note.md @@ -1,5 +1,5 @@ {% note %} -**Note**: The {% data variables.product.prodname_dependency_review_action %} is currently in public beta and subject to change. +**Note**: La {% data variables.product.prodname_dependency_review_action %} se encuentra actualmente en beta público y está sujeta a cambios. {% endnote %} diff --git a/translations/es-ES/data/reusables/dependency-review/dependency-review-api-beta-note.md b/translations/es-ES/data/reusables/dependency-review/dependency-review-api-beta-note.md index 73ee2bb66a..c1286ecc93 100644 --- a/translations/es-ES/data/reusables/dependency-review/dependency-review-api-beta-note.md +++ b/translations/es-ES/data/reusables/dependency-review/dependency-review-api-beta-note.md @@ -1,5 +1,5 @@ {% note %} -**Note**: The Dependency Review API is currently in public beta and subject to change. +**Note**: La API de revisión de dependencias se encuentra actualmente en beta público y está sujeta a cambios. {% endnote %} diff --git a/translations/es-ES/data/reusables/desktop/sign-in-browser.md b/translations/es-ES/data/reusables/desktop/sign-in-browser.md index 50cdbc9634..0cd9b0bebc 100644 --- a/translations/es-ES/data/reusables/desktop/sign-in-browser.md +++ b/translations/es-ES/data/reusables/desktop/sign-in-browser.md @@ -1 +1 @@ -1. In the "Sign in Using Your Browser" pane, click **Continue With Browser**. {% data variables.product.prodname_desktop %} abrirá tu buscador predeterminado. ![Inicio de sesión mediante el enlace de su navegador](/assets/images/help/desktop/sign-in-browser.png) +1. En el panel de "Inicia sesión utilizando tu buscador", haz clic en **Continuar con el buscador**. {% data variables.product.prodname_desktop %} abrirá tu buscador predeterminado. ![Inicio de sesión mediante el enlace de su navegador](/assets/images/help/desktop/sign-in-browser.png) diff --git a/translations/es-ES/data/reusables/discussions/about-organization-discussions.md b/translations/es-ES/data/reusables/discussions/about-organization-discussions.md index 08628cb121..ab5e854cb5 100644 --- a/translations/es-ES/data/reusables/discussions/about-organization-discussions.md +++ b/translations/es-ES/data/reusables/discussions/about-organization-discussions.md @@ -1,5 +1,5 @@ -When you enable organization discussions, you will choose a repository in the organization to be the source repository for your organization discussions. You can use an existing repository or create a repository specifically to hold your organization discussions. Discussions will appear both on the discussions page for the organization and on the discussion page for the source repository. +Cuando habilitas los debates de organización, elegirás un repositorio en la organización para que sea el repositorio fuente para sus debates. Puedes utilizar un repositorio existente o crear uno específicamente para que almacene tus debates de organización. Los debates se mostrarán tanto en la página de debates de la organización como en la página de debates del repositorio fuente. -Permission to participate in or manage discussions in your organization is based on permission in the source repository. For example, a user needs write permission to the source repository in order to delete an organization discussion. This is identical to how a user needs write permission in a repository in order to delete a repository discussion. +El permiso para participar o administrar los debates de tu organización se basa en los permisos del repositorio fuente. Por ejemplo, los usuarios necesitan permisos de escritura en el repositorio fuente para borrar un debate de organización. Esto es idéntico a cómo un usuario necesita permisos de escritura en un repositorio para poder borrar un debate en este. -You can change the source repository at any time. If you change the source repository, discussions are not transferred to the new source repository. +Puedes cambiar el repositorio fuente en cualquier momento. Si cambias el repositorio fuente, los debates no se transferirán al repositorio fuente nuevo. diff --git a/translations/es-ES/data/reusables/discussions/enabling-or-disabling-github-discussions-for-your-organization.md b/translations/es-ES/data/reusables/discussions/enabling-or-disabling-github-discussions-for-your-organization.md index 557169cb55..3a5fb0806d 100644 --- a/translations/es-ES/data/reusables/discussions/enabling-or-disabling-github-discussions-for-your-organization.md +++ b/translations/es-ES/data/reusables/discussions/enabling-or-disabling-github-discussions-for-your-organization.md @@ -1,5 +1,5 @@ 1. En {% data variables.product.product_location %}, navega a la página principal de tu organización. -1. Under your organization name, click {% octicon "gear" aria-label="The gear icon" %} **Settings**. ![Botón de configuración de organización](/assets/images/help/discussions/org-settings.png) -1. Under "Discussions", select **Enable discussions for this organization**. -1. Select a repository to use as the source repository for your organization discussions. ![Settings to enable discussions for an organization](/assets/images/help/discussions/enable-org-discussions.png) +1. Debajo del nombre de tu organización, haz clic en {% octicon "gear" aria-label="The gear icon" %} **Ajustes**. ![Botón de configuración de organización](/assets/images/help/discussions/org-settings.png) +1. Debajo de "Debates", selecciona **Habilitar los debates para esta organización**. +1. Selecciona un repositorio para utilizarlo como el repositorio fuente para los debates de tu organización. ![Ajustes para habilitar los debates para una organización](/assets/images/help/discussions/enable-org-discussions.png) 1. Haz clic en **Save ** (guardar). diff --git a/translations/es-ES/data/reusables/discussions/navigate-to-repo-or-org.md b/translations/es-ES/data/reusables/discussions/navigate-to-repo-or-org.md index 92670f998b..03b3938d64 100644 --- a/translations/es-ES/data/reusables/discussions/navigate-to-repo-or-org.md +++ b/translations/es-ES/data/reusables/discussions/navigate-to-repo-or-org.md @@ -1 +1 @@ -1. On {% data variables.product.product_location %}, navigate to the main page of the repository or organization. +1. En {% data variables.product.product_location %}, navega a la página principal del repositorio u organización. diff --git a/translations/es-ES/data/reusables/discussions/starting-a-poll.md b/translations/es-ES/data/reusables/discussions/starting-a-poll.md index d88e08d7be..0771bfcc26 100644 --- a/translations/es-ES/data/reusables/discussions/starting-a-poll.md +++ b/translations/es-ES/data/reusables/discussions/starting-a-poll.md @@ -1,9 +1,9 @@ {% data reusables.repositories.navigate-to-repo %} {% data reusables.discussions.discussions-tab %} -1. In the list of categories, click **Polls**. ![Screenshot showing "Poll" category](/assets/images/help/discussions/poll-category.png) -1. On the right, click **Start poll**. ![Captura de pantalla que muestra el botón "Iniciar encuesta"](/assets/images/help/discussions/start-poll-button.png) -1. Type a title and optional body for your poll. ![Screenshot showing text fields for title and body](/assets/images/help/discussions/new-poll-title-and-body-fields.png) -1. Type a question for your poll. ![Screenshot showing text fields for the poll's question](/assets/images/help/discussions/new-poll-question.png) -1. Type at least two options for your poll. ![Screenshot showing text fields for the poll's options](/assets/images/help/discussions/new-poll-options.png) -1. Optionally, to add a extra poll options, click **Add an option**. ![Screenshot showing "Add an option" button](/assets/images/help/discussions/new-poll-add-option.png) -1. Click **Start poll**. ![Captura de pantalla que muestra el botón "Iniciar encuesta"](/assets/images/help/discussions/new-poll-start-poll-button.png) +1. En la lista de categorías, haz clic en **Encuestas**. ![Captura de pantalla que muestra la categoría de "Encuesta"](/assets/images/help/discussions/poll-category.png) +1. A la derecha, haz clic en **Iniciar encuesta**. ![Captura de pantalla que muestra el botón "Iniciar encuesta"](/assets/images/help/discussions/start-poll-button.png) +1. Escribe un título y un cuerpo opcional para tu encuesta. ![Captura de pantalla que muestra los campos de texto para el título y el cuerpo](/assets/images/help/discussions/new-poll-title-and-body-fields.png) +1. Escribe una pregunta para tu encuesta. ![Captura de pantalla que muestra los campos de texto para la pregunta de la encuesta](/assets/images/help/discussions/new-poll-question.png) +1. Escribe por lo menos dos opciones para tu encuesta. ![Captura de pantalla que muestra los campos de texto para las opciones de la encuesta](/assets/images/help/discussions/new-poll-options.png) +1. Opcionalmente, para agregar una opción de encuesta adicional, haz clic en **Agregar una opción**. ![Captura de pantalla que muestra el botón "Agregar una opción"](/assets/images/help/discussions/new-poll-add-option.png) +1. Haz clic en **Iniciar encuesta**. ![Captura de pantalla que muestra el botón "Iniciar encuesta"](/assets/images/help/discussions/new-poll-start-poll-button.png) diff --git a/translations/es-ES/data/reusables/education/access-github-community-exchange.md b/translations/es-ES/data/reusables/education/access-github-community-exchange.md index 315f709fbe..bea8e637fc 100644 --- a/translations/es-ES/data/reusables/education/access-github-community-exchange.md +++ b/translations/es-ES/data/reusables/education/access-github-community-exchange.md @@ -4,4 +4,4 @@ If you're a student or faculty member at an accredited educational institution, - If you’re a student and you haven't joined {% data variables.product.prodname_education %} yet, apply using the [student application form](https://education.github.com/discount_requests/student_application). For more information, see "[About {% data variables.product.prodname_global_campus %} for students](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students)." -- If you’re an educator and you haven't joined {% data variables.product.prodname_education %} yet, apply using the [teacher application form](https://education.github.com/discount_requests/teacher_application). For more information, see "[Apply to {% data variables.product.prodname_global_campus %} as a teacher](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)." +- If you’re an educator and you haven't joined {% data variables.product.prodname_education %} yet, apply using the [teacher application form](https://education.github.com/discount_requests/teacher_application). Para obtener más información, consulta la sección "[Solicitar ingresar al {% data variables.product.prodname_global_campus %} como docente](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)". diff --git a/translations/es-ES/data/reusables/education/apply-for-team.md b/translations/es-ES/data/reusables/education/apply-for-team.md index 46384e2886..f34afbc02a 100644 --- a/translations/es-ES/data/reusables/education/apply-for-team.md +++ b/translations/es-ES/data/reusables/education/apply-for-team.md @@ -1 +1 @@ -- Solicita gratis [{% data variables.product.prodname_team %}](/articles/github-s-products), que permite tener ilimitados usuarios y repositorios privados. For more information, see "[Apply to {% data variables.product.prodname_global_campus %} as a teacher](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)." +- Solicita gratis [{% data variables.product.prodname_team %}](/articles/github-s-products), que permite tener ilimitados usuarios y repositorios privados. Para obtener más información, consulta la sección "[Solicitar ingresar al {% data variables.product.prodname_global_campus %} como docente](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)". diff --git a/translations/es-ES/data/reusables/enterprise-accounts/emu-cap-validates.md b/translations/es-ES/data/reusables/enterprise-accounts/emu-cap-validates.md index 0f5e2fb0f4..bc24aa3b1e 100644 --- a/translations/es-ES/data/reusables/enterprise-accounts/emu-cap-validates.md +++ b/translations/es-ES/data/reusables/enterprise-accounts/emu-cap-validates.md @@ -1 +1 @@ -When your enterprise uses OIDC SSO, {% data variables.product.prodname_dotcom %} will automatically use your IdP's conditional access policy (CAP) IP conditions to validate user interactions with {% data variables.product.prodname_dotcom %}, when members change IP addresses, and each time a personal access token or SSH key is used. +Cuando tu empresa utiliza el SSO de OIDC, {% data variables.product.prodname_dotcom %} utilizará automáticamente las condiciones de IP de la política de acceso condicional (CAP) de tu IdP para validar las interacciones de los usuarios con {% data variables.product.prodname_dotcom %}, cuando los miembros cambien sus direcciones IP y cada que se utilice un token de acceso personal o llave SSH. diff --git a/translations/es-ES/data/reusables/enterprise-accounts/repo-creation-policy.md b/translations/es-ES/data/reusables/enterprise-accounts/repo-creation-policy.md index a39d234056..753cfb7784 100644 --- a/translations/es-ES/data/reusables/enterprise-accounts/repo-creation-policy.md +++ b/translations/es-ES/data/reusables/enterprise-accounts/repo-creation-policy.md @@ -1 +1,6 @@ -1. Debajo de "Repository creation" (Creación de repositorios), selecciona una política. ![Menú desplegable con opciones de políticas de creación de repositorios](/assets/images/help/business-accounts/repository-creation-policy-drop-down.png) +1. Debajo de "Repository creation" (Creación de repositorios), selecciona una política. + {% ifversion enterprise-namespace-repo-setting %} + ![Menú desplegable con opciones de políticas de creación de repositorios](/assets/images/help/business-accounts/restrict-personal-namespace-setting.png) + {% else %} + ![Menú desplegable con opciones de políticas de creación de repositorios](/assets/images/help/business-accounts/repository-creation-policy-drop-down.png) + {% endif %} diff --git a/translations/es-ES/data/reusables/enterprise-accounts/repository-visibility-policy.md b/translations/es-ES/data/reusables/enterprise-accounts/repository-visibility-policy.md deleted file mode 100644 index 16eee6509a..0000000000 --- a/translations/es-ES/data/reusables/enterprise-accounts/repository-visibility-policy.md +++ /dev/null @@ -1 +0,0 @@ -1. Debajo de "Repository visibility change" (Cambio de visibilidad de repositorios), usa el menú desplegable y elige una política. ![Menú desplegable con opciones de políticas de visibilidad de repositorios](/assets/images/help/business-accounts/repository-visibility-policy-drop-down.png) diff --git a/translations/es-ES/data/reusables/enterprise-accounts/security-tab.md b/translations/es-ES/data/reusables/enterprise-accounts/security-tab.md index 40001f464a..dd0e1e0c56 100644 --- a/translations/es-ES/data/reusables/enterprise-accounts/security-tab.md +++ b/translations/es-ES/data/reusables/enterprise-accounts/security-tab.md @@ -1,2 +1,7 @@ +{%- ifversion ghec or ghes > 3.4 or ghae-issue-7875 %} +1. En la barra lateral izquierda, haz clic en **Seguridad de autenticación**. + {% ifversion ghae %}![Security tab in the enterprise account settings sidebar](/assets/images/enterprise/github-ae/enterprise-account-settings-authentication-security-tab.png){% else %}![Security tab in the enterprise account settings sidebar](/assets/images/help/business-accounts/enterprise-account-settings-authentication-security-tab.png){% endif %} +{%- else %} 1. En la barra lateral izquierda, haz clic en **Security** (Seguridad). {% ifversion ghae %}![Security tab in the enterprise account settings sidebar](/assets/images/enterprise/github-ae/enterprise-account-settings-security-tab.png){% else %}![Security tab in the enterprise account settings sidebar](/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png){% endif %} +{%- endif %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/enterprise/about-github-for-enterprises.md b/translations/es-ES/data/reusables/enterprise/about-github-for-enterprises.md index eec503fbd5..611ea65ab9 100644 --- a/translations/es-ES/data/reusables/enterprise/about-github-for-enterprises.md +++ b/translations/es-ES/data/reusables/enterprise/about-github-for-enterprises.md @@ -1 +1 @@ -For more information about how businesses can use {% data variables.product.company_short %}'s products to support their software development lifecycle, see "[About {% data variables.product.prodname_dotcom %} for enterprises](/admin/overview/about-github-for-enterprises)." \ No newline at end of file +Para obtener más información sobre cómo nuestros negocios pueden utilizar los productos de {% data variables.product.company_short %} para apoyar su ciclo de desarrollo de software, consulta la sección "[Acerca de {% data variables.product.prodname_dotcom %} para empresas](/admin/overview/about-github-for-enterprises)". \ No newline at end of file diff --git a/translations/es-ES/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md b/translations/es-ES/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md index c5d6100063..d9e308eee9 100644 --- a/translations/es-ES/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md +++ b/translations/es-ES/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md @@ -1,4 +1,4 @@ -1. Define the key as a environment variable for {% data variables.product.product_name %}, replacing `` with the GPG key ID. +1. Define the key as an environment variable for {% data variables.product.product_name %}, replacing `` with the GPG key ID. ```bash{:copy} ghe-config "secrets.gpgverify.web-signing-key" "$(gpg --export-secret-keys -a | awk '{printf "%s\\n", $0}')" diff --git a/translations/es-ES/data/reusables/gated-features/codespaces-classroom-articles.md b/translations/es-ES/data/reusables/gated-features/codespaces-classroom-articles.md index 924aac0d15..fb0f2fcb07 100644 --- a/translations/es-ES/data/reusables/gated-features/codespaces-classroom-articles.md +++ b/translations/es-ES/data/reusables/gated-features/codespaces-classroom-articles.md @@ -1 +1 @@ -Codespaces is available to use with {% data variables.product.prodname_classroom %} for organizations that use {% data variables.product.prodname_team %}. To find out if you qualify for a free upgrade to {% data variables.product.prodname_team %}, see "[Apply to {% data variables.product.prodname_global_campus %} as a teacher](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)." +Codespaces is available to use with {% data variables.product.prodname_classroom %} for organizations that use {% data variables.product.prodname_team %}. Para saber si calificas para una mejora a {% data variables.product.prodname_team %}, consulta la secciòn "[Solicitar entrar al {% data variables.product.prodname_global_campus %} como docente](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)". diff --git a/translations/es-ES/data/reusables/gated-features/codespaces.md b/translations/es-ES/data/reusables/gated-features/codespaces.md index d4d9524bea..25704e65d5 100644 --- a/translations/es-ES/data/reusables/gated-features/codespaces.md +++ b/translations/es-ES/data/reusables/gated-features/codespaces.md @@ -1 +1 @@ -{% data variables.product.prodname_github_codespaces %} está disponible para las organizaciones que utilizan {% data variables.product.prodname_team %} o {% data variables.product.prodname_ghe_cloud %}. {% data variables.product.prodname_github_codespaces %} is also available as a limited beta release for individual users on {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_pro %} plans. {% data reusables.gated-features.more-info-org-products %} +{% data variables.product.prodname_github_codespaces %} está disponible para las organizaciones que utilizan {% data variables.product.prodname_team %} o {% data variables.product.prodname_ghe_cloud %}. {% data variables.product.prodname_github_codespaces %} también está disponible como un lanzamiento beta limitado para los usuarios individuales en los planes de {% data variables.product.prodname_free_user %} y {% data variables.product.prodname_pro %}. {% data reusables.gated-features.more-info-org-products %} diff --git a/translations/es-ES/data/reusables/gated-features/dependency-vulnerable-calls.md b/translations/es-ES/data/reusables/gated-features/dependency-vulnerable-calls.md index 1f6773128e..2608c16d56 100644 --- a/translations/es-ES/data/reusables/gated-features/dependency-vulnerable-calls.md +++ b/translations/es-ES/data/reusables/gated-features/dependency-vulnerable-calls.md @@ -1,11 +1,11 @@ {%- ifversion fpt %} -Detection of vulnerable calls is enabled on public repositories. This analysis is also available in private repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have licensed {% data variables.product.prodname_GH_advanced_security %}. +Detection of vulnerable calls is enabled on public repositories. Este análisis también está disponible en repositorios privados que le pertenezcan a las organizaciones que utilizan {% data variables.product.prodname_ghe_cloud %} y que tienen {% data variables.product.prodname_GH_advanced_security %} con licencia. {%- elsif ghec %} -Detection of vulnerable calls is included in {% data variables.product.product_name %} for public repositories. To detect vulnerable calls in private repositories owned by organizations, your organization must have a license for {% data variables.product.prodname_GH_advanced_security %}. +La detección de llamadas vulnerables se incluye en {% data variables.product.product_name %} para repositorios públicos. Para detectar llamadas vulnerables en repositorios privados que le pertenecen a las organizaciones, tu organización debe tener una licencia para {% data variables.product.prodname_GH_advanced_security %}. {%- elsif ghes > 3.5 %} -Detection of vulnerable calls is available for organization-owned repositories in {% data variables.product.product_name %}. Esta característica requiere una licencia para la {% data variables.product.prodname_GH_advanced_security %}. +La detección de llamadas vulnerables está disponible para los repositorios que pertenecen a organizaciones de {% data variables.product.product_name %}. Esta característica requiere una licencia para la {% data variables.product.prodname_GH_advanced_security %}. {%- elsif ghae-issue-6076 %} La detección de llamadas vulnerables está disponible para los repositorios que pertenecen a organizaciones de {% data variables.product.product_name %}. Esta es una característica de la {% data variables.product.prodname_GH_advanced_security %} (gratuita durante el lanzamiento beta). diff --git a/translations/es-ES/data/reusables/git/cache-on-repository-path.md b/translations/es-ES/data/reusables/git/cache-on-repository-path.md new file mode 100644 index 0000000000..ced81ebbd9 --- /dev/null +++ b/translations/es-ES/data/reusables/git/cache-on-repository-path.md @@ -0,0 +1,5 @@ +1. To configure Git to cache credentials for each local directory where you clone a repository, enter the following command. + + ```shell{:copy} + git config --global credential.useHttpPath true + ``` diff --git a/translations/es-ES/data/reusables/git/clear-stored-gcm-credentials.md b/translations/es-ES/data/reusables/git/clear-stored-gcm-credentials.md new file mode 100644 index 0000000000..04e3de748e --- /dev/null +++ b/translations/es-ES/data/reusables/git/clear-stored-gcm-credentials.md @@ -0,0 +1,5 @@ +- If the output is `manager-core`, you're using Git Credential Manager. To clear the credentials, run the following command. + + ```shell{:copy} + git credential-manager reject https://github.com + ``` diff --git a/translations/es-ES/data/reusables/git/clear-the-stored-credentials.md b/translations/es-ES/data/reusables/git/clear-the-stored-credentials.md new file mode 100644 index 0000000000..f723d7ab97 --- /dev/null +++ b/translations/es-ES/data/reusables/git/clear-the-stored-credentials.md @@ -0,0 +1 @@ +1. If the output confirms that you're using a credential manager, clear the stored credentials for the credential manager. diff --git a/translations/es-ES/data/reusables/git/confirm-credential-manager.md b/translations/es-ES/data/reusables/git/confirm-credential-manager.md new file mode 100644 index 0000000000..68c6e99397 --- /dev/null +++ b/translations/es-ES/data/reusables/git/confirm-credential-manager.md @@ -0,0 +1,5 @@ +1. To confirm your use of a credential manager, enter the following command and note the output. + + ```shell{:copy} + git config --get credential.helper + ``` diff --git a/translations/es-ES/data/reusables/git/no-credential-manager.md b/translations/es-ES/data/reusables/git/no-credential-manager.md new file mode 100644 index 0000000000..fe79c2ff04 --- /dev/null +++ b/translations/es-ES/data/reusables/git/no-credential-manager.md @@ -0,0 +1 @@ +- If the output doesn't include the name of a credential manager, there is no credential manager configured, and you can proceed to the next step. \ No newline at end of file diff --git a/translations/es-ES/data/reusables/git/open-terminal.md b/translations/es-ES/data/reusables/git/open-terminal.md new file mode 100644 index 0000000000..f6d095397c --- /dev/null +++ b/translations/es-ES/data/reusables/git/open-terminal.md @@ -0,0 +1 @@ +1. Abre Terminal. diff --git a/translations/es-ES/data/reusables/git/provide-credentials.md b/translations/es-ES/data/reusables/git/provide-credentials.md new file mode 100644 index 0000000000..351a1e87d1 --- /dev/null +++ b/translations/es-ES/data/reusables/git/provide-credentials.md @@ -0,0 +1,3 @@ +1. The first time that you use Git to clone a repository or access data in a repository that you've already cloned, Git will request credentials. Provide the PAT for the account with access to the repository. + + Git will cache the PAT for the directory you're in, and you'll be able to access and write repository data on {% data variables.product.product_location %} using the correct account. diff --git a/translations/es-ES/data/reusables/gpg/configure-ssh-signing.md b/translations/es-ES/data/reusables/gpg/configure-ssh-signing.md new file mode 100644 index 0000000000..f0f489a73a --- /dev/null +++ b/translations/es-ES/data/reusables/gpg/configure-ssh-signing.md @@ -0,0 +1,4 @@ +1. Configure Git to use SSH to sign commits and tags: + ```bash + $ git config --global gpg.format ssh + ``` \ No newline at end of file diff --git a/translations/es-ES/data/reusables/gpg/copy-gpg-key-id.md b/translations/es-ES/data/reusables/gpg/copy-gpg-key-id.md index e075c5dd1a..b10e58d80c 100644 --- a/translations/es-ES/data/reusables/gpg/copy-gpg-key-id.md +++ b/translations/es-ES/data/reusables/gpg/copy-gpg-key-id.md @@ -1,9 +1,9 @@ 1. Desde la lista de llaves GPG, compia la forma larga de la ID de la llave GPG que quieres utilizar. En este ejemplo, el ID de la llave GPG es `3AA5C34371567BD2`: - ```shell + ```shell{:copy} $ gpg --list-secret-keys --keyid-format=long /Users/hubot/.gnupg/secring.gpg ------------------------------------ sec 4096R/3AA5C34371567BD2 2016-03-10 [expires: 2017-03-10] uid Hubot ssb 4096R/42B317FD4BA89E7A 2016-03-10 - ``` + ``` diff --git a/translations/es-ES/data/reusables/gpg/copy-ssh-public-key.md b/translations/es-ES/data/reusables/gpg/copy-ssh-public-key.md new file mode 100644 index 0000000000..36b53fd808 --- /dev/null +++ b/translations/es-ES/data/reusables/gpg/copy-ssh-public-key.md @@ -0,0 +1,43 @@ +1. Copia la llave SSH pública a tu portapapeles. + + Si tu archivo de llave SSH pública tiene un nombre diferente que en el código de ejemplo, modifica el nombre de archivo para que coincida con tu configuración actual. Al copiar tu clave, no agregues líneas nuevas o espacios en blanco. +{% mac %} + + ```shell + $ pbcopy < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub + # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard + ``` + + {% tip %} + + **Sugerencia:** Si `pbcopy` no está funcionando, puedes ubicar la carpeta `.ssh` oculta, abrir el archivo en tu editor de texto favorito, y copiarlo en tu portapapeles. + + {% endtip %} +{% endmac %} +{% windows %} + + ```shell + $ clip < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub + # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard + ``` + + {% tip %} + + **Sugerencia:** Si `clip` no está funcionando, puedes ubicar la carpeta `.shh` oculta, abrir el archivo en tu editor de texto favorito, y copiarlo en tu portapapeles. + + {% endtip %} +{% endwindows %} +{% linux %} + + ```shell + $ cat ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub + # Then select and copy the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file + # displayed in the terminal to your clipboard + ``` + + {% tip %} + + **Tip:** Como alternativa, puedes ubicar la carpeta `.ssh` oculta, abrir el archivo en tu editor de texto favorito y copiarlo a tu portapapeles. + + {% endtip %} +{% endlinux %} diff --git a/translations/es-ES/data/reusables/gpg/list-keys-with-note.md b/translations/es-ES/data/reusables/gpg/list-keys-with-note.md index 9e243ce572..64b0a703f9 100644 --- a/translations/es-ES/data/reusables/gpg/list-keys-with-note.md +++ b/translations/es-ES/data/reusables/gpg/list-keys-with-note.md @@ -1,10 +1,11 @@ - 1. Utiliza el comando `gpg --list-secret-keys --keyid-format=long` para enumerar la forma larga de las llaves GPG para las cuales tienes tanto una llave pública como una privada. Se requiere una llave privada para registrar confirmaciones o etiquetas. - ```shell - $ gpg --list-secret-keys --keyid-format=long -``` - {% note %} - **Nota:** Algunas instalaciones GPG en Linux pueden requerir que uses `gpg2 --list-keys --keyid-format LONG` para visualizar una lista de tus llaves existentes en su lugar. En este caso también deberás configurar Git para que use `gpg2` by running `git config --global gpg.program gpg2`. + ```shell{:copy} + $ gpg --list-secret-keys --keyid-format=long + ``` - {% endnote %} + {% note %} + + **Nota:** Algunas instalaciones GPG en Linux pueden requerir que uses `gpg2 --list-keys --keyid-format LONG` para visualizar una lista de tus llaves existentes en su lugar. En este caso también deberás configurar Git para que use `gpg2` by running `git config --global gpg.program gpg2`. + + {% endnote %} diff --git a/translations/es-ES/data/reusables/gpg/paste-gpg-key-id.md b/translations/es-ES/data/reusables/gpg/paste-gpg-key-id.md index 0a8f65444f..b42148bdd8 100644 --- a/translations/es-ES/data/reusables/gpg/paste-gpg-key-id.md +++ b/translations/es-ES/data/reusables/gpg/paste-gpg-key-id.md @@ -1,9 +1,9 @@ -1. To set your primary GPG signing key in Git, paste the text below, substituting in the GPG primary key ID you'd like to use. En este ejemplo, el ID de la llave GPG es `3AA5C34371567BD2`: +1. Para configurar tu llave de firmado GPG primaria en Git, pega el siguiente texto, substituyendo la ID de llave primaria GPG que te gustaría utilizar. En este ejemplo, el ID de la llave GPG es `3AA5C34371567BD2`: ```shell $ git config --global user.signingkey 3AA5C34371567BD2 ``` - Alternatively, when setting a subkey include the `!` suffix. In this example, the GPG subkey ID is `4BB6D45482678BE3`: + Como alternativa, cuando compartas una subllave, incluye el sufijo `!`. En este ejemplo, la ID de subllave GPG es `4BB6D45482678BE3`: ```shell $ git config --global user.signingkey 4BB6D45482678BE3! ``` diff --git a/translations/es-ES/data/reusables/gpg/paste-ssh-public-key.md b/translations/es-ES/data/reusables/gpg/paste-ssh-public-key.md new file mode 100644 index 0000000000..1274a0acb5 --- /dev/null +++ b/translations/es-ES/data/reusables/gpg/paste-ssh-public-key.md @@ -0,0 +1,4 @@ +1. To set your SSH signing key in Git, paste the text below, substituting the contents of your clipboard for the key you'd like to use. Since the key contains spaces, you must wrap it in quotes: + ```bash + $ git config --global user.signingkey 'ssh-ed25519 AAAAC3(...) user@example.com' + ``` \ No newline at end of file diff --git a/translations/es-ES/data/reusables/gpg/ssh-git-version.md b/translations/es-ES/data/reusables/gpg/ssh-git-version.md new file mode 100644 index 0000000000..aea08195e9 --- /dev/null +++ b/translations/es-ES/data/reusables/gpg/ssh-git-version.md @@ -0,0 +1,6 @@ + +{% note %} + +**Note:** SSH signature verification is available in Git 2.34 or later. Para actualizar tu versiíon de Git, consulta el sitio web de [Git](https://git-scm.com/downloads). + +{% endnote %} diff --git a/translations/es-ES/data/reusables/gpg/x-509-key.md b/translations/es-ES/data/reusables/gpg/x-509-key.md index 5965862c30..a87d0e6827 100644 --- a/translations/es-ES/data/reusables/gpg/x-509-key.md +++ b/translations/es-ES/data/reusables/gpg/x-509-key.md @@ -1,5 +1,5 @@ -### Informarle a Git acerca de tu llave X.509 +## Informarle a Git acerca de tu llave X.509 Puedes usar [smimesign](https://github.com/github/smimesign) para firmar confirmaciones y etiquetas utilizando S/MIME en lugar de GPG. diff --git a/translations/es-ES/data/reusables/identity-and-permissions/about-adding-ip-allow-list-entries.md b/translations/es-ES/data/reusables/identity-and-permissions/about-adding-ip-allow-list-entries.md new file mode 100644 index 0000000000..772581f87a --- /dev/null +++ b/translations/es-ES/data/reusables/identity-and-permissions/about-adding-ip-allow-list-entries.md @@ -0,0 +1,3 @@ +You can create an IP allow list by adding entries that each contain an IP address or address range.{% ifversion ip-allow-list-address-check %} After you finish adding entries, you can check whether a particular IP address would be allowed by any of the enabled entries in your list.{% endif %} + +Before the list restricts access to {% ifversion ghae %}your enterprise{% else %}private assets owned by organizations in your enterprise{% endif %}, you must also enable allowed IP addresses. \ No newline at end of file diff --git a/translations/es-ES/data/reusables/identity-and-permissions/about-checking-ip-address.md b/translations/es-ES/data/reusables/identity-and-permissions/about-checking-ip-address.md new file mode 100644 index 0000000000..dfdc758f91 --- /dev/null +++ b/translations/es-ES/data/reusables/identity-and-permissions/about-checking-ip-address.md @@ -0,0 +1 @@ +You can check whether a particular IP address would be allowed by any of the enabled entries in your IP allow list, even if the list is not currently enabled. \ No newline at end of file diff --git a/translations/es-ES/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md b/translations/es-ES/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md new file mode 100644 index 0000000000..d646e02ec5 --- /dev/null +++ b/translations/es-ES/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md @@ -0,0 +1,5 @@ +You can edit an entry in your IP allow list. If you edit an enabled entry, changes are enforced immediately. + +{% ifversion ip-allow-list-address-check %} +After you finish editing entries, you can check whether a particular IP address would be allowed by any of the enabled entries in your list. +{% endif %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md b/translations/es-ES/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md new file mode 100644 index 0000000000..f886df0690 --- /dev/null +++ b/translations/es-ES/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md @@ -0,0 +1,5 @@ +After you create an IP allow list, you can enable allowed IP addresses. When you enable allowed IP addresses, {% data variables.product.company_short %} immediately enforces any enabled entries in your IP allow list. + +{% ifversion ip-allow-list-address-check %} +Before you enable allowed IP addresses, you can check whether a particular IP address would be allowed by any of the enabled entries in your list. For more information, see "[Checking if an IP address is permitted](#checking-if-an-ip-address-is-permitted)." +{% endif %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/identity-and-permissions/check-ip-address-step.md b/translations/es-ES/data/reusables/identity-and-permissions/check-ip-address-step.md new file mode 100644 index 0000000000..5e73fdddcd --- /dev/null +++ b/translations/es-ES/data/reusables/identity-and-permissions/check-ip-address-step.md @@ -0,0 +1 @@ +1. Under "Check your IP address", enter an IP address. ![Screenshot of the "Check IP address" text field](/assets/images/help/security/check-ip-address.png) \ No newline at end of file diff --git a/translations/es-ES/data/reusables/identity-and-permissions/check-ip-address.md b/translations/es-ES/data/reusables/identity-and-permissions/check-ip-address.md new file mode 100644 index 0000000000..9a187752d6 --- /dev/null +++ b/translations/es-ES/data/reusables/identity-and-permissions/check-ip-address.md @@ -0,0 +1,3 @@ +{%- ifversion ip-allow-list-address-check %} +1. Optionally, check if a particular IP address would be allowed by any of the enabled entries in your list. For more information, see "[Checking if an IP address is permitted](#checking-if-an-ip-address-is-permitted)." +{%- endif %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/identity-and-permissions/ip-allow-lists-enable.md b/translations/es-ES/data/reusables/identity-and-permissions/ip-allow-lists-enable.md index e236790aec..65f0446fcc 100644 --- a/translations/es-ES/data/reusables/identity-and-permissions/ip-allow-lists-enable.md +++ b/translations/es-ES/data/reusables/identity-and-permissions/ip-allow-lists-enable.md @@ -1 +1,3 @@ -Para aplicar la lista de IP permitidas, primero debes agregar direcciones a la lista, y después habilitarla. Debes agregar tu dirección IP actual o un rango coincidente antes de habilitar la lista de permisos de IP. +Para requerir la lista de direcciones IP permitidas, primero debes agregar direcciones IP a ella y luego habilitarla.{% ifversion ip-allow-list-address-check %} Después de que completes tu lista, puedes verificar si una dirección IP en particular estaría permitida en cualquiera de las entradas habilitadas en dicha lista.{% endif %} + +Debes agregar tu dirección IP actual o un rango coincidente antes de habilitar la lista de permisos de IP. diff --git a/translations/es-ES/data/reusables/identity-and-permissions/ipv6-allow-lists.md b/translations/es-ES/data/reusables/identity-and-permissions/ipv6-allow-lists.md new file mode 100644 index 0000000000..3c26491fe2 --- /dev/null +++ b/translations/es-ES/data/reusables/identity-and-permissions/ipv6-allow-lists.md @@ -0,0 +1,7 @@ +{% ifversion fpt or ghec %} +{% note %} + +**Note:** {% data variables.product.company_short %} is gradually rolling out support for IPv6. As {% data variables.product.prodname_dotcom %} services continue to add IPv6 support, we will start recognizing IPv6 addresses of {% data variables.product.prodname_dotcom %} users. To prevent possible access interruptions, please ensure you have added any necessary IPv6 addresses to your IP allow list. + +{% endnote %} +{% endif %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/organizations/about-following-organizations.md b/translations/es-ES/data/reusables/organizations/about-following-organizations.md new file mode 100644 index 0000000000..52e52467fb --- /dev/null +++ b/translations/es-ES/data/reusables/organizations/about-following-organizations.md @@ -0,0 +1 @@ +When you follow organizations on {% data variables.product.product_name %}, you'll see their {% ifversion fpt or ghec %}public{% endif %} activity on your personal dashboard. This activity includes new discussions, sponsorships, and repositories. \ No newline at end of file diff --git a/translations/es-ES/data/reusables/organizations/follow-organizations-beta.md b/translations/es-ES/data/reusables/organizations/follow-organizations-beta.md new file mode 100644 index 0000000000..8d9ef03cd1 --- /dev/null +++ b/translations/es-ES/data/reusables/organizations/follow-organizations-beta.md @@ -0,0 +1,5 @@ +{% note %} + +**Nota:** La capacidad de seguir organizaciones se encuentra actualmente en beta público y está sujeta a cambios. + +{% endnote %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/package_registry/authenticate-packages.md b/translations/es-ES/data/reusables/package_registry/authenticate-packages.md index a766f6e96d..5ca4e91584 100644 --- a/translations/es-ES/data/reusables/package_registry/authenticate-packages.md +++ b/translations/es-ES/data/reusables/package_registry/authenticate-packages.md @@ -4,4 +4,4 @@ You can use a personal access token (PAT) to authenticate to {% data variables.p To authenticate to a {% data variables.product.prodname_registry %} registry within a {% data variables.product.prodname_actions %} workflow, you can use: - `GITHUB_TOKEN` to publish packages associated with the workflow repository. -- a PAT to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). +- a PAT with at least `packages:read` scope to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). diff --git a/translations/es-ES/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md b/translations/es-ES/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md deleted file mode 100644 index 710a154d36..0000000000 --- a/translations/es-ES/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md +++ /dev/null @@ -1,11 +0,0 @@ -{% ifversion fpt or ghec or ghes > 3.4 %} - -Para autenticarse en el {% data variables.product.prodname_container_registry %} dentro de un flujo de trabajo de {% data variables.product.prodname_actions %}, utiliza el `GITHUB_TOKEN` para tener la mejor experiencia en seguridad. Si tu flujo de trabajo utiliza un token de acceso personal (PAT) para autenticarse en `{% data reusables.package_registry.container-registry-hostname %}`, entonces te recomendamos ampliamente que lo actualices para que utilice el `GITHUB_TOKEN`. - -{% ifversion fpt or ghec %}Para obtener orientación sobre cómo actualizar tus flujos de trabajo que se autentican con `{% data reusables.package_registry.container-registry-hostname %}` con un token de acceso personal, consulta la sección "[Actualizar un flujo de trab ajo que accede a `ghcr.io`](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#upgrading-a-workflow-that-accesses-ghcrio)".{% endif %} - -Para obtener más información sobre el `GITHUB_TOKEN`, consulta la sección "[Autenticación en un flujo de trabajo](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)". - -Si estás utilizando el {% data variables.product.prodname_container_registry %} en las acciones, sigue nuestras mejores prácticas de seguridad en "[Fortalecimiento de seguridad para las Acciones de GitHub](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)". - -{% endif %} diff --git a/translations/es-ES/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md b/translations/es-ES/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md new file mode 100644 index 0000000000..520a91c938 --- /dev/null +++ b/translations/es-ES/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md @@ -0,0 +1,7 @@ +If your workflow is using a personal access token (PAT) to authenticate to a registry, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. + +{% ifversion fpt or ghec %}For guidance on updating your workflows that authenticate to a registry with a personal access token, see "[Upgrading a workflow that accesses a registry using a PAT](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#upgrading-a-workflow-that-accesses-a-registry-using-a-pat)."{% endif %} + +Para obtener más información sobre el `GITHUB_TOKEN`, consulta la sección "[Autenticación en un flujo de trabajo](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)". + +For more information about the best practises when using a registry in actions, see "[Security hardening for GitHub Actions](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)." diff --git a/translations/es-ES/data/reusables/package_registry/container-registry-migration-namespaces.md b/translations/es-ES/data/reusables/package_registry/container-registry-migration-namespaces.md index 9d7d0dc5e0..ecb450e5a1 100644 --- a/translations/es-ES/data/reusables/package_registry/container-registry-migration-namespaces.md +++ b/translations/es-ES/data/reusables/package_registry/container-registry-migration-namespaces.md @@ -1 +1 @@ -Any scripts or {% data variables.product.prodname_actions %} workflows that use the namespace for the Docker registry, {% data variables.product.prodname_docker_registry_namespace %}, will continue to work after migration to the {% data variables.product.prodname_container_registry %} at {% data variables.product.prodname_container_registry_namespace %}. +Cualquier script o flujo de trabajo de {% data variables.product.prodname_actions %} que utilice un designador de nombre para el registro de Docker, {% data variables.product.prodname_docker_registry_namespace %}, seguirá funcionando después de su migración al {% data variables.product.prodname_container_registry %} en {% data variables.product.prodname_container_registry_namespace %}. diff --git a/translations/es-ES/data/reusables/package_registry/no-graphql-to-delete-packages.md b/translations/es-ES/data/reusables/package_registry/no-graphql-to-delete-packages.md new file mode 100644 index 0000000000..cbab609f2b --- /dev/null +++ b/translations/es-ES/data/reusables/package_registry/no-graphql-to-delete-packages.md @@ -0,0 +1 @@ +{% ifversion fpt or ghec %} The {% data variables.product.prodname_registry %} GraphQL API does not support containers or Docker images that use the package namespace `https://ghcr.io/OWNER/PACKAGE-NAME`, or npm images that use the package namespace `https://npm.pkg.github.com/OWNER/PACKAGE-NAME`.{% endif %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md b/translations/es-ES/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md index ae12fb4907..cb2a817e52 100644 --- a/translations/es-ES/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md +++ b/translations/es-ES/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md @@ -1,16 +1,16 @@ -{% ifversion ghes > 3.1 or ghes < 3.5 %} +{% ifversion ghes < 3.5 %} -In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server 3.5 or later may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 when you upgrade from an earlier release to 3.5 or later. A fix for 3.5 and later will be available in an upcoming patch release. +In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server 3.5 or later may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 when you upgrade from an earlier release to 3.5 or later. A fix will be available in upcoming patch releases. -To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). [Updated: 2022-08-16] +To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). [Updated: 2022-08-26] -{% elsif ghes > 3.4 or ghes < 3.7 %} +{% elsif ghes = 3.5 or ghes = 3.6 %} -In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server {{ currentVersion }} may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 as you upgrade to the latest release. To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). +In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server {{ allVersions[currentVersion].currentRelease }} may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 as you upgrade to the latest release. To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). - To display the missing alerts for all repositories owned by an organization, organization owners can navigate to the organization's **Code security and analysis** settings, then click **Enable all** for secret scanning. Para obtener más información, consulta la sección "[Administrar la configuración de análisis y seguridad para tu organización](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories)". - To display the missing alerts for an individual repository, people with admin access to the repository can disable then enable secret scanning for the repository. Para obtener más información, consulta la sección "[Administrar la configuración de seguridad y análisis para tu repositorio](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)". -A fix will be available in an upcoming patch release. [Updated: 2022-08-16] +A fix will be available in an upcoming patch release. [Updated: 2022-08-26] {% endif %} diff --git a/translations/es-ES/data/reusables/repositories/anyone-can-view-anonymized-url.md b/translations/es-ES/data/reusables/repositories/anyone-can-view-anonymized-url.md index 1609e74415..6f8739557f 100644 --- a/translations/es-ES/data/reusables/repositories/anyone-can-view-anonymized-url.md +++ b/translations/es-ES/data/reusables/repositories/anyone-can-view-anonymized-url.md @@ -1,5 +1,5 @@ {% warning %} -**Warning:** If you attach a file to a pull request, issue comment, or ticket in the {% data variables.contact.support_portal %}, anyone can view the anonymized URL without authentication, even if the pull request is in a private repository{% ifversion ghes %}, or if private mode is enabled{% endif %}. Para mantener privados archivos de medios sensibles, estos se deben servir desde una red o servidor privados que requieran autenticación. {% ifversion fpt or ghec %}Para obtener más información sobre las URL anonimizadas, consulta la sección "[Acerca de las URL anonimizadas](/github/authenticating-to-github/about-anonymized-urls)".{% endif %} +**Advertencia:** Si adjuntas un archivo a una solicitud de cambios, comentario de propuesta o ticket en el {% data variables.contact.support_portal %}, cualquiera podrá ver la URL anonimizada sin autenticación, incluso si la solicitud de cambios se encuentra en un repositorio privado{% ifversion ghes %} o si se habilita el modo privado{% endif %}. Para mantener privados archivos de medios sensibles, estos se deben servir desde una red o servidor privados que requieran autenticación. {% ifversion fpt or ghec %}Para obtener más información sobre las URL anonimizadas, consulta la sección "[Acerca de las URL anonimizadas](/github/authenticating-to-github/about-anonymized-urls)".{% endif %} {% endwarning %} diff --git a/translations/es-ES/data/reusables/secret-scanning/partner-secret-list-private-repo.md b/translations/es-ES/data/reusables/secret-scanning/partner-secret-list-private-repo.md index db35209d86..db8631fa6b 100644 --- a/translations/es-ES/data/reusables/secret-scanning/partner-secret-list-private-repo.md +++ b/translations/es-ES/data/reusables/secret-scanning/partner-secret-list-private-repo.md @@ -75,7 +75,7 @@ Plivo | ID de Autorización de Plivo con Token de Autorización de Plivo | plivo {%- ifversion fpt or ghec or ghes > 3.6 or ghae-issue-7456 %} Prefect | Llave de la API del Servidor de Prefect | prefect_server_api_key Prefect | Llave de la API de Usuario de Prefect | prefect_user_api_key{% endif %} Proctorio | Llave de Consumidor de Proctorio | proctorio_consumer_key Proctorio | Llave de Enlace de Proctorio | proctorio_linkage_key Proctorio | Llave de Registro de Proctorio | proctorio_registration_key Proctorio | Llave de Secreto de Proctorio | proctorio_secret_key Pulumi | Token de Acceso a Pulumi | pulumi_access_token PyPI | Token de la API de PyPI | pypi_api_token {%- ifversion fpt or ghec or ghes > 3.6 or ghae-issue-7456 %} -ReadMe | ReadMe API Access Key | readmeio_api_access_token{% endif %} +ReadMe | Llave de Acceso de la API de ReadMe API | readmeio_api_access_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.5 or ghae-issue-7375 %} redirect.pizza | Token de la API de redirect.pizza | redirect_pizza_api_token{% endif %} RubyGems | Llave de la API de RubyGems | rubygems_api_key Samsara | Token de la API de Samsara | samsara_api_token Samsara | Token de Acceso OAuth de Samsara | samsara_oauth_access_token {%- ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6944 %} diff --git a/translations/es-ES/data/reusables/secret-scanning/push-protection-web-ui-choice.md b/translations/es-ES/data/reusables/secret-scanning/push-protection-web-ui-choice.md index 4713a971bb..6c63eaf13f 100644 --- a/translations/es-ES/data/reusables/secret-scanning/push-protection-web-ui-choice.md +++ b/translations/es-ES/data/reusables/secret-scanning/push-protection-web-ui-choice.md @@ -2,5 +2,12 @@ Cuando utilizas la IU web para intentar confirmar un secreto compatible en un re Puedes ver un letrero en la parte superior de la página con información sobre la ubicación del secreto y este también se subrayará en el archivo para que lo puedas encontrar con facilidad. +{% ifversion push-protection-custom-link-orgs %} + + ![Captura de pantalla que muestra una confirmación bloqueada en la IU web debido a la protección contra subidas del escaneo de secretos](/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-blocked-banner-with-link.png) + +{% else %} + ![Captura de pantalla que muestra una confirmación bloqueada en la IU web debido a la protección contra subidas del escaneo de secretos](/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-blocked-banner.png) - \ No newline at end of file + +{% endif %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/secret-scanning/secret-list-private-push-protection.md b/translations/es-ES/data/reusables/secret-scanning/secret-list-private-push-protection.md index 2c4bf4dfcf..c143ad8609 100644 --- a/translations/es-ES/data/reusables/secret-scanning/secret-list-private-push-protection.md +++ b/translations/es-ES/data/reusables/secret-scanning/secret-list-private-push-protection.md @@ -15,12 +15,12 @@ Azure | Llave Cuenta de Almacenamiento de Azure | azure_storage_account_key{% en {%- ifversion fpt or ghec or ghes > 3.6 or ghae-issue-7456 %} JFrog | Token de Acceso a la Plataforma de JFrog | jfrog_platform_access_token JFrog | Llave de la API de la Plataforma de JFrog | jfrog_platform_api_key{% endif %} Ionic | Token de Acceso Personal a Ionic | ionic_personal_access_token Ionic | Token de Actualización de Ionic | ionic_refresh_token Linear | Llave de la API de Linear | linear_api_key Linear | Token de Acceso OAuth a Linear | linear_oauth_access_token Midtrans | Llave del Servidor de Producción de Midtrans | midtrans_production_server_key New Relic | Llave de la API Personal de New Relic | new_relic_personal_api_key New Relic | Llavde ed la API de REST de New Relic | new_relic_rest_api_key New Relic | Llave de Consulta de Perspectivas de New Relic | new_relic_insights_query_key npm | Token de Acceso a npm | npm_access_token NuGet | Llave de la API de NuGet | nuget_api_key Onfido | Token de la API en Vivo de Onfido | onfido_live_api_token OpenAI | Llave de la API de OpenAI | openai_api_key PlanetScale | Contraseña de la Base de Datos de PlanetScale | planetscale_database_password PlanetScale | Token OAuth de PlanetScale | planetscale_oauth_token PlanetScale | Token de Servicio de PlanetScale | planetscale_service_token Postman | Llave de la API de Postman | postman_api_key {%- ifversion fpt or ghec or ghes > 3.6 or ghae-issue-7456 %} -Prefect | Prefect Server API Key | prefect_server_api_key Prefect | Prefect User API Key | prefect_user_api_key{% endif %} Proctorio | Proctorio Secret Key | proctorio_secret_key +Prefect | Llave de la API del Servidor de Prefect | prefect_server_api_key Prefect | Llave de la API de Usuario de Prefect | prefect_user_api_key{% endif %} Proctorio | Llav del Secreto de Proctorio | proctorio_secret_key {%- ifversion fpt or ghec or ghes > 3.6 or ghae-issue-7456 %} -ReadMe | ReadMe API Access Key | readmeio_api_access_token{% endif %} +ReadMe | Llave de Acceso de la API de ReadMe API | readmeio_api_access_token{% endif %} {%- ifversion fpt or ghec or ghes > 3.5 or ghae-issue-7375 %} redirect.pizza | Token de la API de redirect.pizza | redirect_pizza_api_token{% endif %} Samsara | Token de la API de Samsara | samsara_api_token Samsara | Token de Acceso OAuth a Samsara | samsara_oauth_access_token SendGrid | Llave de la API de SendGrid | sendgrid_api_key Sendinblue | Llave de la API de Sendinblue | sendinblue_api_key Sendinblue | Llave SMTP de Sendinblue | sendinblue_smtp_key Shippo | Token de la API en Vivo de Shippo | shippo_live_api_token Shopify | Secreto Compartido de la Aplicación de Shopify | shopify_app_shared_secret Shopify | Token de Acceso a Shopify | shopify_access_token Slack | Token de la API de Slack | slack_api_token Stripe | Llave Secreta de la API en Vivo de Stripe | stripe_api_key Tencent Cloud | ID Secreta de la Nube de Tencent | tencent_cloud_secret_id Typeform | Token de Acceso Personal a Typeform | typeform_personal_access_token {%- ifversion fpt or ghec or ghes > 3.6 or ghae-issue-7456 %} -Uniwise | WISEflow API Key | wiseflow_api_key{% endif %} WorkOS | WorkOS Production API Key | workos_production_api_key +Uniwise | Llave de la API de WISEflow | wiseflow_api_key{% endif %} WorkOS | Llave de la API de Producción de WorkOS | workos_production_api_key {%- ifversion fpt or ghec or ghes > 3.6 or ghae-issue-7456 %} Zuplo | Llave de la API de Consumidor de Zuplo | zuplo_consumer_api_key{% endif %} diff --git a/translations/es-ES/data/reusables/webhooks/pull_request_review_thread_short_desc.md b/translations/es-ES/data/reusables/webhooks/pull_request_review_thread_short_desc.md index d0496c2448..09e843def9 100644 --- a/translations/es-ES/data/reusables/webhooks/pull_request_review_thread_short_desc.md +++ b/translations/es-ES/data/reusables/webhooks/pull_request_review_thread_short_desc.md @@ -1 +1 @@ -Activity related to a comment thread on a pull request being marked as resolved or unresolved. {% data reusables.webhooks.action_type_desc %} +Actividad relacionada con un hilo de comentarios en una solicitud de cambios que se marcó como resuelta o no resuelta. {% data reusables.webhooks.action_type_desc %} diff --git a/translations/es-ES/data/reusables/webhooks/pull_request_thread_properties.md b/translations/es-ES/data/reusables/webhooks/pull_request_thread_properties.md index c851f14289..f4acfb40fe 100644 --- a/translations/es-ES/data/reusables/webhooks/pull_request_thread_properties.md +++ b/translations/es-ES/data/reusables/webhooks/pull_request_thread_properties.md @@ -1,5 +1,5 @@ | Clave | Tipo | Descripción | | ---------------------- | ----------- | ----------------------------------------------------------------------------------- | -| `Acción` | `secuencia` | La acción que se realizó. Puede ser una de las siguientes:
    • `resolved` - A comment thread on a pull request was marked as resolved.
    • `unresolved` - A previously resolved comment thread on a pull request was marked as unresolved.
    | -| `solicitud_extracción` | `objeto` | The [pull request](/rest/reference/pulls) the thread pertains to. | -| `hilo` | `objeto` | The thread that was affected. | +| `Acción` | `secuencia` | La acción que se realizó. Puede ser una de las siguientes:
    • `resolved` - Un hilo de comentarios en una solicitud de cambios se marcó como resuelto.
    • `unresolved` - Un hilo de comentarios previamente resueltos en una solicitud de cambios se marcó como no resuelta.
    | +| `solicitud_extracción` | `objeto` | La [solicitud de cmabios](/rest/reference/pulls) a la cual pertenece el hilo. | +| `hilo` | `objeto` | El hilo que se afectó. | diff --git a/translations/es-ES/data/ui.yml b/translations/es-ES/data/ui.yml index 357e367935..72c865ca9c 100644 --- a/translations/es-ES/data/ui.yml +++ b/translations/es-ES/data/ui.yml @@ -32,9 +32,9 @@ search: search_error: Ocurrió un error al intentar realizar la búsqueda. description: Ingrese un término de búsqueda para encontrarlo en la Documentación de GitHub. label: Buscar en los GitHub Docs - results_found: Found {n} results in {s}ms - results_page: This is page {page} of {pages}. - nothing_found: Nothing found 😿 + results_found: Se encontrar on {n} resultados en {s}ms + results_page: Esta es la página {page} de {pages}. + nothing_found: Sin resultados 😿 homepage: explore_by_product: Explorar por producto version_picker: Versión diff --git a/translations/es-ES/data/variables/product.yml b/translations/es-ES/data/variables/product.yml index 7b77bbbe9d..d248c92e5f 100644 --- a/translations/es-ES/data/variables/product.yml +++ b/translations/es-ES/data/variables/product.yml @@ -112,6 +112,10 @@ prodname_registry: 'Registro del paquete de GitHub' prodname_container_registry: 'Registro de contenedores' prodname_docker_registry_namespace: '{% ifversion fpt or ghec %}`docker.pkg.github.com`{% elsif ghes or ghae %}docker.HOSTNAME{% endif %}' prodname_container_registry_namespace: '{% ifversion fpt or ghec %}`ghcr.io`{% elsif ghes or ghae %}containers.HOSTNAME{% endif %}' +prodname_npm_registry: 'Registro de npm' +prodname_ghcr_and_npm_registry: '{% data variables.product.prodname_container_registry %}{% ifversion packages-npm-v2 %} and {% data variables.product.prodname_npm_registry %}{% endif %}' +prodname_ghcr_or_npm_registry: '{% data variables.product.prodname_container_registry %}{% ifversion packages-npm-v2 %} or {% data variables.product.prodname_npm_registry %}{% endif %}' +prodname_ghcr_and_npm_registry_full: '{% data variables.product.prodname_container_registry %} (`ghcr.io`){% ifversion packages-npm-v2 %} and {% data variables.product.prodname_npm_registry %} (`npm.pkg.github.com`){% endif %}' #GitHub Insights prodname_insights: 'GitHub Insights' #GitHub Sponsors diff --git a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md index 5a437e284b..0be564ecf1 100644 --- a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md +++ b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md @@ -1,6 +1,6 @@ --- title: Setting up and managing your personal account on GitHub -intro: 'You can manage settings for your personal account on {% data variables.product.prodname_dotcom %}, including email preferences, collaborator access for personal repositories, and organization memberships.' +intro: 'You can manage settings for your personal account on {% ifversion fpt or ghec or ghes %}{% data variables.product.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %}, including email preferences, access to personal repositories, and organization memberships. You can also manage the account itself.' shortTitle: Personal accounts redirect_from: - /categories/setting-up-and-managing-your-github-user-account @@ -15,6 +15,7 @@ topics: - Accounts children: - /managing-personal-account-settings + - /managing-your-personal-account - /managing-email-preferences - /managing-access-to-your-personal-repositories - /managing-your-membership-in-organizations diff --git a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md index a2d3ec2c4e..c38de04124 100644 --- a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md +++ b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md @@ -1,6 +1,6 @@ --- title: ユーザ アカウント設定の管理 -intro: ユーザ名を変更する、アカウントを削除するなど、個人アカウントの設定を変更できます。 +intro: 'You can manage settings for your personal account, including your theme, username, default branch, accessibility, and security settings.' redirect_from: - /categories/29/articles - /categories/user-accounts @@ -19,9 +19,6 @@ children: - /managing-your-theme-settings - /managing-your-tab-size-rendering-preference - /changing-your-github-username - - /merging-multiple-personal-accounts - - /converting-a-user-into-an-organization - - /deleting-your-personal-account - /permission-levels-for-a-personal-account-repository - /permission-levels-for-a-project-board-owned-by-a-personal-account - /managing-accessibility-settings @@ -29,7 +26,6 @@ children: - /managing-security-and-analysis-settings-for-your-personal-account - /managing-access-to-your-personal-accounts-project-boards - /integrating-jira-with-your-personal-projects - - /best-practices-for-leaving-your-company - /what-does-the-available-for-hire-checkbox-do shortTitle: Personal account settings --- diff --git a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company.md b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md similarity index 95% rename from translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company.md rename to translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md index 0f84794666..155379d05f 100644 --- a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company.md +++ b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md @@ -6,6 +6,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/best-practices-for-leaving-your-company - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/best-practices-for-leaving-your-company - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/best-practices-for-leaving-your-company + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company versions: fpt: '*' ghec: '*' diff --git a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization.md b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md similarity index 95% rename from translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization.md rename to translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md index 5097e8193a..911efee527 100644 --- a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization.md +++ b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md @@ -7,6 +7,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/converting-a-user-into-an-organization - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization intro: You can convert your personal account into an organization. これにより、Organization に属するリポジトリに対して、より細かく権限を設定できます。 versions: fpt: '*' @@ -66,5 +67,5 @@ You can also convert your personal account directly into an organization. アカ ## 参考リンク - [Team の設定](/articles/setting-up-teams) -{% ifversion fpt or ghec %}-"[Organization に参加するようユーザを招待する](/articles/inviting-users-to-join-your-organization){% endif %} +{% ifversion fpt or ghec %}- 「[ユーザを Organization に招待する](/articles/inviting-users-to-join-your-organization)」{% endif %} - [Organization にアクセスする](/articles/accessing-an-organization) diff --git a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account.md b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md similarity index 59% rename from translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account.md rename to translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md index cc6d495b49..0830d12f26 100644 --- a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account.md +++ b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md @@ -1,39 +1,53 @@ --- title: Deleting your personal account -intro: 'You can delete your personal account on {% data variables.product.product_name %} at any time.' +intro: 'You can delete your personal account on {% data variables.product.product_location %} at any time.' redirect_from: - /articles/deleting-a-user-account - /articles/deleting-your-user-account - /github/setting-up-and-managing-your-github-user-account/deleting-your-user-account - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account versions: fpt: '*' ghes: '*' ghec: '*' topics: - Accounts -shortTitle: Delete your personal account +shortTitle: Delete your account --- -Deleting your personal account removes all repositories, forks of private repositories, wikis, issues, pull requests, and pages owned by your account. {% ifversion fpt or ghec %} 他のユーザが所有するリポジトリでこれまで作成した Issue とプルリクエスト、また行ったコメントが削除されることはなく、代わりに [ゴーストユーザ](https://github.com/ghost)に関連付けられます。{% else %}他のユーザが所有するリポジトリでこれまで作成した Issue とプルリクエスト、また行ったコメントが削除されることはありません。{% endif %} +## About deletion of your personal account -{% ifversion fpt or ghec %} When you delete your account we stop billing you. The email address associated with the account becomes available for use with a different account on {% data variables.product.product_location %}. After 90 days, the account name also becomes available to anyone else to use on a new account. {% endif %} +Deleting your personal account removes all repositories, forks of private repositories, wikis, issues, pull requests, and pages owned by your account. {% ifversion fpt or ghec %}Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted. Your resources and comments will become associated with the [ghost user](https://github.com/ghost).{% else %}Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted.{% endif %} -If you’re the only owner of an organization, you must transfer ownership to another person or delete the organization before you can delete your personal account. If there are other owners in the organization, you must remove yourself from the organization before you can delete your personal account. +{% ifversion ghec %} + +{% note %} + +**Note**: If your enterprise manages your account and you sign into {% data variables.product.product_location %} through your company's identity provider (IdP), you cannot delete your account. 詳しい情報については「[{% data variables.product.prodname_emus %}について](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)」を参照してください。 + +{% endnote %} + +{% endif %} + +{% ifversion fpt or ghec %}When you delete your account we stop billing you. The email address associated with the account becomes available for use with a different account on {% data variables.product.product_location %}. After 90 days, the account name also becomes available to anyone else to use on a new account. {% endif %} + +If you're the only owner of an organization, you must transfer ownership to another person or delete the organization before you can delete your personal account. If there are other owners in the organization, you must remove yourself from the organization before you can delete your personal account. + +詳しい情報については、次の記事を参照してください。 -詳しい情報については、以下を参照してください。 - "[Organization の所有権の移譲](/articles/transferring-organization-ownership)" - "[Organization アカウントの削除](/articles/deleting-an-organization-account)" - "[Organization から自分を削除する](/articles/removing-yourself-from-an-organization/)" ## アカウントデータのバックアップ -Before you delete your personal account, make a copy of all repositories, private forks, wikis, issues, and pull requests owned by your account. +Before you delete your personal account, make a copy of all repositories, private forks, wikis, issues, and pull requests owned by your account. For more information, see "[Backing up a repository](/repositories/archiving-a-github-repository/backing-up-a-repository)." {% warning %} -**Warning:** Once your personal account has been deleted, GitHub cannot restore your content. +**Warning:** Once your personal account has been deleted, {% ifversion fpt or ghec %}{% data variables.product.company_short %}{% elsif ghes or ghae %}an enterprise owner{% endif %} cannot restore your content. {% endwarning %} diff --git a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md new file mode 100644 index 0000000000..ab1c7a9394 --- /dev/null +++ b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md @@ -0,0 +1,19 @@ +--- +title: Managing your personal account +intro: 'You can manage your personal account on {% ifversion fpt or ghec or ghes %}{% data variables.product.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %}. For example, you can {% ifversion fpt or ghec %}manage multiple accounts, {% endif %}convert an account to an organization{% ifversion fpt or ghec or ghes %}, or delete an account{% endif %}.' +shortTitle: Manage personal account +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - Accounts +children: + - /managing-multiple-accounts + - /merging-multiple-personal-accounts + - /converting-a-user-into-an-organization + - /best-practices-for-leaving-your-company + - /deleting-your-personal-account +--- + diff --git a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md new file mode 100644 index 0000000000..d8af914a05 --- /dev/null +++ b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md @@ -0,0 +1,105 @@ +--- +title: Managing multiple accounts +intro: 'If you use one workstation to contribute to projects for more than one account on {% data variables.product.product_location %}, you can modify your Git configuration to simplify the contribution process.' +versions: + feature: multiple-accounts-one-workstation +topics: + - Accounts + - Git + - GitHub +shortTitle: Manage multiple accounts +--- + +## About management of multiple accounts + +In some cases, you may need to use multiple accounts on {% data variables.product.product_location %}. For example, you may have a personal account for open source contributions, and your employer may also create and manage a user account for you within an enterprise. + +You cannot use your {% data variables.product.prodname_managed_user %} to contribute to public projects on {% data variables.product.product_location %}, so you must contribute to those resources using your personal account. For more information, see "[About {% data variables.product.prodname_emus %}]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#abilities-and-restrictions-of-managed-user-accounts){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% elsif ghec %}."{% endif %} + +If you want to use one workstation to contribute from both accounts, you can simplify contribution with Git by using a mixture of protocols to access repository data, or by using credentials on a per-repository basis. + +{% warning %} + +**Warning**: Be mindful when you use one workstation to contribute to two separate accounts. Management of two or more accounts can increase the chance of mistakenly leaking internal code to the public. + +{% endwarning %} + +If you aren't required to use a {% data variables.product.prodname_managed_user %}, {% data variables.product.company_short %} recommends that you use one personal account for all your work on {% data variables.product.product_location %}. With a single personal account, you can contribute to a combination of personal, open source, or professional projects using one identity. Other people can invite the account to contribute to both individual repositories and repositories owned by an organization, and the account can be a member of multiple organizations or enterprises. + +## Contributing to two accounts using HTTPS and SSH + +If you contribute with two accounts from one workstation, you can access repositories by using a different protocol and credentials for each account. + +Git can use either the HTTPS or SSH protocol to access and update data in repositories on {% data variables.product.product_location %}. The protocol you use to clone a repository determines which credentials your workstation will use to authenticate when you access the repository. With this approach to account management, you store the credentials for one account to use for HTTPS connections and upload an SSH key to the other account to use for SSH connections. + +You can find both the HTTPS or an SSH URLs for cloning a repository on {% data variables.product.product_name %}. 詳しい情報については[リポジトリのクローン](/repositories/creating-and-managing-repositories/cloning-a-repository)を参照してください。 + +For more information about the use of SSH to access repositories on {% data variables.product.product_name %}, see "[Connecting to {% data variables.product.prodname_dotcom %} with SSH](/authentication/connecting-to-github-with-ssh)." + +## Contributing to multiple accounts using HTTPS and PATs + +Alternatively, if you want to use the HTTPS protocol for both accounts, you can use different personal access tokens (PAT) for each account by configuring Git to store different credentials for each repository. + +{% mac %} + +{% data reusables.git.open-terminal %} +{% data reusables.git.confirm-credential-manager %} +{% data reusables.git.clear-the-stored-credentials %} + {% data reusables.git.no-credential-manager %} + - If the output is `osxkeychain`, you're using the macOS keychain. To clear the credentials, enter the following command. + + ```shell{:copy} + git credential-osxkeychain erase https://github.com + ``` + {% data reusables.git.clear-stored-gcm-credentials %} +{% data reusables.git.cache-on-repository-path %} +{% data reusables.accounts.create-personal-access-tokens %} +{% data reusables.git.provide-credentials %} + +{% endmac %} + +{% windows %} + +1. Git Bash を開きます。 +{% data reusables.git.confirm-credential-manager %} +{% data reusables.git.clear-the-stored-credentials %} + {% data reusables.git.no-credential-manager %} + {% data reusables.git.clear-stored-gcm-credentials %} + - If the output is `wincred`, you're using the Windows Credential Manager. To clear the credentials, enter the following command. + + ```shell{:copy} + cmdkey /delete:LegacyGeneric:target=git:https://github.com + ``` +{% data reusables.git.cache-on-repository-path %} +{% data reusables.accounts.create-personal-access-tokens %} +{% data reusables.git.provide-credentials %} + +{% endwindows %} + +{% linux %} + +{% data reusables.git.open-terminal %} +{% data reusables.git.confirm-credential-manager %} +{% data reusables.git.clear-the-stored-credentials %} + {% data reusables.git.no-credential-manager %} + {% data reusables.git.clear-stored-gcm-credentials %} +{% data reusables.git.cache-on-repository-path %} +{% data reusables.accounts.create-personal-access-tokens %} +{% data reusables.git.provide-credentials %} + +{% endlinux %} + +## Contributing to multiple accounts using SSH and `GIT_SSH_COMMAND` + +If you want to use the SSH protocol for both accounts, you can use different SSH keys for each account. For more information about using SSH, see "[Connecting to {% data variables.product.prodname_dotcom %} with SSH](/authentication/connecting-to-github-with-ssh)." + +To use a different SSH key for different repositories that you clone to your workstation, you must write a shell wrapper function for Git operations. The function should perform the following steps. +1. Determine the repository's full name with owner, using a command such as `git config --get remote.origin.url`. +2. Choose the correct SSH key for authentication. +3. Modify `GIT_SSH_COMMAND` accordingly. For more information about `GIT_SSH_COMMAND`, see [Environment Variables](https://git-scm.com/docs/git#Documentation/git.txt-codeGITSSHCOMMANDcode) in the Git documentation. + +For example, the following command sets the `GIT_SSH_COMMAND` environment variable to specify an SSH command that uses the private key file at **_PATH/TO/KEY/FILE_** for authentication to clone the repository named **_OWNER_**/**_REPOSITORY_** on {% data variables.product.product_location %}. + +
    +GIT_SSH_COMMAND='ssh -i PATH/TO/KEY/FILE -o IdentitiesOnly=yes' git clone git@github.com:OWNER/REPOSITORY
+
    diff --git a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts.md b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md similarity index 94% rename from translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts.md rename to translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md index 2a406483de..e77a634540 100644 --- a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts.md +++ b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md @@ -8,12 +8,13 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/merging-multiple-user-accounts - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts versions: fpt: '*' ghec: '*' topics: - Accounts -shortTitle: Merge multiple personal accounts +shortTitle: Merge multiple accounts --- {% tip %} diff --git a/translations/ja-JP/content/actions/creating-actions/metadata-syntax-for-github-actions.md b/translations/ja-JP/content/actions/creating-actions/metadata-syntax-for-github-actions.md index e29c1020bb..f08f5c057d 100644 --- a/translations/ja-JP/content/actions/creating-actions/metadata-syntax-for-github-actions.md +++ b/translations/ja-JP/content/actions/creating-actions/metadata-syntax-for-github-actions.md @@ -354,7 +354,7 @@ runs: #### `runs.steps[*].with` -**Optional** A `map` of the input parameters defined by the action. 各入力パラメータはキー/値ペアです。 入力パラメータは環境変数として設定されます。 The variable is prefixed with INPUT_ and converted to upper case. +**Optional** A `map` of the input parameters defined by the action. 各入力パラメータはキー/値ペアです。 For more information, see [Example: Specifying inputs](#example-specifying-inputs). ```yaml runs: diff --git a/translations/ja-JP/content/actions/creating-actions/publishing-actions-in-github-marketplace.md b/translations/ja-JP/content/actions/creating-actions/publishing-actions-in-github-marketplace.md index e264f2a72e..66ee2080e3 100644 --- a/translations/ja-JP/content/actions/creating-actions/publishing-actions-in-github-marketplace.md +++ b/translations/ja-JP/content/actions/creating-actions/publishing-actions-in-github-marketplace.md @@ -38,9 +38,10 @@ You can add the action you've created to {% data variables.product.prodname_mark To draft a new release and publish the action to {% data variables.product.prodname_marketplace %}, follow these instructions: {% data reusables.repositories.navigate-to-repo %} -1. When a repository contains an action metadata file (`action.yml` or `action.yaml`), you'll see a banner to publish the action to {% data variables.product.prodname_marketplace %}. Click **Draft a release**. -![Publish this action to markeplace button](/assets/images/help/repository/publish-github-action-to-markeplace-button.png) -1. Select **Publish this action to the {% data variables.product.prodname_marketplace %}**. If you can't select the **Publish this action to the {% data variables.product.prodname_marketplace %}** checkbox, you'll need to read and accept the {% data variables.product.prodname_marketplace %} agreement first. +1. Navigate to the action metadata file in your repository (`action.yml` or `action.yaml`), and you'll see a banner to publish the action to {% data variables.product.prodname_marketplace %}. Click **Draft a release**. + + ![Publish this action to marketplace button](/assets/images/help/repository/publish-github-action-to-marketplace-button.png) +1. Under "Release Action", select the checkbox to publish the action to the {% data variables.product.prodname_marketplace %}. If you can't select the checkbox, you must first click the link to read and accept the {% data variables.product.prodname_marketplace %} Developer Agreement. ![Select publish to Marketplace](/assets/images/help/repository/marketplace_actions_publish.png) 1. If the labels in your metadata file contain any problems, you will see an error message. ![See notification](/assets/images/help/repository/marketplace_actions_fixerrors.png) diff --git a/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md b/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md index 7e41005e42..965e09780e 100644 --- a/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md +++ b/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md @@ -73,6 +73,7 @@ The following example OIDC token uses a subject (`sub`) that references a job en "repository": "octo-org/octo-repo", "repository_owner": "octo-org", "actor_id": "12", + "repo_visibility": private, "repository_id": "74", "repository_owner_id": "65", "run_id": "example-run-id", @@ -130,6 +131,7 @@ The token also includes custom claims provided by {% data variables.product.prod | `job_workflow_ref` | This is the ref path to the reusable workflow used by this job. For more information, see "["Using OpenID Connect with reusable workflows"](/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows)." | | `ref` | _(Reference)_ The git ref that triggered the workflow run. | | `ref_type` | The type of `ref`, for example: "branch". | +| `repo_visibility` | The visibility of the repository where the workflow is running. Accepts the following values: `internal`, `private`, or `public`. | | `リポジトリ` | The repository from where the workflow is running. | | `repository_id` | The ID of the repository from where the workflow is running. | | `repository_owner` | The name of the organization in which the `repository` is stored. | @@ -145,11 +147,11 @@ With OIDC, a {% data variables.product.prodname_actions %} workflow requires a t Audience and Subject claims are typically used in combination while setting conditions on the cloud role/resources to scope its access to the GitHub workflows. - **Audience**: By default, this value uses the URL of the organization or repository owner. This can be used to set a condition that only the workflows in the specific organization can access the cloud role. -- **Subject**: Has a predefined format and is a concatenation of some of the key metadata about the workflow, such as the {% data variables.product.prodname_dotcom %} organization, repository, branch, or associated [`job`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idenvironment) environment. See "[Example subject claims](#example-subject-claims)" to see how the subject claim is assembled from concatenated metadata. +- **Subject**: By default, has a predefined format and is a concatenation of some of the key metadata about the workflow, such as the {% data variables.product.prodname_dotcom %} organization, repository, branch, or associated [`job`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idenvironment) environment. See "[Example subject claims](#example-subject-claims)" to see how the subject claim is assembled from concatenated metadata. -There are also many additional claims supported in the OIDC token that can also be used for setting these conditions. +If you need more granular trust conditions, you can customize the issuer (`iss`) and subject (`sub`) claims that are included with the JWT. For more information, see "[Customizing the token claims](#customizing-the-token-claims)". -In addition, your cloud provider could allow you to assign a role to the access tokens, letting you specify even more granular permissions. +There are also many additional claims supported in the OIDC token that can be used for setting these conditions. In addition, your cloud provider could allow you to assign a role to the access tokens, letting you specify even more granular permissions. {% note %} @@ -240,6 +242,197 @@ curl -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" "$ACTIONS_ID_TOK {% data reusables.actions.oidc-permissions-token %} +{% ifversion actions-oidc-hardening-config %} +## Customizing the token claims + +You can security harden your OIDC configuration by customizing the claims that are included with the JWT. These customisations allow you to define more granular trust conditions on your cloud roles when allowing your workflows to access resources hosted in the cloud: + +{% ifversion ghec %} - For an additional layer of security, you can append the `issuer` url with your enterprise slug. This lets you set conditions on the issuer (`iss`) claim, configuring it to only accept JWT tokens from a unique `issuer` URL that must include your enterprise slug.{% endif %} +- You can standardize your OIDC configuration by setting conditions on the subject (`sub`) claim that require JWT tokens to originate from a specific repository, reusable workflow, or other source. +- You can define granular OIDC policies by using additional OIDC token claims, such as `repository_id` and `repo_visibility`. For more information, see "[Understanding the OIDC token](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#understanding-the-oidc-token)". + +To customize these claim formats, organization and repository admins can use the REST API endpoints described in the following sections. + +{% ifversion ghec %} + +### Switching to a unique token URL + +By default, the JWT is issued by {% data variables.product.prodname_dotcom %}'s OIDC provider at `https://token.actions.githubusercontent.com`. This path is presented to your cloud provider using the `iss` value in the JWT. + +Enterprise admins can security harden their OIDC configuration by configuring their enterprise to receive tokens from a unique URL at `https://api.github.com/enterprises//actions/oidc/customization/issuer`. Replace `` with the slug value of your enterprise. + +This configuration means that your enterprise will receive the OIDC token from a unique URL, and you can then configure your cloud provider to only accept tokens from that URL. This helps ensure that only the enterprise's repositories can access your cloud resources using OIDC. + +To activate this setting for your enterprise, an enterprise admin must use the `/enterprises/{enterprise}/actions/oidc/customization/issuer` endpoint and specify `"include_enterprise_slug": true` in the request body. For more information, see "[Set the {% data variables.product.prodname_actions %} OIDC custom issuer policy for an enterprise](/rest/actions/oidc#set-the-github-actions-oidc-custom-issuer-policy-for-an-enterprise)." + +After this setting is applied, the JWT will contain the updated `iss` value. In the following example, the `iss` key uses `octocat-inc` as its `enterpriseSlug` value: + +```json +{ + "jti": "6f4762ed-0758-4ccb-808d-ee3af5d723a8" + "sub": "repo:octocat-inc/private-server:ref:refs/heads/main" + "aud": "http://octocat-inc.example/octocat-inc" + "enterprise": "octocat-inc" + "iss": "https://api.github.com/enterprises/octocat-inc/actions/oidc/customization/issuer", + "bf": 1755350653, + "exp": 1755351553, + "iat": 1755351253 +} +``` + +{% endif %} + +### Customizing the subject claims for an organization + +To configure organization-wide security, compliance, and standardization, you can customize the standard claims to suit your required access conditions. If your cloud provider supports conditions on subject claims, you can create a condition that checks whether the `sub` value matches the path of the reusable workflow, such as `"job_workflow_ref: "octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main""`. The exact format will vary depending on your cloud provider's OIDC configuration. To configure the matching condition on {% data variables.product.prodname_dotcom %}, you can can use the REST API to require that the `sub` claim must always include a specific custom claim, such as `job_workflow_ref`. For more information, see "[Set the customization template for an OIDC subject claim for an organization](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization)." + +Customizing the claims results in a new format for the entire `sub` claim, which replaces the default predefined `sub` format in the token described in "[Example subject claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims)." + +The following example templates demonstrate various ways to customize the subject claim. To configure these settings on {% data variables.product.prodname_dotcom %}, organization admins use the REST API to specify a list of claims that must be included in the subject (`sub`) claim. {% data reusables.actions.use-request-body-api %} + +To customize your subject claims, you should first create a matching condition in your cloud provider's OIDC configuration, before customizing the configuration using the REST API. Once the configuration is completed, each time a new job runs, the OIDC token generated during that job will follow the new customization template. If the matching condition doesn't exist in the cloud provider's OIDC configuration before the job runs, the generated token might not be accepted by the cloud provider, since the cloud conditions may not be synchronized. + +{% note %} + +**Note**: When the organization template is applied, it will not affect any existing repositories that already use OIDC. For existing repositories, as well as any new repositories that are created after the template has been applied, the repository owner will need to opt-in to receive this configuration. For more information, see "[Set the opt-in flag of an OIDC subject claim customization for a repository](/rest/actions/oidc#set-the-opt-in-flag-of-an-oidc-subject-claim-customization-for-a-repository)." + +{% endnote %} + +#### Example: Allowing repository based on visibility and owner + +This example template allows the `sub` claim to have a new format, using `repository_owner` and `repository_visibility`: + +```json +{ + "include_claim_keys": [ + "repository_owner", + "repository_visibility" + ] +} +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repository_owner` and `repository_visibility`. For example: `"repository_owner: "monalisa":repository_visibility:private"`. The approach lets you restrict cloud role access to only private repositories within an organization or enterprise. + +#### Example: Allowing access to all repositories with a specific owner + +This example template enables the `sub` claim to have a new format with only the value of `repository_owner`. {% data reusables.actions.use-request-body-api %} + +```json +{ + "include_claim_keys": [ + "repository_owner" + ] +} + +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include a specific value for `repository_owner`. For example: `"repository_owner: "monalisa""` + +#### Example: Requiring a reusable workflow + +This example template allows the `sub` claim to have a new format that contains the value of the `job_workflow_ref` claim. This enables an enterprise to use [reusable workflows](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims) to enforce consistent deployments across its organizations and repositories. + +{% data reusables.actions.use-request-body-api %} + +```json + { + "include_claim_keys": [ + "job_workflow_ref" + ] + } +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include a specific value for `job_workflow_ref`. For example: `"job_workflow_ref: "octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main""`. + +#### Example: Requiring a reusable workflow and other claims + +The following example template combines the requirement of a specific reusable workflow with additional claims. {% data reusables.actions.use-request-body-api %} + +This example also demonstrates how to use `"context"` to define your conditions. This is the part that follows the repository in the [default `sub` format](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims). For example, when the job references an environment, the context contains: `environment:`. + +```json +{ + "include_claim_keys": [ + "repo", + "context", + "job_workflow_ref" + ] +} +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repo`, `context`, and `job_workflow_ref`. + +This customization template requires that the `sub` uses the following format: `repo::environment::job_workflow_ref:`. For example: `"sub": "repo:octo-org/octo-repo:environment:prod:job_workflow_ref:octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main"` + +#### Example: Granting access to a specific repository + +This example template lets you grant cloud access to all the workflows in a specific repository, across all branches/tags and environments. To help improve security, combine this template with the custom issuer URL described in "[Customizing the token URL for an enterprise](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-url-for-an-enterprise)." + +{% data reusables.actions.use-request-body-api %} + +```json +{ + "include_claim_keys": [ + "repo" + ] +} +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require a `repo` claim that matches the required value. + +#### Example: Using system-generated GUIDs + +This example template enables predictable OIDC claims with system-generated GUIDs that do not change between renames of entities (such as renaming a repository). {% data reusables.actions.use-request-body-api %} + +```json + { + "include_claim_keys": [ + "repository_id" + ] + } +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require a `repository_id` claim that matches the required value. + +oR: + +```json +{ + "include_claim_keys": [ + "repository_owner_id" + ] +} +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require a `repository_owner_id` claim that matches the required value. + +#### Resetting your customizations + +This example template resets the subject claims to the default format. {% data reusables.actions.use-request-body-api %} This template effectively opts out of any organization-level customization policy. + +```json +{ + "include_claim_keys": [ + "repo", + "context" + ] +} +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repo` and `context`. + +#### Using the default subject claims + +For repositories that can receive a subject claim policy from their organization, the repository owner can later choose to opt-out and instead use the default `sub` claim format. To configure this, the repository admin must use the REST API endpoint at "[Set the opt-out flag of an OIDC subject claim customization for a repository](/rest/actions/oidc#set-the-opt-out-flag-of-an-oidc-subject-claim-customization-for-a-repository)" with the following request body: + +```json +{ + "use_default": true +} +``` + +{% endif %} + ## Updating your workflows for OIDC You can now update your YAML workflows to use OIDC access tokens instead of secrets. Popular cloud providers have published their official login actions that make it easy for you to get started with OIDC. For more information about updating your workflows, see the cloud-specific guides listed below in "[Enabling OpenID Connect for your cloud provider](#enabling-openid-connect-for-your-cloud-provider)." diff --git a/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md b/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md index 0aa06921aa..f8fd239334 100644 --- a/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md +++ b/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md @@ -32,10 +32,52 @@ This guide gives an overview of how to configure HashiCorp Vault to trust {% dat To use OIDC with HashiCorp Vault, you will need to add a trust configuration for the {% data variables.product.prodname_dotcom %} OIDC provider. For more information, see the HashiCorp Vault [documentation](https://www.vaultproject.io/docs/auth/jwt). -Configure the vault to accept JSON Web Tokens (JWT) for authentication: -- For the `oidc_discovery_url`, use {% ifversion ghes %}`https://HOSTNAME/_services/token`{% else %}`https://token.actions.githubusercontent.com`{% endif %} -- For `bound_issuer`, use {% ifversion ghes %}`https://HOSTNAME/_services/token`{% else %}`https://token.actions.githubusercontent.com`{% endif %} -- Ensure that `bound_subject` is correctly defined for your security requirements. For more information, see ["Configuring the OIDC trust with the cloud"](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#configuring-the-oidc-trust-with-the-cloud) and [`hashicorp/vault-action`](https://github.com/hashicorp/vault-action). +To configure your Vault server to accept JSON Web Tokens (JWT) for authentication: + +1. Enable the JWT `auth` method, and use `write` to apply the configuration to your Vault. For `oidc_discovery_url` and `bound_issuer` parameters, use {% ifversion ghes %}`https://HOSTNAME/_services/token`{% else %}`https://token.actions.githubusercontent.com`{% endif %}. These parameters allow the Vault server to verify the received JSON Web Tokens (JWT) during the authentication process. + + ```sh{:copy} + vault auth enable jwt + ``` + + ```sh{:copy} + vault write auth/jwt/config \ + bound_issuer="{% ifversion ghes %}https://HOSTNAME/_services/token{% else %}https://token.actions.githubusercontent.com{% endif %}" \ + oidc_discovery_url="{% ifversion ghes %}https://HOSTNAME/_services/token{% else %}https://token.actions.githubusercontent.com{% endif %}" + ``` +2. Configure a policy that only grants access to the specific paths your workflows will use to retrieve secrets. For more advanced policies, see the HashiCorp Vault [Policies documentation](https://www.vaultproject.io/docs/concepts/policies). + + ```sh{:copy} + vault policy write myproject-production - <`: Replace this with the URL of your HashiCorp Vault. +- ``: Replace this with the Namespace you've set in HashiCorp Vault. For example: `admin`. - ``: Replace this with the role you've set in the HashiCorp Vault trust relationship. -- ``: Replace this with the audience you've defined in the HashiCorp Vault trust relationship. -- ``: Replace this with the path to the secret you're retrieving from HashiCorp Vault. For example: `secret/data/ci npmToken`. +- ``: Replace this with the path to the secret you're retrieving from HashiCorp Vault. For example: `secret/data/production/ci npmToken`. ```yaml{:copy} jobs: - retrieve-secret: - steps: - - name: Retrieve secret from Vault - uses: hashicorp/vault-action@v2.4.0 - with: - url: - role: - method: jwt - jwtGithubAudience: - secrets: + retrieve-secret: + runs-on: ubuntu-latest + permissions: + id-token: write + contents: read + steps: + - name: Retrieve secret from Vault + uses: hashicorp/vault-action@v2.4.0 + with: + method: jwt + url: + namespace: + role: + secrets: - - name: Use secret from Vault - run: | - # This step has access to the secret retrieved above; see hashicorp/vault-action for more details. + - name: Use secret from Vault + run: | + # This step has access to the secret retrieved above; see hashicorp/vault-action for more details. +``` + +{% note %} + +**ノート**: + +- If your Vault server is not accessible from the public network, consider using a self-hosted runner with other available Vault [auth methods](https://www.vaultproject.io/docs/auth). 詳しい情報については「[セルフホストランナーについて](/actions/hosting-your-own-runners/about-self-hosted-runners)」を参照してください。 +- `` must be set for a Vault Enterprise (including HCP Vault) deployment. For more information, see [Vault namespace](https://www.vaultproject.io/docs/enterprise/namespaces). + +{% endnote %} + +### Revoking the access token + +By default, the Vault server will automatically revoke access tokens when their TTL is expired, so you don't have to manually revoke the access tokens. However, if you do want to revoke access tokens immediately after your job has completed or failed, you can manually revoke the issued token using the [Vault API](https://www.vaultproject.io/api/auth/token#revoke-a-token-self). + +1. Set the `exportToken` option to `true` (default: `false`). This exports the issued Vault access token as an environment variable: `VAULT_TOKEN`. +2. Add a step to call the [Revoke a Token (Self)](https://www.vaultproject.io/api/auth/token#revoke-a-token-self) Vault API to revoke the access token. + +```yaml{:copy} +jobs: + retrieve-secret: + runs-on: ubuntu-latest + permissions: + id-token: write + contents: read + steps: + - name: Retrieve secret from Vault + uses: hashicorp/vault-action@v2.4.0 + with: + exportToken: true + method: jwt + url: + role: + secrets: + + - name: Use secret from Vault + run: | + # This step has access to the secret retrieved above; see hashicorp/vault-action for more details. + + - name: Revoke token + # This step always runs at the end regardless of the previous steps result + if: always() + run: | + curl -X POST -sv -H "X-Vault-Token: {% raw %}${{ env.VAULT_TOKEN }}{% endraw %}" \ + /v1/auth/token/revoke-self ``` diff --git a/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md b/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md index b481d6a0a5..e783735846 100644 --- a/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md +++ b/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md @@ -23,11 +23,18 @@ topics: Rather than copying and pasting deployment jobs from one workflow to another, you can create a reusable workflow that performs the deployment steps. A reusable workflow can be used by another workflow if it meets one of the access requirements described in "[Reusing workflows](/actions/learn-github-actions/reusing-workflows#access-to-reusable-workflows)." -When combined with OpenID Connect (OIDC), reusable workflows let you enforce consistent deployments across your repository, organization, or enterprise. You can do this by defining trust conditions on cloud roles based on reusable workflows. +You should be familiar with the concepts described in "\[Reusing workflows\](/actions/learn-github-actions/reusing-workflows" and "[About security hardening with OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)." -In order to create trust conditions based on reusable workflows, your cloud provider must support custom claims for `job_workflow_ref`. This allows your cloud provider to identify which repository the job originally came from. If your cloud provider only supports the standard claims (_audience_ and _subject_), it will not be able to determine that the job originated from the reusable workflow repository. Cloud providers that support `job_workflow_ref` include Google Cloud Platform and HashiCorp Vault. +## Defining the trust conditions -Before proceeding, you should be familiar with the concepts of [reusable workflows](/actions/learn-github-actions/reusing-workflows) and [OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect). +When combined with OpenID Connect (OIDC), reusable workflows let you enforce consistent deployments across your repository, organization, or enterprise. You can do this by defining trust conditions on cloud roles based on reusable workflows. The available options will vary depending on your cloud provider: + +- **Using `job_workflow_ref`**: + - To create trust conditions based on reusable workflows, your cloud provider must support custom claims for `job_workflow_ref`. This allows your cloud provider to identify which repository the job originally came from. + - For clouds that only support the standard claims (audience (`aud`) and subject (`sub`)), you can use the API to customize the `sub` claim to include `job_workflow_ref`. For more information, see "[Customizing the token claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". Support for custom claims is currently available for Google Cloud Platform and HashiCorp Vault. + +- **Customizing the token claims**: + - You can configure more granular trust conditions by customizing the issuer (`iss`) and subject (`sub`) claims included with the JWT. For more information, see "[Customizing the token claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". ## How the token works with reusable workflows diff --git a/translations/ja-JP/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md b/translations/ja-JP/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md index 2a31a921b5..d3cdb214af 100644 --- a/translations/ja-JP/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md +++ b/translations/ja-JP/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md @@ -18,15 +18,23 @@ shortTitle: Run runner app on startup {% capture service_first_step %}1. セルフホストランナー アプリケーションが現在実行中の場合は、そのアプリケーションを停止します。{% endcapture %} {% capture service_non_windows_intro_shell %}ランナー マシンで、セルフホストランナー アプリケーションをインストールしたディレクトリでシェルを開きます。 以下のコマンドを使って、セルフホストランナーサービスをインストール及び管理します。{% endcapture %} -{% capture service_nonwindows_intro %}セルフホストランナーアプリケーションをサービスとして設定する前に、ランナーを{% data variables.product.product_name %}に追加しなければなりません。 詳しい情報については「[セルフホストランナーの追加](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)」を参照してください。{% endcapture %} -{% capture service_win_name %}actions.runner.*{% endcapture %} +{% capture service_nonwindows_intro %} + +{% note %} + +**Note:** You must add a runner to {% data variables.product.product_name %} before you can configure the self-hosted runner application as a service. 詳しい情報については「[セルフホストランナーの追加](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)」を参照してください。 + +{% endnote %} +{% endcapture %} + +{% capture service_win_name %}actions.runner.*{% endcapture %} {% linux %} {{ service_nonwindows_intro }} -`systemd`を利用するLinuxのシステムでは、セルフホストランナーアプリケーションと共に配布されている`svc.sh`スクリプトを使い、セルフホストランナーアプリケーションをサービスとしてインストール及び管理できます。 +For Linux systems that use `systemd`, you can use the `svc.sh` script that is created after successfully adding the runner to install and manage using the application as a service. {{ service_non_windows_intro_shell }} diff --git a/translations/ja-JP/content/actions/learn-github-actions/contexts.md b/translations/ja-JP/content/actions/learn-github-actions/contexts.md index cf85def425..a2f95f52c6 100644 --- a/translations/ja-JP/content/actions/learn-github-actions/contexts.md +++ b/translations/ja-JP/content/actions/learn-github-actions/contexts.md @@ -33,17 +33,13 @@ You can access contexts using the expression syntax. For more information, see " {% data reusables.actions.context-injection-warning %} -| コンテキスト名 | 種類 | 説明 | -| ---------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `github` | `オブジェクト` | ワークフロー実行に関する情報。 詳しい情報については、「[`github` コンテキスト](#github-context)」を参照してください。 | -| `env` | `オブジェクト` | ワークフロー、ジョブ、ステップで設定された環境変数が含まれます。 詳しい情報については、[`env` コンテキスト](#env-context)を参照してください。 | -| `ジョブ` | `オブジェクト` | Information about the currently running job. 詳しい情報については、「[`job` コンテキスト](#job-context)」を参照してください。 | -| `steps` | `オブジェクト` | Information about the steps that have been run in the current job. 詳しい情報については、「[`steps` コンテキスト](#steps-context)」を参照してください。 | -| `runner` | `オブジェクト` | 現在のジョブを実行している runner に関する情報。 詳しい情報については[`runner`コンテキスト](#runner-context)を参照してください。 | -| `secrets` | `オブジェクト` | Contains the names and values of secrets that are available to a workflow run. For more information, see [`secrets` context](#secrets-context). | -| `strategy` | `オブジェクト` | Information about the matrix execution strategy for the current job. For more information, see [`strategy` context](#strategy-context). | -| `matrix` | `オブジェクト` | Contains the matrix properties defined in the workflow that apply to the current job. For more information, see [`matrix` context](#matrix-context). | -| `needs` | `オブジェクト` | Contains the outputs of all jobs that are defined as a dependency of the current job. 詳しい情報については[`needs`コンテキスト](#needs-context)を参照してください。 | +| コンテキスト名 | 種類 | 説明 | +| -------- | -------- | ------------------------------------------------------------------------------------------------ | +| `github` | `オブジェクト` | ワークフロー実行に関する情報。 詳しい情報については、「[`github` コンテキスト](#github-context)」を参照してください。 | +| `env` | `オブジェクト` | ワークフロー、ジョブ、ステップで設定された環境変数が含まれます。 詳しい情報については、[`env` コンテキスト](#env-context)を参照してください。 | +| `ジョブ` | `オブジェクト` | Information about the currently running job. 詳しい情報については、「[`job` コンテキスト](#job-context)」を参照してください。 | +{%- ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} +| `jobs` | `object` | For reusable workflows only, contains outputs of jobs from the reusable workflow. For more information, see [`jobs` context](#jobs-context). |{% endif %} | `steps` | `object` | Information about the steps that have been run in the current job. 詳しい情報については、「[`steps` コンテキスト](#steps-context)」を参照してください。 | | `runner` | `object` | Information about the runner that is running the current job. 詳しい情報については[`runner`コンテキスト](#runner-context)を参照してください。 | | `secrets` | `object` | Contains the names and values of secrets that are available to a workflow run. For more information, see [`secrets` context](#secrets-context). | | `strategy` | `object` | Information about the matrix execution strategy for the current job. For more information, see [`strategy` context](#strategy-context). | | `matrix` | `object` | Contains the matrix properties defined in the workflow that apply to the current job. For more information, see [`matrix` context](#matrix-context). | | `needs` | `object` | Contains the outputs of all jobs that are defined as a dependency of the current job. 詳しい情報については[`needs`コンテキスト](#needs-context)を参照してください。 | {%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4757 %} | `inputs` | `object` | Contains the inputs of a reusable {% ifversion actions-unified-inputs %}or manually triggered {% endif %}workflow. For more information, see [`inputs` context](#inputs-context). |{% endif %} @@ -84,7 +80,7 @@ The following table indicates where each context and special function can be use | jobs.<job_id>.name | github, needs, strategy, matrix, inputs | | | jobs.<job_id>.outputs.<output_id> | github, needs, strategy, matrix, job, runner, env, secrets, steps, inputs | | | jobs.<job_id>.runs-on | github, needs, strategy, matrix, inputs | | -| jobs.<job_id>.secrets.<secrets_id> | github, needs, secrets{% ifversion actions-unified-inputs %}, inputs{% endif %} | | +| jobs.<job_id>.secrets.<secrets_id> | github, needs,{% ifversion actions-reusable-workflow-matrix %} strategy, matrix,{% endif %} secrets{% ifversion actions-unified-inputs %}, inputs{% endif %} | | | jobs.<job_id>.services | github, needs, strategy, matrix, inputs | | | jobs.<job_id>.services.<service_id>.credentials | github, needs, strategy, matrix, env, secrets, inputs | | | jobs.<job_id>.services.<service_id>.env.<env_id> | github, needs, strategy, matrix, job, runner, env, secrets, inputs | | @@ -98,7 +94,7 @@ The following table indicates where each context and special function can be use | jobs.<job_id>.steps.working-directory | github, needs, strategy, matrix, job, runner, env, secrets, steps, inputs | hashFiles | | jobs.<job_id>.strategy | github, needs, inputs | | | jobs.<job_id>.timeout-minutes | github, needs, strategy, matrix, inputs | | -| jobs.<job_id>.with.<with_id> | github, needs{% ifversion actions-unified-inputs %}, inputs{% endif %} | | +| jobs.<job_id>.with.<with_id> | github, needs{% ifversion actions-reusable-workflow-matrix %}, strategy, matrix{% endif %}{% ifversion actions-unified-inputs %}, inputs{% endif %} | | | on.workflow_call.inputs.<inputs_id>.default | github{% ifversion actions-unified-inputs %}, inputs{% endif %} | | | on.workflow_call.outputs.<output_id>.value | github, jobs, inputs | | {% else %} @@ -184,7 +180,7 @@ jobs: | {% ifversion actions-stable-actor-ids %}The username of the user that triggered the initial workflow run. If the workflow run is a re-run, this value may differ from `github.triggering_actor`. Any workflow re-runs will use the privileges of `github.actor`, even if the actor initiating the re-run (`github.triggering_actor`) has different privileges.{% else %}The username of the user that initiated the workflow run.{% endif %} | | | | | | | | `github.api_url` | `string` | The URL of the {% data variables.product.prodname_dotcom %} REST API. | -| `github.base_ref` | `string` | ワークフローの実行における `base_ref` またはプルリクエストのターゲットブランチ。 このプロパティは、ワークフローの実行をトリガーするイベントが `pull_request` または `pull_request_target` のいずれかである場合にのみ使用できます。 | +| `github.base_ref` | `string` | ワークフローの実行における `base_ref` またはPull Requestのターゲットブランチ。 このプロパティは、ワークフローの実行をトリガーするイベントが `pull_request` または `pull_request_target` のいずれかである場合にのみ使用できます。 | | `github.env` | `string` | Path on the runner to the file that sets environment variables from workflow commands. This file is unique to the current step and is a different file for each step in a job. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/learn-github-actions/workflow-commands-for-github-actions#setting-an-environment-variable)." | | `github.event` | `オブジェクト` | webhook ペイロードの完全なイベント。 このコンテキストを使用して、イベントの個々のプロパティにアクセスできます。 This object is identical to the webhook payload of the event that triggered the workflow run, and is different for each event. The webhooks for each {% data variables.product.prodname_actions %} event is linked in "[Events that trigger workflows](/articles/events-that-trigger-workflows/)." For example, for a workflow run triggered by the [`push` event](/actions/using-workflows/events-that-trigger-workflows#push), this object contains the contents of the [push webhook payload](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#push). | | `github.event_name` | `string` | ワークフローの実行をトリガーしたイベントの名前。 | @@ -196,11 +192,11 @@ jobs: {%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5338 %} | `github.ref_name` | `string` | {% data reusables.actions.ref_name-description %} | | `github.ref_protected` | `string` | {% data reusables.actions.ref_protected-description %} | | `github.ref_type` | `string` | {% data reusables.actions.ref_type-description %} {%- endif %} -| `github.path` | `string` | Path on the runner to the file that sets system `PATH` variables from workflow commands. This file is unique to the current step and is a different file for each step in a job. 詳しい情報については「[{% data variables.product.prodname_actions %}のワークフローコマンド](/actions/learn-github-actions/workflow-commands-for-github-actions#adding-a-system-path)」を参照してください。 | | `github.repository` | `string` | The owner and repository name. `Codertocat/Hello-World`などです。 | | `github.repository_owner` | `string` | The repository owner's name. たとえば`Codertocat`。 | | `github.repositoryUrl` | `string` | The Git URL to the repository. For example, `git://github.com/codertocat/hello-world.git`. | | `github.retention_days` | `string` | The number of days that workflow run logs and artifacts are kept. | | `github.run_id` | `string` | {% data reusables.actions.run_id_description %} | | `github.run_number` | `string` | {% data reusables.actions.run_number_description %} +| `github.path` | `string` | Path on the runner to the file that sets system `PATH` variables from workflow commands. This file is unique to the current step and is a different file for each step in a job. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/learn-github-actions/workflow-commands-for-github-actions#adding-a-system-path)." | | `github.repository` | `string` | The owner and repository name. `Codertocat/Hello-World`などです。 | | `github.repository_owner` | `string` | The repository owner's name. たとえば`Codertocat`。 | | `github.repositoryUrl` | `string` | The Git URL to the repository. For example, `git://github.com/codertocat/hello-world.git`. | | `github.retention_days` | `string` | The number of days that workflow run logs and artifacts are kept. | | `github.run_id` | `string` | {% data reusables.actions.run_id_description %} | | `github.run_number` | `string` | {% data reusables.actions.run_number_description %} {%- ifversion fpt or ghec or ghes > 3.5 or ghae-issue-4722 %} | `github.run_attempt` | `string` | A unique number for each attempt of a particular workflow run in a repository. This number begins at 1 for the workflow run's first attempt, and increments with each re-run. | {%- endif %} -| `github.server_url` | `string` | The URL of the GitHub server. たとえば、`https://github.com` などです。 | | `github.sha` | `string` | The commit SHA that triggered the workflow run. | | `github.token` | `string` | A token to authenticate on behalf of the GitHub App installed on your repository. これは機能的に`GITHUB_TOKEN`シークレットに等価です。 詳しい情報については「[自動トークン認証](/actions/security-guides/automatic-token-authentication)」を参照してください。
    Note: This context property is set by the Actions runner, and is only available within the execution `steps` of a job. Otherwise, the value of this property will be `null`. |{% ifversion actions-stable-actor-ids %} | `github.triggering_actor` | `string` | The username of the user that initiated the workflow run. If the workflow run is a re-run, this value may differ from `github.actor`. Any workflow re-runs will use the privileges of `github.actor`, even if the actor initiating the re-run (`github.triggering_actor`) has different privileges. |{% endif %} | `github.workflow` | `string` | The name of the workflow. ワークフローファイルで `name` を指定していない場合、このプロパティの値は、リポジトリ内にあるワークフローファイルのフルパスになります。 | | `github.workspace` | `string` | The default working directory on the runner for steps, and the default location of your repository when using the [`checkout`](https://github.com/actions/checkout) action. | +| `github.server_url` | `string` | The URL of the GitHub server. たとえば、`https://github.com` などです。 | | `github.sha` | `string` | {% data reusables.actions.github_sha_description %} | | `github.token` | `string` | A token to authenticate on behalf of the GitHub App installed on your repository. これは機能的に`GITHUB_TOKEN`シークレットに等価です。 詳しい情報については「[自動トークン認証](/actions/security-guides/automatic-token-authentication)」を参照してください。
    Note: This context property is set by the Actions runner, and is only available within the execution `steps` of a job. Otherwise, the value of this property will be `null`. |{% ifversion actions-stable-actor-ids %} | `github.triggering_actor` | `string` | The username of the user that initiated the workflow run. If the workflow run is a re-run, this value may differ from `github.actor`. Any workflow re-runs will use the privileges of `github.actor`, even if the actor initiating the re-run (`github.triggering_actor`) has different privileges. |{% endif %} | `github.workflow` | `string` | The name of the workflow. ワークフローファイルで `name` を指定していない場合、このプロパティの値は、リポジトリ内にあるワークフローファイルのフルパスになります。 | | `github.workspace` | `string` | The default working directory on the runner for steps, and the default location of your repository when using the [`checkout`](https://github.com/actions/checkout) action. | ### Example contents of the `github` context @@ -390,6 +386,72 @@ jobs: - run: ./run-tests ``` +{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} + +## `jobs` context + +The `jobs` context is only available in reusable workflows, and can only be used to set outputs for a reusable workflow. 詳しい情報については「[ワークフローの再利用](/actions/using-workflows/reusing-workflows#using-outputs-from-a-reusable-workflow)」を参照してください。 + +| プロパティ名 | 種類 | 説明 | +| ------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `jobs` | `オブジェクト` | This is only available in reusable workflows, and can only be used to set outputs for a reusable workflow. This object contains all the properties listed below. | +| `jobs..result` | `string` | The result of a job in the reusable workflow. `success`、`failure`、`cancelled`、`skipped`のいずれかの値をとります。 | +| `jobs..outputs` | `オブジェクト` | The set of outputs of a job in a reusable workflow. | +| `jobs..outputs.` | `string` | The value of a specific output for a job in a reusable workflow. | + +### Example contents of the `jobs` context + +This example `jobs` context contains the result and outputs of a job from a reusable workflow run. + +```json +{ + example_job: { + result: success, + outputs: { + output1: hello, + output2: world + } + } +} +``` + +### Example usage of the `jobs` context + +This example reusable workflow uses the `jobs` context to set outputs for the reusable workflow. Note how the outputs flow up from the steps, to the job, then to the `workflow_call` trigger. 詳しい情報については「[ワークフローの再利用](/actions/using-workflows/reusing-workflows#using-outputs-from-a-reusable-workflow)」を参照してください。 + +{% raw %} +```yaml{:copy} +name: Reusable workflow + +on: + workflow_call: + # Map the workflow outputs to job outputs + outputs: + firstword: + description: "The first output string" + value: ${{ jobs.example_job.outputs.output1 }} + secondword: + description: "The second output string" + value: ${{ jobs.example_job.outputs.output2 }} + +jobs: + example_job: + name: Generate output + runs-on: ubuntu-latest + # Map the job outputs to step outputs + outputs: + output1: ${{ steps.step1.outputs.firstword }} + output2: ${{ steps.step2.outputs.secondword }} + steps: + - id: step1 + run: echo "::set-output name=firstword::hello" + - id: step2 + run: echo "::set-output name=secondword::world" +``` +{% endraw %} + +{% endif %} + ## `steps` コンテキスト The `steps` context contains information about the steps in the current job that have an [`id`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsid) specified and have already run. @@ -508,7 +570,7 @@ jobs: ## `secrets` context -The `secrets` context contains the names and values of secrets that are available to a workflow run. The `secrets` context is not available for composite actions. For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." +The `secrets` context contains the names and values of secrets that are available to a workflow run. The `secrets` context is not available for composite actions. シークレットに関する詳しい情報については「[暗号化されたシークレット](/actions/security-guides/encrypted-secrets)」を参照してください。 `GITHUB_TOKEN` is a secret that is automatically created for every workflow run, and is always included in the `secrets` context. 詳しい情報については「[自動トークン認証](/actions/security-guides/automatic-token-authentication)」を参照してください。 diff --git a/translations/ja-JP/content/actions/learn-github-actions/environment-variables.md b/translations/ja-JP/content/actions/learn-github-actions/environment-variables.md index 2d34b53a4f..cc5b5115ae 100644 --- a/translations/ja-JP/content/actions/learn-github-actions/environment-variables.md +++ b/translations/ja-JP/content/actions/learn-github-actions/environment-variables.md @@ -147,7 +147,7 @@ The default environment variables that {% data variables.product.prodname_dotcom {%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5338 %} | `GITHUB_REF_NAME` | {% data reusables.actions.ref_name-description %} For example, `feature-branch-1`.| | `GITHUB_REF_PROTECTED` | {% data reusables.actions.ref_protected-description %} | | `GITHUB_REF_TYPE` | {% data reusables.actions.ref_type-description %} {%- endif %} -| `GITHUB_REPOSITORY` | The owner and repository name. `octocat/Hello-World`などです。 | | `GITHUB_REPOSITORY_OWNER` | The repository owner's name. `octocat`などです。 | | `GITHUB_RETENTION_DAYS` | The number of days that workflow run logs and artifacts are kept. For example, `90`. | | `GITHUB_RUN_ATTEMPT` | A unique number for each attempt of a particular workflow run in a repository. This number begins at 1 for the workflow run's first attempt, and increments with each re-run. For example, `3`. | | `GITHUB_RUN_ID` | {% data reusables.actions.run_id_description %} For example, `1658821493`. | | `GITHUB_RUN_NUMBER` | {% data reusables.actions.run_number_description %} For example, `3`. | | `GITHUB_SERVER_URL`| The URL of the {% data variables.product.product_name %} server. For example: `https://{% data variables.product.product_url %}`. | `GITHUB_SHA` | The commit SHA that triggered the workflow. The value of this commit SHA depends on the event that triggered the workflow. For more information, see [Events that trigger workflows](/actions/using-workflows/events-that-trigger-workflows). たとえば、`ffac537e6cbbf934b08745a378932722df287a53`です。 | +| `GITHUB_REPOSITORY` | The owner and repository name. `octocat/Hello-World`などです。 | | `GITHUB_REPOSITORY_OWNER` | The repository owner's name. `octocat`などです。 | | `GITHUB_RETENTION_DAYS` | The number of days that workflow run logs and artifacts are kept. For example, `90`. | | `GITHUB_RUN_ATTEMPT` | A unique number for each attempt of a particular workflow run in a repository. This number begins at 1 for the workflow run's first attempt, and increments with each re-run. For example, `3`. | | `GITHUB_RUN_ID` | {% data reusables.actions.run_id_description %} For example, `1658821493`. | | `GITHUB_RUN_NUMBER` | {% data reusables.actions.run_number_description %} For example, `3`. | | `GITHUB_SERVER_URL`| The URL of the {% data variables.product.product_name %} server. For example: `https://{% data variables.product.product_url %}`. | `GITHUB_SHA` | {% data reusables.actions.github_sha_description %} {%- ifversion actions-job-summaries %} | `GITHUB_STEP_SUMMARY` | The path on the runner to the file that contains job summaries from workflow commands. This file is unique to the current step and changes for each step in a job. For example, `/home/rob/runner/_layout/_work/_temp/_runner_file_commands/step_summary_1cb22d7f-5663-41a8-9ffc-13472605c76c`. 詳しい情報については「[{% data variables.product.prodname_actions %}のワークフローコマンド](/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary)」を参照してください。 | {%- endif %} diff --git a/translations/ja-JP/content/actions/learn-github-actions/understanding-github-actions.md b/translations/ja-JP/content/actions/learn-github-actions/understanding-github-actions.md index 9d55eacd5e..151fdbe6cc 100644 --- a/translations/ja-JP/content/actions/learn-github-actions/understanding-github-actions.md +++ b/translations/ja-JP/content/actions/learn-github-actions/understanding-github-actions.md @@ -93,7 +93,7 @@ You can write your own actions, or you can find actions to use in your workflows - {% data variables.product.prodname_actions %} について詳しくは、「[アクションの検索とカスタマイズ](/actions/learn-github-actions/finding-and-customizing-actions)」を参照してください。 {% ifversion fpt or ghec or ghes %} -- To understand how billing works for {% data variables.product.prodname_actions %}, see "[About billing for {% data variables.product.prodname_actions %}](/actions/reference/usage-limits-billing-and-administration#about-billing-for-github-actions)". +- To understand how billing works for {% data variables.product.prodname_actions %}, see "[About billing for {% data variables.product.prodname_actions %}](/actions/reference/usage-limits-billing-and-administration#about-billing-for-github-actions)." {% endif %} ## サポートへの連絡 diff --git a/translations/ja-JP/content/actions/publishing-packages/publishing-nodejs-packages.md b/translations/ja-JP/content/actions/publishing-packages/publishing-nodejs-packages.md index 57bb6f28eb..5a26f04f43 100644 --- a/translations/ja-JP/content/actions/publishing-packages/publishing-nodejs-packages.md +++ b/translations/ja-JP/content/actions/publishing-packages/publishing-nodejs-packages.md @@ -98,9 +98,9 @@ Please note that you need to set the `registry-url` to `https://registry.npmjs.o ### 宛先リポジトリの設定 -*package.json* ファイルで `repository` キーを指定しない場合、{% data variables.product.prodname_registry %} は *package.json* ファイルの `name` フィールドで指定した {% data variables.product.prodname_dotcom %} リポジトリにパッケージを公開します。 たとえば、`@my-org/test` という名前のパッケージは、`my-org/test` {% data variables.product.prodname_dotcom %} というリポジトリに公開されます。 +Linking your package to {% data variables.product.prodname_registry %} using the `repository` key is optional. If you choose not to provide the `repository` key in your *package.json* file, then {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the `name` field of the *package.json* file. たとえば、`@my-org/test` という名前のパッケージは、`my-org/test` {% data variables.product.prodname_dotcom %} というリポジトリに公開されます。 If the `url` specified in the `repository` key is invalid, your package may still be published however it won't be linked to the repository source as intended. -ただし、`repository` キーを指定すると、そのキーのリポジトリが {% data variables.product.prodname_registry %} の宛先 npm レジストリとして使用されます。 たとえば、以下の *package.json* を公開すると、`my-amazing-package` という名前のパッケージが `octocat/my-other-repo` {% data variables.product.prodname_dotcom %} リポジトリに公開されます。 +If you do provide the `repository` key in your *package.json* file, then the repository in that key is used as the destination npm registry for {% data variables.product.prodname_registry %}. たとえば、以下の *package.json* を公開すると、`my-amazing-package` という名前のパッケージが `octocat/my-other-repo` {% data variables.product.prodname_dotcom %} リポジトリに公開されます。 Once published, only the repository source is updated, and the package doesn't inherit any permissions from the destination repository. ```json { diff --git a/translations/ja-JP/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md b/translations/ja-JP/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md index a4078416ff..bb214de90b 100644 --- a/translations/ja-JP/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md +++ b/translations/ja-JP/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md @@ -51,7 +51,7 @@ For more information on workflow run artifacts, see "[Persisting workflow data u ワークフローは、現在のブランチ、ベースブランチ（フォークされたリポジトリのベースブランチを含む）、またはデフォルトブランチ（通常は `main`）で作成されたキャッシュにアクセスして復元できます。 たとえば、デフォルトブランチで作成されたキャッシュは、どのPull Requestからもアクセスできます。 また、`feature-b` ブランチに `feature-a` ベースブランチがある場合、`feature-b` でトリガーされたワークフローは、デフォルトのブランチ（`main`）、`feature-a`、および `feature-b` で作成されたキャッシュにアクセスできます。 -Access restrictions provide cache isolation and security by creating a logical boundary between different branches. For example, a cache created for the branch `feature-a` (with the base `main`) would not be accessible to a pull request for the branch `feature-c` (with the base `main`). +Access restrictions provide cache isolation and security by creating a logical boundary between different branches or tags. For example, a cache created for the branch `feature-a` (with the base `main`) would not be accessible to a pull request for the branch `feature-c` (with the base `main`). On similar lines, a cache created for the tag `release-a` (from the base `main`) would not be accessible to a workflow triggered for the tag `release-b` (with the base `main`). Multiple workflows within a repository share cache entries. A cache created for a branch within a workflow can be accessed and restored from another workflow for the same repository and branch. diff --git a/translations/ja-JP/content/actions/using-workflows/events-that-trigger-workflows.md b/translations/ja-JP/content/actions/using-workflows/events-that-trigger-workflows.md index 1a2fbb5f41..46f479dde5 100644 --- a/translations/ja-JP/content/actions/using-workflows/events-that-trigger-workflows.md +++ b/translations/ja-JP/content/actions/using-workflows/events-that-trigger-workflows.md @@ -812,6 +812,8 @@ Runs your workflow when activity on a pull request in the workflow's repository This event runs in the context of the base of the pull request, rather than in the context of the merge commit, as the `pull_request` event does. This prevents execution of unsafe code from the head of the pull request that could alter your repository or steal any secrets you use in your workflow. This event allows your workflow to do things like label or comment on pull requests from forks. Avoid using this event if you need to build or run code from the pull request. +To ensure repository security, branches with names that match certain patterns (such as those which look similar to SHAs) may not trigger workflows with the `pull_request_target` event. + {% warning %} **Warning:** For workflows that are triggered by the `pull_request_target` event, the `GITHUB_TOKEN` is granted read/write repository permission unless the `permissions` key is specified and the workflow can access secrets, even when it is triggered from a fork. ワークフローはPull Requestのベースのコンテキストで実行されますが、このイベントでPull Requestから信頼できないコードをチェックアウトしたり、ビルドしたり、実行したりしないようにしなければなりません。 Additionally, any caches share the same scope as the base branch. To help prevent cache poisoning, you should not save the cache if there is a possibility that the cache contents were altered. 詳細については、GitHub Security Lab Web サイトの「[GitHub Actions とワークフローを安全に保つ: pwn リクエストの防止](https://securitylab.github.com/research/github-actions-preventing-pwn-requests)」を参照してください。 @@ -957,7 +959,7 @@ on: #### Running your workflow only when a push to specific branches occurs -You can use the `branches` or `branches-ignore` filter to configure your workflow to only run when specific branches are pushed. 詳しい情報については「[GitHub Actionsのワークフロー構文](/actions/learn-github-actions/workflow-syntax-for-github-actions#onpushbranchestagsbranches-ignoretags-ignore)」を参照してください。 +You can use the `branches` or `branches-ignore` filter to configure your workflow to only run when specific branches are pushed. For more information, see "[Workflow syntax for GitHub Actions](/actions/learn-github-actions/workflow-syntax-for-github-actions#onpushbranchestagsbranches-ignoretags-ignore)." For example, this workflow will run when someone pushes to `main` or to a branch that starts with `releases/`. @@ -986,7 +988,7 @@ on: #### Running your workflow only when a push of specific tags occurs -You can use the `tags` or `tags-ignore` filter to configure your workflow to only run when specific tags are pushed. 詳しい情報については「[GitHub Actionsのワークフロー構文](/actions/learn-github-actions/workflow-syntax-for-github-actions#onpushbranchestagsbranches-ignoretags-ignore)」を参照してください。 +You can use the `tags` or `tags-ignore` filter to configure your workflow to only run when specific tags are pushed. For more information, see "[Workflow syntax for GitHub Actions](/actions/learn-github-actions/workflow-syntax-for-github-actions#onpushbranchestagsbranches-ignoretags-ignore)." For example, this workflow will run when someone pushes a tag that starts with `v1.`. @@ -1039,7 +1041,7 @@ on: {% data reusables.actions.branch-requirement %} -Runs your workflow when activity related to {% data variables.product.prodname_registry %} occurs in your repository. 詳しい情報については、「[{% data variables.product.prodname_registry %} のドキュメント](/packages)」を参照してください。 +Runs your workflow when activity related to {% data variables.product.prodname_registry %} occurs in your repository. For more information, see "[{% data variables.product.prodname_registry %} Documentation](/packages)." For example, you can run a workflow when a new package version has been `published`. @@ -1091,7 +1093,7 @@ on: {% data reusables.actions.branch-requirement %} -{% data variables.product.product_name %} の外部で生じるアクティビティのためにワークフローをトリガーしたい場合、{% data variables.product.product_name %} API を使って、[`repository_dispatch`](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads/#repository_dispatch) と呼ばれる webhook イベントをトリガーできます。 詳細については、「[リポジトリディスパッチ イベントの作成](/rest/reference/repos#create-a-repository-dispatch-event)」を参照してください。 +You can use the {% data variables.product.product_name %} API to trigger a webhook event called [`repository_dispatch`](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads/#repository_dispatch) when you want to trigger a workflow for activity that happens outside of {% data variables.product.product_name %}. 詳細については、「[リポジトリディスパッチ イベントの作成](/rest/reference/repos#create-a-repository-dispatch-event)」を参照してください。 When you make a request to create a `repository_dispatch` event, you must specify an `event_type` to describe the activity type. By default, all `repository_dispatch` activity types trigger a workflow to run. You can use the `types` keyword to limit your workflow to run when a specific `event_type` value is sent in the `repository_dispatch` webhook payload. diff --git a/translations/ja-JP/content/actions/using-workflows/reusing-workflows.md b/translations/ja-JP/content/actions/using-workflows/reusing-workflows.md index e66d63eb07..a26e315cd3 100644 --- a/translations/ja-JP/content/actions/using-workflows/reusing-workflows.md +++ b/translations/ja-JP/content/actions/using-workflows/reusing-workflows.md @@ -39,7 +39,7 @@ You can view the reused workflows referenced in your {% data variables.product.p ### Reusable workflows and starter workflows -スターターワークフローを使うと、Organizationでワークフローの作成権限を持つ人は誰でも、ワークフローを素早く容易に作成できます。 When people create a new workflow, they can choose a starter workflow and some or all of the work of writing the workflow will be done for them. Within a starter workflow, you can also reference reusable workflows to make it easy for people to benefit from reusing centrally managed workflow code. If you use a tag or branch name when referencing the reusable workflow, you can ensure that everyone who reuses that workflow will always be using the same YAML code. However, if you reference a reusable workflow by a tag or branch, be sure that you can trust that version of the workflow. For more information, see "[Security hardening for {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions#reusing-third-party-workflows)." +スターターワークフローを使うと、Organizationでワークフローの作成権限を持つ人は誰でも、ワークフローを素早く容易に作成できます。 When people create a new workflow, they can choose a starter workflow and some or all of the work of writing the workflow will be done for them. Within a starter workflow, you can also reference reusable workflows to make it easy for people to benefit from reusing centrally managed workflow code. If you use a commit SHA when referencing the reusable workflow, you can ensure that everyone who reuses that workflow will always be using the same YAML code. However, if you reference a reusable workflow by a tag or branch, be sure that you can trust that version of the workflow. For more information, see "[Security hardening for {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions#reusing-third-party-workflows)." For more information, see "[Creating starter workflows for your organization](/actions/learn-github-actions/creating-starter-workflows-for-your-organization)." @@ -69,10 +69,14 @@ Called workflows that are owned by the same user or organization{% ifversion ghe ## 制限事項 +{% ifversion nested-reusable-workflow %} +* You can connect up to four levels of workflows. For more information, see "[Calling a nested reusable workflow](#calling-a-nested-reusable-workflow)." +{% else %} * Reusable workflows can't call other reusable workflows. +{% endif %} * Reusable workflows stored within a private repository can only be used by workflows within the same repository. -* Any environment variables set in an `env` context defined at the workflow level in the caller workflow are not propagated to the called workflow. For more information about the `env` context, see "[Context and expression syntax for GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions#env-context)." -* The `strategy` property is not supported in any job that calls a reusable workflow. +* Any environment variables set in an `env` context defined at the workflow level in the caller workflow are not propagated to the called workflow. For more information about the `env` context, see "[Context and expression syntax for GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions#env-context)."{% ifversion actions-reusable-workflow-matrix %}{% else %} +* The `strategy` property is not supported in any job that calls a reusable workflow.{% endif %} ## Creating a reusable workflow @@ -105,7 +109,13 @@ You can define inputs and secrets, which can be passed from the caller workflow {% endraw %} For details of the syntax for defining inputs and secrets, see [`on.workflow_call.inputs`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callinputs) and [`on.workflow_call.secrets`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callsecrets). {% ifversion actions-inherit-secrets-reusable-workflows %} -1. In the reusable workflow, reference the input or secret that you defined in the `on` key in the previous step. If the secrets are inherited using `secrets: inherit`, you can reference them even if they are not defined in the `on` key. +1. In the reusable workflow, reference the input or secret that you defined in the `on` key in the previous step. + + {% note %} + + **Note**: If the secrets are inherited by using `secrets: inherit` in the calling workflow, you can reference them even if they are not explicitly defined in the `on` key. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit)." + + {% endnote %} {%- else %} 1. In the reusable workflow, reference the input or secret that you defined in the `on` key in the previous step. {%- endif %} @@ -127,7 +137,7 @@ You can define inputs and secrets, which can be passed from the caller workflow {% note %} - **Note**: Environment secrets are encrypted strings that are stored in an environment that you've defined for a repository. Environment secrets are only available to workflow jobs that reference the appropriate environment. For more information, see "[Using environments for deployment](/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets)." + **Note**: Environment secrets are encrypted strings that are stored in an environment that you've defined for a repository. Environment secrets are only available to workflow jobs that reference the appropriate environment. 詳しい情報については「[デプロイメントへの環境の利用](/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets)」を参照してください。 {% endnote %} @@ -164,7 +174,36 @@ jobs: token: ${{ secrets.token }} ``` {% endraw %} +{% ifversion actions-reusable-workflow-matrix %} +## Using a matrix strategy with a reusable workflow +Jobs using the matrix strategy can call a reusable workflow. + +マトリックス戦略を使うと、単一のジョブ定義中で変数を使って、変数の組み合わせに基づく複数のジョブの実行を自動的に生成できます。 For example, you can use a matrix strategy to pass different inputs to a reusable workflow. マトリクスに関する詳しい情報については「[ジョブでのマトリクスの利用](/actions/using-jobs/using-a-matrix-for-your-jobs)」を参照してください。 + +### Example matrix strategy with a reusable workflow + +This workflow file references the matrix context by defining the variable `target` with the values `[dev, stage, prod]`. このワークフローは、変数中のそれぞれの値に対して1つずつ、3つのジョブを実行します。 The workflow file also calls a reusable workflow by using the `uses` keyword. + +{% raw %} +```yaml{:copy} +name: Reusable workflow with matrix strategy + +on: + push: + +jobs: + ReuseableMatrixJobForDeployment: + strategy: + matrix: + target: [dev, stage, prod] + uses: octocat/octo-repo/.github/workflows/deployment.yml@main + with: + target: ${{ matrix.target }} +``` +{% endraw %} + +{% endif %} ## Calling a reusable workflow You call a reusable workflow by using the `uses` keyword. Unlike when you are using actions within a workflow, you call reusable workflows directly within a job, and not from within job steps. @@ -234,9 +273,61 @@ jobs: ``` {% endraw %} +{% ifversion nested-reusable-workflow %} +## Nesting reusable workflows + +You can connect a maximum of four levels of workflows - that is, the top-level caller workflow and up to three levels of reusable workflows. For example: _caller-workflow.yml_ → _called-workflow-1.yml_ → _called-workflow-2.yml_ → _called-workflow-3.yml_. Loops in the workflow tree are not permitted. + +From within a reusable workflow you can call another reusable workflow. + +{% raw %} +```yaml{:copy} +name: Reusable workflow + +on: + workflow_call: + +jobs: + call-another-reusable: + uses: octo-org/example-repo/.github/workflows/another-reusable.yml@v1 +``` +{% endraw %} + +### Passing secrets to nested workflows + +You can use `jobs..secrets` in a calling workflow to pass named secrets to a directly called workflow. Alternatively, you can use `jobs..secrets.inherit` to pass all of the calling workflow's secrets to a directly called workflow. For more information, see the section "[Passing inputs and secrets to a reusable workflow](/actions/using-workflows/reusing-workflows#passing-inputs-and-secrets-to-a-reusable-workflow)" above, and the reference article "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit)." Secrets are only passed to directly called workflow, so in the workflow chain A > B > C, workflow C will only receive secrets from A if they have been passed from A to B, and then from B to C. + +In the following example, workflow A passes all of its secrets to workflow B, by using the `inherit` keyword, but workflow B only passes one secret to workflow C. Any of the other secrets passed to workflow B are not available to workflow C. + +{% raw %} +```yaml +jobs: + workflowA-calls-workflowB: + uses: octo-org/example-repo/.github/workflows/B.yml@main + secrets: inherit # pass all secrets +``` + +```yaml +jobs: + workflowB-calls-workflowC: + uses: different-org/example-repo/.github/workflows/C.yml@main + secrets: + envPAT: ${{ secrets.envPAT }} # pass just this secret +``` +{% endraw %} + +### Access and permissions + +A workflow that contains nested reusable workflows will fail if any of the nested workflows is inaccessible to the initial caller workflow. For more information, see "[Access to reusable workflows](/actions/using-workflows/reusing-workflows#access-to-reusable-workflows)." + +`GITHUB_TOKEN` permissions can only be the same or more restrictive in nested workflows. For example, in the workflow chain A > B > C, if workflow A has `package: read` token permission, then B and C cannot have `package: write` permission. 詳しい情報については「[自動トークン認証](/actions/security-guides/automatic-token-authentication)」を参照してください。 +{% endif %} + ## Using outputs from a reusable workflow -A reusable workflow may generate data that you want to use in the caller workflow. To use these outputs, you must specify them as the outputs of the reusable workflow. +A reusable workflow may generate data that you want to use in the caller workflow. To use these outputs, you must specify them as the outputs of the reusable workflow.{% ifversion actions-reusable-workflow-matrix %} + +If a reusable workflow that sets an output is executed with a matrix strategy, the output will be the output set by the last successful completing reusable workflow of the matrix which actually sets a value. That means if the last successful completing reusable workflow sets an empty string for its output, and the second last successful completing reusable workflow sets an actual value for its output, the output will contain the value of the second last completing reusable workflow.{% endif %} The following reusable workflow has a single job containing two steps. In each of these steps we set a single word as the output: "hello" and "world." In the `outputs` section of the job, we map these step outputs to job outputs called: `output1` and `output2`. In the `on.workflow_call.outputs` section we then define two outputs for the workflow itself, one called `firstword` which we map to `output1`, and one called `secondword` which we map to `output2`. diff --git a/translations/ja-JP/content/actions/using-workflows/workflow-syntax-for-github-actions.md b/translations/ja-JP/content/actions/using-workflows/workflow-syntax-for-github-actions.md index 49968b343a..93cef6d72c 100644 --- a/translations/ja-JP/content/actions/using-workflows/workflow-syntax-for-github-actions.md +++ b/translations/ja-JP/content/actions/using-workflows/workflow-syntax-for-github-actions.md @@ -365,9 +365,9 @@ For more information, see "[Context availability](/actions/learn-github-actions/ ジョブでステップの一部として実行されるアクションを選択します。 アクションとは、再利用可能なコードの単位です。 ワークフロー、パブリックリポジトリ、または[公開されているDockerコンテナイメージ](https://hub.docker.com/)と同じリポジトリで定義されているアクションを使用できます。 -Git ref、SHA、またはDockerタグ番号を指定して、使用しているアクションのバージョンを含めることを強く推奨します。 バージョンを指定しないと、アクションのオーナーがアップデートを公開したときに、ワークフローが中断したり、予期せぬ動作をしたりすることがあります。 +We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag. バージョンを指定しないと、アクションのオーナーがアップデートを公開したときに、ワークフローが中断したり、予期せぬ動作をしたりすることがあります。 - リリースされたアクションバージョンのコミットSHAを使用するのが、安定性とセキュリティのうえで最も安全です。 -- 特定のメジャーアクションバージョンを使用すると、互換性を維持したまま重要な修正とセキュリティパッチを受け取ることができます。 ワークフローが引き続き動作することも保証できます。 +- If the action publishes major version tags, you should expect to receive critical fixes and security patches while still retaining compatibility. Note that this behavior is at the discretion of the action's author. - アクションのデフォルトブランチを使用すると便利なこともありますが、別のユーザが破壊的変更を加えた新しいメジャーバージョンをリリースすると、ワークフローが動作しなくなる場合があります。 入力が必要なアクションもあり、入力を[`with`](#jobsjob_idstepswith)キーワードを使って設定する必要があります。 必要な入力を判断するには、アクションのREADMEファイルをお読みください。 @@ -1037,15 +1037,23 @@ Allowed expression contexts: `github`, `needs`, and `secrets`. - `[]` 括弧内にリストされた、あるいは範囲に含まれる1つのキャラクタにマッチします。 範囲に含めることができるのは`a-z`、`A-Z`、`0-9`のみです。 たとえば、`[0-9a-z]`という範囲は任意の数字もしくは小文字にマッチします。 たとえば`[CB]at`は`Cat`あるいは`Bat`にマッチし、`[1-2]00`は`100`や`200`にマッチします。 - `!`: パターンの先頭に置くと、肯定のパターンを否定にします。 先頭のキャラクタではない場合は、特別な意味を持ちません。 -YAMLにおいては、`*`、`[`、`!`は特別なキャラクタです。 パターンを`*`、`[`、`!`で始める場合、そのパターンをクオートで囲まなければなりません。 +YAMLにおいては、`*`、`[`、`!`は特別なキャラクタです。 パターンを`*`、`[`、`!`で始める場合、そのパターンをクオートで囲まなければなりません。 Also, if you use a [flow sequence](https://yaml.org/spec/1.2.2/#flow-sequences) with a pattern containing `[` and/or `]`, the pattern must be enclosed in quotes. ```yaml -# 有効 -- '**/README.md' +# Valid +branches: + - '**/README.md' -# 無効 - ワークフローの実行を妨げる -# 解析エラーを作成する -- **/README.md +# Invalid - creates a parse error that +# prevents your workflow from running. +branches: + - **/README.md + +# Valid +branches: [ main, 'release/v[0-9].[0-9]' ] + +# Invalid - creates a parse error +branches: [ main, release/v[0-9].[0-9] ] ``` For more information about branch, tag, and path filter syntax, see "[`on..`](#onpushbranchestagsbranches-ignoretags-ignore)", "[`on..`](#onpull_requestpull_request_targetbranchesbranches-ignore)", and "[`on..paths`](#onpushpull_requestpull_request_targetpathspaths-ignore)." diff --git a/translations/ja-JP/content/admin/configuration/configuring-github-connect/about-github-connect.md b/translations/ja-JP/content/admin/configuration/configuring-github-connect/about-github-connect.md index 801d3c5066..4b900f7f44 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-github-connect/about-github-connect.md +++ b/translations/ja-JP/content/admin/configuration/configuring-github-connect/about-github-connect.md @@ -8,6 +8,7 @@ type: overview topics: - Enterprise - GitHub Connect +miniTocMaxHeadingLevel: 3 --- ## About {% data variables.product.prodname_github_connect %} @@ -37,6 +38,16 @@ Unified contributions | Allow users to include anonymized contribution counts fo ## Data transmission for {% data variables.product.prodname_github_connect %} +When {% data variables.product.prodname_github_connect %} is enabled, a record on {% data variables.product.prodname_ghe_cloud %} stores information about the connection. If you enable individual features of {% data variables.product.prodname_github_connect %}, additional data is transmitted. + +{% note %} + +**Note:** No repositories, issues, or pull requests are ever transmitted from {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} by {% data variables.product.prodname_github_connect %}. + +{% endnote %} + +### Data transmitted when {% data variables.product.prodname_github_connect %} is enabled + When you enable {% data variables.product.prodname_github_connect %} or specific {% data variables.product.prodname_github_connect %} features, a record on {% data variables.product.prodname_ghe_cloud %} stores the following information about the connection. {% ifversion ghes %} - The public key portion of your {% data variables.product.prodname_ghe_server %} license @@ -54,11 +65,7 @@ When you enable {% data variables.product.prodname_github_connect %} or specific {% data variables.product.prodname_github_connect %} syncs the above connection data between {% data variables.product.product_location %} and {% data variables.product.prodname_ghe_cloud %} weekly, from the day and approximate time that {% data variables.product.prodname_github_connect %} was enabled. -{% note %} - -**Note:** No repositories, issues, or pull requests are ever transmitted from {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} by {% data variables.product.prodname_github_connect %}. - -{% endnote %} +### Data transmitted by individual features of {% data variables.product.prodname_github_connect %} Additional data is transmitted if you enable individual features of {% data variables.product.prodname_github_connect %}. @@ -68,7 +75,7 @@ Automatic user license sync | Each {% data variables.product.product_name %} use {% data variables.product.prodname_dependabot_alerts %} | Vulnerability alerts | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %} | {% data variables.product.product_name %} |{% endif %}{% ifversion dependabot-updates-github-connect %} {% data variables.product.prodname_dependabot_updates %} | Dependencies and the metadata for each dependency's repository

    If a dependency is stored in a private repository on {% data variables.product.prodname_dotcom_the_website %}, data will only be transmitted if {% data variables.product.prodname_dependabot %} is configured and authorized to access that repository. | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %} | {% data variables.product.product_name %} {% endif %} {% data variables.product.prodname_dotcom_the_website %} actions | Name of action, action (YAML file from {% data variables.product.prodname_marketplace %}) | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %}

    From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %}{% ifversion server-statistics %} -{% data variables.product.prodname_server_statistics %} | Aggregate {% data variables.product.prodname_ghe_server %} usage metrics
    For the list of aggregate metrics collected, see "[{% data variables.product.prodname_server_statistics %} data collected](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)." | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %}{% endif %} +{% data variables.product.prodname_server_statistics %} | Aggregate metrics about your usage of {% data variables.product.prodname_ghe_server %}. For the complete list of metrics, see "[About {% data variables.product.prodname_server_statistics %}](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)." | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %}{% endif %} Unified search | Search terms, search results | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %}

    From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %} | Unified contributions | Contribution counts | From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.prodname_dotcom_the_website %} | diff --git a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md index 1a0e48a7e4..3f1e658fb4 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md +++ b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md @@ -672,7 +672,7 @@ ghe-repo ユーザ名/reponame {% warning %} -**Warning**: Before using the `--prune` argument to remove unreachable Git objects, put {% data variables.product.product_location %} into maintenance mode, or ensure the repository is offline. 詳しい情報については"[メンテナンスモードの有効化とスケジューリング](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)"を参照してください。 +**Warning**: Before using the `--prune` argument to remove unreachable Git objects, put {% data variables.product.product_location %} into maintenance mode, or ensure all repositories within the same repository network are locked. 詳しい情報については"[メンテナンスモードの有効化とスケジューリング](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)"を参照してください。 {% endwarning %} diff --git a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md index 1d70ad47bd..30b804c836 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md +++ b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md @@ -31,12 +31,15 @@ Azure NSG を使用したインスタンスレベルの制限については、E ## 許可 IP アドレスを追加する +{% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} {% data reusables.identity-and-permissions.ip-allow-lists-add-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-add-description %} {% data reusables.identity-and-permissions.ip-allow-lists-add-entry %} +{% data reusables.identity-and-permissions.check-ip-address %} ## {% data variables.product.prodname_github_apps %}によるアクセスの許可 @@ -44,6 +47,8 @@ Azure NSG を使用したインスタンスレベルの制限については、E ## 許可 IP アドレスを有効化する +{% data reusables.identity-and-permissions.about-enabling-allowed-ip-addresses %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} @@ -52,6 +57,8 @@ Azure NSG を使用したインスタンスレベルの制限については、E ## 許可 IP アドレスを編集する +{% data reusables.identity-and-permissions.about-editing-ip-allow-list-entries %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} @@ -59,6 +66,18 @@ Azure NSG を使用したインスタンスレベルの制限については、E {% data reusables.identity-and-permissions.ip-allow-lists-edit-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-description %} 8. [**Update**] をクリックします。 +{% data reusables.identity-and-permissions.check-ip-address %} + +{% ifversion ip-allow-list-address-check %} +## Checking if an IP address is permitted + +{% data reusables.identity-and-permissions.about-checking-ip-address %} + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.security-tab %} +{% data reusables.identity-and-permissions.check-ip-address-step %} +{% endif %} ## 許可 IP アドレスを削除する diff --git a/translations/ja-JP/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md b/translations/ja-JP/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md index f973191794..9466611747 100644 --- a/translations/ja-JP/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md +++ b/translations/ja-JP/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md @@ -20,7 +20,7 @@ shortTitle: Create HA replica ## High Availabilityレプリカの作成 1. 新しい {% data variables.product.prodname_ghe_server %} アプライアンスを希望するプラットフォームにセットアップします。 レプリカアプライアンスのCPU、RAM、ストレージ設定は、プライマリアプライアンスと同じにするべきです。 レプリカアプライアンスは、独立した環境にインストールすることをお勧めします。 下位層のハードウェア、ソフトウェア、ネットワークコンポーネントは、プライマリアプライアンスのそれらとは分離されているべきです。 クラウドプロバイダを利用している場合には、別個のリージョンもしくはゾーンを使ってください。 詳細は「["{% data variables.product.prodname_ghe_server %} インスタンスをセットアップする](/enterprise/admin/guides/installation/setting-up-a-github-enterprise-server-instance)」を参照してください。 -1. Ensure that both the primary appliance and the new replica appliance can communicate with each other over ports 122/TCP and 1194/UDP. 詳しい情報については"[ネットワークポート](/admin/configuration/configuring-network-settings/network-ports#administrative-ports)"を参照してください。 +1. Ensure that the new appliance can communicate with all other appliances in this high availability environment over ports 122/TCP and 1194/UDP. 詳しい情報については"[ネットワークポート](/admin/configuration/configuring-network-settings/network-ports#administrative-ports)"を参照してください。 1. ブラウザで新しいレプリカアプライアンスのIPアドレスにアクセスして、所有する{% data variables.product.prodname_enterprise %}のライセンスをアップロードしてください。 {% data reusables.enterprise_installation.replica-steps %} 1. SSHを使ってレプリカアプライアンスのIPアドレスに接続してください。 diff --git a/translations/ja-JP/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md b/translations/ja-JP/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md index 2bbd327b5a..b2a5d8490c 100644 --- a/translations/ja-JP/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md +++ b/translations/ja-JP/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md @@ -45,7 +45,7 @@ If you use a standalone organization with {% data variables.product.product_name ### Authentication with {% data variables.product.prodname_emus %} and federation -If you need more control of the accounts for your enterprise members on {% data variables.product.product_location %}, you can use {% data variables.product.prodname_emus %}. With {% data variables.product.prodname_emus %}, you provision and manage accounts for your enterprise members on {% data variables.product.product_location %} using your IdP. Each member signs into an account that you create, and your enterprise manages the account. Contributions to the rest of {% data variables.product.prodname_dotcom_the_website %} are restricted. For more information, see "[About {% data variables.product.prodname_emus %}](/admin/identity-and-access-management/using-enterprise-managed-users-and-saml-for-iam/about-enterprise-managed-users)." +If you need more control of the accounts for your enterprise members on {% data variables.product.product_location %}, you can use {% data variables.product.prodname_emus %}. With {% data variables.product.prodname_emus %}, you provision and manage accounts for your enterprise members on {% data variables.product.product_location %} using your IdP. Each member signs into an account that you create, and your enterprise manages the account. Contributions to the rest of {% data variables.product.prodname_dotcom_the_website %} are restricted. 詳しい情報については「[{% data variables.product.prodname_emus %}について](/admin/identity-and-access-management/using-enterprise-managed-users-and-saml-for-iam/about-enterprise-managed-users)」を参照してください。 ## Identifying the best authentication method for your enterprise @@ -82,7 +82,11 @@ These restrictions are unacceptable for some enterprises. To determine whether { ### Do your developers rely on collaboration outside of your enterprise? -{% data variables.product.prodname_managed_users_caps %} can only contribute to repositories within your enterprise. If your developers need to collaborate in repositories outside your enterprise, even private repositories, to complete their work, {% data variables.product.prodname_emus %} may not be right for your enterprise, and SAML SSO may be a better solution. +{% data variables.product.prodname_managed_users_caps %} can only contribute to repositories within your enterprise. If your developers must contribute to both repositories within and outside of your enterprise, including private repositories, {% data variables.product.prodname_emus %} may not be right for your enterprise. SAML SSO may be a better solution. + +Some companies maintain repositories within an existing enterprise using SAML SSO on {% data variables.product.product_location %}, and also create an {% data variables.product.prodname_emu_enterprise %}. Developers who contribute to repositories owned by both enterprises from a single workstation must switch between the accounts on {% data variables.product.product_location %} within a single browser, or use a different browser for each account. The developer may also need to customize the workstation's Git configuration to accommodate the two accounts. The complexity of this workflow can increase the risk of mistakenly leaking internal code to the public. + +If you decide to create an {% data variables.product.prodname_emu_enterprise %} but require that developers contribute to resources outside of the enterprise from a single workstation, you can provide support for switching between the accounts in a developer's local Git configuration. 詳しい情報については「[{% data variables.product.prodname_emus %}について](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#supporting-developers-with-multiple-user-accounts-on-githubcom)」を参照してください。 ### Does your enterprise rely on outside collaborators? diff --git a/translations/ja-JP/content/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/accessing-your-enterprise-account-if-your-identity-provider-is-unavailable.md b/translations/ja-JP/content/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/accessing-your-enterprise-account-if-your-identity-provider-is-unavailable.md index 9e98bc2594..53dada8349 100644 --- a/translations/ja-JP/content/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/accessing-your-enterprise-account-if-your-identity-provider-is-unavailable.md +++ b/translations/ja-JP/content/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/accessing-your-enterprise-account-if-your-identity-provider-is-unavailable.md @@ -15,7 +15,7 @@ permissions: Enterprise owners can use a recovery code to access an enterprise a You can use a recovery code to access your enterprise account when an authentication configuration error or an issue with your identity provider (IdP) prevents you from using SSO. -In order to access your enterprise account this way, you must have previously downloaded and stored the recovery codes for your enterprise. For more information, see "[Downloading your enterprise account's single sign-on recovery codes](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes)." +In order to access your enterprise account this way, you must have previously downloaded and stored the recovery codes for your enterprise. 詳しい情報については「[Enterpriseアカウントのシングルサインオンリカバリコードのダウンロード](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes)」を参照してください。 {% data reusables.saml.recovery-code-caveats %} diff --git a/translations/ja-JP/content/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes.md b/translations/ja-JP/content/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes.md index 5cfb1add8c..8d80b0b021 100644 --- a/translations/ja-JP/content/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes.md +++ b/translations/ja-JP/content/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes.md @@ -33,4 +33,4 @@ If you did not save your recovery codes when you configured SSO, you can still a {% endnote %}{% endif %} ![Screenshot of the button to test SAML configuration before enforcing](/assets/images/help/enterprises/saml-recovery-codes-link.png) -1. To save your recovery codes, click **Download**, **Print**, or **Copy**. ![Screenshot of the buttons to download, print, or copy your recovery codes](/assets/images/help/saml/saml_recovery_code_options.png) +1. To save your recovery codes, click **Download**, **Print**, or **Copy**. ![リカバリコードのダウンロード、印刷、コピーのボタンのスクリーンショット](/assets/images/help/saml/saml_recovery_code_options.png) diff --git a/translations/ja-JP/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md b/translations/ja-JP/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md index 4f6da52c8b..c39730012a 100644 --- a/translations/ja-JP/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md +++ b/translations/ja-JP/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md @@ -36,8 +36,6 @@ You can grant {% data variables.product.prodname_managed_users %} access to and The usernames of your enterprise's {% data variables.product.prodname_managed_users %} and their profile information, such as display names and email addresses, are set by through your IdP and cannot be changed by the users themselves. For more information, see "[Usernames and profile information](#usernames-and-profile-information)." -{% data reusables.enterprise-accounts.emu-forks %} - Enterprise owners can audit all of the {% data variables.product.prodname_managed_users %}' actions on {% data variables.product.prodname_dotcom %}. For more information, see "[Audit log events for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise#about-audit-log-events-for-your-enterprise)." To use {% data variables.product.prodname_emus %}, you need a separate type of enterprise account with {% data variables.product.prodname_emus %} enabled. For more information about creating this account, see "[About enterprises with managed users](#about-enterprises-with-managed-users)." @@ -75,7 +73,8 @@ To use {% data variables.product.prodname_emus %}, you need a separate type of e * {% data variables.product.prodname_managed_users_caps %} cannot create gists or comment on gists. * {% data variables.product.prodname_managed_users_caps %} cannot install {% data variables.product.prodname_github_apps %} on their user accounts. * Other {% data variables.product.prodname_dotcom %} users cannot see, mention, or invite a {% data variables.product.prodname_managed_user %} to collaborate. -* {% data variables.product.prodname_managed_users_caps %} can only own private repositories and {% data variables.product.prodname_managed_users %} can only invite other enterprise members to collaborate on their owned repositories. +* You can choose whether {% data variables.product.prodname_managed_users %} are able to create repositories owned by their user accounts. 詳しい情報については、「[Enterprise でのリポジトリ管理ポリシーを適用する](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-repository-creation)」を参照してください。 +* If you allow {% data variables.product.prodname_managed_users %} to create repositories owned by their user accounts, they can only own private repositories and can only invite other enterprise members to collaborate on their user-owned repositories. * {% data reusables.enterprise-accounts.emu-forks %} * Only private and internal repositories can be created in organizations owned by an {% data variables.product.prodname_emu_enterprise %}, depending on organization and enterprise repository visibility settings. * {% data variables.product.prodname_managed_users_caps %} are limited in their use of {% data variables.product.prodname_pages %}. 詳しい情報については、「[{% data variables.product.prodname_pages %} について](/pages/getting-started-with-github-pages/about-github-pages#limitations-for-enterprise-managed-users)」を参照してください。 @@ -113,6 +112,8 @@ Before your developers can use {% data variables.product.prodname_ghe_cloud %} w 5. Once authentication and provisioning are configured, you can start provisioning members and managing teams. For more information, see "[Managing team memberships with identity provider groups](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups)." +If members of your enterprise must use one workstation to contribute to repositories on {% data variables.product.product_location %} from both a {% data variables.product.prodname_managed_user %} and a personal account, you can provide support. For more information, see "[Supporting developers with multiple user accounts on {% data variables.product.prodname_dotcom_the_website %}](#supporting-developers-with-multiple-user-accounts-on-githubcom)." + ## {% data variables.product.prodname_managed_user %} として認証を行う {% data variables.product.prodname_managed_users_caps %} must authenticate through their identity provider. To authenticate, a {% data variables.product.prodname_managed_user %} can visit their IdP application portal or use the login page on {% data variables.product.prodname_dotcom_the_website %}. @@ -132,3 +133,9 @@ Before your developers can use {% data variables.product.prodname_ghe_cloud %} w A conflict may occur when provisioning users if the unique parts of the identifier provided by your IdP are removed during normalization. If you're unable to provision a user due to a username conflict, you should modify the username provided by your IdP. For more information, see "[Resolving username conflicts](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication#resolving-username-conflicts)." The profile name and email address of a {% data variables.product.prodname_managed_user %} is also provided by the IdP. {% data variables.product.prodname_managed_users_caps %} cannot change their profile name or email address on {% data variables.product.prodname_dotcom %}, and the IdP can only provide a single email address. + +## Supporting developers with multiple user accounts on {% data variables.product.product_location %} + +People on your team may need to contribute to resources on {% data variables.product.product_location %} that are outside of your {% data variables.product.prodname_emu_enterprise %}. For example, you may wish to maintain a separate enterprise for your company's open source projects. Because a {% data variables.product.prodname_managed_user %} cannot contribute to public resources, users will need to maintain a separate, personal account for this work. + +People who must contribute from two user accounts on {% data variables.product.product_location %} using one workstation can configure Git to simplify the process. For more information, see "[Managing multiple accounts](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts)." diff --git a/translations/ja-JP/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md b/translations/ja-JP/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md index 567cf18724..fc6e984083 100644 --- a/translations/ja-JP/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md +++ b/translations/ja-JP/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md @@ -22,9 +22,11 @@ CAP support is enabled automatically for any {% data variables.product.prodname_ For more information about using OIDC with {% data variables.product.prodname_emus %}, see "[Configuring OIDC for Enterprise Managed Users](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-oidc-for-enterprise-managed-users)" and "[Migrating from SAML to OIDC](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc)." -## About using CAP with IP allow lists +{% note %} -We recommend disabling your enterprise account's IP allow list and relying on your IdP's CAP. If you enable IP allow lists for your enterprise and also make use of your IdP's CAP, both the IP allow list and CAP will be enforced. If either restriction rejects a user's IP address, the request fails. For more information about IP allow lists, see "[Enforcing policies for security settings in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)." +**Note:** If you use Conditional Access (CA) network location policies in your Azure AD tenant, do not use the IP allow list feature on {% data variables.product.prodname_dotcom_the_website %}, with your enterprise account or with any of the organizations owned by the enterprise. Using both is unsupported and can result in the wrong policy applying. For more information about IP allow lists, see "[Enforcing security settings in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)" and "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization)." + +{% endnote %} ## Considerations for integrations and automations diff --git a/translations/ja-JP/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md b/translations/ja-JP/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md index 273f3e7263..c88833c1d5 100644 --- a/translations/ja-JP/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md +++ b/translations/ja-JP/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md @@ -26,11 +26,12 @@ If you're new to {% data variables.product.prodname_emus %} and haven't yet conf {% note %} -**Note:** To sign in as the setup user, you will need a recovery code. If you do not already have your recovery codes, you can access the codes while signed in as an enterprise owner. For more information, see "[Downloading your enterprise account's single sign-on recovery codes](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes)." +**Note:** To sign in as the setup user, you will need a recovery code. If you do not already have your recovery codes, you can access the codes while signed in as an enterprise owner. 詳しい情報については「[Enterpriseアカウントのシングルサインオンリカバリコードのダウンロード](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes)」を参照してください。 {% endnote %} 1. Before you begin the migration, sign in to Azure and disable provisioning in the existing {% data variables.product.prodname_emu_idp_application %} application. +1. If you use [Conditional Access (CA) network location policies](https://docs.microsoft.com/en-us/azure/active-directory/conditional-access/location-condition) in Azure AD, and you're currently using an IP allow list with your enterprise account or any of the organizations owned by the enterprise account on {% data variables.product.prodname_dotcom_the_website %}, disable the IP allow lists. For more information, see "[Enforcing security settings in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)" and "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization)." 1. Sign into {% data variables.product.prodname_dotcom_the_website %} as the setup user for your enterprise with the username **@SHORT-CODE_admin**. 1. When prompted to continue to your identity provider, click **Use a recovery code** and sign in using one of your enterprise's recovery codes. {% data reusables.enterprise-accounts.access-enterprise %} diff --git a/translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/mapping-okta-groups-to-teams.md b/translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/mapping-okta-groups-to-teams.md index 0a5391066c..05d3d9eac7 100644 --- a/translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/mapping-okta-groups-to-teams.md +++ b/translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/mapping-okta-groups-to-teams.md @@ -98,4 +98,4 @@ Enterprise owners can use the site admin dashboard to check how Okta groups are {% data reusables.saml.external-identity-audit-events %} -For more information, see "[Reviewing the audit log for your organization](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization)." +詳しい情報については「[OrganizationのAudit logのレビュー](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization)」を参照してください。 diff --git a/translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md b/translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md index 753fcca38a..d17cfa8c89 100644 --- a/translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md +++ b/translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md @@ -77,7 +77,7 @@ The following SAML attributes are available for {% data variables.product.produc | Name | Required? | Description | | :- | :- | :- | -| `NameID` | Yes | A persistent user identifier. Any persistent name identifier format may be used. {% ifversion ghec %}If you use an enterprise with {% data variables.product.prodname_emus %}, {% endif %}{% data variables.product.product_name %} will normalize the `NameID` element to use as a username unless one of the alternative assertions is provided. For more information, see "[Username considerations for external authentication](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication)." | +| `NameID` | Yes | A persistent user identifier. Any persistent name identifier format may be used. {% ifversion ghec %}If you use an enterprise with {% data variables.product.prodname_emus %}, {% endif %}{% data variables.product.product_name %} will normalize the `NameID` element to use as a username unless one of the alternative assertions is provided. For more information, see "[Username considerations for external authentication](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication)."

    {% note %}**Note:** It's important to use a human-readable, persistent identifier. Using a transient identifier format like `urn:oasis:names:tc:SAML:2.0:nameid-format:transient` will result in re-linking of accounts on every sign-in, which can be detrimental to authorization management.{% endnote %} | | `SessionNotOnOrAfter` | No | The date that {% data variables.product.product_name %} invalidates the associated session. After invalidation, the person must authenticate once again to access {% ifversion ghec or ghae %}your enterprise's resources{% elsif ghes %}{% data variables.product.product_location %}{% endif %}. For more information, see "[Session duration and timeout](#session-duration-and-timeout)." | {%- ifversion ghes or ghae %} | `administrator` | No | When the value is `true`, {% data variables.product.product_name %} will automatically promote the user to be a {% ifversion ghes %}site administrator{% elsif ghae %}enterprise owner{% endif %}. Setting this attribute to anything but `true` will result in demotion, as long as the value is not blank. Omitting this attribute or leaving the value blank will not change the role of the user. | diff --git a/translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md b/translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md index 82ae28f7a5..f548ac98b4 100644 --- a/translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md +++ b/translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md @@ -44,7 +44,8 @@ You set up the audit log stream on {% data variables.product.product_name %} by - [Amazon S3](#setting-up-streaming-to-amazon-s3) - [Azure Blob Storage](#setting-up-streaming-to-azure-blob-storage) -- [Azure Event Hubs](#setting-up-streaming-to-azure-event-hubs) +- [Azure Event Hubs](#setting-up-streaming-to-azure-event-hubs){% ifversion streaming-datadog %} +- [Datadog](#setting-up-streaming-to-datadog){% endif %} - [Google Cloud Storage](#setting-up-streaming-to-google-cloud-storage) - [Splunk](#setting-up-streaming-to-splunk) @@ -60,7 +61,7 @@ You can set up streaming to S3 with access keys or, to avoid storing long-lived #### Setting up streaming to S3 with access keys {% endif %} -To stream audit logs to Amazon's S3 endpoint, you must have a bucket and access keys. For more information, see [Creating, configuring, and working with Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) in the the AWS documentation. Make sure to block public access to the bucket to protect your audit log information. +To stream audit logs to Amazon's S3 endpoint, you must have a bucket and access keys. For more information, see [Creating, configuring, and working with Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) in the AWS documentation. Make sure to block public access to the bucket to protect your audit log information. To set up audit log streaming from {% data variables.product.prodname_dotcom %} you will need: * The name of your Amazon S3 bucket @@ -231,6 +232,32 @@ You need two pieces of information about your event hub: its instance name and t {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +{% ifversion streaming-datadog %} +### Setting up streaming to Datadog + +To set up streaming to Datadog, you must create a client token or an API key in Datadog, then configure audit log streaming in {% data variables.product.product_name %} using the token for authentication. You do not need to create a bucket or other storage container in Datadog. + +After you set up streaming to Datadog, you can see your audit log data by filtering by "github.audit.streaming." For more information, see [Log Management](https://docs.datadoghq.com/logs/). + +1. If you don't already have a Datadog account, create one. +1. In Datadog, generate a client token or an API key, then click **Copy key**. For more information, see [API and Application Keys](https://docs.datadoghq.com/account_management/api-app-keys/) in Datadog Docs. +{% data reusables.enterprise.navigate-to-log-streaming-tab %} +1. Select the **Configure stream** dropdown menu and click **Datadog**. + + ![Screenshot of the "Configure stream" dropdown menu with "Datadog" highlighted](/assets/images/help/enterprises/audit-stream-choice-datadog.png) +1. Under "Token", paste the token you copied earlier. + + ![Screenshot of the "Token" field](/assets/images/help/enterprises/audit-stream-datadog-token.png) +1. Select the "Site" dropdown menu and click your Datadog site. To determine your Datadog site, compare your Datadog URL to the table in [Datadog sites](https://docs.datadoghq.com/getting_started/site/) in Datadog Docs. + + ![Screenshot of the "Site" dropdown menu](/assets/images/help/enterprises/audit-stream-datadog-site.png) +1. To verify that {% data variables.product.prodname_dotcom %} can connect and write to the Datadog endpoint, click **Check endpoint**. + + ![エンドポイントのチェック](/assets/images/help/enterprises/audit-stream-check.png) +{% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +1. After a few minutes, confirm that audit log data is appearing on the **Logs** tab in Datadog. If audit log data is not appearing, confirm that your token and site are correct in {% data variables.product.prodname_dotcom %}. +{% endif %} + ### Setting up streaming to Google Cloud Storage To set up streaming to Google Cloud Storage, you must create a service account in Google Cloud with the appropriate credentials and permissions, then configure audit log streaming in {% data variables.product.product_name %} using the service account's credentials for authentication. @@ -291,6 +318,10 @@ To stream audit logs to Splunk's HTTP Event Collector (HEC) endpoint you must ma Pausing the stream allows you to perform maintenance on the receiving application without losing audit data. Audit logs are stored for up to seven days on {% data variables.product.product_location %} and are then exported when you unpause the stream. +{% ifversion streaming-datadog %} +Datadog only accepts logs from up to 18 hours in the past. If you pause a stream to a Datadog endpoint for more than 18 hours, you risk losing logs that Datadog won't accept after you resume streaming. +{% endif %} + {% data reusables.enterprise.navigate-to-log-streaming-tab %} 1. Click **Pause stream**. diff --git a/translations/ja-JP/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md b/translations/ja-JP/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md index 423c60d41d..c6c4391149 100644 --- a/translations/ja-JP/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md +++ b/translations/ja-JP/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md @@ -77,12 +77,17 @@ Enterprise owners can restrict access to private assets owned by organizations i ### 許可 IP アドレスを追加する +{% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} + +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} {% data reusables.identity-and-permissions.ip-allow-lists-add-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-add-description %} {% data reusables.identity-and-permissions.ip-allow-lists-add-entry %} +{% data reusables.identity-and-permissions.check-ip-address %} ### {% data variables.product.prodname_github_apps %}によるアクセスの許可 @@ -90,6 +95,8 @@ Enterprise owners can restrict access to private assets owned by organizations i ### 許可 IP アドレスを有効化する +{% data reusables.identity-and-permissions.about-enabling-allowed-ip-addresses %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} @@ -98,6 +105,8 @@ Enterprise owners can restrict access to private assets owned by organizations i ### 許可 IP アドレスを編集する +{% data reusables.identity-and-permissions.about-editing-ip-allow-list-entries %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} @@ -105,6 +114,18 @@ Enterprise owners can restrict access to private assets owned by organizations i {% data reusables.identity-and-permissions.ip-allow-lists-edit-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-description %} 8. [**Update**] をクリックします。 +{% data reusables.identity-and-permissions.check-ip-address %} + +{% ifversion ip-allow-list-address-check %} +### Checking if an IP address is permitted + +{% data reusables.identity-and-permissions.about-checking-ip-address %} + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.security-tab %} +{% data reusables.identity-and-permissions.check-ip-address-step %} +{% endif %} ### 許可 IP アドレスを削除する @@ -124,13 +145,13 @@ Enterprise owners can restrict access to private assets owned by organizations i ## Managing SSH certificate authorities for your enterprise -You can use a SSH certificate authorities (CA) to allow members of any organization owned by your enterprise to access that organization's repositories using SSH certificates you provide. {% data reusables.organizations.can-require-ssh-cert %}詳しい情報については、「[SSS 認証局について](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities)」を参照してください。 +You can use a SSH certificate authorities (CA) to allow members of any organization owned by your enterprise to access that organization's repositories using SSH certificates you provide. {% data reusables.organizations.can-require-ssh-cert %}詳細については、「[SSH認証局について](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities)」を参照してください。 {% data reusables.organizations.add-extension-to-cert %} ### SSH 認証局を追加する -If you require SSH certificates for your enterprise, enterprise members should use a special URL for Git operations over SSH. 詳しい情報については、「[SSH 認証局について](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities#about-ssh-urls-with-ssh-certificates)」を参照してください。 +EnterpriseでSSH証明書が必要な場合、EnterpriseのメンバーはSSH経由のGitの操作に特別なURLを使わなければなりません。 詳しい情報については、「[SSH 認証局について](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities#about-ssh-urls-with-ssh-certificates)」を参照してください。 {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} diff --git a/translations/ja-JP/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md b/translations/ja-JP/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md index 65a9d2af70..91be9722aa 100644 --- a/translations/ja-JP/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md +++ b/translations/ja-JP/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md @@ -71,24 +71,28 @@ Enterprise オーナーがメンバーによる特定のタイプのリポジト {% endif %} -## Enforcing a policy for {% ifversion ghec or ghes or ghae %}base{% else %}default{% endif %} repository permissions +## Enforcing a policy for base repository permissions -Across all organizations owned by your enterprise, you can set a {% ifversion ghec or ghes or ghae %}base{% else %}default{% endif %} repository permission level (none, read, write, or admin) for organization members, or allow owners to administer the setting on the organization level. +Across all organizations owned by your enterprise, you can set a base repository permission level (none, read, write, or admin) for organization members, or allow owners to administer the setting on the organization level. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} -4. Under "{% ifversion ghec or ghes or ghae %}Base{% else %}Default{% endif %} permissions", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -5. Under "{% ifversion ghec or ghes or ghae %}Base{% else %}Default{% endif %} permissions", use the drop-down menu and choose a policy. - {% ifversion ghec or ghes or ghae %} - ![リポジトリ権限ポリシーオプションのドロップダウンメニュー](/assets/images/help/business-accounts/repository-permissions-policy-drop-down.png) - {% else %} - ![リポジトリ権限ポリシーオプションのドロップダウンメニュー](/assets/images/enterprise/business-accounts/repository-permissions-policy-drop-down.png) - {% endif %} +4. Under "Base permissions", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +5. Under "Base permissions", use the drop-down menu and choose a policy. ![リポジトリ権限ポリシーオプションのドロップダウンメニュー](/assets/images/help/business-accounts/repository-permissions-policy-drop-down.png) + ## Enforcing a policy for repository creation -Across all organizations owned by your enterprise, you can allow members to create repositories, restrict repository creation to organization owners, or allow owners to administer the setting on the organization level. メンバーにリポジトリの作成を許可する場合は、パブリック、プライベート、内部の各リポジトリをどう組み合わせて作成するかを任意に選択できます。 {% data reusables.repositories.internal-repo-default %} 詳しい情報については「[内部リポジトリを作成する](/articles/creating-an-internal-repository)」を参照してください。 +Across all organizations owned by your enterprise, you can allow members to create repositories, restrict repository creation to organization owners, or allow owners to administer the setting on the organization level. + +If you allow members to create repositories in your organizations, you can choose which types of repositories (public, private, and internal) that members can create. + +{% ifversion enterprise-namespace-repo-setting %} +{% ifversion ghec %}If your enterprise uses {% data variables.product.prodname_emus %}, you{% else %}You{% endif %} can also prevent users from creating repositories owned by their user accounts. +{% endif %} + +{% data reusables.repositories.internal-repo-default %} 詳しい情報については「[内部リポジトリを作成する](/articles/creating-an-internal-repository)」を参照してください。 {% data reusables.organizations.repo-creation-constants %} @@ -96,33 +100,32 @@ Across all organizations owned by your enterprise, you can allow members to crea {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} 5. [Repository creation] で、設定変更に関する情報を読みます。 {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -{% ifversion ghes or ghae or ghec %} {% data reusables.enterprise-accounts.repo-creation-policy %} -{% data reusables.enterprise-accounts.repo-creation-types %} -{% else %} -6. [Repository creation（リポジトリの作成）] で、ドロップダウンメニューを使用してポリシーを選択します。 - - ![リポジトリ作成ポリシーのドロップダウンメニュー](/assets/images/enterprise/site-admin-settings/repository-creation-drop-down.png) -{% endif %} +{% data reusables.enterprise-accounts.repo-creation-types %}{% ifversion enterprise-namespace-repo-setting %} +1. Optionally, {% ifversion ghec %}if your enterprise uses {% data variables.product.prodname_emus %} and you want {% endif %}to prevent enterprise members from creating repositories owned by their user accounts, select **Block the creation of user namespace repositories**. ![Screenshot showing the list of disabled options from forking policy](/assets/images/help/business-accounts/restrict-personal-namespace-enabled-setting.png){% endif %} ## Enforcing a policy for forking private or internal repositories Enterprise が所有しているすべての Organization 全体で、ユーザーにリポジトリのフォーク用にプライベートまたは内部リポジトリへのアクセスを許可したり、プライベートまたは内部リポジトリのフォークを一切禁止したり、オーナーが Organization レベルで設定を管理できるようにしたりすることができます。 +{% ifversion enterprise-namespace-repo-setting %} +{% note %} + +**Note:** If {% ifversion ghec %}your enterprise uses {% data variables.product.prodname_emus %} and {% endif %}your "Repository creation" policy prevents enterprise members from creating repositories owned by their user accounts, members will not be allowed to fork a repository in their user accounts, regardless of your "Repository forking" policy. + +{% endnote %} +{% endif %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} 3. Under "Repository forking", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} 4. [Repository forking] で、ドロップダウンメニューを使用してポリシーを選択します。 - ![リポジトリ フォーク ポリシー オプションのドロップダウンメニュー](/assets/images/help/business-accounts/repository-forking-policy-drop-down.png) - -{% ifversion innersource-fork-policies %} + ![リポジトリ フォーク ポリシー オプションのドロップダウンメニュー](/assets/images/help/business-accounts/repository-forking-policy-drop-down.png){% ifversion innersource-fork-policies %} 5. If forking is enabled, you can specify where users are allowed to fork repositories. Review the information about changing the setting and choose a policy. - ![Screenshot showing the list of repository forking policy options](/assets/images/help/business-accounts/repository-forking-policy-settings.png) -{% endif %} - + ![Screenshot showing the list of repository forking policy options](/assets/images/help/business-accounts/repository-forking-policy-settings.png){% endif %} ## Enforcing a policy for inviting{% ifversion ghec %} outside{% endif %} collaborators to repositories @@ -140,8 +143,6 @@ Across all organizations owned by your enterprise, you can allow members to invi ![Drop-down menu with invitation policy options](/assets/images/enterprise/business-accounts/repository-invitation-policy-drop-down.png) {% endif %} -{% ifversion ghec or ghes or ghae %} - ## Enforcing a policy for the default branch name Across all organizations owned by your enterprise, you can set the default branch name for any new repositories that members create. すべての Organization 全体でそのデフォルトブランチ名を施行することも、Organization ごとに異なる名前を設定することもできます。 @@ -152,8 +153,6 @@ Across all organizations owned by your enterprise, you can set the default branc 4. オプションで、Enterprise のすべての Organization に対してデフォルトブランチ名を施行する場合は [**Enforce across this enterprise**] を選択します。 ![[Enforcement] チェックボックス](/assets/images/help/business-accounts/default-branch-name-enforce.png) 5. [**Update**] をクリックします。 ![[Update] ボタン](/assets/images/help/business-accounts/default-branch-name-update.png) -{% endif %} - ## Enforcing a policy for changes to repository visibility Across all organizations owned by your enterprise, you can allow members with admin access to change a repository's visibility, restrict repository visibility changes to organization owners, or allow owners to administer the setting on the organization level. メンバーがリポジトリの可視性を変更できないようにした場合、Enterprise のオーナーのみがリポジトリの可視性を変更できます。 @@ -163,9 +162,8 @@ Enterprise のオーナーがリポジトリの作成を Organization のオー {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} -5. [Repository visibility change] で、設定変更についての情報を確認します。 {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} - -{% data reusables.enterprise-accounts.repository-visibility-policy %} +1. [Repository visibility change] で、設定変更についての情報を確認します。 {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +1. "Repository visibility change（リポジトリの可視性の変更）"の下で、ドロップダウンメニューを使ってポリシーを選択してください。 ![リポジトリの可視性のポリシーの選択肢があるドロップダウンメニュー](/assets/images/help/business-accounts/repository-visibility-policy-drop-down.png) ## Enforcing a policy for repository deletion and transfer diff --git a/translations/ja-JP/content/admin/user-management/managing-organizations-in-your-enterprise/restoring-a-deleted-organization.md b/translations/ja-JP/content/admin/user-management/managing-organizations-in-your-enterprise/restoring-a-deleted-organization.md index b4849f1302..a2576bd5cd 100644 --- a/translations/ja-JP/content/admin/user-management/managing-organizations-in-your-enterprise/restoring-a-deleted-organization.md +++ b/translations/ja-JP/content/admin/user-management/managing-organizations-in-your-enterprise/restoring-a-deleted-organization.md @@ -45,7 +45,7 @@ In all the search phrases below, replace ORGANIZATION with the name of the organ ### Restoring teams 1. To find each team name, search the audit log for `action:team.create org:ORGANIZATION`. -1. Manually recreate the team. For more information, see "[Creating a team](/organizations/organizing-members-into-teams/creating-a-team)." +1. Manually recreate the team. 詳しい情報については「[Teamの作成](/organizations/organizing-members-into-teams/creating-a-team)」を参照してください。 1. To find the members that have been added to each team, search for `action:team.add_member team:"ORGANIZATION/TEAM"`. 1. Manually re-add the team members. For more information, see "[Adding organization members to a team](/organizations/organizing-members-into-teams/adding-organization-members-to-a-team)." 1. To find the repositories that the team was granted access to, search for `action:team.add_repository team:"ORGANIZATION/TEAM"`. diff --git a/translations/ja-JP/content/authentication/connecting-to-github-with-ssh/about-ssh.md b/translations/ja-JP/content/authentication/connecting-to-github-with-ssh/about-ssh.md index 5293b50d56..acd9b5e15c 100644 --- a/translations/ja-JP/content/authentication/connecting-to-github-with-ssh/about-ssh.md +++ b/translations/ja-JP/content/authentication/connecting-to-github-with-ssh/about-ssh.md @@ -1,6 +1,6 @@ --- title: SSH について -intro: 'SSH プロトコルを利用すれば、リモートのサーバーやサービスに接続し、認証を受けられます。 SSH キーを使用すると、アクセスのたびにユーザ名と個人アクセストークンを入力することなく {% data variables.product.product_name %} に接続できます。' +intro: 'SSH プロトコルを利用すれば、リモートのサーバーやサービスに接続し、認証を受けられます。 With SSH keys, you can connect to {% data variables.product.product_name %} without supplying your username and personal access token at each visit.{% ifversion ssh-commit-verification %} You can also use an SSH key to sign commits.{% endif %}' redirect_from: - /articles/about-ssh - /github/authenticating-to-github/about-ssh @@ -16,7 +16,7 @@ topics: {% data reusables.ssh.about-ssh %} For more information about SSH, see [Secure Shell](https://en.wikipedia.org/wiki/Secure_Shell) on Wikipedia. -When you set up SSH, you will need to generate a new private SSH key and add it to the SSH agent. You must also add the public SSH key to your account on {% data variables.product.product_name %} before you use the key to authenticate. For more information, see "[Generating a new SSH key and adding it to the ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)" and "[Adding a new SSH key to your {% data variables.product.prodname_dotcom %} account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)." +When you set up SSH, you will need to generate a new private SSH key and add it to the SSH agent. You must also add the public SSH key to your account on {% data variables.product.product_name %} before you use the key to authenticate{% ifversion ssh-commit-verification %} or sign commits{% endif %}. For more information, see "[Generating a new SSH key and adding it to the ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)"{% ifversion ssh-commit-verification %}, {% else %} and{% endif %} "[Adding a new SSH key to your {% data variables.product.prodname_dotcom %} account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account){% ifversion ssh-commit-verification %}" and "[About commit signature verification](/articles/about-commit-signature-verification){% endif %}." You can further secure your SSH key by using a hardware security key, which requires the physical hardware security key to be attached to your computer when the key pair is used to authenticate with SSH. You can also secure your SSH key by adding your key to the ssh-agent and using a passphrase. 詳しい情報については[SSH キーのパスフレーズを使う](/github/authenticating-to-github/working-with-ssh-key-passphrases)を参照してください。 @@ -33,7 +33,6 @@ Organizations that use {% data variables.product.prodname_ghe_cloud %} can provi {% else ghec or ghes or ghae %} If you're a member of an organization that provides SSH certificates, you can use your certificate to access that organization's repositories without adding the certificate to your account on {% data variables.product.product_name %}. You cannot use your certificate to access forks of the organization's repositories, if the forks is owned by your personal account. 詳しい情報については「[SSH認証局について](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities)」を参照してください。 {% endif %} - ## 参考リンク - [SSH のトラブルシューティング](/articles/troubleshooting-ssh) diff --git a/translations/ja-JP/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md b/translations/ja-JP/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md index 06825e0163..36719a9de4 100644 --- a/translations/ja-JP/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md +++ b/translations/ja-JP/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md @@ -19,6 +19,8 @@ shortTitle: Add a new SSH key {% data reusables.ssh.about-ssh %} For more information, see "[About SSH](/authentication/connecting-to-github-with-ssh/about-ssh)." +{% ifversion ssh-commit-verification %}You can also use SSH to sign commits and tags. For more information about commit signing, see "[About commit signature verification](/articles/about-commit-signature-verification)."{% endif %} + After you generate an SSH key pair, you must add the public key to {% ifversion fpt or ghec or ghes %}{% data variables.product.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %} to enable SSH access for your account. ## 必要な環境 @@ -30,111 +32,45 @@ Before adding a new SSH key to your account on {% ifversion ghae %}{% data varia ## Adding a new SSH key to your account -After adding a new SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you can reconfigure any local repositories to use SSH. 詳しい情報については[リモート URL の HTTPS から SSH への切り替え](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-https-to-ssh)を参照してください。 +After adding a new SSH authentication key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you can reconfigure any local repositories to use SSH. 詳しい情報については[リモート URL の HTTPS から SSH への切り替え](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-https-to-ssh)を参照してください。 {% data reusables.ssh.key-type-support %} -{% mac %} - {% webui %} -1. SSH 公開鍵をクリップボードにコピーします。 - - SSH 公開鍵のファイル名がサンプルコードと異なる場合は、現在の設定に一致するようにファイル名を変更してください。 キーをコピーする際には、改行や空白を追加しないでください。 - - ```shell - $ pbcopy < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub - # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard - ``` - - {% tip %} - - **ヒント:** `pbcopy` がうまく動作しない場合は、隠れフォルダ `.ssh` にアクセスし、使い慣れたテキストエディタでこのファイルを開き、クリップボードにコピーしてください。 - - {% endtip %} - +{% data reusables.gpg.copy-ssh-public-key %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.ssh %} -4. [**New SSH key**] または [**Add SSH key**] をクリックします。 ![SSH キーボタン](/assets/images/help/settings/ssh-add-ssh-key.png) -5. [Title] フィールドで、新しいキーを説明するラベルを追加します。 たとえば、個人のMacを使っているなら、このキーを「Personal MacBook Air」とすることができるでしょう。 -6. キーを [Key] フィールドに貼り付けます。 ![キーフィールド](/assets/images/help/settings/ssh-key-paste.png) -7. **[Add SSH key]** をクリックしてください。 ![キーの追加ボタン](/assets/images/help/settings/ssh-add-key.png) +4. [**New SSH key**] または [**Add SSH key**] をクリックします。 +{% ifversion ssh-commit-verification %} + ![SSH キーボタン](/assets/images/help/settings/ssh-add-ssh-key-with-auth.png) +{% else %} + ![SSH キーボタン](/assets/images/help/settings/ssh-add-ssh-key.png) +{% endif %} +5. [Title] フィールドで、新しいキーを説明するラベルを追加します。 For example, if you're using a personal laptop, you might call this key "Personal laptop". +{% ifversion ssh-commit-verification %} +6. Select the type of key, either authentication or signing. For more information about commit signing, see "[About commit signature verification](/articles/about-commit-signature-verification)." +{% endif %} +7. キーを [Key] フィールドに貼り付けます。 +{% ifversion ssh-commit-verification %} + ![キーフィールド](/assets/images/help/settings/ssh-key-paste-with-type.png) +{% else %} + ![キーフィールド](/assets/images/help/settings/ssh-key-paste.png) +{% endif %} +8. **[Add SSH key]** をクリックしてください。 ![キーの追加ボタン](/assets/images/help/settings/ssh-add-key.png) {% data reusables.user-settings.sudo-mode-popup %} {% endwebui %} -{% endmac %} - -{% windows %} - -{% webui %} - -1. SSH 公開鍵をクリップボードにコピーします。 - - SSH 公開鍵のファイル名がサンプルコードと異なる場合は、現在の設定に一致するようにファイル名を変更してください。 キーをコピーする際には、改行や空白を追加しないでください。 - - ```shell - $ clip < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub - # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard - ``` - - {% tip %} - - **ヒント:** `clip` がうまく動作しない場合は、隠しフォルダ `.ssh` にアクセスし、使い慣れたテキストエディタでこのファイルを開き、クリップボードにコピーしてください。 - - {% endtip %} - -{% data reusables.user-settings.access_settings %} -{% data reusables.user-settings.ssh %} -4. [**New SSH key**] または [**Add SSH key**] をクリックします。 ![SSH キーボタン](/assets/images/help/settings/ssh-add-ssh-key.png) -5. [Title] フィールドで、新しいキーを説明するラベルを追加します。 たとえば、個人のMacを使っているなら、このキーを「Personal MacBook Air」とすることができるでしょう。 -6. キーを [Key] フィールドに貼り付けます。 ![キーフィールド](/assets/images/help/settings/ssh-key-paste.png) -7. **[Add SSH key]** をクリックしてください。 ![キーの追加ボタン](/assets/images/help/settings/ssh-add-key.png) -{% data reusables.user-settings.sudo-mode-popup %} - -{% endwebui %} - -{% endwindows %} - -{% linux %} - -{% webui %} - -1. SSH 公開鍵をクリップボードにコピーします。 - - SSH 公開鍵のファイル名がサンプルコードと異なる場合は、現在の設定に一致するようにファイル名を変更してください。 キーをコピーする際には、改行や空白を追加しないでください。 - - ```shell - $ cat ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub - # Then select and copy the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file - # displayed in the terminal to your clipboard - ``` - - {% tip %} - - **Tip:** Alternatively, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. - - {% endtip %} - -{% data reusables.user-settings.access_settings %} -{% data reusables.user-settings.ssh %} -4. [**New SSH key**] または [**Add SSH key**] をクリックします。 ![SSH キーボタン](/assets/images/help/settings/ssh-add-ssh-key.png) -5. [Title] フィールドで、新しいキーを説明するラベルを追加します。 たとえば、個人のMacを使っているなら、このキーを「Personal MacBook Air」とすることができるでしょう。 -6. キーを [Key] フィールドに貼り付けます。 ![キーフィールド](/assets/images/help/settings/ssh-key-paste.png) -7. **[Add SSH key]** をクリックしてください。 ![キーの追加ボタン](/assets/images/help/settings/ssh-add-key.png) -{% data reusables.user-settings.sudo-mode-popup %} - -{% endwebui %} - -{% endlinux %} - {% cli %} {% data reusables.cli.cli-learn-more %} Before you can use the {% data variables.product.prodname_cli %} to add an SSH key to your account, you must authenticate to the {% data variables.product.prodname_cli %}. For more information, see [`gh auth login`](https://cli.github.com/manual/gh_auth_login) in the {% data variables.product.prodname_cli %} documentation. -To add an SSH key to your GitHub account, use the `ssh-key add` subcommand, specifying your public key. +{% ifversion ssh-commit-verification %}At present, you can only use {% data variables.product.prodname_cli %} to add SSH authentication keys, you cannot add SSH signing keys.{% endif %} + +To add an SSH authentication key to your GitHub account, use the `ssh-key add` subcommand, specifying your public key. ```shell gh ssh-key add key-file diff --git a/translations/ja-JP/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md b/translations/ja-JP/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md index adb05a61f9..c53ee9bac6 100644 --- a/translations/ja-JP/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md +++ b/translations/ja-JP/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md @@ -1,6 +1,6 @@ --- -title: About commit signature verification -intro: 'Using GPG or S/MIME, you can sign tags and commits locally. These tags or commits are marked as verified on {% data variables.product.product_name %} so other people can be confident that the changes come from a trusted source.' +title: コミット署名の検証について +intro: 'Using GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME, you can sign tags and commits locally. これらのタグやコミットは {% data variables.product.product_name %} で検証済みとしてマークされているため、他のユーザはその変更が信頼できるソースからのものであると確信できます。' redirect_from: - /articles/about-gpg-commit-and-tag-signatures - /articles/about-gpg @@ -17,11 +17,20 @@ topics: - Access management shortTitle: Commit signature verification --- -## About commit signature verification -You can sign commits and tags locally, to give other people confidence about the origin of a change you have made. If a commit or tag has a GPG or S/MIME signature that is cryptographically verifiable, GitHub marks the commit or tag {% ifversion fpt or ghec %}"Verified" or "Partially verified."{% else %}"Verified."{% endif %} +## コミット署名の検証について -![Verified commit](/assets/images/help/commits/verified-commit.png) +コミットとタグにローカルで署名して、行った変更の根拠を他のユーザに信頼してもらうことができます。 If a commit or tag has a GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME signature that is cryptographically verifiable, {% data variables.product.product_name %} marks the commit or tag {% ifversion fpt or ghec %}"Verified" or "Partially verified."{% else %}"Verified."{% endif %} + +![検証されたコミット](/assets/images/help/commits/verified-commit.png) + +{% ifversion ghes or ghae %} +If a commit or tag has a signature that can't be verified, {% data variables.product.product_name %} marks the commit or tag "Unverified." +{% endif %} + +{% ifversion ssh-commit-verification %} +For most individual users, GPG or SSH will be the best choice for signing commits. S/MIME signatures are usually required in the context of a larger organization. SSH signatures are the simplest to generate. You can even upload your existing authentication key to {% data variables.product.product_name %} to also use as a signing key. Generating a GPG signing key is more involved than generating an SSH key, but GPG has features that SSH does not. A GPG key can expire or be revoked when no longer used. {% data variables.product.product_name %} shows commits that were signed with such a key as "Verified" unless the key was marked as compromised. SSH keys don't have this capability. +{% endif %} {% ifversion fpt or ghec %} Commits and tags have the following verification statuses, depending on whether you have enabled vigilant mode. By default vigilant mode is not enabled. For information on how to enable vigilant mode, see "[Displaying verification statuses for all of your commits](/github/authenticating-to-github/displaying-verification-statuses-for-all-of-your-commits)." @@ -30,27 +39,26 @@ Commits and tags have the following verification statuses, depending on whether Signing commits differs from signing off on a commit. For more information about signing off on commits, see "[Managing the commit signoff policy for your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository)." -### Default statuses +### デフォルトのステータス -| Status | Description | -| -------------- | ----------- | -| **Verified** | The commit is signed and the signature was successfully verified. -| **Unverified** | The commit is signed but the signature could not be verified. -| No verification status | The commit is not signed. +| 状況 | 説明 | +| ---------------------- | ----------------------------- | +| **Verified** | コミットが署名され、署名が正常に検証されました。 | +| **Unverified** | コミットは署名されていますが、署名を検証できませんでした。 | +| No verification status | コミットが署名されていません。 | ### Signature verification for rebase and merge {% data reusables.pull_requests.rebase_and_merge_verification %} For more information, see "[Rebasing and merging your commits](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github#rebasing-and-merging-your-commits)." -### Statuses with vigilant mode enabled +### 警戒モードが有効になっているステータス {% data reusables.identity-and-permissions.vigilant-mode-verification-statuses %} -{% else %} -If a commit or tag has a signature that can't be verified, {% data variables.product.product_name %} marks the commit or tag "Unverified." {% endif %} + Repository administrators can enforce required commit signing on a branch to block all commits that are not signed and verified. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-signed-commits)." {% data reusables.identity-and-permissions.verification-status-check %} @@ -59,10 +67,10 @@ Repository administrators can enforce required commit signing on a branch to blo {% ifversion ghes %}If a site administrator has enabled web commit signing, {% data variables.product.product_name %} will automatically use GPG to sign commits you make using the web interface. Commits signed by {% data variables.product.product_name %} will have a verified status. You can verify the signature locally using the public key available at `https://HOSTNAME/web-flow.gpg`. For more information, see "[Configuring web commit signing](/admin/configuration/configuring-your-enterprise/configuring-web-commit-signing)." {% else %}{% data variables.product.prodname_dotcom %} will automatically use GPG to sign commits you make using the web interface. Commits signed by {% data variables.product.prodname_dotcom %} will have a verified status. You can verify the signature locally using the public key available at https://github.com/web-flow.gpg. The full fingerprint of the key is `5DE3 E050 9C47 EA3C F04A 42D3 4AEE 18F8 3AFD EB23`. -You can optionally choose to have {% data variables.product.prodname_dotcom %} sign commits you make in {% data variables.product.prodname_github_codespaces %}. For more information about enabling GPG verification for your codespaces, see "[Managing GPG verification for {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)."{% endif %} +You can optionally choose to have {% data variables.product.prodname_dotcom %} GPG sign commits you make in {% data variables.product.prodname_github_codespaces %}. For more information about enabling GPG verification for your codespaces, see "[Managing GPG verification for {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)."{% endif %} {% endif %} -## GPG commit signature verification +## GPG コミット署名の検証 You can use GPG to sign commits with a GPG key that you generate yourself. @@ -70,13 +78,32 @@ You can use GPG to sign commits with a GPG key that you generate yourself. To sign commits using GPG and have those commits verified on {% data variables.product.product_name %}, follow these steps: -1. [Check for existing GPG keys](/articles/checking-for-existing-gpg-keys) -2. [Generate a new GPG key](/articles/generating-a-new-gpg-key) +1. [既存の GPG キーがあるかチェックする](/articles/checking-for-existing-gpg-keys) +2. [新しい GPG キーを生成する](/articles/generating-a-new-gpg-key) 3. [Add a GPG key to your GitHub account](/articles/adding-a-gpg-key-to-your-github-account) -4. [Tell Git about your signing key](/articles/telling-git-about-your-signing-key) -5. [Sign commits](/articles/signing-commits) -6. [Sign tags](/articles/signing-tags) +4. [Git へ署名キーを伝える](/articles/telling-git-about-your-signing-key) +5. [コミットに署名する](/articles/signing-commits) +6. [タグに署名する](/articles/signing-tags) +{% ifversion ssh-commit-verification %} +## SSH commit signature verification + +You can use SSH to sign commits with an SSH public key that you generate yourself. If you already use an SSH key to authenticate with {% data variables.product.product_name %}, you can also upload that same key again for use as a signing key. There's no limit on the number of signing keys you can add to your account. + +{% data variables.product.product_name %} uses [ssh_data](https://github.com/github/ssh_data), an open source Ruby library, to confirm that your locally signed commits and tags are cryptographically verifiable against a public key you have added to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. + +{% data reusables.gpg.ssh-git-version %} + +To sign commits using SSH and have those commits verified on {% data variables.product.product_name %}, follow these steps: + +1. [Check for existing SSH keys](/articles/checking-for-existing-ssh-keys) +2. [Generate a new SSH key](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) +3. [Add a SSH signing key to your GitHub account](/articles/adding-a-new-ssh-key-to-your-github-account) +4. [Git へ署名キーを伝える](/articles/telling-git-about-your-signing-key) +5. [コミットに署名する](/articles/signing-commits) +6. [タグに署名する](/articles/signing-tags) + +{% endif %} ## S/MIME commit signature verification You can use S/MIME to sign commits with an X.509 key issued by your organization. @@ -87,9 +114,9 @@ You can use S/MIME to sign commits with an X.509 key issued by your organization To sign commits using S/MIME and have those commits verified on {% data variables.product.product_name %}, follow these steps: -1. [Tell Git about your signing key](/articles/telling-git-about-your-signing-key) -2. [Sign commits](/articles/signing-commits) -3. [Sign tags](/articles/signing-tags) +1. [Git へ署名キーを伝える](/articles/telling-git-about-your-signing-key) +2. [コミットに署名する](/articles/signing-commits) +3. [タグに署名する](/articles/signing-tags) You don't need to upload your public key to {% data variables.product.product_name %}. @@ -101,8 +128,8 @@ Organizations and {% data variables.product.prodname_github_apps %} that require Signature verification for bots will only work if the request is verified and authenticated as the {% data variables.product.prodname_github_app %} or bot and contains no custom author information, custom committer information, and no custom signature information, such as Commits API. {% endif %} -## Further reading +## 参考リンク -- "[Signing commits](/articles/signing-commits)" -- "[Signing tags](/articles/signing-tags)" -- "[Troubleshooting commit signature verification](/articles/troubleshooting-commit-signature-verification)" +- 「[コミットに署名する](/articles/signing-commits)」 +- 「[タグに署名する](/articles/signing-tags)」 +- 「[コミット署名検証のトラブルシューティング](/articles/troubleshooting-commit-signature-verification)」 diff --git a/translations/ja-JP/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md b/translations/ja-JP/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md index cfdecad083..83aa2c0f2f 100644 --- a/translations/ja-JP/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md +++ b/translations/ja-JP/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md @@ -19,7 +19,7 @@ redirect_from: コンピューターでローカルで作業する場合、Git を使用すると、変更の作者とコミッターのアイデンティティを設定できます。 これにより、他のユーザが、自分が作成したコミットとタグが実際に自分によって作成されたものであると確信することが困難になる可能性があります。 この問題を解決するため、コミットとタグに署名することができます。 詳しい情報については、「[コミットに署名する](/github/authenticating-to-github/signing-commits)」および「[タグに署名する](/github/authenticating-to-github/signing-tags)」を参照してください。 {% data variables.product.prodname_dotcom %} は、署名されたコミットとタグに検証ステータスのマークを付けます。 -デフォルトでは、コミットとタグは、正常に検証された GPG または S/MIME キーで署名されている場合、「検証済み」としてマークされます。 If a commit or tag has a signature that can't be verified by {% data variables.product.prodname_dotcom %}, we mark the commit or tag "Unverified." それ以外の場合、検証ステータスは表示されません。 +By default commits and tags are marked "Verified" if they are signed with a GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME key that was successfully verified. If a commit or tag has a signature that can't be verified by {% data variables.product.prodname_dotcom %}, we mark the commit or tag "Unverified." それ以外の場合、検証ステータスは表示されません。 ただし、{% data variables.product.prodname_dotcom %} 設定で警戒モードを有効にすることで、他のユーザにコミットとタグに起因するアイデンティティの信頼性を高めることができます。 警戒モードを有効にすると、すべてのコミットとタグに 3 つの検証ステータスのいずれかがマークされます。 diff --git a/translations/ja-JP/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md b/translations/ja-JP/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md index ca5cd18d90..a51f2ff18b 100644 --- a/translations/ja-JP/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md +++ b/translations/ja-JP/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md @@ -29,11 +29,11 @@ topics: {% data reusables.command_line.open_the_multi_os_terminal %} 3. GPG キーペアを生成します。 GPG には複数のバージョンがあるため、関連する [_man ページ_](https://en.wikipedia.org/wiki/Man_page)を参考にして適切なキーの生成コマンドを見つける必要があります。 キーには RSA を使用する必要があります。 - バージョン 2.1.17 以降の場合は、以下のテキストを貼り付けて GPG キーペアを生成します。 - ```shell + ```shell{:copy} $ gpg --full-generate-key ``` - バージョン 2.1.17 およびそれ以降でない場合は、 `gpg --full-generate-key` コマンドが使えません。 以下のテキストを貼り付けてステップ 6 に進んでください。 - ```shell + ```shell{:copy} $ gpg --default-new-key-algo rsa4096 --gen-key ``` 4. At the prompt, specify the kind of key you want, or press `Enter` to accept the default. @@ -52,10 +52,10 @@ topics: {% data reusables.gpg.list-keys-with-note %} {% data reusables.gpg.copy-gpg-key-id %} 10. 以下のテキストを貼り付けます。GPG キー ID は実際に使用するものを入力してください。 この例では、GPG キー ID は `3AA5C34371567BD2` です。 - ```shell - $ gpg --armor --export 3AA5C34371567BD2 - # ASCII armor 形式で GPG キーを出力する - ``` + ```shell{:copy} + $ gpg --armor --export 3AA5C34371567BD2 + # Prints the GPG key ID, in ASCII armor format + ``` 11. `-----BEGIN PGP PUBLIC KEY BLOCK-----` で始まり、`-----END PGP PUBLIC KEY BLOCK-----` で終わる GPG キーをコピーします。 12. [GPG キーを GitHub アカウントに追加](/articles/adding-a-gpg-key-to-your-github-account)します。 diff --git a/translations/ja-JP/content/authentication/managing-commit-signature-verification/index.md b/translations/ja-JP/content/authentication/managing-commit-signature-verification/index.md index 03daae58a2..8a80a00e46 100644 --- a/translations/ja-JP/content/authentication/managing-commit-signature-verification/index.md +++ b/translations/ja-JP/content/authentication/managing-commit-signature-verification/index.md @@ -1,6 +1,6 @@ --- title: コミット署名の検証を管理する -intro: 'GPG または S/MIME を使用してローカルで作業に署名できます。 信頼できるソースによるコミットであることを他のユーザに知らせるために、{% data variables.product.product_name %} はこの署名を検証します。{% ifversion fpt %} {% data variables.product.product_name %} は、{% data variables.product.product_name %} Web インターフェイスを使用して自動的にコミットに署名します。{% endif %}' +intro: '{% data variables.product.product_name %} will verify GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME signatures so other people will know that your commits come from a trusted source.{% ifversion fpt %} {% data variables.product.product_name %} will automatically sign commits you make using the {% data variables.product.product_name %} web interface.{% endif %}' redirect_from: - /articles/generating-a-gpg-key - /articles/signing-commits-with-gpg diff --git a/translations/ja-JP/content/authentication/managing-commit-signature-verification/signing-commits.md b/translations/ja-JP/content/authentication/managing-commit-signature-verification/signing-commits.md index f945c1976e..d1a77b6bed 100644 --- a/translations/ja-JP/content/authentication/managing-commit-signature-verification/signing-commits.md +++ b/translations/ja-JP/content/authentication/managing-commit-signature-verification/signing-commits.md @@ -1,6 +1,6 @@ --- title: コミットに署名する -intro: GPG または S/MIME を使用してローカルでコミットに署名できます。 +intro: 'You can sign commits locally using GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME.' redirect_from: - /articles/signing-commits-and-tags-using-gpg - /articles/signing-commits-using-gpg @@ -52,9 +52,5 @@ Git バージョン 2.0.0 以降で、ローカルリポジトリでデフォル ## 参考リンク -* [既存の GPG キーのチェック](/articles/checking-for-existing-gpg-keys) -* [新しい GPG キーの生成](/articles/generating-a-new-gpg-key) -* "[Adding a GPG key to your GitHub account](/articles/adding-a-gpg-key-to-your-github-account)" * 「[Git へ署名キーを伝える](/articles/telling-git-about-your-signing-key)」 -* [GPG キーとメールの関連付け](/articles/associating-an-email-with-your-gpg-key) * 「[タグに署名する](/articles/signing-tags)」 diff --git a/translations/ja-JP/content/authentication/managing-commit-signature-verification/signing-tags.md b/translations/ja-JP/content/authentication/managing-commit-signature-verification/signing-tags.md index 3dc0060ec7..c1d8787ab7 100644 --- a/translations/ja-JP/content/authentication/managing-commit-signature-verification/signing-tags.md +++ b/translations/ja-JP/content/authentication/managing-commit-signature-verification/signing-tags.md @@ -1,6 +1,6 @@ --- title: タグに署名する -intro: GPG または S/MIME を使用してローカルでタグに署名できます。 +intro: 'You can sign tags locally using GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME.' redirect_from: - /articles/signing-tags-using-gpg - /articles/signing-tags @@ -32,9 +32,6 @@ topics: ## 参考リンク - [リポジトリのタグを表示する](/articles/viewing-your-repositorys-tags) -- [既存の GPG キーのチェック](/articles/checking-for-existing-gpg-keys) -- [新しい GPG キーの生成](/articles/generating-a-new-gpg-key) -- "[Adding a GPG key to your GitHub account](/articles/adding-a-gpg-key-to-your-github-account)" - 「[Git へ署名キーを伝える](/articles/telling-git-about-your-signing-key)」 - [GPG キーとメールの関連付け](/articles/associating-an-email-with-your-gpg-key) - 「[コミットに署名する](/articles/signing-commits)」 diff --git a/translations/ja-JP/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md b/translations/ja-JP/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md index b801c5a1df..9b0a093038 100644 --- a/translations/ja-JP/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md +++ b/translations/ja-JP/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md @@ -1,6 +1,6 @@ --- title: Git へ署名キーを伝える -intro: ローカルでコミットに署名するには、使用する GPG または X.509 キーがあることを Git に知らせる必要があります。 +intro: 'To sign commits locally, you need to inform Git that there''s a GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or X.509 key you''d like to use.' redirect_from: - /articles/telling-git-about-your-gpg-key - /articles/telling-git-about-your-signing-key @@ -52,8 +52,6 @@ If you're using a GPG key that matches your committer identity and your verified $ killall gpg-agent ``` -{% data reusables.gpg.x-509-key %} - {% endmac %} {% windows %} @@ -75,8 +73,6 @@ If you're using a GPG key that matches your committer identity and your verified {% data reusables.gpg.copy-gpg-key-id %} {% data reusables.gpg.paste-gpg-key-id %} -{% data reusables.gpg.x-509-key %} - {% endwindows %} {% linux %} @@ -101,15 +97,25 @@ If you're using a GPG key that matches your committer identity and your verified ```bash $ [ -f ~/.bashrc ] && echo 'export GPG_TTY=$(tty)' >> ~/.bashrc ``` - {% endlinux %} +{% ifversion ssh-commit-verification %} +## Telling Git about your SSH key + +You can use an existing SSH key to sign commits and tags, or generate a new one specifically for signing. 詳しい情報については、「[新しい SSH キーを生成して ssh-agent に追加する](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)」を参照してください。 + +{% data reusables.gpg.ssh-git-version %} + +{% data reusables.command_line.open_the_multi_os_terminal %} +{% data reusables.gpg.configure-ssh-signing %} +{% data reusables.gpg.copy-ssh-public-key %} +{% data reusables.gpg.paste-ssh-public-key %} + +{% endif %} + +{% data reusables.gpg.x-509-key %} ## 参考リンク -- [既存の GPG キーのチェック](/articles/checking-for-existing-gpg-keys) -- [新しい GPG キーの生成](/articles/generating-a-new-gpg-key) -- [GPG キーで検証済みのメールアドレスを使う](/articles/using-a-verified-email-address-in-your-gpg-key) -- "[Adding a GPG key to your GitHub account](/articles/adding-a-gpg-key-to-your-github-account)" -- [GPG キーとメールの関連付け](/articles/associating-an-email-with-your-gpg-key) +- "[Adding a new SSH key to your GitHub account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)." - 「[コミットに署名する](/articles/signing-commits)」 - 「[タグに署名する](/articles/signing-tags)」 diff --git a/translations/ja-JP/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md b/translations/ja-JP/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md index 10c0e66819..a54630c5bc 100644 --- a/translations/ja-JP/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md +++ b/translations/ja-JP/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md @@ -22,7 +22,10 @@ shortTitle: Check verification status 1. {% data variables.product.product_name %}上で、プルリクエストに移動します。 {% data reusables.repositories.review-pr-commits %} 3. コミットの省略されたコミットハッシュの横に、コミット署名が検証済みか{% ifversion fpt or ghec %}、部分的に検証済みか、{% endif %}未検証かを示すボックスがあります。 ![署名されたコミット](/assets/images/help/commits/gpg-signed-commit-verified-without-details.png) -4. コミットシグニチャの詳細情報を表示するには、[**検証済み**]{% ifversion fpt or ghec %}、[**部分的に検証済み**]、{% endif %}または [**未検証**] をクリックします。 ![検証された署名済みコミット](/assets/images/help/commits/gpg-signed-commit_verified_details.png) +4. コミットシグニチャの詳細情報を表示するには、[**検証済み**]{% ifversion fpt or ghec %}、[**部分的に検証済み**]、{% endif %}または [**未検証**] をクリックします。 GPG signed commits will show the ID of the key that was used. ![Verified GPG signed commit](/assets/images/help/commits/gpg-signed-commit_verified_details.png) +{% ifversion ssh-commit-verification %} + SSH signed commits will show the signature of the public key that was used. ![Verified SSH signed commit](/assets/images/help/commits/ssh-signed-commit-verified-details.png) +{% endif %} ## タグの署名検証のステータスの確認 diff --git a/translations/ja-JP/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md b/translations/ja-JP/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md index e7fb70174a..81683b18f8 100644 --- a/translations/ja-JP/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md +++ b/translations/ja-JP/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md @@ -49,9 +49,9 @@ All data transferred out, when triggered by {% data variables.product.prodname_a Storage usage is shared with build artifacts produced by {% data variables.product.prodname_actions %} for repositories owned by your account. For more information, see "[About billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)." -{% data variables.product.prodname_dotcom %} charges usage to the account that owns the repository where the package is published. If your account's usage surpasses these limits and you have set a spending limit above $0 USD, you will pay $0.25 USD per GB of storage per day and $0.50 USD per GB of data transfer. +{% data variables.product.prodname_dotcom %} charges usage to the account that owns the repository where the package is published. If your account's usage surpasses these limits and you have set a spending limit above $0 USD, you will pay $0.008 USD per GB of storage per day and $0.50 USD per GB of data transfer. -For example, if your organization uses {% data variables.product.prodname_team %}, allows unlimited spending, uses 150GB of storage, and has 50GB of data transfer out during a month, the organization would have overages of 148GB for storage and 40GB for data transfer for that month. The storage overage would cost $0.25 USD per GB per day or $37 USD. The overage for data transfer would cost $0.50 USD per GB or $20 USD. +For example, if your organization uses {% data variables.product.prodname_team %}, allows unlimited spending, uses 150GB of storage, and has 50GB of data transfer out during a month, the organization would have overages of 148GB for storage and 40GB for data transfer for that month. The storage overage would cost $0.008 USD per GB per day or approximately $37 USD for a 31-day month. The overage for data transfer would cost $0.50 USD per GB or $20 USD. {% data reusables.dotcom_billing.pricing_calculator.pricing_cal_packages %} diff --git a/translations/ja-JP/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md b/translations/ja-JP/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md index a66a670f5f..c2cba44e7f 100644 --- a/translations/ja-JP/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md +++ b/translations/ja-JP/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md @@ -32,7 +32,7 @@ There are a few approaches for tackling newly committed credentials, but one exa {% note %} - **Note:** You can automate this step. For large enterprises and organizations with hundreds of repositories, manually following up is unsustainable. You could incorporate automation into the webhook process defined in the first step. The webhook payload contains repository and organization information about the leaked secret. Using this information, you can contact the current maintainers on the repository and create a email/message to the responsible people or open an issue. + **Note:** You can automate this step. For large enterprises and organizations with hundreds of repositories, manually following up is unsustainable. You could incorporate automation into the webhook process defined in the first step. The webhook payload contains repository and organization information about the leaked secret. Using this information, you can contact the current maintainers on the repository and create an email/message to the responsible people or open an issue. {% endnote %} 3. **Educate**: Create an internal training document assigned to the developer who committed the secret. Within this training document, you can explain the risks created by committing secrets and direct them to your best practice information about using secrets securely in development. If the a developer doesn't learn from the experience and continues to commit secrets, you could create an escalation process, but education usually works well. diff --git a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md index a5948aba46..23e20a25a3 100644 --- a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md @@ -43,8 +43,8 @@ By default, the code scanning alerts page is filtered to show alerts for the def ![Summary of alerts](/assets/images/help/repository/code-scanning-click-alert.png) {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %} - {% data reusables.code-scanning.alert-default-branch %} - ![The "Affected branches" section in an alert](/assets/images/help/repository/code-scanning-affected-branches.png){% endif %} + {% data reusables.code-scanning.alert-default-branch %} + ![The "Affected branches" section in an alert](/assets/images/help/repository/code-scanning-affected-branches.png){% endif %} 1. Optionally, if the alert highlights a problem with data flow, click **Show paths** to display the path from the data source to the sink where it's used. {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %} ![The "Show paths" link on an alert](/assets/images/help/repository/code-scanning-show-paths.png) diff --git a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md index 686a099b7b..5f3939294a 100644 --- a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md @@ -32,6 +32,12 @@ topics: {% data variables.product.prodname_codeql %}は、コードをビルドするコンテナ内で実行しなければなりません。 これは、{% data variables.product.prodname_codeql_cli %}{% ifversion codeql-runner-supported %}、{% data variables.product.prodname_codeql_runner %}{% endif %}、{% data variables.product.prodname_actions %}のいずれを使っていても当てはまります。 {% data variables.product.prodname_codeql_cli %}{% ifversion codeql-runner-supported %}あるいは{% data variables.product.prodname_codeql_runner %}{% endif %}については、詳しい情報は「[CIシステムへの{% data variables.product.prodname_codeql_cli %}のインストール](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)」{% ifversion codeql-runner-supported %}あるいは「[CIシステムでの{% data variables.product.prodname_codeql_runner %}の実行](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)」{% endif %}を参照してください。 {% data variables.product.prodname_actions %} を使用している場合は、同じコンテナですべてのアクションを実行するようワークフローを設定します。 詳しい情報については「[ワークフローの例](#example-workflow)」を参照してください。 +{% note %} + +**ノート:** {% data reusables.code-scanning.non-glibc-linux-support %} + +{% endnote %} + ## 依存関係 使用しているコンテナで特定の依存関係がない場合 (たとえば、Git は PATH 変数にインストールされ、追加されている必要がある)、{% data variables.product.prodname_code_scanning %} を実行する上で困難が生じる場合があります。 依存関係の問題が生じた場合は、通常{% data variables.product.prodname_dotcom %}のランナーのイメージに含まれているソフトウェアのリストをレビューしてください。 詳しい情報については、次の場所にある特定のバージョンの `readme` ファイルを参照してください。 diff --git a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md index 52e0b98fd3..32cea9db26 100644 --- a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md @@ -151,25 +151,29 @@ The names of the {% data variables.product.prodname_code_scanning %} analysis ch ![{% data variables.product.prodname_code_scanning %} pull request checks](/assets/images/help/repository/code-scanning-pr-checks.png) -When the {% data variables.product.prodname_code_scanning %} jobs complete, {% data variables.product.prodname_dotcom %} works out whether any alerts were added by the pull request and adds the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" entry to the list of checks. After {% data variables.product.prodname_code_scanning %} has been performed at least once, you can click **Details** to view the results of the analysis. If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion fpt or ghes > 3.2 or ghae or ghec %}an "Analysis not found"{% else %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check. +When the {% data variables.product.prodname_code_scanning %} jobs complete, {% data variables.product.prodname_dotcom %} works out whether any alerts were added by the pull request and adds the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" entry to the list of checks. After {% data variables.product.prodname_code_scanning %} has been performed at least once, you can click **Details** to view the results of the analysis. -{% ifversion fpt or ghes > 3.2 or ghae or ghec %} - ![Analysis not found for commit message](/assets/images/help/repository/code-scanning-analysis-not-found.png) +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-7095 %} + +{% elsif ghes < 3.5 or ghae %} +If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion ghes > 3.2 or ghae %}an "Analysis not found"{% elsif ghes = 3.2 %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check. + +{% ifversion ghes > 3.2 or ghae %} + ![Analysis not found for commit message](/assets/images/enterprise/3.4/repository/code-scanning-analysis-not-found.png) The table lists one or more categories. Each category relates to specific analyses, for the same tool and commit, performed on a different language or a different part of the code. For each category, the table shows the two analyses that {% data variables.product.prodname_code_scanning %} attempted to compare to determine which alerts were introduced or fixed in the pull request. For example, in the screenshot above, {% data variables.product.prodname_code_scanning %} found an analysis for the merge commit of the pull request, but no analysis for the head of the main branch. -{% else %} - ![Missing analysis for commit message](/assets/images/enterprise/3.2/repository/code-scanning-missing-analysis.png) -{% endif %} -{% ifversion fpt or ghes > 3.2 or ghae or ghec %} ### Reasons for the "Analysis not found" message -{% else %} + +{% elsif ghes = 3.2 %} + ![Missing analysis for commit message](/assets/images/enterprise/3.2/repository/code-scanning-missing-analysis.png) + ### Reasons for the "Missing analysis" message {% endif %} -After {% data variables.product.prodname_code_scanning %} has analyzed the code in a pull request, it needs to compare the analysis of the topic branch (the branch you used to create the pull request) with the analysis of the base branch (the branch into which you want to merge the pull request). This allows {% data variables.product.prodname_code_scanning %} to compute which alerts are newly introduced by the pull request, which alerts were already present in the base branch, and whether any existing alerts are fixed by the changes in the pull request. Initially, if you use a pull request to add {% data variables.product.prodname_code_scanning %} to a repository, the base branch has not yet been analyzed, so it's not possible to compute these details. In this case, when you click through from the results check on the pull request you will see the {% ifversion fpt or ghes > 3.2 or ghae or ghec %}"Analysis not found"{% else %}"Missing analysis for base commit SHA-HASH"{% endif %} message. +After {% data variables.product.prodname_code_scanning %} has analyzed the code in a pull request, it needs to compare the analysis of the topic branch (the branch you used to create the pull request) with the analysis of the base branch (the branch into which you want to merge the pull request). This allows {% data variables.product.prodname_code_scanning %} to compute which alerts are newly introduced by the pull request, which alerts were already present in the base branch, and whether any existing alerts are fixed by the changes in the pull request. Initially, if you use a pull request to add {% data variables.product.prodname_code_scanning %} to a repository, the base branch has not yet been analyzed, so it's not possible to compute these details. In this case, when you click through from the results check on the pull request you will see the {% ifversion ghes > 3.2 or ghae %}"Analysis not found"{% elsif ghes = 3.2 %}"Missing analysis for base commit SHA-HASH"{% endif %} message. There are other situations where there may be no analysis for the latest commit to the base branch for a pull request. These include: @@ -177,7 +181,7 @@ There are other situations where there may be no analysis for the latest commit To check whether a branch has been scanned, go to the {% data variables.product.prodname_code_scanning_capc %} page, click the **Branch** drop-down and select the relevant branch. -![Choose a branch from the Branch drop-down menu](/assets/images/help/repository/code-scanning-branch-dropdown.png) + ![Choose a branch from the Branch drop-down menu](/assets/images/help/repository/code-scanning-branch-dropdown.png) The solution in this situation is to add the name of the base branch to the `on:push` and `on:pull_request` specification in the {% data variables.product.prodname_code_scanning %} workflow on that branch and then make a change that updates the open pull request that you want to scan. @@ -189,6 +193,8 @@ There are other situations where there may be no analysis for the latest commit Merge a trivial change into the base branch to trigger {% data variables.product.prodname_code_scanning %} on this latest commit, then push a change to the pull request to retrigger {% data variables.product.prodname_code_scanning %}. +{% endif %} + ## Next steps After setting up {% data variables.product.prodname_code_scanning %}, and allowing its actions to complete, you can: diff --git a/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md index daeb17e483..74df7049d2 100644 --- a/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md +++ b/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md @@ -45,9 +45,15 @@ If you upload a second SARIF file for a commit with the same category and from t If you're new to SARIF and want to learn more, see Microsoft's [`SARIF tutorials`](https://github.com/microsoft/sarif-tutorials) repository. -## Preventing duplicate alerts using fingerprints +## Providing data to track {% data variables.product.prodname_code_scanning %} alerts across runs -Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the right line of code when files are edited. +Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the correct line of code when files are edited. The `ruleID` for a result has to be the same across analysis. + +### Reporting consistent filepaths + +The filepath has to be consistent across the runs to enable a computation of a stable fingerprint. If the filepaths differ for the same result, each time there is a new analysis a new alert will be created, and the old one will be closed. This will cause having multiple alerts for the same result. + +### Including data for fingerprint generation {% data variables.product.prodname_dotcom %} uses the `partialFingerprints` property in the OASIS standard to detect when two results are logically identical. For more information, see the "[partialFingerprints property](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" entry in the OASIS documentation. @@ -77,6 +83,12 @@ You can check a SARIF file is compatible with {% data variables.product.prodname If you use a code analysis engine other than {% data variables.product.prodname_codeql %}, you can review the supported SARIF properties to optimize how your analysis results will appear on {% data variables.product.prodname_dotcom %}. +{% note %} + +**Note:** You must supply an explicit value for any property marked as "required". The empty string is not supported for required properties. + +{% endnote %} + Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.product.prodname_code_scanning %} will only use the following supported properties. ### `sarifLog` object @@ -138,7 +150,7 @@ Each `result` object contains details for one alert in the codebase. Within the | `level`| **Optional.** The severity of the result. This level overrides the default severity defined by the rule. {% data variables.product.prodname_code_scanning_capc %} uses the level to filter results by severity on {% data variables.product.prodname_dotcom %}. | `message.text`| **Required.** A message that describes the result. {% data variables.product.prodname_code_scanning_capc %} displays the message text as the title of the result. Only the first sentence of the message will be displayed when visible space is limited. | `locations[]`| **Required.** The set of locations where the result was detected up to a maximum of 10. Only one location should be included unless the problem can only be corrected by making a change at every specified location. **Note:** At least one location is required for {% data variables.product.prodname_code_scanning %} to display a result. {% data variables.product.prodname_code_scanning_capc %} will use this property to decide which file to annotate with the result. Only the first value of this array is used. All other values are ignored. -| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Preventing duplicate alerts using fingerprints](#preventing-duplicate-alerts-using-fingerprints)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. +| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Providing data to track code scanning alerts across runs](#providing-data-to-track-code-scanning-alerts-across-runs)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. | `codeFlows[].threadFlows[].locations[]`| **Optional.** An array of `location` objects for a `threadFlow` object, which describes the progress of a program through a thread of execution. A `codeFlow` object describes a pattern of code execution used to detect a result. If code flows are provided, {% data variables.product.prodname_code_scanning %} will expand code flows on {% data variables.product.prodname_dotcom %} for the relevant result. For more information, see the [`location` object](#location-object). | `relatedLocations[]`| A set of locations relevant to this result. {% data variables.product.prodname_code_scanning_capc %} will link to related locations when they are embedded in the result message. For more information, see the [`location` object](#location-object). @@ -204,7 +216,7 @@ These example SARIF output files show supported properties and example values. ### Example with minimum required properties -This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties or don't include values, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. +This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties, omit values, or use an empty string, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. ```json { diff --git a/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md b/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md index 1e03a239f3..193ee54f5a 100644 --- a/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md +++ b/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md @@ -58,7 +58,7 @@ For more information see the [`upload-sarif` action](https://github.com/github/c The `upload-sarif` action can be configured to run when the `push` and `scheduled` event occur. For more information about {% data variables.product.prodname_actions %} events, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#preventing-duplicate-alerts-using-fingerprints)." +If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#providing-data-to-track-code-scanning-alerts-across-runs)." {% data reusables.code-scanning.upload-sarif-alert-limit %} diff --git a/translations/ja-JP/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md b/translations/ja-JP/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md index 5710bee622..1a2e15b3a5 100644 --- a/translations/ja-JP/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md +++ b/translations/ja-JP/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md @@ -37,20 +37,40 @@ topics: コードベースが既知のセキュリティリスクのある依存関係を使用していることを検出すると、{% data variables.product.product_name %} は {% data variables.product.prodname_dependabot_alerts %} を生成します。 {% data variables.product.prodname_dependabot_security_updates %} が有効になっているリポジトリの場合、{% data variables.product.product_name %} がデフォルトのブランチで脆弱性のある依存関係を検出すると、{% data variables.product.prodname_dependabot %} はそれを修正するためのプルリクエストを作成します。 プルリクエストは、脆弱性を回避するために必要最低限の安全なバージョンに依存関係をアップグレードします。 -{% ifversion dependabot-most-important-sort-option %} デフォルトでは、{% data variables.product.prodname_dependabot_alerts %}は重要度の順に{% data variables.product.prodname_dependabot_alerts %}タブに表示されますが、他の基準でアラートをソートできます。 {% endif %}{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5638 %}{% data variables.product.prodname_dependabot_alerts %}タブのドロップダウンメニューを使って、あるいはフィルタを検索バーで`key:value`ペアを入力することによって{% data variables.product.prodname_dependabot_alerts %}をソート及びフィルタリングしたりできます。 利用可能なフィルタは、リポジトリ（たとえば`repo:my-repository`）、パッケージ（たとえば`package:django`）、エコシステム（たとえば`ecosystem:npm`）、マニフェスト（たとえば`manifest:webwolf/pom.xml`）、状態（たとえば`is:open`）、アドバイザリがパッチを持っているか（たとえば`has: patch`）です。{% ifversion dependabot-alerts-development-label %}たとえば`scope:development`あるいは`scope:runtime`というように、`scope`を使って依存関係のスコープデータでアラートをフィルタすることもできます。 `scope:development`を指定すると、アラートのリストは実働ではなく開発の間に使われた依存関係だけを表示します。{% endif %} - それぞれの{% data variables.product.prodname_dependabot %}アラートは一意の数値識別子を持っており、{% data variables.product.prodname_dependabot_alerts %}タブにはすべての検出された脆弱性に対するアラートがリストされます。 旧来の{% data variables.product.prodname_dependabot_alerts %}は依存関係で脆弱性をグループ化し、依存関係ごとに1つのアラートを生成しました。 旧来の{% data variables.product.prodname_dependabot %}アラートにアクセスすると、そのパッケージでフィルタされた{% data variables.product.prodname_dependabot_alerts %}タブにリダイレクトされます。 {% endif %} + +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5638 %} +ユーザインターフェースで利用できる様々なフィルタとソートのオプションを使って、{% data variables.product.prodname_dependabot_alerts %}をフィルタリング及びソートできます。 詳しい情報については下の「[{% data variables.product.prodname_dependabot_alerts %}の優先順位付け](#prioritizing-across--data-variablesproductprodname_dependabot_alerts-)」を参照してください。 + +## {% data variables.product.prodname_dependabot_alerts %}の優先順位付け + +{% data variables.product.company_short %}は{% data variables.product.prodname_dependabot_alerts %}の修正の優先順位付けに役立ちます。 {% ifversion dependabot-most-important-sort-option %}デフォルトでは、{% data variables.product.prodname_dependabot_alerts %}は重要度でソートされます。 "Most important（重要な順）"のソート順は、まず焦点を置くべき{% data variables.product.prodname_dependabot_alerts %}の優先順位付けを助けてくれます。 アラートは、潜在的な影響、行動可能性、関連性に基づいてランク付けされます。 優先順位の計算は常に改善されており、CSVVスコア、依存関係スコープ、脆弱性のある関数呼び出しがアラートで見つかっているかといった要素を含みます。 + +!["Most important"ソートのあるソートドロップダウンのスクリーンショット](/assets/images/help/dependabot/dependabot-alerts-sort-dropdown.png) {% endif %} +{% data reusables.dependabot.dependabot-alerts-filters %} + +検索バーを通じて利用できるフィルタに加えて、アラートリストの上部にあるドロップダウンメニューを使って{% data variables.product.prodname_dependabot_alerts %}をソート及びフィルタリングできます。 検索バーでは、アラートと関連するセキュリティアドバイザリの全文検索もできます。 セキュリティアドバイザリ名または説明の一部を検索して、そのセキュリティアドバイザリに関連するリポジトリ内のアラートを返させることができます。 たとえば`yaml.load() API could execute arbitrary code`を検索すれば、この検索文字列はアドバイザリの説明にあるので「[PyYAML insecurely deserializes YAML strings leading to arbitrary code execution](https://github.com/advisories/GHSA-rprw-h62v-c2w7)」にリンクされた{% data variables.product.prodname_dependabot_alerts %}が返されます。 + +{% endif %} + +{% ifversion dependabot-bulk-alerts %} + ![{% data variables.product.prodname_dependabot_alerts %}タブ中のフィルタ及びソートメニューのスクリーンショット](/assets/images/help/graphs/dependabot-alerts-filters-checkbox.png){% elsif ghes = 3.5 %} +リストの上部にあるドロップダウンメニューでフィルタを選択し、続いて適用したいフィルタをクリックできます。 ![Screenshot of the filter and sort menus in the {% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/enterprise/3.5/dependabot/dependabot-alerts-filters.png){% endif %} + {% ifversion dependabot-alerts-development-label %} ## 依存関係のスコープに対してサポートされているエコシステムとマニフェスト - {% data reusables.dependabot.dependabot-alerts-dependency-scope %} -開発時の依存関係としてリストされているパッケージに対するアラートは、{% data variables.product.prodname_dependabot_alerts %}のページ上で`Development`ラベルでマークされており、`scope`フィルタでフィルタリングすることもできます。 ![アラートのリスト内の"Development"を表示しているスクリーンショット](/assets/images/help/repository/dependabot-alerts-development-label.png) +開発時の依存関係としてリストされているパッケージに対するアラートは、{% data variables.product.prodname_dependabot_alerts %}のページ上で`Development`ラベルでマークされており、`scope`フィルタでフィルタリングすることもできます。 -開発スコープのパッケージに対するアラートの詳細ページには、`Development`ラベルを含むTags"セクションが表示されます。 ![アラートの詳細ページ内の"Tags"セクションを表示しているスクリーンショット](/assets/images/help/repository/dependabot-alerts-tags-section.png) +![アラートのリスト内の"Development"を表示しているスクリーンショット](/assets/images/help/repository/dependabot-alerts-development-label.png) + +開発スコープのパッケージに対するアラートの詳細ページには、`Development`ラベルを含むTags"セクションが表示されます。 + +![アラートの詳細ページ内の"Tags"セクションを表示しているスクリーンショット](/assets/images/help/repository/dependabot-alerts-tags-section.png) {% endif %} @@ -90,23 +110,10 @@ topics: {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-dependabot-alerts %} -1. あるいは、アラートをフィルタリングするには、**Repository（リポジトリ）**、**Package（パッケージ）**、**Ecosystem（エコシステム）**、**Manifest（マニフェスト）**ドロップダウンメニューを選択し、続いて適用したいフィルタをクリックしてください。 検索バーにフィルタを入力することもできます。 たとえば`ecosystem:npm`{% ifversion ghes < 3.7 or ghae-issue-5638 %}もしくは`has:patch`{% endif %}{% ifversion dependabot-alerts-development-label %}、`has:patch`、`scope:development`{% endif %}。 アラートをソートするには、**Sort（ソート）**ドロップダウンメニューを選択し、ソートの基準にしたいオプションをクリックするか、検索バーに`sort:`と入力してから、候補（たとえば`sort:newest`）から選択肢を選んでください。 - - {% ifversion dependabot-most-important-sort-option %} - {% note %} - - **ノート:** デフォルトでは、{% data variables.product.prodname_dependabot_alerts %}は重要度でソートされています。 "Most important（重要な順）"ソートは、まず焦点を置くべき{% data variables.product.prodname_dependabot_alerts %}の優先順位付けを助けてくれます。 アラートは、潜在的な影響、行動可能性、関連性に基づいてランク付けされます。 優先順位の計算は常に改善されており、CSVVスコア、依存関係スコープ、脆弱性のある関数呼び出しがアラートで見つかっているかといった要素を含みます。 - {% endnote %} - - !["Most important"ソートのあるソートドロップダウンのスクリーンショット](/assets/images/help/dependabot/dependabot-alerts-sort-dropdown.png) - {% endif %} - - アラートのラベルをクリックして、その種類のアラートだけを表示させることもできます。{% ifversion dependabot-alerts-development-label %}たとえば、アラートのリスト内の`Development`ラベルをクリックすれば、実働ではなく開発で使われている依存関係に関係するアラートだけが表示されます。 サポートされているエコシステムのリストに関する情報については「[依存関係スコープでサポートされているエコシステムとマニフェスト](#supported-ecosystems-and-manifests-for-dependency-scope)」を参照してください。 - -{% endif %} +1. あるいは、アラートをフィルタリングするには、ドロップダウンメニューでフィルタを選択し、続いて適用したいフィルタをクリックしてください。 検索バーにフィルタを入力することもできます。 アラートのフィルタリングとソートに関する詳しい情報については「[{% data variables.product.prodname_dependabot_alerts %}の優先順位付け](#prioritizing-across--data-variablesproductprodname_dependabot_alerts-)」を参照してください。 {%- ifversion dependabot-bulk-alerts %} ![{% data variables.product.prodname_dependabot_alerts %}タブ中のフィルタ及びソートメニューのスクリーンショット](/assets/images/help/graphs/dependabot-alerts-filters-checkbox.png){% else %} - ![Screenshot of the filter and sort menus in the {% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/enterprise/3.5/dependabot/dependabot-alerts-filters.png){% endif %} +![Screenshot of the filter and sort menus in the {% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/enterprise/3.5/dependabot/dependabot-alerts-filters.png){% endif %} 1. 表示したいアラートをクリックしてください。{% ifversion dependabot-bulk-alerts %} ![Alert selected in list of alerts](/assets/images/help/graphs/click-alert-in-alerts-list-checkbox.png){% else %} ![Alert selected in list of alerts](/assets/images/enterprise/3.5/dependabot/click-alert-in-alerts-list-ungrouped.png){% endif %} @@ -156,7 +163,12 @@ topics: 依存関係のアップグレードのための広汎な作業をスケジュールしていたり、アラートを修正する必要はないと判断したりした場合、アラートを却下できます。 すでに評価済みのアラートを却下すると、新しいアラートが現れたときにトリアージしやすくなります。 1. アラートの詳細を表示させます。 詳しい情報については上の「[脆弱性のある依存関係の表示](#viewing-dependabot-alerts)」を参照してください。 -1. "Dismiss（却下）"ドロップダウンを選択し、アラートを却下する理由をクリックしてください。{% ifversion reopen-dependabot-alerts %}却下された未修正のアラートは、後で再度オープンできます。{% endif %} ![[Dismiss] ドロップダウンでアラートを却下する理由を選択する](/assets/images/help/repository/dependabot-alert-dismiss-drop-down-ungrouped.png) +1. "Dismiss（却下）"ドロップダウンを選択し、アラートを却下する理由をクリックしてください。{% ifversion reopen-dependabot-alerts %}却下された未修正のアラートは、後で再度オープンできます。{% endif %} +{% ifversion dependabot-alerts-dismissal-comment %}1. あるいは、却下のコメントを追加してください。 却下のコメントはアラートのタイムラインに追加され、監査とレポートの際の正当性として利用できます。 GraphQL APIを使って、コメントの取得や設定ができます。 コメントは`dismissComment`フィールドに含まれます。 詳しい情報については、GraphQL APIドキュメンテーションの「[{% data variables.product.prodname_dependabot_alerts %}](/graphql/reference/objects#repositoryvulnerabilityalert)を参照してください。 + ![却下のコメントを追加するオプション付きで、"Dismiss"ドロップダウンからアラートを却下する方法を示しているスクリーンショット](/assets/images/help/repository/dependabot-alerts-dismissal-comment.png) +1. **Dismiss alert（アラートを却下）**をクリックしてください。 +{% else %} + ![[Dismiss] ドロップダウンでアラートを却下する理由を選択する](/assets/images/help/repository/dependabot-alert-dismiss-drop-down-ungrouped.png){% endif %} {% ifversion dependabot-bulk-alerts %} ### 複数のアラートを一度に却下する diff --git a/translations/ja-JP/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md b/translations/ja-JP/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md index aafa359dad..25efa92f84 100644 --- a/translations/ja-JP/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md +++ b/translations/ja-JP/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md @@ -415,7 +415,7 @@ updates: ### `open-pull-requests-limit` -デフォルトでは、{% data variables.product.prodname_dependabot %} は、バージョン更新に対して最大 5 つのプルリクエストをオープンします。 5 つのプルリクエストがオープンになると、オープンになっているリクエストの一部をマージまたはクローズするまで、新しいリクエストはブロックされます。オープンになっているリクエストの一部をマージまたはクローズしたら、その後の更新で新しいプルリクエストを開くことができます。 この制限を変更するには、`open-pull-requests-limit` を使用します。 これは、パッケージマネージャーのバージョン更新を一時的に無効にする簡単な方法としても使用できます。 +デフォルトでは、{% data variables.product.prodname_dependabot %} は、バージョン更新に対して最大 5 つのプルリクエストをオープンします。 {% data variables.product.prodname_dependabot %}からのオープンなPull Requestが5つあると、それらのオープンなリクエストからマージもしくはクローズされたものが出てくるまでは、{% data variables.product.prodname_dependabot %}は新しいリクエストをオープンしません。 この制限を変更するには、`open-pull-requests-limit` を使用します。 これは、パッケージマネージャーのバージョン更新を一時的に無効にする簡単な方法としても使用できます。 このオプションはセキュリティアップデートに影響を与えません。セキュリティアップデートには、10 件のオープンプルリクエストの内部制限があります。 diff --git a/translations/ja-JP/content/code-security/secret-scanning/about-secret-scanning.md b/translations/ja-JP/content/code-security/secret-scanning/about-secret-scanning.md index 481ec138e4..0110c45c23 100644 --- a/translations/ja-JP/content/code-security/secret-scanning/about-secret-scanning.md +++ b/translations/ja-JP/content/code-security/secret-scanning/about-secret-scanning.md @@ -39,7 +39,7 @@ Service providers can partner with {% data variables.product.company_short %} to {% ifversion secret-scanning-push-protection %} -You can also enable {% data variables.product.prodname_secret_scanning %} as a push protection for a repository or an organization. When you enable this feature, {% data variables.product.prodname_secret_scanning %} prevents contributors from pushing code with a detected secret. To proceed, contributors must either remove the secret(s) from the push or, if needed, bypass the protection. For more information, see "[Protecting pushes with {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." +You can also enable {% data variables.product.prodname_secret_scanning %} as a push protection for a repository or an organization. When you enable this feature, {% data variables.product.prodname_secret_scanning %} prevents contributors from pushing code with a detected secret. To proceed, contributors must either remove the secret(s) from the push or, if needed, bypass the protection. {% ifversion push-protection-custom-link-orgs %}Admins can also specify a custom link that is displayed to the contributor when a push is blocked; the link can contain resources specific to the organization to aid contributors. {% endif %}For more information, see "[Protecting pushes with {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." {% endif %} diff --git a/translations/ja-JP/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md b/translations/ja-JP/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md index af2fe9a6c9..5dad5906eb 100644 --- a/translations/ja-JP/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md +++ b/translations/ja-JP/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md @@ -60,8 +60,20 @@ shortTitle: プッシュ保護の有効化 コマンドラインでは、一度に最大で5つの検出されたシークレットが表示されます。 特定のシークレットが既にリポジトリ中で検出されており、アラートが既に存在するなら、{% data variables.product.prodname_dotcom %}はそのシークレットをブロックしません。 +{% ifversion push-protection-custom-link-orgs %} + +Organizationの管理者は、プッシュがブロックされたときに表示されるカスタムリンクを提供できます。 このカスタムリンクには、Organization固有のリソースと、利用を進めるシークレットの保管庫や、ブロックされたシークレットに関連して質問の連絡を取る相手といったアドバイスを含めることができます。 + +{% ifversion push-protection-custom-link-orgs-beta %}{% data reusables.advanced-security.custom-link-beta %}{% endif %} + +![ユーザがシークレットをリポジトリにプッシュしようとしたときにプッシュがブロックされたことを示しているスクリーンショット](/assets/images/help/repository/secret-scanning-push-protection-with-custom-link.png) + +{% else %} + ![ユーザがシークレットをリポジトリにプッシュしようとしたときにプッシュがブロックされたことを示しているスクリーンショット](/assets/images/help/repository/secret-scanning-push-protection-with-link.png) +{% endif %} + {% data reusables.secret-scanning.push-protection-remove-secret %} ブロックされたシークレットの修復に関する詳しい情報については「[プッシュ保護によってブロックされたブランチのプッシュ](/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection#resolving-a-blocked-push-on-the-command-line)」を参照してください。 シークレットが本物であることが確認され、後で修復しようと考えているなら、できるかぎり早くそのシークレットを修復すべきです。 たとえば、そのシークレットを取り消して、リポジトリのコミット履歴から削除することになるでしょう。 露出してしまった実際のシークレットは、不正アクセスを避けるために取り消さなければなりません。 取り消す前にシークレットをまずローテートすることを検討すべきかもしれません。 詳しい情報については「[センシティブなデータをリポジトリから削除する](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)」を参照してください。 @@ -88,6 +100,14 @@ shortTitle: プッシュ保護の有効化 Web UIでは、{% data variables.product.prodname_dotcom %}は検出されたシークレットを一度に1つだけしか表示しません。 特定のシークレットが既にリポジトリ中で検出されており、アラートが既に存在するなら、{% data variables.product.prodname_dotcom %}はそのシークレットをブロックしません。 +{% ifversion push-protection-custom-link-orgs %} + +Organizationの管理者は、プッシュがブロックされたときに表示されるカスタムリンクを提供できます。 このカスタムリンクには、Organization固有のリソースやアドバイスを含めることができます。 たとえば、このカスタムリンクはOrganizationのシークレットの保管庫に関する情報を持つREADMEファイルや、質問のエスカレート先のチームや個人、あるいはOrganizationで承認されたシークレットの扱いやコミット履歴の書き換えのポリシーなどを指すようにすることができます。 + +{% ifversion push-protection-custom-link-orgs-beta %}{% data reusables.advanced-security.custom-link-beta %}{% endif %} + +{% endif %} + Web UIを使って、シークレットをファイルから削除できます。 シークレットを削除すると、ページ上部のバナーは変化し、変更をコミットできるようになったことを知らせてくれます。 ![シークレットの修正後にコミットが許可されたことをWeb Uiで表示しているスクリーンショット](/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-allowed.png) diff --git a/translations/ja-JP/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md b/translations/ja-JP/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md index e9aba789dd..f8cb7656a3 100644 --- a/translations/ja-JP/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md +++ b/translations/ja-JP/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md @@ -26,6 +26,14 @@ shortTitle: ブロックされたブランチのプッシュ {% endtip %} +{% ifversion push-protection-custom-link-orgs %} + +Organizationの管理者は、プッシュがブロックされた際の{% data variables.product.product_name %}からのメッセージに含められるカスタムリンクを提供できます。 このカスタムリンクには、Organization固有のリソースやアドバイスと、Organizationのポリシーを含めることができます。 + +{% ifversion push-protection-custom-link-orgs-beta %}{% data reusables.advanced-security.custom-link-beta %}{% endif %} + +{% endif %} + ## ブロックされたプッシュのコマンドラインでの解決 {% data reusables.secret-scanning.push-protection-command-line-choice %} diff --git a/translations/ja-JP/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md b/translations/ja-JP/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md index 7f94a835ea..f71712faf0 100644 --- a/translations/ja-JP/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md +++ b/translations/ja-JP/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md @@ -12,25 +12,25 @@ shortTitle: プライベートイメージレジストリ ## About private image registries and {% data variables.product.prodname_github_codespaces %} -A registry is a secure space for storing, managing, and fetching private container images. You may use one to store one or more images. There are many examples of registries, such as {% data variables.product.prodname_dotcom %} Container Registry, Azure Container Registry, or DockerHub. +A registry is a secure space for storing, managing, and fetching private container images. You may use one to store one or more images. There are many examples of registries, such as {% data variables.product.prodname_container_registry %}, {% data variables.product.prodname_npm_registry %}, Azure Container Registry, or DockerHub. -{% data variables.product.prodname_dotcom %} Container Registry can be configured to pull container images seamlessly, without having to provide any authentication credentials to {% data variables.product.prodname_github_codespaces %}. For other image registries, you must create secrets in {% data variables.product.prodname_dotcom %} to store the access details, which will allow {% data variables.product.prodname_codespaces %} to access images stored in that registry. +{% data variables.product.prodname_ghcr_and_npm_registry %} can be configured to allow container images to be pulled seamlessly into {% data variables.product.prodname_github_codespaces %} during codespace creation, without having to provide any authentication credentials. For other image registries, you must create secrets in {% data variables.product.prodname_dotcom %} to store the access details, which will allow {% data variables.product.prodname_codespaces %} to access images stored in that registry. -## Accessing images stored in {% data variables.product.prodname_dotcom %} Container Registry +## Accessing images stored in {% data variables.product.prodname_ghcr_and_npm_registry %} -{% data variables.product.prodname_dotcom %} Container Registry is the easiest way for {% data variables.product.prodname_codespaces %} to consume devcontainer container images. +{% data variables.product.prodname_ghcr_and_npm_registry %} provide the easiest way for {% data variables.product.prodname_codespaces %} to consume dev container images. -For more information, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)". +For more information, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)" and "[Working with the npm registry](/packages/working-with-a-github-packages-registry/working-with-the-npm-registry)". ### Accessing an image published to the same repository as the codespace -If you publish a container image to {% data variables.product.prodname_dotcom %} Container Registry in the same repository that the codespace is being launched in, you will automatically be able to fetch that image on codespace creation. You won't have to provide any additional credentials, unless the **Inherit access from repo** option was unselected when the container image was published. +If you publish a container image to {% data variables.product.prodname_ghcr_or_npm_registry %} in the same repository that the codespace is being launched in, you will automatically be able to fetch that image on codespace creation. You won't have to provide any additional credentials, unless the **Inherit access from repo** option was unselected when the container image was published. #### Inheriting access from the repository from which an image was published -By default, when you publish a container image to {% data variables.product.prodname_dotcom %} Container Registry, the image inherits the access setting of the repository from which the image was published. For example, if the repository is public, the image is also public. If the repository is private, the image is also private, but is accessible from the repository. +By default, when you publish a container image to {% data variables.product.prodname_ghcr_or_npm_registry %}, the image inherits the access setting of the repository from which the image was published. For example, if the repository is public, the image is also public. If the repository is private, the image is also private, but is accessible from the repository. -This behavior is controlled by the **Inherit access from repo** option. **Inherit access from repo** is selected by default when publishing via {% data variables.product.prodname_actions %}, but not when publishing directly to {% data variables.product.prodname_dotcom %} Container Registry using a Personal Access Token (PAT). +This behavior is controlled by the **Inherit access from repo** option. **Inherit access from repo** is selected by default when publishing via {% data variables.product.prodname_actions %}, but not when publishing directly to {% data variables.product.prodname_ghcr_or_npm_registry %} using a Personal Access Token (PAT). If the **Inherit access from repo** option was not selected when the image was published, you can manually add the repository to the published container image's access controls. 詳しい情報については「[パッケージのアクセス制御と可視性](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#inheriting-access-for-a-container-image-from-a-repository)」を参照してください。 @@ -46,13 +46,13 @@ If you want to allow a subset of an organization's repositories to access a cont ### Publishing a container image from a codespace -Seamless access from a codespace to {% data variables.product.prodname_dotcom %} Container Registry is limited to pulling container images. If you want to publish a container image from inside a codespace, you must use a personal access token (PAT) with the `write:packages` scope. +Seamless access from a codespace to {% data variables.product.prodname_ghcr_or_npm_registry %} is limited to pulling container images. If you want to publish a container image from inside a codespace, you must use a personal access token (PAT) with the `write:packages` scope. -We recommend publishing images via {% data variables.product.prodname_actions %}. For more information, see "[Publishing Docker images](/actions/publishing-packages/publishing-docker-images)." +We recommend publishing images via {% data variables.product.prodname_actions %}. For more information, see "[Publishing Docker images](/actions/publishing-packages/publishing-docker-images)" and "[Publishing Node.js packages](/actions/publishing-packages/publishing-nodejs-packages)." ## Accessing images stored in other container registries -If you are accessing a container image from a registry that isn't {% data variables.product.prodname_dotcom %} Container Registry, {% data variables.product.prodname_codespaces %} checks for the presence of three secrets, which define the server name, username, and personal access token (PAT) for a container registry. これらのシークレットが見つかった場合、{% data variables.product.prodname_github_codespaces %} はレジストリを codespace 内で使用できるようにします。 +If you are accessing a container image from a registry that isn't {% data variables.product.prodname_ghcr_or_npm_registry %}, {% data variables.product.prodname_codespaces %} checks for the presence of three secrets, which define the server name, username, and personal access token (PAT) for a container registry. これらのシークレットが見つかった場合、{% data variables.product.prodname_github_codespaces %} はレジストリを codespace 内で使用できるようにします。 - `<*>_CONTAINER_REGISTRY_SERVER` - `<*>_CONTAINER_REGISTRY_USER` diff --git a/translations/ja-JP/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md b/translations/ja-JP/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md index 77bd7be249..9781ece278 100644 --- a/translations/ja-JP/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md +++ b/translations/ja-JP/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md @@ -90,15 +90,13 @@ You can add further script, preferences, configuration files to your dotfiles re If your codespace fails to pick up configuration settings from dotfiles, see "[Troubleshooting dotfiles for {% data variables.product.prodname_codespaces %}](/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces)." -## Other available settings - You can also personalize {% data variables.product.prodname_codespaces %} using additional [{% data variables.product.prodname_codespaces %} settings](https://github.com/settings/codespaces): -- To set your default region, see "[Setting your default region for {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces)." -- To set your editor, see "[Setting your default editor for {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces)." -- To add encrypted secrets, see "[Managing encrypted secrets for {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces)." - To enable GPG verification, see "[Managing GPG verification for {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)." -- To allow your codespaces to access other repositories, see "[Managing repository access for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces)." +- To set your editor, see "[Setting your default editor for {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces)." +- To set how long a codespace can remain unused before it is automatically stopped, see "[Setting your timeout period for GitHub Codespaces](/codespaces/customizing-your-codespace/setting-your-timeout-period-for-github-codespaces)." +- To set the period for which your unused codespaces are retained, see "[Configuring automatic deletion of your codespaces](/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces)." +- To set your default region, see "[Setting your default region for {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces)." ## Further reading diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/creating-a-codespace.md index d4164f266b..8b9766e0d6 100644 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ b/translations/ja-JP/content/codespaces/developing-in-codespaces/creating-a-codespace.md @@ -2,7 +2,6 @@ title: codespace を作成する intro: リポジトリのブランチの codespace を作成して、オンラインで開発できます。 product: '{% data reusables.gated-features.codespaces %}' -permissions: '{% data reusables.codespaces.availability %}' redirect_from: - /github/developing-online-with-github-codespaces/creating-a-codespace - /github/developing-online-with-codespaces/creating-a-codespace @@ -21,7 +20,7 @@ shortTitle: Create a codespace You can create a codespace on {% data variables.product.prodname_dotcom_the_website %}, in {% data variables.product.prodname_vscode %}, or by using {% data variables.product.prodname_cli %}. {% data reusables.codespaces.codespaces-are-personal %} -Codespaces はリポジトリの特定のブランチに関連付けられており、リポジトリを空にすることはできません。 {% data reusables.codespaces.concurrent-codespace-limit %}詳しい情報については、「[codespace を削除する](/github/developing-online-with-codespaces/deleting-a-codespace)」を参照してください。 +Codespaces はリポジトリの特定のブランチに関連付けられており、リポジトリを空にすることはできません。 {% data reusables.codespaces.concurrent-codespace-limit %} When you create a codespace, a number of steps happen to create and connect you to your development environment: @@ -45,27 +44,22 @@ If you want to use Git hooks for your codespace, then you should set up hooks us ## Access to {% data variables.product.prodname_github_codespaces %} -{% data reusables.codespaces.availability %} - When you have access to {% data variables.product.prodname_github_codespaces %}, you'll see a "Codespaces" tab within the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu when you view a repository. -You'll have access to codespaces under the following conditions: +You'll have access to {% data variables.product.prodname_github_codespaces %} under the following conditions: -* You are a member of an organization that has enabled {% data variables.product.prodname_codespaces %} and set a spending limit. -* An organization owner has granted you access to {% data variables.product.prodname_codespaces %}. -* The repository is owned by the organization that has enabled {% data variables.product.prodname_codespaces %}. +Either all of these are true: +* You are a member, or outside collaborator, of an organization that has enabled {% data variables.product.prodname_codespaces %} and set a spending limit. +* The organization owner has allowed you to create codespaces at the organization's expense. +* The repository for which you want to create a codespace is owned by this organization. -{% note %} - -**Note:** Individuals who have already joined the beta with their personal {% data variables.product.prodname_dotcom %} account will not lose access to {% data variables.product.prodname_codespaces %}, however {% data variables.product.prodname_codespaces %} for individuals will continue to remain in beta. - -{% endnote %} - -Organization owners can allow all members of the organization to create codespaces, limit codespace creation to selected organization members, or disable codespace creation. For more information about managing access to codespaces within your organization, see "[Enable Codespaces for users in your organization](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization#enable-codespaces-for-users-in-your-organization)." +Or both of these are true: +* You are participating in the beta of {% data variables.product.prodname_codespaces %} for individual users. +* Either you own the repository for which you want to create a codespace, or it is owned by an organization of which you are either a member or an outside collaborator. Before {% data variables.product.prodname_codespaces %} can be used in an organization, an owner or billing manager must have set a spending limit. For more information, see "[About spending limits for Codespaces](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces#about-spending-limits-for-codespaces)." -If you would like to create a codespace for a repository owned by your personal account or another user, and you have permission to create repositories in an organization that has enabled {% data variables.product.prodname_github_codespaces %}, you can fork user-owned repositories to that organization and then create a codespace for the fork. +Organization owners can specify who can create and use codespaces at the organization's expense. Organization owners can also prevent any codespace usage being charged to the organization. For more information, see "[Enabling {% data variables.product.prodname_github_codespaces %} for your organization](/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization#choose-who-can-create-codespaces-that-are-billed-to-your-organization)." ## codespace を作成する diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace.md index 99cc389a24..efc1b97870 100644 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace.md +++ b/translations/ja-JP/content/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace.md @@ -2,7 +2,6 @@ title: Default environment variables for your codespace shortTitle: デフォルトの環境変数 product: '{% data reusables.gated-features.codespaces %}' -permissions: '{% data reusables.codespaces.availability %}' intro: '{% data variables.product.prodname_dotcom %} sets default environment variables for each codespace.' versions: fpt: '*' diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md index 0dbfcc71be..255c770297 100644 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md +++ b/translations/ja-JP/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md @@ -2,7 +2,6 @@ title: codespace で開発する intro: '{% data variables.product.product_name %} で codespace を開き、{% data variables.product.prodname_vscode %} の機能を使用して開発できます。' product: '{% data reusables.gated-features.codespaces %}' -permissions: 'You can develop in codespaces you''ve created for repositories owned by organizations using {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %}.' redirect_from: - /github/developing-online-with-github-codespaces/developing-in-a-codespace - /github/developing-online-with-codespaces/developing-in-a-codespace diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/renaming-a-codespace.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/renaming-a-codespace.md index cc0ca02af9..fb0484b87d 100644 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/renaming-a-codespace.md +++ b/translations/ja-JP/content/codespaces/developing-in-codespaces/renaming-a-codespace.md @@ -27,7 +27,9 @@ To find the display name of a codespace: ![Screenshot of the Remote Explorer in VS Code](/assets/images/help/codespaces/codespaces-remote-explorer.png) +{% indented_data_reference reusables.codespaces.remote-explorer spaces=2 %} - In a terminal window on your local machine, use this {% data variables.product.prodname_cli %} command: `gh codespace list`. + ### Permanent codespace names In addition to the display name, when you create a codespace, a permanent name is also assigned to the codespace. The name is a combination of your {% data variables.product.company_short %} handle, the repository name, and some random characters. For example: `octocat-myrepo-gmc7`. You can't change this name. diff --git a/translations/ja-JP/content/codespaces/guides.md b/translations/ja-JP/content/codespaces/guides.md index 8349120fb8..59bdf9721a 100644 --- a/translations/ja-JP/content/codespaces/guides.md +++ b/translations/ja-JP/content/codespaces/guides.md @@ -40,7 +40,6 @@ includeGuides: - /codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization - /codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization - /codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces - - /codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces - /codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types - /codespaces/managing-codespaces-for-your-organization/retricting-the-idle-timeout-period - /codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces diff --git a/translations/ja-JP/content/codespaces/index.md b/translations/ja-JP/content/codespaces/index.md index 9a79bd2714..cd1444eae7 100644 --- a/translations/ja-JP/content/codespaces/index.md +++ b/translations/ja-JP/content/codespaces/index.md @@ -7,11 +7,11 @@ introLinks: quickstart: /codespaces/getting-started/quickstart featuredLinks: guides: - - /billing/managing-billing-for-github-codespaces/about-billing-for-codespaces - /codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization - - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project - - /codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces - /codespaces/developing-in-codespaces/codespaces-lifecycle + - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project + - /codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces + - /billing/managing-billing-for-github-codespaces/about-billing-for-codespaces popular: - /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces - /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces diff --git a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md index db2f279779..8a9f270e83 100644 --- a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md +++ b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md @@ -1,9 +1,9 @@ --- title: Enabling GitHub Codespaces for your organization -shortTitle: Enable Codespaces -intro: 'Organization 内のどのユーザが {% data variables.product.prodname_github_codespaces %} を使用できるかを制御できます。' +shortTitle: 'Enable {% data variables.product.prodname_codespaces %}' +intro: 'You can control which users in your organization can use {% data variables.product.prodname_github_codespaces %} at the organization''s expense.' product: '{% data reusables.gated-features.codespaces %}' -permissions: 'To manage user permissions for {% data variables.product.prodname_github_codespaces %} for an organization, you must be an organization owner.' +permissions: 'To alter an organization''s billing settings, you must be an organization owner.' redirect_from: - /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization - /codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization @@ -13,25 +13,23 @@ versions: type: how_to topics: - Codespaces - - Permissions + - Billing - Administrator --- - ## About enabling {% data variables.product.prodname_github_codespaces %} for your organization -Organization のオーナーは、Organization 内のどのユーザが Codespaces を作成および使用できるかを制御できます。 +Organization owners can control which users in your organization can create and use codespaces at the organization's expense. -To use codespaces in your organization, you must do the following: +Only people who can clone a repository can create a codespace for that repository. To allow people to create codespaces for repositories owned by your organization, you must: + +- Ensure that users have at least write access to the repositories where they want to use a codespace. 詳しい情報については「[リポジトリへのアクセスを持つTeamや人の管理](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)」を参照してください。 +- Ensure that your organization does not have an IP address allow list enabled. For more information, see "[Managing allowed IP addresses for your organization](/{% ifversion fpt %}enterprise-cloud@latest/{% endif %}organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} + +To allow people to create codespaces for which your organization will be billed, you must: -- Ensure that users have [at least write access](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization) to the repositories where they want to use a codespace. -- [Enable {% data variables.product.prodname_github_codespaces %} for users in your organization](#enable-codespaces-for-users-in-your-organization). You can choose to allow {% data variables.product.prodname_codespaces %} for selected users or only for specific users. - [Set a spending limit](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces) -- Ensure that your organization does not have an IP address allow list enabled. For more information, see "[Managing allowed IP addresses for your organization](/{% ifversion fpt %}enterprise-cloud@latest/{% endif %}organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} - -By default, a codespace can only access the repository from which it was created. Organization 内の Codespaces で、codespace の作者がアクセスできる他の Organization リポジトリにアクセスできるようにする場合は、「[{% data variables.product.prodname_codespaces %} のアクセスとセキュリティを管理する](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)」を参照してください。 - -## Enable {% data variables.product.prodname_codespaces %} for users in your organization +- [Choose who can create codespaces that are billed to your organization](#choose-who-can-create-codespaces-that-are-billed-to-your-organization) {% ifversion fpt %} {% note %} @@ -40,31 +38,44 @@ By default, a codespace can only access the repository from which it was created {% endnote %} {% endif %} + +By default, a codespace can only access the repository from which it was created. If you want codespaces in your organization to be able to access other organization repositories that the codespace creator can access, see "[Managing repository access for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces)." + +## Choose who can create codespaces that are billed to your organization + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.click-codespaces %} -1. [User permissions] で、次のいずれかのオプションを選択します。 +1. Under "Billing," select one of the following options: - * [**Selected users**] にすると、{% data variables.product.prodname_codespaces %} を使用する特定の Organization メンバーを選択できます。 - * **Allow for all members** to allow all your organization members to use {% data variables.product.prodname_codespaces %}. - * **Allow for all members and outside collaborators** to allow all your organization members as well as outside collaborators to use {% data variables.product.prodname_codespaces %}. + * **Disabled** - Your organization will not be charged for codespace usage. {% data variables.product.prodname_codespaces %} created for your organization's repositories will be billed to the individual users who create them. + * **Selected members** - {% data variables.product.prodname_codespaces %} created for your organization's repositories by selected members will be billed to the organization. + * **All members** - {% data variables.product.prodname_codespaces %} created for your organization's repositories by members of your organization will be billed to the organization. + * **All members and outside collaborators** - {% data variables.product.prodname_codespaces %} created for your organization's repositories by organization members and outside collaborators will be billed to the organization. - !["User permissions" のラジオボタン](/assets/images/help/codespaces/org-user-permission-settings-outside-collaborators.png) + ![Radio buttons for "Billing"](/assets/images/help/codespaces/codespaces-org-billing-settings.png) {% note %} - **Note:** When you select **Allow for all members and outside collaborators**, all outside collaborators who have been added to specific repositories can create and use {% data variables.product.prodname_codespaces %}. Your organization will be billed for all usage incurred by outside collaborators. For more information on managing outside collaborators, see "[About outside collaborators](/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization#about-outside-collaborators)." + **Note:** When you select **All members and outside collaborators**, all outside collaborators who have been added to specific repositories can create and use {% data variables.product.prodname_codespaces %} for those repositories, and your organization will be billed for this usage. For more information on managing outside collaborators, see "[About outside collaborators](/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization#about-outside-collaborators)." {% endnote %} 1. [**Save**] をクリックします。 +1. If you chose **Selected members**, an input box is displayed for you to enter the names of users you want to select. + + ![Input box for selecting users](/assets/images/help/codespaces/codespaces-org-billing-add-users.png) ## Disabling {% data variables.product.prodname_codespaces %} for your organization +You can prevent the creation and use of codespaces billable to your organization. + +{% data reusables.codespaces.codespaces-disabling-org-billing %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.click-codespaces %} -1. Under "User permissions", select **Disabled**. +1. Under "Billing," select **Disabled**. ## 利用限度の設定 diff --git a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-github-codespaces-in-your-organization.md b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-github-codespaces-in-your-organization.md index ca50b3f071..6ab2c5e722 100644 --- a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-github-codespaces-in-your-organization.md +++ b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-github-codespaces-in-your-organization.md @@ -35,11 +35,15 @@ You can set a usage limit for the codespaces in your organization or repository. ## Disabling or limiting {% data variables.product.prodname_codespaces %} -You can disable the use of {% data variables.product.prodname_codespaces %} in your organization or repository. For more information, see "[Managing repository access for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)." +You can disable all use of {% data variables.product.prodname_github_codespaces %} that would be billed to your organization. Alternatively, you can specify which organization members or collaborators can use {% data variables.product.prodname_codespaces %} at your organization's expense. For more information, see "[Enabling {% data variables.product.prodname_github_codespaces %} for your organization](/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization)." -You can also limit the individual users who can use {% data variables.product.prodname_codespaces %}. For more information, see "[Managing user permissions for your organization](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)." +{% data reusables.codespaces.codespaces-disabling-org-billing %} -You can limit the choice of machine types that are available for repositories owned by your organization. This allows you to prevent people using overly resourced machines for their codespaces. 詳しい情報については「[マシンタイプへのアクセス制限](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types)」を参照してください。 +You can configure which repositories can be accessed from codespaces created for a particular repository. For more information, see "[Managing access to other repositories within your codespace](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)." + +You can limit the choice of types of machine that are available for codespaces created from repositories owned by your organization. This allows you to prevent people using overly resourced machines for their codespaces, and incurring unnecessary charges. 詳しい情報については「[マシンタイプへのアクセス制限](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types)」を参照してください。 + +You can also restrict how long a codespace can remain unused before it is automatically deleted. This can help to reduce storage costs for {% data variables.product.prodname_codespaces %}. For more information, see "[Restricting the retention period for codespaces](/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces)." ## Deleting unused codespaces @@ -47,6 +51,6 @@ Your users can delete their codespaces in https://github.com/codespaces and from {% note %} -**注釈:** codespace を作成したユーザだけが削除できます。 現在、Organization のオーナーが Organization 内で作成された Codespaces を削除する方法はありません。 +**Note:** Codespaces are automatically deleted after they have been stopped and have remained inactive for a defined number of days. For more information, see "[Restricting the retention period for codespaces](/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces)." A codespace can only be manually deleted by the person who created the codespace. {% endnote %} diff --git a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md index 04cb517ff7..b4e181be5b 100644 --- a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md +++ b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md @@ -20,7 +20,7 @@ redirect_from: {% warning %} -**Deprecation note**: The access and security setting described below is now deprecated and is documented here for reference only. To enable expanded access to other repositories, add the requested permissions to your dev container definition. For more information, see "[Managing access to other repositories within your codespace](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)." +**Deprecation note**: The access and security setting described below is now deprecated and is documented here for reference only. To enable expanded access to other repositories, add the requested permissions to your `devcontainer.json` configuration file. For more information, see "[Managing access to other repositories within your codespace](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)." {% endwarning %} diff --git a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md index 415f43e055..6a55e8dc43 100644 --- a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md +++ b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md @@ -43,6 +43,8 @@ For example, you could create an organization-wide policy that restricts the mac If you add an organization-wide policy, you should set it to the largest choice of machine types that will be available for any repository in your organization. You can then add repository-specific policies to further restrict the choice. +{% data reusables.codespaces.codespaces-org-policies-note %} + ## Adding a policy to limit the available machine types {% data reusables.profile.access_org %} diff --git a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md index fc28f2cf6e..06c9c95946 100644 --- a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md +++ b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md @@ -40,6 +40,8 @@ When you create a policy, you choose whether it applies to all repositories in y If you add an organization-wide policy with a timeout constraint, you should set the timeout to the longest acceptable period. You can then add separate policies that set the maximum timeout to a shorter period for specific repositories in your organization. +{% data reusables.codespaces.codespaces-org-policies-note %} + ## Adding a policy to set a maximum idle timeout period {% data reusables.profile.access_org %} diff --git a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md index 06d0b8f5e8..68dda36c9c 100644 --- a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md +++ b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md @@ -26,6 +26,8 @@ When you create a policy, you choose whether it applies to all repositories in y If you add an organization-wide policy with a retention constraint, you should set the retention period to the longest acceptable period. You can then add separate policies that set the maximum retention to a shorter period for specific repositories in your organization. +{% data reusables.codespaces.codespaces-org-policies-note %} + ## Adding a policy to set a maximum codespace retention period {% data reusables.profile.access_org %} diff --git a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md index 32407ca041..81f43ee279 100644 --- a/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md +++ b/translations/ja-JP/content/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md @@ -36,6 +36,8 @@ For example, you could create an organization-wide policy that restricts the vis If you add an organization-wide policy, you should set it to the most lenient visibility option that will be available for any repository in your organization. You can then add repository-specific policies to further restrict the choice. +{% data reusables.codespaces.codespaces-org-policies-note %} + ## Adding a policy to limit the port visibility options {% data reusables.profile.access_org %} diff --git a/translations/ja-JP/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md b/translations/ja-JP/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md index d99f845a82..850b43433f 100644 --- a/translations/ja-JP/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md +++ b/translations/ja-JP/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md @@ -132,7 +132,3 @@ When you enable access and security for a repository owned by your personal acco 1. [Selected repositories] を選択した場合、ドロップダウンメニューを選択してから、あなたの所有するその他のリポジトリにアクセスを許可する、リポジトリのコードスペースをクリックします。 所有するその他のリポジトリにコードスペースによるアクセスを許可したい、すべてのリポジトリについて同じ手順を繰り返します。 ![[Selected repositories]ドロップダウンメニュー](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) - -## 参考リンク - -- "[Managing repository access for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces)" diff --git a/translations/ja-JP/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md b/translations/ja-JP/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md index 5094075f8b..a64f9e0920 100644 --- a/translations/ja-JP/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md +++ b/translations/ja-JP/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md @@ -31,6 +31,7 @@ The name the codespace is also included in many of the log files. For example, i Every codespace also has an ID (identifier). This is not shown by default in {% data variables.product.prodname_vscode %} so you may need to update the settings for the {% data variables.product.prodname_github_codespaces %} extension before you can access the ID. 1. In {% data variables.product.prodname_vscode %}, browser or desktop, in the Activity Bar on the left, click **Remote Explorer** to show details for the codespace. -2. If the sidebar includes a "Codespace Performance" section, hover over the "Codespace ID" and click the clipboard icon to copy the ID. -3. If the information is not shown, click {% octicon "gear" aria-label="The gear icon" %}, in the bottom-left corner of the Activity Bar, to display the "Settings" tab. -4. Expand **Extensions** and click **{% data variables.product.prodname_github_codespaces %}** to display the settings for the extension. Then enable **Show Performance Explorer** to display the "Codespace Performance" section in the sidebar. ![Codespace ID and settings required to display performance information](/assets/images/help/codespaces/find-codespace-id.png) +{% indented_data_reference reusables.codespaces.remote-explorer spaces=3 %} +1. If the sidebar includes a "Codespace Performance" section, hover over the "Codespace ID" and click the clipboard icon to copy the ID. +1. If the information is not shown, click {% octicon "gear" aria-label="The gear icon" %}, in the bottom-left corner of the Activity Bar, to display the "Settings" tab. +1. Expand **Extensions** and click **{% data variables.product.prodname_github_codespaces %}** to display the settings for the extension. Then enable **Show Performance Explorer** to display the "Codespace Performance" section in the sidebar. ![Codespace ID and settings required to display performance information](/assets/images/help/codespaces/find-codespace-id.png) diff --git a/translations/ja-JP/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md b/translations/ja-JP/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md index 81b210ccbe..0f59c4c991 100644 --- a/translations/ja-JP/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md +++ b/translations/ja-JP/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md @@ -539,7 +539,7 @@ Errors with `body` will be prefixed with `body[i]` where `i` represents the inde ### サンプル -``` +```yaml body: - type: dropdown attributes: @@ -552,7 +552,7 @@ body: The error can be fixed by ensuring that no duplicate choices exist in the `options` array. -``` +```yaml body: - type: dropdown attributes: @@ -570,7 +570,7 @@ Errors with `body` will be prefixed with `body[i]` where `i` represents the inde ### サンプル -``` +```yaml body: - type: dropdown attributes: @@ -585,7 +585,7 @@ body: The error can be fixed by removing "None" as an option. If you want a contributor to be able to indicate that they like none of those types of pies, you can additionally remove the `required` validation. -``` +```yaml body: - type: dropdown attributes: @@ -605,7 +605,7 @@ Errors with `body` will be prefixed with `body[i]` where `i` represents the inde ### サンプル -``` +```yaml body: - type: dropdown attributes: @@ -618,7 +618,7 @@ body: The error can be fixed by wrapping each offending option in quotes, to prevent them from being processed as Boolean values. -``` +```yaml body: - type: dropdown attributes: @@ -629,6 +629,36 @@ body: - Maybe ``` +## Body cannot be empty + +The template body `key:value` pair can not be empty. For more information about which top-level keys are required, see "[Syntax for issue forms](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax)." + +The error can be fixed by adding the `body:` section. + +### サンプル + +```yaml +name: Support Request +description: Something went wrong and you need help? +--- +body: +- type: textarea + attributes: + label: "What's wrong?" +``` + +In this example, the error can be fixed by deleting the `---` (document separator) between the headers and the `body` section. + +```yaml +name: Support Request +description: Something went wrong and you need help? + +body: +- type: textarea + attributes: + label: "What's wrong?" +``` + ## 参考リンク - [YAML](https://yaml.org/) diff --git a/translations/ja-JP/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md b/translations/ja-JP/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md index 9741288825..135c0354d0 100644 --- a/translations/ja-JP/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md +++ b/translations/ja-JP/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md @@ -23,6 +23,8 @@ Organization に許可リストがある場合、{% data variables.product.prodn ## {% data variables.product.prodname_github_app %} に IPアドレス許可リストを追加する +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.apps.settings-step %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} diff --git a/translations/ja-JP/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md b/translations/ja-JP/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md index 1f4c4dd83c..30d4a58471 100644 --- a/translations/ja-JP/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md +++ b/translations/ja-JP/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md @@ -47,7 +47,7 @@ Rate limits for {% data variables.product.prodname_github_apps %} and {% data va {% ifversion fpt or ghec %} -{% data variables.product.prodname_github_apps %} that are installed on an organization or a repository within an enterprise on {% data variables.product.product_location %} are subject to a limit of 15,000 requests per hour. +{% data variables.product.prodname_github_apps %} that are installed on an organization within an enterprise on {% data variables.product.product_location %} are subject to a limit of 15,000 requests per hour per organization that has installed the app. {% endif %} diff --git a/translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md b/translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md index 9a22b534de..828e2ca508 100644 --- a/translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -39,46 +39,49 @@ X-Accepted-OAuth-Scopes: user ## 利用できるスコープ -| 名前 | 説明 | -| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |{% ifversion not ghae %} -| **`(スコープなし)`** | パブリックな情報への読み取りのみのアクセスを許可します (ユーザのプロフィール情報、リポジトリの情報、Gist){% endif %}{% ifversion ghes or ghae %} -| **`site_admin`** | サイト管理者に[{% data variables.product.prodname_ghe_server %}の管理APIエンドポイント](/rest/reference/enterprise-admin)へのアクセスを許可します。{% endif %} -| **`repo`** | Grants full access to public{% ifversion ghec or ghes or ghae %}, internal,{% endif %} and private repositories including read and write access to code, commit statuses, repository invitations, collaborators, deployment statuses, and repository webhooks. **Note**: In addition to repository related resources, the `repo` scope also grants access to manage organization-owned resources including projects, invitations, team memberships and webhooks. This scope also grants the ability to manage projects owned by users. | -|  `repo:status` | Grants read/write access to commit statuses in {% ifversion fpt %}public and private{% elsif ghec or ghes %}public, private, and internal{% elsif ghae %}private and internal{% endif %} repositories. このスコープが必要になるのは、コードへのアクセスを許可*することなく*他のユーザあるいはサービスにプライベートリポジトリのコミットステータスへのアクセスを許可したい場合のみです。 | -|  `repo_deployment` | [デプロイメントステータス](/rest/reference/repos#deployments) for {% ifversion not ghae %}パブリック{% else %}内部{% endif %}およびプライベートリポジトリへのアクセスを許可します。 このスコープが必要になるのは、コードへのアクセスを許可*することなく*デプロイメントステータスへのアクセスをユーザまたはサービスに許可する場合のみです。{% ifversion not ghae %} -|  `public_repo` | アクセスをパブリックリポジトリのみに制限します。 これには、コード、コミットステータス、リポジトリプロジェクト、コラボレータ、パブリックリポジトリ及びOrganizationのデプロイメントステータスへの読み書きアクセスが含まれます。 パブリックリポジトリにStarを付けるためにも必要です。{% endif %} -|  `repo:invite` | リポジトリでのコラボレーションへの招待の承認／拒否を許可します。 このスコープが必要になるのは、コードへのアクセスを許可*することなく*他のユーザまたはサービスに招待へのアクセスを許可する場合のみです。{% ifversion fpt or ghes or ghec %} -|  `security_events` | Grants:
    read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning) {%- ifversion ghec %}
    read and write access to security events in the [{% data variables.product.prodname_secret_scanning %} API](/rest/reference/secret-scanning){%- endif %}
    This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %} -| **`admin:repo_hook`** | Grants read, write, ping, and delete access to repository hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. `repo`{% ifversion fpt or ghec or ghes %}および`public_repo`スコープは、{% else %}{% endif %}リポジトリフックを含むリポジトリへの完全なアクセスを許可します。 アクセスをリポジトリフックのみに限定するには、`admin:repo_hook`スコープを使ってください。 | -|  `write:repo_hook` | Grants read, write, and ping access to hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. | -|  `read:repo_hook` | Grants read and ping access to hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. | -| **`admin:org`** | OrganizationとそのTeam、プロジェクト、メンバーシップを完全に管理できます。 | -|  `write:org` | Organizationのメンバーシップ、Organizationのプロジェクト、Teamのメンバーシップへの読み書きアクセス。 | -|  `read:org` | Organizationのメンバーシップ、Organizationのプロジェクト、Teamのメンバーシップへの読み取りのみのアクセス。 | -| **`admin:public_key`** | 公開鍵を完全に管理できます。 | -|  `write:public_key` | 公開鍵の作成、リスト、詳細の表示。 | -|  `read:public_key` | 公開鍵のリストと詳細の表示。 | -| **`admin:org_hook`** | Organizationフックへの読み書き、ping、削除アクセスを許可します。 **ノート:** OAuthトークンがこれらのアクションを行えるのは、OAuth Appが作成したOrganizationフックに対してのみです。 個人アクセストークンがこれらのアクションを行えるのは、ユーザが作成したOrganizationフックに対してのみです。 | -| **`gist`** | Gistへの書き込みアクセスを許可します。 | -| **`notifications`** | 許可するアクセス:
    * ユーザの通知に対する読み取りアクセス
    * スレッドへの既読アクセス
    * リポジトリへのWatch及びWatch解除のアクセス
    * スレッドのサブスクリプションに対する読み書き及び削除アクセス。 | -| **`ユーザ`** | プロフィール情報にのみ読み書きアクセスを許可します。 このスコープには`user:email`と`user:follow`が含まれることに注意してください。 | -|  `read:user` | ユーザのプロフィールデータへの読み取りアクセスを許可します。 | -|  `user:email` | ユーザのメールアドレスへの読み取りアクセスを許可します。 | -|  `user:follow` | Grants access to follow or unfollow other users.{% ifversion projects-oauth-scope %} -| **`project`** | Grants read/write access to user and organization {% data variables.projects.projects_v2 %}. | -|  `read:project` | Grants read only access to user and organization {% data variables.projects.projects_v2 %}.{% endif %} -| **`delete_repo`** | 管理可能なリポジトリの削除アクセスを許可します。 | -| **`write:discussion`** | Teamのディスカッションの読み書きアクセスを許可します。 | -|  `read:discussion` | Allows read access for team discussions. | -| **`write:packages`** | {% data variables.product.prodname_registry %}でのパッケージのアップロードあるいは公開のアクセスを許可します。 詳しい情報については「[パッケージの公開](/github/managing-packages-with-github-packages/publishing-a-package)」を参照してください。 | -| **`read:packages`** | {% data variables.product.prodname_registry %}からのパッケージのダウンロードあるいはインストールのアクセスを許可します。 詳しい情報については「[パッケージのインストール](/github/managing-packages-with-github-packages/installing-a-package)」を参照してください。 | -| **`delete:packages`** | {% data variables.product.prodname_registry %}からのパッケージの削除アクセスを許可します。 詳しい情報については、「[パッケージの削除とリストア](/packages/learn-github-packages/deleting-and-restoring-a-package)」を参照してください。 | -| **`admin:gpg_key`** | GPGキーを完全に管理できます。 | -|  `write:gpg_key` | GPGキーの作成、リスト、詳細の表示ができます。 | -|  `read:gpg_key` | GPGキーのリストと詳細を表示できます。{% ifversion fpt or ghec %} -| **`codespace`** | Grants the ability to create and manage codespaces. Codespaces can expose a GITHUB_TOKEN which may have a different set of scopes. For more information, see "[Security in {% data variables.product.prodname_github_codespaces %}](/codespaces/codespaces-reference/security-in-github-codespaces#authentication)."{% endif %} -| **`ワークフロー`** | {% data variables.product.prodname_actions %}のワークフローファイルの追加と更新機能を許可します。 同じリポジトリ内の他のブランチに同じファイル（パスと内容が同じ）が存在する場合、ワークフローファイルはこのスコープがなくてもコミットできます。 ワークフローファイルは、異なるスコープのセットを持ちうる`GITHUB_TOKEN`を公開できます。 詳しい情報については、「[ワークフローでの認証](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)」を参照してください。 | - +| 名前 | 説明 | +| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |{% ifversion not ghae %} +| **`(スコープなし)`** | パブリックな情報への読み取りのみのアクセスを許可します (ユーザのプロフィール情報、リポジトリの情報、Gist){% endif %}{% ifversion ghes or ghae %} +| **`site_admin`** | サイト管理者に[{% data variables.product.prodname_ghe_server %}の管理APIエンドポイント](/rest/reference/enterprise-admin)へのアクセスを許可します。{% endif %} +| **`repo`** | Grants full access to public{% ifversion ghec or ghes or ghae %}, internal,{% endif %} and private repositories including read and write access to code, commit statuses, repository invitations, collaborators, deployment statuses, and repository webhooks. **Note**: In addition to repository related resources, the `repo` scope also grants access to manage organization-owned resources including projects, invitations, team memberships and webhooks. This scope also grants the ability to manage projects owned by users. | +|  `repo:status` | Grants read/write access to commit statuses in {% ifversion fpt %}public and private{% elsif ghec or ghes %}public, private, and internal{% elsif ghae %}private and internal{% endif %} repositories. このスコープが必要になるのは、コードへのアクセスを許可*することなく*他のユーザあるいはサービスにプライベートリポジトリのコミットステータスへのアクセスを許可したい場合のみです。 | +|  `repo_deployment` | [デプロイメントステータス](/rest/reference/repos#deployments) for {% ifversion not ghae %}パブリック{% else %}内部{% endif %}およびプライベートリポジトリへのアクセスを許可します。 このスコープが必要になるのは、コードへのアクセスを許可*することなく*デプロイメントステータスへのアクセスをユーザまたはサービスに許可する場合のみです。{% ifversion not ghae %} +|  `public_repo` | アクセスをパブリックリポジトリのみに制限します。 これには、コード、コミットステータス、リポジトリプロジェクト、コラボレータ、パブリックリポジトリ及びOrganizationのデプロイメントステータスへの読み書きアクセスが含まれます。 パブリックリポジトリにStarを付けるためにも必要です。{% endif %} +|  `repo:invite` | リポジトリでのコラボレーションへの招待の承認／拒否を許可します。 このスコープが必要になるのは、コードへのアクセスを許可*することなく*他のユーザまたはサービスに招待へのアクセスを許可する場合のみです。{% ifversion fpt or ghes or ghec %} +|  `security_events` | Grants:
    read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning) {%- ifversion ghec %}
    read and write access to security events in the [{% data variables.product.prodname_secret_scanning %} API](/rest/reference/secret-scanning){%- endif %}
    This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %} +| **`admin:repo_hook`** | Grants read, write, ping, and delete access to repository hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. The `repo` {% ifversion fpt or ghec or ghes %}and `public_repo` scopes grant{% else %}scope grants{% endif %} full access to repositories, including repository hooks. アクセスをリポジトリフックのみに限定するには、`admin:repo_hook`スコープを使ってください。 | +|  `write:repo_hook` | Grants read, write, and ping access to hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. | +|  `read:repo_hook` | Grants read and ping access to hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. | +| **`admin:org`** | OrganizationとそのTeam、プロジェクト、メンバーシップを完全に管理できます。 | +|  `write:org` | Organizationのメンバーシップ、Organizationのプロジェクト、Teamのメンバーシップへの読み書きアクセス。 | +|  `read:org` | Organizationのメンバーシップ、Organizationのプロジェクト、Teamのメンバーシップへの読み取りのみのアクセス。 | +| **`admin:public_key`** | 公開鍵を完全に管理できます。 | +|  `write:public_key` | 公開鍵の作成、リスト、詳細の表示。 | +|  `read:public_key` | 公開鍵のリストと詳細の表示。 | +| **`admin:org_hook`** | Organizationフックへの読み書き、ping、削除アクセスを許可します。 **ノート:** OAuthトークンがこれらのアクションを行えるのは、OAuth Appが作成したOrganizationフックに対してのみです。 個人アクセストークンがこれらのアクションを行えるのは、ユーザが作成したOrganizationフックに対してのみです。 | +| **`gist`** | Gistへの書き込みアクセスを許可します。 | +| **`notifications`** | 許可するアクセス:
    * ユーザの通知に対する読み取りアクセス
    * スレッドへの既読アクセス
    * リポジトリへのWatch及びWatch解除のアクセス
    * スレッドのサブスクリプションに対する読み書き及び削除アクセス。 | +| **`ユーザ`** | プロフィール情報にのみ読み書きアクセスを許可します。 このスコープには`user:email`と`user:follow`が含まれることに注意してください。 | +|  `read:user` | ユーザのプロフィールデータへの読み取りアクセスを許可します。 | +|  `user:email` | ユーザのメールアドレスへの読み取りアクセスを許可します。 | +|  `user:follow` | Grants access to follow or unfollow other users.{% ifversion projects-oauth-scope %} +| **`project`** | Grants read/write access to user and organization {% data variables.projects.projects_v2 %}. | +|  `read:project` | Grants read only access to user and organization {% data variables.projects.projects_v2 %}.{% endif %} +| **`delete_repo`** | 管理可能なリポジトリの削除アクセスを許可します。 | +| **`write:discussion`** | Teamのディスカッションの読み書きアクセスを許可します。 | +|  `read:discussion` | Allows read access for team discussions. | +| **`write:packages`** | {% data variables.product.prodname_registry %}でのパッケージのアップロードあるいは公開のアクセスを許可します。 詳しい情報については「[パッケージの公開](/github/managing-packages-with-github-packages/publishing-a-package)」を参照してください。 | +| **`read:packages`** | {% data variables.product.prodname_registry %}からのパッケージのダウンロードあるいはインストールのアクセスを許可します。 詳しい情報については「[パッケージのインストール](/github/managing-packages-with-github-packages/installing-a-package)」を参照してください。 | +| **`delete:packages`** | {% data variables.product.prodname_registry %}からのパッケージの削除アクセスを許可します。 詳しい情報については、「[パッケージの削除とリストア](/packages/learn-github-packages/deleting-and-restoring-a-package)」を参照してください。 | +| **`admin:gpg_key`** | GPGキーを完全に管理できます。 | +|  `write:gpg_key` | GPGキーの作成、リスト、詳細の表示ができます。 | +|  `read:gpg_key` | GPGキーのリストと詳細を表示できます。{% ifversion fpt or ghec %} +| **`codespace`** | Grants the ability to create and manage codespaces. Codespaces can expose a GITHUB_TOKEN which may have a different set of scopes. For more information, see "[Security in {% data variables.product.prodname_github_codespaces %}](/codespaces/codespaces-reference/security-in-github-codespaces#authentication)."{% endif %} +| **`ワークフロー`** | {% data variables.product.prodname_actions %}のワークフローファイルの追加と更新機能を許可します。 同じリポジトリ内の他のブランチに同じファイル（パスと内容が同じ）が存在する場合、ワークフローファイルはこのスコープがなくてもコミットできます。 ワークフローファイルは、異なるスコープのセットを持ちうる`GITHUB_TOKEN`を公開できます。 For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)."{% ifversion not fpt %} +| **`admin:enterprise`** | Gives full control of enterprise functionality. For more information, see "[Managing enterprise accounts](/graphql/guides/managing-enterprise-accounts)" in the GraphQL API documentation.

    Includes `manage_runners:enterprise`{% ifversion ghec or ghes > 3.3 %}, `manage_billing:enterprise`,{% endif %} and `read:enterprise`. | +|  `manage_runners:enterprise` | Gives full control over self-hosted runners within the enterprise. 詳しい情報については「[セルフホストランナーについて](/actions/hosting-your-own-runners/about-self-hosted-runners)」を参照してください。 {% ifversion ghec or ghes > 3.3 %} +|  `manage_billing:enterprise` | Read and write enterprise billing data. For more information, see "[Billing](/rest/billing)" in the REST API documentation. {% endif %} +|  `read:enterprise` | Read all data on an enterprise profile. Does not include profile data of enterprise members or organizations.{% endif %} {% note %} **ノート:**OAuth Appは最初のリダイレクトでスコープをリクエストできます。 スコープは、`%20`を使って、空白で区切って複数指定できます。 diff --git a/translations/ja-JP/content/developers/index.md b/translations/ja-JP/content/developers/index.md index 2cdab6ff69..9c46b6ccef 100644 --- a/translations/ja-JP/content/developers/index.md +++ b/translations/ja-JP/content/developers/index.md @@ -1,6 +1,29 @@ --- title: 開発者 -intro: 'APIと統合し、{% data variables.product.prodname_dotcom %}ワークフローをカスタマイズし、アプリケーションを構築してコミュニティと共有することによって、さらに{% data variables.product.prodname_dotcom %}との関係を深めてください。' +intro: 'Go deeper with {% data variables.product.prodname_dotcom %} by integrating with our APIs and webhooks, customizing your {% data variables.product.prodname_dotcom %} workflow, and building and sharing apps with the community.' +introLinks: + About apps: /developers/apps/getting-started-with-apps/about-apps +layout: product-landing +featuredLinks: + guides: + - /developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps + - /developers/apps/building-github-apps/creating-a-github-app + - /developers/apps/building-github-apps/authenticating-with-github-apps + - /developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps + popular: + - /developers/webhooks-and-events/webhooks/webhook-events-and-payloads + - /developers/apps/building-github-apps/creating-a-github-app + - /developers/apps/building-github-apps/authenticating-with-github-apps + - /developers/webhooks-and-events/webhooks/about-webhooks + - /developers/apps/building-oauth-apps/creating-an-oauth-app + - /developers/apps/building-oauth-apps/authorizing-oauth-apps + - /developers/github-marketplace/github-marketplace-overview/about-github-marketplace + guideCards: + - /developers/webhooks-and-events/webhooks/creating-webhooks + - /developers/apps/guides/using-the-github-api-in-your-app + - /developers/apps/guides/creating-ci-tests-with-the-checks-api +changelog: + label: apps versions: fpt: '*' ghes: '*' diff --git a/translations/ja-JP/content/developers/overview/about-githubs-apis.md b/translations/ja-JP/content/developers/overview/about-githubs-apis.md index 60b39e4749..dd06e18dae 100644 --- a/translations/ja-JP/content/developers/overview/about-githubs-apis.md +++ b/translations/ja-JP/content/developers/overview/about-githubs-apis.md @@ -15,17 +15,3 @@ topics: --- GitHub APIには、[REST API](/rest)と[GraphQL API](/graphql)という2つの安定バージョンがあります。 - -## 非推奨のバージョン - -### ベータ - -ベータAPIは2014年4月22日に非推奨となりました。 - -### v2 - -API v2のサポートは2012年6月12日に廃止されました。 - -### v1 - -API v1のサポートは2012年6月12日に廃止されました。 diff --git a/translations/ja-JP/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md b/translations/ja-JP/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md index a0fae35e8f..cf8e39bfa0 100644 --- a/translations/ja-JP/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md +++ b/translations/ja-JP/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md @@ -37,12 +37,12 @@ $ export SECRET_TOKEN=your_token ## GitHub からのペイロードを検証する -シークレットトークンが設定されると、{% data variables.product.product_name %} はそれを使用して各ペイロードでハッシュ署名を作成します。 This hash signature is included with the headers of each request as `X-Hub-Signature-256`. +シークレットトークンが設定されると、{% data variables.product.product_name %} はそれを使用して各ペイロードでハッシュ署名を作成します。 This hash signature is included with the headers of each request as `x-hub-signature-256`. {% ifversion fpt or ghes or ghec %} {% note %} -**注釈:** 下位互換性のために、SHA-1 ハッシュ関数を使用して生成される `X-Hub-Signature` ヘッダーも含まれています。 可能であれば、セキュリティを向上させるために `X-Hub-Signature-256` ヘッダを使用することをお勧めします。 以下は、`X-Hub-Signature-256` ヘッダの使用例です。 +**Note:** For backward-compatibility, we also include the `x-hub-signature` header that is generated using the SHA-1 hash function. If possible, we recommend that you use the `x-hub-signature-256` header for improved security. The example below demonstrates using the `x-hub-signature-256` header. {% endnote %} {% endif %} diff --git a/translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/index.md b/translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/index.md index f6016ea693..d0ffb7013e 100644 --- a/translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/index.md +++ b/translations/ja-JP/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/index.md @@ -9,8 +9,8 @@ redirect_from: versions: fpt: '*' children: - - /use-github-at-your-educational-institution - /github-global-campus-for-students - /github-global-campus-for-teachers + - /use-github-at-your-educational-institution --- diff --git a/translations/ja-JP/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md b/translations/ja-JP/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md index 71d5ab24d3..c0f1a67bca 100644 --- a/translations/ja-JP/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md +++ b/translations/ja-JP/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md @@ -55,7 +55,7 @@ redirect_from: ### 課題のタイプを選択する -[Individual or group assignment] の下で、ドロップダウンメニューを選択し、[**Group assignment**] をクリックします。 課題の作成後は、課題タイプを変更できません。 個人課題を作成する場合は、「[個人課題の作成](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)」を参照してください。 +[Individual or group assignment] の下で、ドロップダウンメニューを選択し、[**Group assignment**] をクリックします。 課題の作成後は、課題タイプを変更できません。 If you'd rather create an individual assignment, see "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)." ### 課題のTeamを定義する diff --git a/translations/ja-JP/content/get-started/exploring-projects-on-github/following-organizations.md b/translations/ja-JP/content/get-started/exploring-projects-on-github/following-organizations.md index 8599a83369..a6385b86bd 100644 --- a/translations/ja-JP/content/get-started/exploring-projects-on-github/following-organizations.md +++ b/translations/ja-JP/content/get-started/exploring-projects-on-github/following-organizations.md @@ -7,15 +7,11 @@ topics: - Profile --- -{% note %} - -**Note:** The ability to follow organizations is currently in public beta and subject to change. - -{% endnote %} +{% data reusables.organizations.follow-organizations-beta %} ## About followers on {% data variables.product.product_name %} -When you follow organizations, you'll see their public activity on your personal dashboard. 詳細は「[パーソナルダッシュボードについて](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community)」を参照してください。 +{% data reusables.organizations.about-following-organizations %} For more information, see "[About your personal dashboard](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community)." You can unfollow an organization if you do not wish to see their {% ifversion fpt or ghec %}public{% endif %} activity on {% data variables.product.product_name %}. diff --git a/translations/ja-JP/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md b/translations/ja-JP/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md index ecbabbb9d7..eddab6d9bf 100644 --- a/translations/ja-JP/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md +++ b/translations/ja-JP/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md @@ -57,11 +57,21 @@ If you have existing source code or repositories stored locally on your computer 1. {% data variables.product.product_location %}上で[新しいリポジトリを作成](/repositories/creating-and-managing-repositories/creating-a-new-repository)します。 エラーを避けるため、新しいリポジトリは*README*、ライセンス、あるいは `gitignore` で初期化しないでください。 これらのファイルは、プロジェクトを {% data variables.product.product_name %}にプッシュした後で追加できます。 ![[Create New Repository] ドロップダウン](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. ワーキングディレクトリをローカルプロジェクトに変更します。 -4. ローカルディレクトリを Git リポジトリとして初期化します。 - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. ファイルを新しいローカルリポジトリに追加します。 これで、それらのファイルが最初のコミットに備えてステージングされます。 + ```shell $ git add . # ローカルリポジトリにファイルを追加し、コミットに備えてステージします。 {% data reusables.git.unstage-codeblock %} @@ -92,10 +102,19 @@ If you have existing source code or repositories stored locally on your computer 1. {% data variables.product.product_location %}上で[新しいリポジトリを作成](/articles/creating-a-new-repository)します。 エラーを避けるため、新しいリポジトリは*README*、ライセンス、あるいは `gitignore` で初期化しないでください。 これらのファイルは、プロジェクトを {% data variables.product.product_name %}にプッシュした後で追加できます。 ![[Create New Repository] ドロップダウン](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. ワーキングディレクトリをローカルプロジェクトに変更します。 -4. ローカルディレクトリを Git リポジトリとして初期化します。 - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. ファイルを新しいローカルリポジトリに追加します。 これで、それらのファイルが最初のコミットに備えてステージングされます。 ```shell $ git add . @@ -127,10 +146,19 @@ If you have existing source code or repositories stored locally on your computer 1. {% data variables.product.product_location %}上で[新しいリポジトリを作成](/articles/creating-a-new-repository)します。 エラーを避けるため、新しいリポジトリは*README*、ライセンス、あるいは `gitignore` で初期化しないでください。 これらのファイルは、プロジェクトを {% data variables.product.product_name %}にプッシュした後で追加できます。 ![[Create New Repository] ドロップダウン](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. ワーキングディレクトリをローカルプロジェクトに変更します。 -4. ローカルディレクトリを Git リポジトリとして初期化します。 - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. ファイルを新しいローカルリポジトリに追加します。 これで、それらのファイルが最初のコミットに備えてステージングされます。 ```shell $ git add . diff --git a/translations/ja-JP/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md b/translations/ja-JP/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md index bebf212082..841657afae 100644 --- a/translations/ja-JP/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md +++ b/translations/ja-JP/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md @@ -197,7 +197,7 @@ Members of your organization or enterprise can use tools from the {% data variab ### 4. Publishing and managing {% data variables.product.prodname_registry %} {% data reusables.getting-started.packages %} ### 5. {% data variables.product.prodname_pages %}を使用する -{% data variables.product.prodname_pages %} is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository and publishes a website. You can manage the publication of {% data variables.product.prodname_pages %} sites at the organization level. For more information, see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)" and "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." +{% data variables.product.prodname_pages %}は、HTML、CSS、JavaScriptファイルをリポジトリから直接取得してWebサイトを公開する、静的サイトホスティングサービスです。 You can manage the publication of {% data variables.product.prodname_pages %} sites at the organization level. For more information, see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)" and "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." ## Part 7: Participating in {% data variables.product.prodname_dotcom %}'s community Members of your organization or enterprise can use GitHub's learning and support resources to get the help they need. You can also support the open source community. @@ -206,9 +206,9 @@ Members of your organization or enterprise can use GitHub's learning and support You can read documentation that reflects the features available with {% data variables.product.prodname_ghe_cloud %}. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)." ### 2. Learning with {% data variables.product.prodname_learning %} -Members of your organization or enterprise can learn new skills by completing fun, realistic projects in your very own GitHub repository with [{% data variables.product.prodname_learning %}](https://skills.github.com/). Each course is a hands-on lesson created by the GitHub community and taught by a friendly bot. +Members of your organization or enterprise can learn new skills by completing fun, realistic projects in your very own GitHub repository with [{% data variables.product.prodname_learning %}](https://skills.github.com/). 各コースは、GitHubのコミュニティが作成したハンズオンのレッスンで、親切なbotによって教えてもらえます。 -For more information, see "[Git and {% data variables.product.prodname_dotcom %} learning resources](/github/getting-started-with-github/quickstart/git-and-github-learning-resources)." +詳しい情報については「[Gitと{% data variables.product.prodname_dotcom %}の学習リソース](/github/getting-started-with-github/quickstart/git-and-github-learning-resources)」を参照してください。 ### 3. Supporting the open source community {% data reusables.getting-started.sponsors %} diff --git a/translations/ja-JP/content/get-started/quickstart/be-social.md b/translations/ja-JP/content/get-started/quickstart/be-social.md index f2ae29f7f0..3bd6a70bc6 100644 --- a/translations/ja-JP/content/get-started/quickstart/be-social.md +++ b/translations/ja-JP/content/get-started/quickstart/be-social.md @@ -58,7 +58,23 @@ From your dashboard, click the drop down menu of your username on the left side ![アカウントのコンテキストの切り替えのドロップダウン](/assets/images/help/overview/dashboard-contextswitcher.png) -### {% data variables.product.prodname_dotcom %} 上の他のプロジェクトを調べる +{% ifversion for-you-feed %} + +## Following organizations + +{% data reusables.organizations.follow-organizations-beta %} + +{% data reusables.organizations.about-following-organizations %} + +To follow an organization, in the header of the organization's page, click **Follow**. + +![Screenshot of the organization header, with the follow button highlighted](/assets/images/help/profile/organization-profile-following.png) + +For more information, see "[Following organizations](/get-started/exploring-projects-on-github/following-organizations)." + +{% endif %} + +## {% data variables.product.prodname_dotcom %} 上の他のプロジェクトを調べる You can discover new and interesting projects on {% data variables.product.prodname_dotcom %}'s Explore page. You can star interesting projects to make them easy to find again later. Visit your stars page to see all your starred projects. For more information about stars, see "[Saving repositories with stars](/get-started/exploring-projects-on-github/saving-repositories-with-stars)." diff --git a/translations/ja-JP/content/get-started/quickstart/set-up-git.md b/translations/ja-JP/content/get-started/quickstart/set-up-git.md index 58eb8ee4b2..6ca5da9d55 100644 --- a/translations/ja-JP/content/get-started/quickstart/set-up-git.md +++ b/translations/ja-JP/content/get-started/quickstart/set-up-git.md @@ -42,17 +42,17 @@ If you do not need to work with files locally, {% data variables.product.product 1. [Git の最新バージョンをダウンロードしてインストールする](https://git-scm.com/downloads)。 -{% note %} + {% note %} -**Note**: If you are using a Chrome OS device, additional set up is required: + **Note**: If you are using a Chrome OS device, additional set up is required: -2. Install a terminal emulator such as Termux from the Google Play Store on your Chrome OS device. -3. From the terminal emulator that you installed, install Git. For example, in Termux, enter `apt install git` and then type `y` when prompted. + 1. Install a terminal emulator such as Termux from the Google Play Store on your Chrome OS device. + 1. From the terminal emulator that you installed, install Git. For example, in Termux, enter `apt install git` and then type `y` when prompted. -{% endnote %} + {% endnote %} -2. [Git でユーザ名を設定する](/github/getting-started-with-github/setting-your-username-in-git)。 -3. [Git のコミットメールアドレスを設定する](/articles/setting-your-commit-email-address)。 +1. [Git でユーザ名を設定する](/github/getting-started-with-github/setting-your-username-in-git)。 +1. [Git のコミットメールアドレスを設定する](/articles/setting-your-commit-email-address)。 ## Authenticating with {% data variables.product.prodname_dotcom %} from Git diff --git a/translations/ja-JP/content/get-started/using-github/github-command-palette.md b/translations/ja-JP/content/get-started/using-github/github-command-palette.md index 650351e96a..cff9bb5aa0 100644 --- a/translations/ja-JP/content/get-started/using-github/github-command-palette.md +++ b/translations/ja-JP/content/get-started/using-github/github-command-palette.md @@ -160,9 +160,9 @@ These commands are available from all scopes. These commands are available only within the scope of an organization. -| Command | Behavior | -|:---------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `New team` | Create a new team in the current organization. For more information, see "[Creating a team](/organizations/organizing-members-into-teams/creating-a-team)." | +| Command | Behavior | +|:---------- |:-------------------------------------------------------------------------------------------------------------------------------------------- | +| `New team` | Create a new team in the current organization. 詳しい情報については「[Teamの作成](/organizations/organizing-members-into-teams/creating-a-team)」を参照してください。 | ### Repository commands diff --git a/translations/ja-JP/content/index.md b/translations/ja-JP/content/index.md index 0c08b0f04d..c738b1a54b 100644 --- a/translations/ja-JP/content/index.md +++ b/translations/ja-JP/content/index.md @@ -19,6 +19,7 @@ redirect_from: - /troubleshooting-common-issues versions: '*' children: + - search - get-started - account-and-profile - authentication diff --git a/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md b/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md index 4c5f660ecc..e353ac3073 100644 --- a/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md +++ b/translations/ja-JP/content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md @@ -19,10 +19,10 @@ allowTitleToDifferFromFilename: true {% note %} -**{% ifversion classic-project-visibility-permissions %}Notes{% else %}Note{% endif %}:** {% ifversion classic-project-visibility-permissions %} +**{% ifversion classic-project-visibility-permissions %}ノート{% else %}ノート{% endif %}:** {% ifversion classic-project-visibility-permissions %} * {% data reusables.projects.owners-can-limit-visibility-permissions %} -* {% endif %}When you make your {% data variables.projects.projects_v1_board %} {% ifversion ghae %}internal{% else %}public{% endif %}, organization members are given read access by default. Organizationの特定のメンバーに対して、その人が所属するTeamにアクセスを付与するか、その人をコラボレータとして{% data variables.projects.projects_v1_board %}に追加することによって、書き込みあるいは管理権限を付与することができます。 詳しい情報については[Organizationの{% data variables.product.prodname_project_v1_caps %}の権限](/articles/project-board-permissions-for-an-organization)」を参照してください。 +* {% endif %}{% data variables.projects.projects_v1_board %}を{% ifversion ghae %}インターナル{% else %}パブリック{% endif %}にすると、デフォルトではOrganizationのメンバーには読み取りアクセスが付与されます。 Organizationの特定のメンバーに対して、その人が所属するTeamにアクセスを付与するか、その人をコラボレータとして{% data variables.projects.projects_v1_board %}に追加することによって、書き込みあるいは管理権限を付与することができます。 詳しい情報については[Organizationの{% data variables.product.prodname_project_v1_caps %}の権限](/articles/project-board-permissions-for-an-organization)」を参照してください。 {% endnote %} diff --git a/translations/ja-JP/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md b/translations/ja-JP/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md index 7e46a5395c..cfd6821b28 100644 --- a/translations/ja-JP/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md +++ b/translations/ja-JP/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md @@ -23,7 +23,7 @@ To transfer an open issue to another repository, you must have write access to t {% endnote %} -When you transfer an issue, comments, labels and assignees are retained. The issue's milestones are not retained. This issue will stay on any user-owned or organization-wide project boards and be removed from any repository project boards. For more information, see "[About project boards](/articles/about-project-boards)." +When you transfer an issue, comments and assignees are retained. Labels and milestones are also retained if they're present in the target repository, with labels matching by name and milestones matching by both name and due date. This issue will stay on any user-owned or organization-wide project boards and be removed from any repository project boards. For more information, see "[About project boards](/articles/about-project-boards)." People or teams who are mentioned in the issue will receive a notification letting them know that the issue has been transferred to a new repository. The original URL redirects to the new issue's URL. People who don't have read permissions in the new repository will see a banner letting them know that the issue has been transferred to a new repository that they can't access. diff --git a/translations/ja-JP/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md b/translations/ja-JP/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md index 0d3646f467..66d1d9f1e0 100644 --- a/translations/ja-JP/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md +++ b/translations/ja-JP/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md @@ -36,15 +36,22 @@ Enterprise アカウントで Organization に対して許可される IP アド ## 許可 IP アドレスを追加する +{% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} + +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} {% data reusables.identity-and-permissions.ip-allow-lists-add-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-add-description %} {% data reusables.identity-and-permissions.ip-allow-lists-add-entry %} +{% data reusables.identity-and-permissions.check-ip-address %} ## 許可 IP アドレスを有効化する +{% data reusables.identity-and-permissions.about-enabling-allowed-ip-addresses %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} @@ -69,6 +76,8 @@ Enterprise アカウントで Organization に対して許可される IP アド ## 許可 IP アドレスを編集する +{% data reusables.identity-and-permissions.about-editing-ip-allow-list-entries %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} @@ -76,6 +85,18 @@ Enterprise アカウントで Organization に対して許可される IP アド {% data reusables.identity-and-permissions.ip-allow-lists-edit-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-description %} 1. [**Update**] をクリックします。 +{% data reusables.identity-and-permissions.check-ip-address %} + +{% ifversion ip-allow-list-address-check %} +## Checking if an IP address is permitted + +{% data reusables.identity-and-permissions.about-checking-ip-address %} + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +{% data reusables.organizations.security %} +{% data reusables.identity-and-permissions.check-ip-address-step %} +{% endif %} ## 許可 IP アドレスを削除する diff --git a/translations/ja-JP/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md b/translations/ja-JP/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md index d5cee8b617..686a427ea5 100644 --- a/translations/ja-JP/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md +++ b/translations/ja-JP/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md @@ -740,7 +740,7 @@ For more information, see "[Managing the publication of {% data variables.produc | Action | Description |------------------|------------------- |`create` | Triggered when an organization owner creates a new custom repository role. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." -|`destroy` | Triggered when a organization owner deletes a custom repository role. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." +|`destroy` | Triggered when an organization owner deletes a custom repository role. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." |`update` | Triggered when an organization owner edits an existing custom repository role. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." {% endif %} diff --git a/translations/ja-JP/content/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities.md b/translations/ja-JP/content/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities.md index da08bc8c9d..f90c8934e7 100644 --- a/translations/ja-JP/content/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities.md +++ b/translations/ja-JP/content/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities.md @@ -23,7 +23,7 @@ SSH CAをOrganizationに追加すると、メンバーはあなたが提供し ## SSH 認証局を追加する -If you require SSH certificates for your enterprise, enterprise members should use a special URL for Git operations over SSH. 詳しい情報については、「[SSH 認証局について](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities#about-ssh-urls-with-ssh-certificates)」を参照してください。 +EnterpriseでSSH証明書が必要な場合、EnterpriseのメンバーはSSH経由のGitの操作に特別なURLを使わなければなりません。 詳しい情報については、「[SSH 認証局について](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities#about-ssh-urls-with-ssh-certificates)」を参照してください。 {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} diff --git a/translations/ja-JP/content/organizations/managing-organization-settings/allowing-project-visibility-changes-in-your-organization.md b/translations/ja-JP/content/organizations/managing-organization-settings/allowing-project-visibility-changes-in-your-organization.md index 7588bc6e65..4bf5c6a6b4 100644 --- a/translations/ja-JP/content/organizations/managing-organization-settings/allowing-project-visibility-changes-in-your-organization.md +++ b/translations/ja-JP/content/organizations/managing-organization-settings/allowing-project-visibility-changes-in-your-organization.md @@ -1,6 +1,6 @@ --- title: Organizationでのプロジェクトの可視性の変更の許可 -intro: 'Organization owners can allow members with admin permissions to adjust the visibility of {% data variables.projects.projects_v2_and_v1 %} in their organization.' +intro: 'Organizationのオーナーは、管理権限を持つメンバーに、Organization内の{% data variables.projects.projects_v2_and_v1 %}の可視性の調整を許可できます。' versions: feature: classic-project-visibility-permissions-or-projects-v2 topics: @@ -11,9 +11,9 @@ allowTitleToDifferFromFilename: true permissions: 'Organization owners can allow {% data variables.projects.project_v2_and_v1 %} visibility changes for an organization.' --- -You can restrict who has the ability to change the visibility of {% data variables.projects.projects_v2_and_v1 %} in your organization, such as restricting members from changing {% data variables.projects.projects_v2_and_v1 %} from private to public. +{% data variables.projects.projects_v2_and_v1 %}をプライベートからパブリックに変更できるメンバーを制限するといったように、Organizationにおいて{% data variables.projects.projects_v2_and_v1 %}の可視性を変更できる人を制限できます。 -You can limit the ability to change {% data variables.projects.project_v2_and_v1 %} visibility to just organization owners, or you can allow anyone granted admin permissions to change the visibility. +{% data variables.projects.project_v2_and_v1 %}の可視性を変更できるのをOrganizationオーナーだけに制限したり、あるいは管理権限を付与されている人なら誰でもこの可視性を変更できるように許可したりすることができます。 {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} @@ -24,7 +24,7 @@ You can limit the ability to change {% data variables.projects.project_v2_and_v1 ## 参考リンク {% ifversion projects-v2 %} -- "[Managing visibility of your {% data variables.projects.projects_v2 %}](/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects)" +- 「[{% data variables.projects.projects_v2 %}の可視性の管理](/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects)」 {%- endif %}{%- ifversion projects-v1 %} - 「[{% data variables.product.prodname_project_v1 %}の可視性の変更](/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility)」 {% endif %} diff --git a/translations/ja-JP/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md b/translations/ja-JP/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md index 70895a13ef..6f1b4da2a6 100644 --- a/translations/ja-JP/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md +++ b/translations/ja-JP/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md @@ -1,6 +1,6 @@ --- title: OrganizationでのGitHub Discussionsの有効化もしくは無効化 -intro: 'Organization内の1つのリポジトリに限定されない会話をするための場所として、{% data variables.product.prodname_discussions %}をOrganizationで利用できます。' +intro: 'You can use {% data variables.product.prodname_discussions %} in an organization as a place for your organization to have conversations that aren''t specific to a single repository within your organization.' permissions: 'Organization owners can enable {% data variables.product.prodname_discussions %} for their organization.' versions: feature: discussions diff --git a/translations/ja-JP/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md b/translations/ja-JP/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md index 8e453b64f0..1acc884c51 100644 --- a/translations/ja-JP/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md +++ b/translations/ja-JP/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md @@ -92,9 +92,10 @@ Organization内では、ロールをOrganization、Team、リポジトリのレ - **Set interaction limits（インタラクションの制限を設定）**: 自分のパブリックリポジトリで特定のユーザによるコメント、Issueのオープン、Pull Requestの作成を一時的に制限し、アクティビティの制限期間を施行。 詳しい情報については「[リポジトリでの操作の制限](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)」を参照してください。 {%- endif %} - **Set the social preview（ソーシャルプレビューの設定）**: リポジトリがリンクされたときにソーシャルメディア上に表示される識別画像をリポジトリに追加。 詳細は「[リポジトリのソーシャルメディア向けプレビューをカスタマイズする](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview)」を参照してください。 -- **Push commits to protected branches（保護されたブランチにコミットをプッシュ）**: 保護されたブランチとしてマークされているブランチにプッシュ。 +- **Push commits to protected branches（保護されたブランチにコミットをプッシュ）**: 保護されたブランチとしてマークされているブランチにプッシュ。 ブランチ保護ルールは引き続き適用され、プッシュが拒否されることがあります。 - **Create protected tags（保護されたタグの作成）**: タグの保護ルールにマッチしたタグの作成。 詳しい情報については「[タグ保護ルールの設定](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules)」を参照してください。 -- **Delete protected tags（タグ保護ルールの削除）**: タグ保護ルールにマッチしたタグの削除。 詳しい情報については「[タグ保護ルールの設定](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules)」を参照してください。 +- **Delete protected tags（タグ保護ルールの削除）**: タグ保護ルールにマッチしたタグの削除。 詳しい情報については「[タグ保護ルールの設定](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules)」を参照してください。{% ifversion bypass-branch-protections %} +- **ブランチ保護のバイパス**: 保護されたブランチにブランチ保護ルールに準拠せずにプッシュ。{% endif %} ### セキュリティ diff --git a/translations/ja-JP/content/packages/index.md b/translations/ja-JP/content/packages/index.md index df29da2cf1..968eddf1d9 100644 --- a/translations/ja-JP/content/packages/index.md +++ b/translations/ja-JP/content/packages/index.md @@ -18,6 +18,7 @@ featuredLinks: guideCards: - '{% ifversion docker-ghcr-enterprise-migration %}/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry{% endif %}' - '{% ifversion fpt or ghec or ghes > 3.4 %}/packages/working-with-a-github-packages-registry/working-with-the-container-registry{% else %}/packages/working-with-a-github-packages-registry/working-with-the-docker-registry{% endif %}' + - '{% ifversion packages-npm-v2 %}/packages/working-with-a-github-packages-registry/working-with-the-npm-registry{% endif %}' - /packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry changelog: label: packages diff --git a/translations/ja-JP/content/packages/learn-github-packages/about-permissions-for-github-packages.md b/translations/ja-JP/content/packages/learn-github-packages/about-permissions-for-github-packages.md index 6bedc6b0bb..15b8a24c93 100644 --- a/translations/ja-JP/content/packages/learn-github-packages/about-permissions-for-github-packages.md +++ b/translations/ja-JP/content/packages/learn-github-packages/about-permissions-for-github-packages.md @@ -18,20 +18,22 @@ shortTitle: 権限について リポジトリスコープのパッケージは、パッケージを所有するリポジトリの権限と可視性を継承します。 リポジトリをスコープとするパッケージは、リポジトリのメインページにアクセスし、ページ右にある**パッケージ**リンクをクリックすれば見つかります。 {% ifversion fpt or ghec %}詳しい情報については「[リポジトリのパッケージへの接続](/packages/learn-github-packages/connecting-a-repository-to-a-package)」を参照してください。{% endif %} -以下の{% data variables.product.prodname_registry %}レジストリは、リポジトリスコープの権限を使います。 +以下の{% data variables.product.prodname_registry %}レジストリは、リポジトリスコープの権限**のみ**を使います。 {% ifversion not fpt or ghec %}-Dockerレジストリ（`docker.pkg.github.com`）{% endif %} - - npmレジストリ + {% ifversion packages-npm-v2 %}{% else %}- npm registry{% endif %} - RubyGemsレジストリ - Apache Mavenレジストリ - NuGetレジストリ +{% ifversion packages-npm-v2 %}{% data variables.product.prodname_ghcr_and_npm_registry %}については、パッケージがユーザ、Organizationをスコープとするか、あるいはリポジトリにリンクするかを選択できます。{% endif %} + {% ifversion fpt or ghec %} ## ユーザ/Organizationスコープのパッケージの詳細な権限 詳細な権限を持つパッケージは、個人ユーザもしくはOrganizationアカウントをスコープとします。 パッケージのアクセス制御と可視性は、パッケージに接続された（あるいはリンクされた）リポジトリは別個に変更できます。 -現在の処、{% data variables.product.prodname_container_registry %}だけがコンテナイメージパッケージに関する詳細な権限を提供しています。 +現在のところ、{% data variables.product.prodname_ghcr_and_npm_registry %}だけがコンテナイメージパッケージに関する詳細な権限を提供しています。 ## コンテナイメージの可視性とアクセス権限 diff --git a/translations/ja-JP/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md b/translations/ja-JP/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md index 7577c081f5..0624ca0bcb 100644 --- a/translations/ja-JP/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md +++ b/translations/ja-JP/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md @@ -16,7 +16,7 @@ shortTitle: アクセスコントロールと可視性 詳細な権限を持つパッケージは、個人ユーザもしくはOrganizationアカウントをスコープとします。 パッケージのアクセス制御と可視性は、パッケージに接続された（あるいはリンクされた）リポジトリは別個に変更できます。 -現在は、{% data variables.product.prodname_container_registry %}でのみ詳細な権限を使うことができます。 詳細な権限は、npmレジストリのような他のパッケージレジストリではサポートされていません。{% ifversion docker-ghcr-enterprise-migration %}{% data variables.product.prodname_container_registry %}への移行に関する詳しい情報については「[Dockerレジストリから{% data variables.product.prodname_container_registry %}への移行](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)」を参照してください。{% endif %} +現在は、{% data variables.product.prodname_ghcr_and_npm_registry %}でのみ詳細な権限を使うことができます。 詳細な権限は、RubyGemsレジストリのような他のパッケージレジストリではサポートされていません。{% ifversion docker-ghcr-enterprise-migration %}{% data variables.product.prodname_container_registry %}への移行に関する詳しい情報については「[Dockerレジストリから{% data variables.product.prodname_container_registry %}への移行](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)」を参照してください。{% endif %} リポジトリをスコープとするパッケージの権限や、PATに関するパッケージ関連のスコープ、Actionsのワークフローの権限の管理についての詳しい情報は、「[GitHub Packagesの権限について](/packages/learn-github-packages/about-permissions-for-github-packages)」を参照してください。 @@ -95,7 +95,7 @@ Organization が所有するコンテナイメージに対する管理者権限 {% ifversion fpt or ghec %} ## パッケージへの{% data variables.product.prodname_codespaces %}アクセスの確保 -デフォルトでは、codespaceは**Inherit access（アクセスの継承）**オプションが選択された同じリポジトリ内で公開されたパッケージなど、{% data variables.product.prodname_dotcom %} Container Registry内の特定パッケージにシームレスにアクセスできます。 自動的に設定されるアクセスに関する詳しい情報については「[{% data variables.product.prodname_dotcom %} Container Registryに保存されたイメージへのアクセス](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-images-stored-in-github-container-registry)」を参照してください。 +デフォルトでは、codespaceは**Inherit access（アクセスの継承）**オプションが選択された同じリポジトリ内で公開されたパッケージなど、{% data variables.product.prodname_ghcr_and_npm_registry %} 内の特定パッケージにシームレスにアクセスできます。 自動的に設定されるアクセスに関する詳しい情報については「[codespaceへのプライベートイメージレジストリへのアクセスの許可](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-images-stored-in-container-registry-and-npm-registry) 」を参照してください。 あるいは、codespaceがパッケージに確実にアクセスできるようにするには、codespaceが起動されたリポジトリへのアクセスを許可しなければなりません。 diff --git a/translations/ja-JP/content/packages/learn-github-packages/deleting-and-restoring-a-package.md b/translations/ja-JP/content/packages/learn-github-packages/deleting-and-restoring-a-package.md index 2290c045b1..75b849f90e 100644 --- a/translations/ja-JP/content/packages/learn-github-packages/deleting-and-restoring-a-package.md +++ b/translations/ja-JP/content/packages/learn-github-packages/deleting-and-restoring-a-package.md @@ -23,12 +23,12 @@ shortTitle: パッケージの削除と復元 - プライベートパッケージ全体 - パッケージの全バージョンでダウンロード数が5000以下の場合、パブリックパッケージ全体 - プライベートパッケージの特定のバージョン -- パッケージバージョンのダウンロード数が5000以下の場合、パブリックパッケージの特定のバージョン +- パッケージバージョンのダウンロード数が5,000以下の場合、パブリックパッケージの特定のバージョン {% note %} **注釈:** -- パッケージのいずれかのパージョンでダウンロード数が5000を超えている場合は、パブリックパッケージを削除できません。 この場合は、[GitHubサポート](https://support.github.com/contact?tags=docs-packages)までお問い合わせください。 +- パッケージのいずれかのパージョンでダウンロード数が5,000を超えている場合は、パブリックパッケージを削除できません。 この場合は、[GitHubサポート](https://support.github.com/contact?tags=docs-packages)までお問い合わせください。 - パブリックパッケージを削除する場合、そのパッケージに依存するプロジェクトを破壊する可能性があることに注意してください。 {% endnote %} @@ -46,7 +46,7 @@ REST APIを使用してパッケージを管理できます。 詳しい情報 {% endif %} -権限とアクセスをリポジトリから継承するパッケージでは、GraphQLを使って特定のパッケージバージョンを削除できます。{% ifversion fpt or ghec %}{% data variables.product.prodname_registry %}GraphQL APIは、パッケージの名前空間`https://ghcr.io/OWNER/PACKAGE-NAME`を使うコンテナあるいはDockerイメージをサポートしません。{% endif %}GraphQLサポートに関する詳しい情報については「[GraphQLでリポジトリをスコープとするパッケージのバージョンを削除する](#deleting-a-version-of-a-repository-scoped-package-with-graphql)」を参照してください。 +権限とアクセスをリポジトリから継承するパッケージでは、GraphQLを使って特定のパッケージバージョンを削除できます。{% data reusables.package_registry.no-graphql-to-delete-packages %}GraphQLサポートに関する詳しい情報については「[GraphQLでリポジトリをスコープとするパッケージのバージョンを削除する](#deleting-a-version-of-a-repository-scoped-package-with-graphql)」を参照してください。 {% endif %} @@ -54,17 +54,19 @@ REST APIを使用してパッケージを管理できます。 詳しい情報 リポジトリからアクセス権限を継承しているパッケージの場合、そのリポジトリに対する管理者権限がある場合はパッケージを削除できます。 -{% data variables.product.prodname_registry %}上でリポジトリのスコープが付いたパッケージには、以下が挙げられます。 -- npm -- RubyGems -- maven -- Gradle -- NuGet -{% ifversion not fpt or ghec %}-`docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`にあるDockerイメージ{% endif %} +以下の{% data variables.product.prodname_registry %}レジストリは、リポジトリスコープの権限**のみ**を使います。 + + {% ifversion not fpt or ghec %}-`docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`にあるDockerイメージ{% endif %} + {% ifversion packages-npm-v2 %}{% else %}- npm{% endif %} + - RubyGemsレジストリ + - Apache Mavenレジストリ + - NuGetレジストリ + +{% ifversion packages-npm-v2 %}{% data variables.product.prodname_ghcr_and_npm_registry %}については、パッケージがユーザ、Organizationをスコープとするか、あるいはリポジトリにリンクするかを選択できます。{% endif %} {% ifversion fpt or ghec %} -`https://ghcr.io/OWNER/PACKAGE-NAME`に保存されたコンテナイメージなど、リポジトリとは別に詳細な権限を持つパッケージを削除する場合は、そのパッケージに対するアクセス権限が必要です。 詳しい情報については「[{% data variables.product.prodname_registry %}の権限について](/packages/learn-github-packages/about-permissions-for-github-packages)」を参照してください。 +`https://ghcr.io/OWNER/PACKAGE-NAME`あるいは`https://npm.pkg.github.com/OWNER/PACKAGE-NAME`に保存されたコンテナイメージなど、リポジトリとは別に詳細な権限を持つパッケージを削除する場合は、そのパッケージに対するアクセス権限が必要です。 詳しい情報については「[{% data variables.product.prodname_registry %}の権限について](/packages/learn-github-packages/about-permissions-for-github-packages)」を参照してください。 {% endif %} @@ -86,9 +88,7 @@ REST APIを使用してパッケージを管理できます。 詳しい情報 リポジトリから権限とアクセスを継承しているパッケージの場合、GraphQLを使用して特定のパッケージバージョンを削除できます。 -{% ifversion fpt or ghec %} -`ghcr.io`にあるコンテナあるいはDockerイメージについては、GraphQLはサポートされていませんがREST APIが使えます。 詳しい情報については、「[{% data variables.product.prodname_registry %} API](/rest/reference/packages)」を参照してください。 -{% endif %} +{% data reusables.package_registry.no-graphql-to-delete-packages %}{% ifversion fpt or ghec %}ただし、REST APIを使うことはできます。 詳しい情報については「[{% data variables.product.prodname_registry %} API](/rest/reference/packages)」を参照してください。{% endif %} GraphQL APIの`deletePackageVersion`ミューテーションを使ってください。 `read:packages`、`delete:packages`、`repo`スコープを持つトークンを使わなければなりません。 トークンに関する詳しい情報については「[{% data variables.product.prodname_registry %}について](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)」を参照してください。 diff --git a/translations/ja-JP/content/packages/learn-github-packages/introduction-to-github-packages.md b/translations/ja-JP/content/packages/learn-github-packages/introduction-to-github-packages.md index fc5090006e..5450ffcff9 100644 --- a/translations/ja-JP/content/packages/learn-github-packages/introduction-to-github-packages.md +++ b/translations/ja-JP/content/packages/learn-github-packages/introduction-to-github-packages.md @@ -51,7 +51,7 @@ For more information about the configuration of {% data variables.product.prodna | | | |--------------------|--------------------| -| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_container_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

    For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | +| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_ghcr_and_npm_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

    For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | | Visibility | {% data reusables.package_registry.public-or-private-packages %} | For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." @@ -101,7 +101,9 @@ For more information about Docker and the {% data variables.product.prodname_con ## Managing packages {% ifversion fpt or ghec %} -You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." +You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." + +{% data reusables.package_registry.no-graphql-to-delete-packages %} {% endif %} {% ifversion ghes %} @@ -112,7 +114,9 @@ You can delete a private or public package in the {% data variables.product.prod You can delete a version of a package in the {% data variables.product.product_name %} user interface or using the GraphQL API. {% endif %} -When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and "[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." +When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. + +For more information, see {% ifversion ghes or ghae %}"[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and {% endif %}"[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "[`package` webhook event](/webhooks/event-payloads/#package)." diff --git a/translations/ja-JP/content/packages/learn-github-packages/viewing-packages.md b/translations/ja-JP/content/packages/learn-github-packages/viewing-packages.md index cfb53cbd2b..4e9f2d9ac4 100644 --- a/translations/ja-JP/content/packages/learn-github-packages/viewing-packages.md +++ b/translations/ja-JP/content/packages/learn-github-packages/viewing-packages.md @@ -23,15 +23,15 @@ versions: パッケージを見ることができるかどうかは、いくつかの要素に依存します。 デフォルトでは、公開したパッケージはすべて見ることができます。 -リポジトリをスコープとするパッケージは、そのパッケージを所有するリポジトリから権限と可視性を継承します。 以下のレジストリは、この種の権限を使用します。{% ifversion not fpt or ghec %} +リポジトリをスコープとするパッケージは、そのパッケージを所有するリポジトリから権限と可視性を継承します。 以下のレジストリは、この種類の権限**のみ**を利用します:{% ifversion not fpt or ghec %} - Dockerレジストリ (`docker.pkg.github.com`){% endif %} -- npmレジストリ +{% ifversion packages-npm-v2 %}{% else %}- npm registry{% endif %} - RubyGemsレジストリ - Apache Mavenレジストリ - NuGetレジストリ {% ifversion fpt or ghec %} -コンテナレジストリは、個人ユーザもしくはOrganizationアカウントが所有する各パッケージごとにカスタマイズできる、詳細な権限及び可視性の設定のオプションを提供します。 詳細な権限を利用することも、パッケージをレジストリに接続してその権限を継承することもできます。 詳しい情報については「[リポジトリのパッケージへの接続](/packages/learn-github-packages/connecting-a-repository-to-a-package)」を参照してください。 +{% data variables.product.prodname_ghcr_and_npm_registry %}は、個人ユーザもしくはOrganizationアカウントが所有する各パッケージごとにカスタマイズできる、詳細な権限及び可視性の設定のオプションを提供します。 詳細な権限を利用することも、パッケージをレジストリに接続してその権限を継承することもできます。 詳しい情報については「[リポジトリのパッケージへの接続](/packages/learn-github-packages/connecting-a-repository-to-a-package)」を参照してください。 {% endif %} 詳しい情報については「[GitHub Packagesの権限について](/packages/learn-github-packages/about-permissions-for-github-packages)」{% ifversion fpt or ghec %}及び「[パッケージのアクセス制御と可視性の設定](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)」{% endif %}を参照してください。 diff --git a/translations/ja-JP/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md b/translations/ja-JP/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md index abf40d8435..6b3f8fc7cd 100644 --- a/translations/ja-JP/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md +++ b/translations/ja-JP/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md @@ -24,9 +24,9 @@ shortTitle: Publish & install with Actions You can extend the CI and CD capabilities of your repository by publishing or installing packages as part of your workflow. {% ifversion fpt or ghec %} -### Authenticating to the {% data variables.product.prodname_container_registry %} +### Authenticating to the {% data variables.product.prodname_ghcr_and_npm_registry %} -{% data reusables.package_registry.authenticate_with_pat_for_container_registry %} +{% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} {% endif %} @@ -40,7 +40,7 @@ You can reference the `GITHUB_TOKEN` in your workflow file using the {% raw %}`{ {% note %} -**Note:** Repository-owned packages include RubyGems, npm, Apache Maven, NuGet, {% ifversion fpt or ghec %}and Gradle. {% else %}Gradle, and Docker packages that use the package namespace `docker.pkg.github.com`.{% endif %} +**Note:** Some registries, such as RubyGems, {% ifversion packages-npm-v2 %}{% else %}npm, {% endif %}Apache Maven, NuGet, {% ifversion fpt or ghec %}and Gradle{% else %}Gradle, and Docker packages that use the package namespace `docker.pkg.github.com`{% endif %}, only allow repository-owned packages. With {% data variables.product.prodname_ghcr_and_npm_registry_full %} you can choose to allow packages to be owned by a user, an organization, or linked to a repository. {% endnote %} @@ -49,11 +49,11 @@ When you enable GitHub Actions, GitHub installs a GitHub App on your repository. {% data variables.product.prodname_registry %} allows you to push and pull packages through the `GITHUB_TOKEN` available to a {% data variables.product.prodname_actions %} workflow. {% ifversion fpt or ghec %} -## About permissions and package access for {% data variables.product.prodname_container_registry %} +## About permissions and package access for {% data variables.product.prodname_ghcr_and_npm_registry %} -The {% data variables.product.prodname_container_registry %} (`ghcr.io`) allows users to create and administer containers as free-standing resources at the organization level. Containers can be owned by an organization or personal account and you can customize access to each of your containers separately from repository permissions. +The {% data variables.product.prodname_ghcr_and_npm_registry_full %} allows users to create and administer packages as free-standing resources at the organization level. Packages can be owned by an organization or personal account and you can customize access to each of your packages separately from repository permissions. -All workflows accessing the {% data variables.product.prodname_container_registry %} should use the `GITHUB_TOKEN` instead of a personal access token. For more information about security best practices, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)." +All workflows accessing the {% data variables.product.prodname_ghcr_and_npm_registry %} should use the `GITHUB_TOKEN` instead of a personal access token. For more information about security best practices, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)." ## Default permissions and access settings for containers modified through workflows @@ -484,9 +484,9 @@ Installing packages hosted by {% data variables.product.prodname_registry %} thr {% data reusables.package_registry.actions-configuration %} {% ifversion fpt or ghec %} -## Upgrading a workflow that accesses `ghcr.io` +## Upgrading a workflow that accesses a registry using a PAT -The {% data variables.product.prodname_container_registry %} supports the `GITHUB_TOKEN` for easy and secure authentication in your workflows. If your workflow is using a personal access token (PAT) to authenticate to `ghcr.io`, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. +The {% data variables.product.prodname_ghcr_and_npm_registry %} support the `GITHUB_TOKEN` for easy and secure authentication in your workflows. If your workflow is using a personal access token (PAT) to authenticate to the registry, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. For more information about the `GITHUB_TOKEN`, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)." @@ -504,9 +504,9 @@ Using the `GITHUB_TOKEN` instead of a PAT, which includes the `repo` scope, incr {% endnote %} 1. Optionally, using the "role" drop-down menu, select the default access level that you'd like the repository to have to your container image. ![Permission access levels to give to repositories](/assets/images/help/package-registry/repository-permission-options-for-package-access-through-actions.png) -1. Open your workflow file. On the line where you log in to `ghcr.io`, replace your PAT with {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. +1. Open your workflow file. On the line where you log in to the registry, replace your PAT with {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. -For example, this workflow publishes a Docker image using {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} to authenticate. +For example, this workflow publishes a Docker image to the {% data variables.product.prodname_container_registry %} and uses {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} to authenticate. ```yaml{:copy} name: Demo Push diff --git a/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md b/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md index 02708a404d..98ac905c0a 100644 --- a/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md +++ b/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md @@ -42,7 +42,9 @@ When installing or publishing a Docker image, the {% data variables.product.prod ## Authenticating to the {% data variables.product.prodname_container_registry %} -{% data reusables.package_registry.authenticate_with_pat_for_container_registry %} +{% ifversion fpt or ghec or ghes > 3.4 %} +To authenticate to the {% data variables.product.prodname_container_registry %} (`ghcr.io`) within a {% data variables.product.prodname_actions %} workflow, use the `GITHUB_TOKEN` for the best security and experience. {% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} +{% endif %} {% ifversion ghes %}Ensure that you replace `HOSTNAME` with {% data variables.product.product_location_enterprise %} hostname or IP address in the examples below.{% endif %} diff --git a/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md index 6714384e4d..8007cd2b6f 100644 --- a/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md +++ b/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -21,6 +21,8 @@ shortTitle: npm registry {% data reusables.package_registry.admins-can-configure-package-types %} +{% ifversion packages-npm-v2 %} +{% else %} ## Limits for published npm versions If you publish over 1,000 npm package versions to {% data variables.product.prodname_registry %}, you may see performance issues and timeouts occur during usage. @@ -28,12 +30,17 @@ If you publish over 1,000 npm package versions to {% data variables.product.prod In the future, to improve performance of the service, you won't be able to publish more than 1,000 versions of a package on {% data variables.product.prodname_dotcom %}. Any versions published before hitting this limit will still be readable. If you reach this limit, consider deleting package versions or contact Support for help. When this limit is enforced, our documentation will be updated with a way to work around this limit. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" or "[Contacting Support](/packages/learn-github-packages/about-github-packages#contacting-support)." +{% endif %} ## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} -{% data reusables.package_registry.authenticate-packages-github-token %} +{% ifversion packages-npm-v2 %} +{% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} + +You can also choose to give access permissions to packages independently for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_actions %}. For more information, see "[Ensuring Codespaces access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-codespaces-access-to-your-package) and [Ensuring workflow access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package)." +{% endif %} ### Authenticating with a personal access token @@ -94,12 +101,24 @@ $ npm login --scope=@OWNER --registry=https://HOSTNAME/_regist {% endnote %} -By default, {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the name field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. You can add a summary for the package listing page by including a *README.md* file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. +{% ifversion packages-npm-v2 %} +The {% data variables.product.prodname_registry %} registry stores npm packages within your organization or personal account, and allows you to associate a package with a repository. You can choose whether to inherit permissions from a repository, or set granular permissions independently of a repository. +{% endif %} + +By default, {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the name field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. If you're running [npm v8.5.3](https://github.com/npm/cli/releases/tag/v8.5.3) or later, you can add a summary for the package listing page by including a *README.md* file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. You can publish multiple packages to the same {% data variables.product.prodname_dotcom %} repository by including a `URL` field in the *package.json* file. For more information, see "[Publishing multiple packages to the same repository](#publishing-multiple-packages-to-the-same-repository)." +{% ifversion fpt or ghec %} +When a package is published, it isn't automatically linked to a repository. You can however choose to link your published package to a repository using the user interface or command line. For more information, see "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)." +{% endif %} + You can set up the scope mapping for your project using either a local *.npmrc* file in the project or using the `publishConfig` option in the *package.json*. {% data variables.product.prodname_registry %} only supports scoped npm packages. Scoped packages have names with the format of `@owner/name`. Scoped packages always begin with an `@` symbol. You may need to update the name in your *package.json* to use the scoped name. For example, `"name": "@codertocat/hello-world-npm"`. +{% ifversion packages-npm-v2 %} +When you first publish a package, the default visibility is private. When a package is linked to repository, the package visibility is dependent on the repository's visibility. To change the visibility or set access permissions, see "[Configuring a package's access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." +{% endif %} + {% data reusables.package_registry.viewing-packages %} ### Publishing a package using a local *.npmrc* file diff --git a/translations/ja-JP/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/translations/ja-JP/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index a5c0f73d4c..faead37ea4 100644 --- a/translations/ja-JP/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/translations/ja-JP/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -46,7 +46,7 @@ DNS レコードの設定が正しいかどうかを検証するために利用 {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} 4. "Custom domain（カスタムドメイン）" の下で、カスタムドメインを入力して**Save（保存）**をクリックします。 サイトをブランチから公開しているなら、これで`CNAME`ファイルをソースブランチのルートに追加するコミットが作成されます。 サイトをカスタムの{% data variables.product.prodname_actions %}ワークフローで公開しているなら、`CNAME`ファイルは作成されません。 公開ソースに関する詳しい情報については「[GitHub Pagesサイトの公開ソースの設定](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)」を参照してください。 ![カスタムドメインの保存ボタン](/assets/images/help/pages/save-custom-subdomain.png) -5. お使いの DNS プロバイダにアクセスし、サブドメインがサイトのデフォルトドメインを指す `CNAME` レコードを作成します。 たとえば、サイトで `www.example.com` というサブドメインを使いたい場合、`www.example.com` が `.github.io` を指す`CNAME` レコードを作成します。 Organization サイトで `www.anotherexample.com` というサブドメインを使用する場合、`www.anotherexample.com` が `.github.io` を指す`CNAME` レコードを作成します。 `CNAME` レコードは、リポジトリ名を除いて、常に`.github.io` または `.github.io` を指している必要があります。 {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} +5. お使いの DNS プロバイダにアクセスし、サブドメインがサイトのデフォルトドメインを指す `CNAME` レコードを作成します。 たとえば、サイトで `www.example.com` というサブドメインを使いたい場合、`www.example.com` が `.github.io` を指す`CNAME` レコードを作成します。 Organization サイトで `another.example.com` というサブドメインを使用する場合、`another.example.com` が `.github.io` を指す`CNAME` レコードを作成します。 `CNAME` レコードは、リポジトリ名を除いて、常に`.github.io` または `.github.io` を指している必要があります。 {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} {% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %} {% data reusables.command_line.open_the_multi_os_terminal %} diff --git a/translations/ja-JP/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md b/translations/ja-JP/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md deleted file mode 100644 index af19845c4e..0000000000 --- a/translations/ja-JP/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: Adding a theme to your GitHub Pages site with the theme chooser -intro: 'You can add a theme to your {% data variables.product.prodname_pages %} site to customize your site’s look and feel.' -redirect_from: - - /articles/creating-a-github-pages-site-with-the-jekyll-theme-chooser - - /articles/adding-a-jekyll-theme-to-your-github-pages-site-with-the-jekyll-theme-chooser - - /articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser - - /github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser -product: '{% data reusables.gated-features.pages %}' -versions: - fpt: '*' - ghec: '*' -topics: - - Pages -shortTitle: Add theme to a Pages site -permissions: People with admin permissions for a repository can use the theme chooser to add a theme to a {% data variables.product.prodname_pages %} site. ---- - -## About the theme chooser - -{% ifversion pages-custom-workflow %} - -{% note %} - -**Note**: The Jekyll theme chooser is not supported for {% data variables.product.prodname_pages %} sites that are published with a custom {% data variables.product.prodname_actions %} workflow. If you build your site with Jekyll and publish your site with a custom {% data variables.product.prodname_actions %} workflow, you can add a theme by editing the `_config.yml` file. For more information, see "[Adding a theme to your GitHub Pages site using Jekyll](/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll)." - -{% endnote %} - -{% endif %} - -The theme chooser adds a Jekyll theme to your repository. For more information about Jekyll, see "[About {% data variables.product.prodname_pages %} and Jekyll](/articles/about-github-pages-and-jekyll)." - -How the theme chooser works depends on whether your repository is public or private. - - If {% data variables.product.prodname_pages %} is already enabled for your repository, the theme chooser will add your theme to the current publishing source. - - If your repository is public and {% data variables.product.prodname_pages %} is disabled for your repository, using the theme chooser will enable {% data variables.product.prodname_pages %} and configure the default branch as your publishing source. - - If your repository is private and {% data variables.product.prodname_pages %} is disabled for your repository, you must enable {% data variables.product.prodname_pages %} by configuring a publishing source before you can use the theme chooser. - -For more information about publishing sources, see "[About {% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)." - -If you manually added a Jekyll theme to your repository in the past, those files may be applied even after you use the theme chooser. To avoid conflicts, remove all manually added theme folders and files before using the theme chooser. For more information, see "[Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)." - -## Adding a theme with the theme chooser - -{% data reusables.pages.navigate-site-repo %} -{% data reusables.repositories.sidebar-settings %} -{% data reusables.pages.sidebar-pages %} -3. Under "{% data variables.product.prodname_pages %}," click **Choose a theme** or **Change theme**. - ![Choose a theme button](/assets/images/help/pages/choose-a-theme.png) -4. On the top of the page, click the theme you want, then click **Select theme**. - ![Theme options and Select theme button](/assets/images/help/pages/select-theme.png) -5. You may be prompted to edit your site's *README.md* file. - - To edit the file later, click **Cancel**. - ![Cancel link when editing a file](/assets/images/help/pages/cancel-edit.png) - - To edit the file now, see "[Editing files](/repositories/working-with-files/managing-files/editing-files)." - -Your chosen theme will automatically apply to markdown files in your repository. To apply your theme to HTML files in your repository, you need to add YAML front matter that specifies a layout to each file. For more information, see "[Front Matter](https://jekyllrb.com/docs/front-matter/)" on the Jekyll site. - -## Further reading - -- [Themes](https://jekyllrb.com/docs/themes/) on the Jekyll site diff --git a/translations/ja-JP/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md b/translations/ja-JP/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md index 4c79409386..0edee4e672 100644 --- a/translations/ja-JP/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md +++ b/translations/ja-JP/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md @@ -59,9 +59,9 @@ shortTitle: GitHub Pagesのサイトの作成 新しいファイルを追加で作成することにより、ページを追加できます。 各ファイルは、公開元と同じディレクトリ構造で、サイト上に表示されます。 たとえば、プロジェクトサイトの公開元が `gh-pages` ブランチで、新しいファイル `/about/contact-us.md` を `gh-pages` ブランチに作成した場合、ファイルは {% ifversion fpt or ghec %}`https://.github.io//{% else %}`http(s):///pages///{% endif %}about/contact-us.html` で表示されます。 -また、サイトの見た目をカスタマイズするため、テーマを追加できます。 詳しい情報については、{% ifversion fpt or ghec %}「[テーマ選択画面で {% data variables.product.prodname_pages %} サイトにテーマを追加する](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser){% else %}「[Jekyll テーマ選択画面で {% data variables.product.prodname_pages %} サイトにテーマを追加する](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll){% endif %}」を参照してください。 +また、サイトの見た目をカスタマイズするため、テーマを追加できます。 詳しい情報については、「[Jekyll を使用して {% data variables.product.prodname_pages %} サイトにテーマを追加する](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)」を参照してください。 -サイトを更にカスタマイズするには、Jekyll を使用できます。Jekyll は、{% data variables.product.prodname_pages %} に組み込まれている静的サイトジェネレータです。 詳しい情報については、「[{% data variables.product.prodname_pages %} と Jekyll](/articles/about-github-pages-and-jekyll)」を参照してください。 +サイトを更にカスタマイズするには、Jekyll を使用できます。Jekyll は、{% data variables.product.prodname_pages %} に組み込まれている静的サイトジェネレータです。 詳しい情報については、「[{% data variables.product.prodname_pages %} と Jekyllについて](/articles/about-github-pages-and-jekyll)」を参照してください。 ## 参考リンク diff --git a/translations/ja-JP/content/pages/getting-started-with-github-pages/index.md b/translations/ja-JP/content/pages/getting-started-with-github-pages/index.md index 1714b813ba..f748c506c8 100644 --- a/translations/ja-JP/content/pages/getting-started-with-github-pages/index.md +++ b/translations/ja-JP/content/pages/getting-started-with-github-pages/index.md @@ -17,7 +17,6 @@ topics: children: - /about-github-pages - /creating-a-github-pages-site - - /adding-a-theme-to-your-github-pages-site-with-the-theme-chooser - /configuring-a-publishing-source-for-your-github-pages-site - /changing-the-visibility-of-your-github-pages-site - /creating-a-custom-404-page-for-your-github-pages-site diff --git a/translations/ja-JP/content/pages/index.md b/translations/ja-JP/content/pages/index.md index b0bd3c3c8c..d84c347fd4 100644 --- a/translations/ja-JP/content/pages/index.md +++ b/translations/ja-JP/content/pages/index.md @@ -12,7 +12,6 @@ featuredLinks: - '{% ifversion fpt or ghec %}/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site{% endif %}' - '{% ifversion ghes or ghae %}/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll{% endif %}' - '{% ifversion ghec %}/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site{% endif %}' - - '{% ifversion fpt %}/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser{% endif %}' - '{% ifversion ghes or ghae %}/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll{% endif %}' popular: - '{% ifversion fpt or ghec %}/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages{% endif %}' diff --git a/translations/ja-JP/content/pages/quickstart.md b/translations/ja-JP/content/pages/quickstart.md index 34ebe0cad1..7dc9af525b 100644 --- a/translations/ja-JP/content/pages/quickstart.md +++ b/translations/ja-JP/content/pages/quickstart.md @@ -26,11 +26,12 @@ product: '{% data reusables.gated-features.pages %}' 1. リポジトリ名として`username.github.io`を入力してください。 `username`を自分の{% data variables.product.prodname_dotcom %}ユーザ名で置き換えてください。 たとえば、ユーザ名が`octocat`なら、リポジトリ名は`octocat.github.io`となります。 ![リポジトリ名フィールド](/assets/images/help/pages/create-repository-name-pages.png) {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -1. **Choose a theme（テーマの選択）**をクリックしてください。 ![[Choose a theme] ボタン](/assets/images/help/pages/choose-theme.png) -2. テーマ選択画面が開きます。 利用可能なテーマをブラウズし、**Select theme（テーマの選択）**をクリックしてテーマを選択してください。 後でテーマを変更することも容易なので、はっきりしない場合はとりあえずどれか1つを選択しておいてください。 ![テーマのオプションおよび [Select theme] ボタン](/assets/images/help/pages/select-theme.png) -3. テーマとを選択すると、ファイルエディタで`README.md`ファイルが開かれます。 `README.md`ファイルは、サイトの内容を書くところです。 このファイルを編集することも、あるいはとりあえずデフォルトの内容をそのままにしておくこともできます。 -4. ファイルの編集が終わったら、**Commit changes（変更をコミット）**をクリックしてください。 -5. `username.github.io`にアクセスして、新しいWebサイトを見てみてください。 **メモ:** サイトに対する変更は、その変更を{% data variables.product.product_name %}にプッシュしてから公開されるまでに、最大20分かかることがあります。 +1. "Build and deployment（ビルドとデプロイ）"の下の"Source（ソース）"の下で、**Deploy from a branch（ブランチからデプロイ）**を選択してください。 +1. "Build and deployment（ビルドとデプロイ）"の下の"Branch（ブランチ）"の下で、**None（無し）**もしくは**Branch（ブランチ）**ドロップダウンメニューを使って公開ソースを選択してください。 + + ![公開元を選択するドロップダウンメニュー](/assets/images/help/pages/publishing-source-drop-down.png) +1. あるいは、リポジトリの`README.md`ファイルを開いてください。 `README.md`ファイルは、サイトの内容を書くところです。 このファイルを編集することも、あるいはとりあえずデフォルトの内容をそのままにしておくこともできます。 +1. `username.github.io`にアクセスして、新しいWebサイトを見てみてください。 **メモ:** サイトに対する変更は、その変更を{% data variables.product.product_name %}にプッシュしてから公開されるまでに、最大10分かかることがあります。 ## タイトルと説明の変更 diff --git a/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md b/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md index 9491879d40..68434b0b94 100644 --- a/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md +++ b/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md @@ -75,9 +75,9 @@ You can add `site.github` to a post or page to add any repository references met {% data reusables.pages.add-jekyll-theme %} For more information, see "[Themes](https://jekyllrb.com/docs/themes/)" in the Jekyll documentation. {% ifversion fpt or ghec %} -You can add a supported theme to your site on {% data variables.product.prodname_dotcom %}. For more information, see "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site and "[Adding a theme to your {% data variables.product.prodname_pages %} site with the theme chooser](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser)." +You can add a supported theme to your site on {% data variables.product.prodname_dotcom %}. For more information, see "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site and [Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll"](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll). -To use any other open source Jekyll theme hosted on {% data variables.product.prodname_dotcom %}, you can add the theme manually.{% else %} You can add a theme to your site manually.{% endif %} For more information, see{% ifversion fpt or ghec %} [themes hosted on {% data variables.product.prodname_dotcom %}](https://github.com/topics/jekyll-theme) and{% else %} "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site and{% endif %} "[Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)." +To use any other open source Jekyll theme hosted on {% data variables.product.prodname_dotcom %}, you can add the theme manually.{% else %} You can add a theme to your site manually.{% endif %} For more information, see{% ifversion fpt or ghec %} [themes hosted on {% data variables.product.prodname_dotcom %}](https://github.com/topics/jekyll-theme) and{% else %} "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site and{% endif %} "[Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)". You can override any of your theme's defaults by editing the theme's files. For more information, see your theme's documentation and "[Overriding your theme's defaults](https://jekyllrb.com/docs/themes/#overriding-theme-defaults)" in the Jekyll documentation. @@ -96,7 +96,7 @@ You can download or create Jekyll plugins to extend the functionality of Jekyll - [`jekyll-titles-from-headings`](https://github.com/benbalter/jekyll-titles-from-headings) - [`jekyll-relative-links`](https://github.com/benbalter/jekyll-relative-links) -You can enable additional plugins by adding the plugin's gem to the `plugins` setting in your *_config.yml* file. For more information, see "[Configuration](https://jekyllrb.com/docs/configuration/)" in the Jekyll documentation. +You can enable additional plugins by adding the plugin's gem to the `plugins` setting in your *_config.yml* file. For more information, see "[Configuration](https://jekyllrb.com/docs/configuration/)" in the Jekyll documentation. For a list of supported plugins, see "[Dependency versions](https://pages.github.com/versions/)" on the {% data variables.product.prodname_pages %} site. For usage information for a specific plugin, see the plugin's documentation. diff --git a/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md b/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md index 9e84172aa2..8579be29e2 100644 --- a/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md +++ b/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md @@ -26,7 +26,7 @@ shortTitle: Jekyll build errors for Pages {% note %} -**Note:** It can take up to 20 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}. +**Note:** It can take up to 10 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}. {% endnote %} diff --git a/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md b/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md index ee88d5b4e1..ebc8c85eca 100644 --- a/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md +++ b/translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md @@ -6,6 +6,7 @@ redirect_from: - /articles/adding-a-jekyll-theme-to-your-github-pages-site - /articles/adding-a-theme-to-your-github-pages-site-using-jekyll - /github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-using-jekyll + - /pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser product: '{% data reusables.gated-features.pages %}' versions: fpt: '*' diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md index 6864a5bda6..7b612dd94b 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md @@ -27,7 +27,7 @@ redirect_from: 1. In the "Pull Requests" list, click the pull request you would like to add to a merge queue. 1. Click **Merge when ready** to add the pull request to the merge queue. Alternatively, if you are an administrator, you can: - - Directly merge the pull request by checking **Merge without waiting for requirements to be met (administrators only)**, if allowed by branch protection settings, and follow the standard flow. ![Merge queue options](/assets/images/help/pull_requests/merge-queue-options.png) + - Directly merge the pull request by checking **Merge without waiting for requirements to be met ({% ifversion bypass-branch-protections %}bypass branch protections{% else %}administrators only{% endif %})**, if allowed by branch protection settings, and follow the standard flow. ![Merge queue options](/assets/images/help/pull_requests/merge-queue-options.png) {% tip %} diff --git a/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md b/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md index 11e9da1b0d..b7c888993c 100644 --- a/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md +++ b/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md @@ -32,7 +32,10 @@ topics: デフォルト設定では、各ブランチ保護ルールは、一致するブランチへのフォースプッシュを無効にし、一致するブランチが削除されないようにします。 必要に応じて、これらの制限を無効にし、追加のブランチ保護設定を有効にすることができます。 -デフォルト設定では、ブランチ保護ルールの制限は、リポジトリへの管理者権限を持つユーザには適用されません。 必要に応じて、管理者を含めることもできます。 +{% ifversion bypass-branch-protections %} +By default, the restrictions of a branch protection rule don't apply to people with admin permissions to the repository or custom roles with the "bypass branch protections" permission. You can optionally apply the restrictions to administrators and roles with the "bypass branch protections" permission, too. For more information, see "[Managing custom repository roles for an organization](/en/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". +{% else %} +デフォルト設定では、ブランチ保護ルールの制限は、リポジトリへの管理者権限を持つユーザには適用されません。 You can optionally choose to include administrators, too.{% endif %} {% data reusables.repositories.branch-rules-example %} ブランチ名のパターンの詳細については、「[ブランチ保護ルールを管理する](/github/administering-a-repository/managing-a-branch-protection-rule)」を参照してください。 @@ -52,7 +55,7 @@ topics: {%- ifversion required-deployments %} - [Require deployments to succeed before merging](#require-deployments-to-succeed-before-merging) {%- endif %} -- [管理者を含める](#include-administrators) +{% ifversion bypass-branch-protections %}- [Do not allow bypassing the above settings](#do-not-allow-bypassing-the-above-settings){% else %}- [Include administrators](#include-administrators){% endif %} - [一致するブランチにプッシュできるユーザを制限](#restrict-who-can-push-to-matching-branches) - [フォースプッシュを許可](#allow-force-pushes) - [削除を許可](#allow-deletions) @@ -149,9 +152,15 @@ Requires all comments on the pull request to be resolved before it can be merged You can require that changes are successfully deployed to specific environments before a branch can be merged. For example, you can use this rule to ensure that changes are successfully deployed to a staging environment before the changes merge to your default branch. -### 管理者を含める +{% ifversion bypass-branch-protections %}### Do not allow bypassing the above settings{% else %} +### Include administrators{% endif %} -デフォルトでは、保護されたブランチのルールは、リポジトリの管理者権限を持つユーザには適用されません。 この設定を有効化すると、保護されたブランチのルールを管理者にも適用できます。 +{% ifversion bypass-branch-protections %} +By default, the restrictions of a branch protection rule do not apply to people with admin permissions to the repository or custom roles with the "bypass branch protections" permission in a repository. + +You can enable this setting to apply the restrictions to admins and roles with the "bypass branch protections" permission, too. For more information, see "[Managing custom repository roles for an organization](/en/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". +{% else %} +デフォルトでは、保護されたブランチのルールは、リポジトリの管理者権限を持つユーザには適用されません。 You can enable this setting to include administrators in your protected branch rules.{% endif %} ### 一致するブランチにプッシュできるユーザを制限 diff --git a/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md b/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md index 595acb4023..f290a34502 100644 --- a/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md +++ b/translations/ja-JP/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md @@ -84,7 +84,7 @@ For more information about each of the available branch protection settings, see {%- ifversion required-deployments %} 1. Optionally, to choose which environments the changes must be successfully deployed to before merging, select **Require deployments to succeed before merging**, then select the environments. ![Require successful deployment option](/assets/images/help/repository/require-successful-deployment.png) {%- endif %} -1. Optionally, select **Apply the rules above to administrators**. ![Apply the rules above to administrators checkbox](/assets/images/help/repository/include-admins-protected-branches.png) +1. Optionally, select {% ifversion bypass-branch-protections %}**Do not allow bypassing the above settings**. ![Do not allow bypassing the above settings checkbox](/assets/images/help/repository/do-not-allow-bypassing-the-above-settings.png){% else %}**Apply the rules above to administrators**. ![Apply the rules above to administrators checkbox](/assets/images/help/repository/include-admins-protected-branches.png){% endif %} 1. 必要に応じて、{% ifversion fpt or ghec %}{% data variables.product.prodname_team %} または {% data variables.product.prodname_ghe_cloud %} を使用する Organization がリポジトリを所有している場合には、{% endif %}ブランチ制限を有効化します。 - [**Restrict who can push to matching branches**] を選択します。 ![Branch restriction checkbox](/assets/images/help/repository/restrict-branch.png){% ifversion restrict-pushes-create-branch %} - Optionally, to also restrict the creation of matching branches, select **Restrict pushes that create matching branches**. ![Branch creation restriction checkbox](/assets/images/help/repository/restrict-branch-create.png){% endif %} diff --git a/translations/ja-JP/content/rest/deployments/deployments.md b/translations/ja-JP/content/rest/deployments/deployments.md index 93f1e9d649..489e58df7e 100644 --- a/translations/ja-JP/content/rest/deployments/deployments.md +++ b/translations/ja-JP/content/rest/deployments/deployments.md @@ -19,7 +19,7 @@ miniTocMaxHeadingLevel: 3 デプロイメントのステータスには、オプションとして `description` と `log_url` を含めることもできます。これによりデプロイメントのステータスがより有用なものになるので、非常におすすめです。 `log_url` はデプロイメントの出力の完全な URL で、`description` はデプロイメントで発生したことの概要を示すものです。 -GitHub は、新しいデプロイメント、デプロイメントのステータスが作成されたときに、`deployment` イベント、`deployment_status` イベントをディスパッチします。 これらのイベントにより、サードパーティのインテグレーションがデプロイメントのリクエストに対する応答を受けとり、進展があるたびにステータスを更新できます。 +GitHub は、新しいデプロイメント、デプロイメントのステータスが作成されたときに、`deployment` イベント、`deployment_status` イベントをディスパッチします。 これらのイベントにより、サードパーティのインテグレーションがデプロイメントのリクエストに対する応答を受けとって反応し、進展があるたびにステータスを更新できます。 以下は、これらの相互作用がどのように機能するかを示す簡単なシーケンス図です。 diff --git a/translations/ja-JP/content/rest/guides/getting-started-with-the-checks-api.md b/translations/ja-JP/content/rest/guides/getting-started-with-the-checks-api.md index 11bea77321..3560fe71df 100644 --- a/translations/ja-JP/content/rest/guides/getting-started-with-the-checks-api.md +++ b/translations/ja-JP/content/rest/guides/getting-started-with-the-checks-api.md @@ -41,7 +41,7 @@ GitHub Appは、単に合格/不合格の二択ではない、情報量の多い ![チェック実行のワークフロー](/assets/images/check_runs.png) -チェック実行が15日以上にわたり不完全な状態である場合は、チェック実行の`conclusion`が`stale`になり、{% data variables.product.prodname_dotcom %}に状態が{% octicon "issue-reopened" aria-label="The issue-reopened icon" %}と表示されます。 {% data variables.product.prodname_dotcom %}のみが、チェック実行を`stale`としてマークできます。 チェック実行で出る可能性がある結果についての詳細は、 [`conclusion`パラメータ](/rest/reference/checks#create-a-check-run--parameters)を参照してください。 +If a check run is in an incomplete state for more than 14 days, then the check run's `conclusion` becomes `stale` and appears on {% data variables.product.prodname_dotcom %} as stale with {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. {% data variables.product.prodname_dotcom %}のみが、チェック実行を`stale`としてマークできます。 チェック実行で出る可能性がある結果についての詳細は、 [`conclusion`パラメータ](/rest/reference/checks#create-a-check-run--parameters)を参照してください。 [`check_suite`](/webhooks/event-payloads/#check_suite) webhookを受け取ったら、チェックが完了していなくてもすぐにチェック実行を作成できます。 チェック実行の`status`は、`queued`、`in_progress`、または`completed`の値で更新でき、より詳細を明らかにして`output`を更新できます。 チェック実行にはタイムスタンプ、詳細情報が記載された外部サイトへのリンク、コードの特定の行に対するアノテーション、および実行した分析についての情報を含めることができます。 diff --git a/translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md b/translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md index e4f9dfe075..dd9545f30b 100644 --- a/translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md +++ b/translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md @@ -1,9 +1,6 @@ --- title: Getting started with the REST API -intro: 'Learn the foundations for using the REST API, starting with authentication and some endpoint examples.' -redirect_from: - - /guides/getting-started - - /v3/guides/getting-started +intro: 'Learn how to use the {% data variables.product.prodname_dotcom %} REST API.' versions: fpt: '*' ghes: '*' @@ -11,477 +8,754 @@ versions: ghec: '*' topics: - API -shortTitle: Get started - REST API +shortTitle: Using the API +miniTocMaxHeadingLevel: 3 --- +## About the {% data variables.product.prodname_dotcom %} REST API -Let's walk through core API concepts as we tackle some everyday use cases. +This article describes how to use the {% data variables.product.prodname_dotcom %} REST API using {% data variables.product.prodname_cli %}, JavaScript, or cURL. For a quickstart guide, see "[Quickstart for GitHub REST API](/rest/quickstart)." -{% data reusables.rest-api.dotcom-only-guide-note %} +When you make a request to the REST API, you will specify an HTTP method and a path. Additionally, you might also specify request headers and path, query, or body parameters. The API will return the response status code, response headers, and potentially a response body. -## Overview +The REST API reference documentation describes the HTTP method, path, and parameters for every operation. It also displays example requests and responses for each operation. For more information, see the [REST reference documentation](/rest). -Most applications will use an existing [wrapper library][wrappers] in the language -of your choice, but it's important to familiarize yourself with the underlying API -HTTP methods first. +## Making a request -There's no easier way to kick the tires than through [cURL][curl].{% ifversion fpt or ghec %} If you are using -an alternative client, note that you are required to send a valid -[User Agent header](/rest/overview/resources-in-the-rest-api#user-agent-required) in your request.{% endif %} +To make a request, first find the HTTP method and the path for the operation that you want to use. For example, the "Get Octocat" operation uses the `GET` method and the `/octocat` path. For the full reference documentation for this operation, see "[Get Octocat](/rest/meta#get-octocat)." -### Hello World +{% cli %} -Let's start by testing our setup. Open up a command prompt and enter the -following command: +{% note %} + +**Note**: You must install {% data variables.product.prodname_cli %} in order to use the commands in the {% data variables.product.prodname_cli %} examples. For installation instructions, see the [{% data variables.product.prodname_cli %} repository](https://github.com/cli/cli#installation). + +{% endnote %} + +If you are not already authenticated to {% data variables.product.prodname_cli %}, you must use the `gh auth login` subcommand to authenticate before making any requests. For more information, see "[Authenticating](#authenticating)." + +To make a request using {% data variables.product.prodname_cli %}, use the `api` subcommand along with the path. Use the `--method` or `-X` flag to specify the method. ```shell -$ curl https://api.github.com/zen - -> Keep it logically awesome. +gh api /octocat --method GET ``` -The response will be a random selection from our design philosophies. +{% endcli %} -Next, let's `GET` [Chris Wanstrath's][defunkt github] [GitHub profile][users api]: +{% javascript %} + +{% note %} + +**Note**: You must install and import `octokit` in order to use the Octokit.js library used in the JavaScript examples. For more information, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). + +{% endnote %} + +To make a request using JavaScript, you can use Octokit.js. For more information, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). + +First, create an instance of `Octokit`.{% ifversion ghes or ghae %} Set the base URL to `{% data variables.product.api_url_code %}`. Replace `[hostname]` with the name of {% data variables.product.product_location %}.{% endif %} + +```javascript +const octokit = new Octokit({ {% ifversion ghes or ghae %} + baseUrl: "{% data variables.product.api_url_code %}", +{% endif %}}); +``` + +Then, use the `request` method to make requests. Pass the HTTP method and path as the first argument. + +```javascript +await octokit.request("GET /octocat", {}); +``` + +{% endjavascript %} + +{% curl %} + +Prepend the base URL for the {% data variables.product.prodname_dotcom %} REST API, `{% data variables.product.api_url_code %}`, to the path to get the full URL: `{% data variables.product.api_url_code %}/octocat`.{% ifversion ghes or ghae %} Replace `[hostname]` with the name of {% data variables.product.product_location %}.{% endif %} + +Use the `curl` command in your command line. Use the `--request` or `-X` flag followed by the HTTP method. Use the `--url` flag followed by the full URL. ```shell -# GET /users/defunkt -$ curl https://api.github.com/users/defunkt - -> { -> "login": "defunkt", -> "id": 2, -> "node_id": "MDQ6VXNlcjI=", -> "avatar_url": "https://avatars.githubusercontent.com/u/2?v=4", -> "gravatar_id": "", -> "url": "https://api.github.com/users/defunkt", -> "html_url": "https://github.com/defunkt", -> ... -> } +curl --request GET \ +--url "https://api.github.com/octocat" ``` -Mmmmm, tastes like [JSON][json]. Let's add the `-i` flag to include headers: +{% note %} + +**Note**: If you get a message similar to "command not found: curl", you may need to download and install cURL. For more information, see [the cURL project download page](https://curl.se/download.html). + +{% endnote %} + +{% endcurl %} + +Continue reading to learn how to authenticate, send parameters, and use the response. + +## Authenticating + +Many operations require authentication or return additional information if you are authenticated. Additionally, you can make more requests per hour when you are authenticated.{% cli %} Although some REST API operations are accessible without authentication, you must authenticate to {% data variables.product.prodname_cli %} in order to use the `api` subcommand.{% endcli %} + +### About tokens + +You can authenticate your request by adding a token. + +If you want to use the {% data variables.product.company_short %} REST API for personal use, you can create a personal access token (PAT). The REST API operations used in this article require `repo` scope for personal access tokens. Other operations may require different scopes. For more information about creating a personal access token, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + +If you want to use the API on behalf of an organization or another user, {% data variables.product.company_short %} recommends that you use a {% data variables.product.prodname_github_app %}. If an operation is available to {% data variables.product.prodname_github_apps %}, the REST reference documentation for that operation will say "Works with GitHub Apps." The REST API operations used in this article require `issues` read and write permissions for {% data variables.product.prodname_github_apps %}. Other operations may require different permissions. For more information, see "[Creating a GitHub App](/developers/apps/building-github-apps/creating-a-github-app)", "[Authenticating with GitHub Apps](/developers/apps/building-github-apps/authenticating-with-github-apps), and "[Identifying and authorizing users for GitHub Apps](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps)." + +If you want to use the API in a {% data variables.product.prodname_actions %} workflow, {% data variables.product.company_short %} recommends that you authenticate with the built-in `GITHUB_TOKEN` instead of creating a token. You can grant permissions to the `GITHUB_TOKEN` with the `permissions` key. For more information, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token)." + +### Authentication example + +{% cli %} + +With {% data variables.product.prodname_cli %}, you don't need to create an access token in advance. Use the `auth login` subcommand to authenticate to {% data variables.product.prodname_cli %}: ```shell -$ curl -i https://api.github.com/users/defunkt - -> HTTP/2 200 -> server: GitHub.com -> date: Thu, 08 Jul 2021 07:04:08 GMT -> content-type: application/json; charset=utf-8 -> cache-control: public, max-age=60, s-maxage=60 -> vary: Accept, Accept-Encoding, Accept, X-Requested-With -> etag: W/"61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0" -> last-modified: Fri, 01 Nov 2019 21:56:00 GMT -> x-github-media-type: github.v3; format=json -> access-control-expose-headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, Deprecation, Sunset -> access-control-allow-origin: * -> strict-transport-security: max-age=31536000; includeSubdomains; preload -> x-frame-options: deny -> x-content-type-options: nosniff -> x-xss-protection: 0 -> referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin -> content-security-policy: default-src 'none' -> x-ratelimit-limit: 60 -> x-ratelimit-remaining: 53 -> x-ratelimit-reset: 1625731053 -> x-ratelimit-resource: core -> x-ratelimit-used: 7 -> accept-ranges: bytes -> content-length: 1305 -> x-github-request-id: 9F60:7019:ACC5CD5:B03C931:60E6A368 -> -> { -> "login": "defunkt", -> "id": 2, -> "node_id": "MDQ6VXNlcjI=", -> "avatar_url": "https://avatars.githubusercontent.com/u/2?v=4", -> "gravatar_id": "", -> "url": "https://api.github.com/users/defunkt", -> "html_url": "https://github.com/defunkt", -> -> ... -> } +gh auth login ``` -There are a few interesting bits in the response headers. As expected, the -`Content-Type` is `application/json`. +You can use the `--scopes` flag to specify what scopes you want. If you want to authenticate with a token that you created, you can use the `--with-token` flag. For more information, see the [{% data variables.product.prodname_cli %} `auth login` documentation](https://cli.github.com/manual/gh_auth_login). -Any headers beginning with `X-` are custom headers, and are not included in the -HTTP spec. For example, take note of the `X-RateLimit-Limit` and `X-RateLimit-Remaining` headers. This -pair of headers indicate [how many requests a client can make][rate-limiting] in -a rolling time period (typically an hour) and how many of those requests the -client has already spent. +{% endcli %} -## Authentication - -Unauthenticated clients can make 60 requests per hour. To get more requests per hour, we'll need to -_authenticate_. In fact, doing anything interesting with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API requires -[authentication][authentication]. - -### Using personal access tokens - -The easiest and best way to authenticate with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API is by using Basic Authentication [via OAuth tokens](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens). OAuth tokens include [personal access tokens][personal token]. - -Use a `-u` flag to set your username: - -```shell -$ curl -i -u your_username {% data variables.product.api_url_pre %}/users/octocat - -``` - -When prompted, you can enter your OAuth token, but we recommend you set up a variable for it: - -You can use `-u "your_username:$token"` and set up a variable for `token` to avoid leaving your token in shell history, which should be avoided. - -```shell -$ curl -i -u your_username:$token {% data variables.product.api_url_pre %}/users/octocat - -``` - -When authenticating, you should see your rate limit bumped to 5,000 requests an hour, as indicated in the `X-RateLimit-Limit` header. In addition to providing more calls per hour, authentication enables you to read and write private information using the API. - -You can easily [create a **personal access token**][personal token] using your [Personal access tokens settings page][tokens settings]: +{% javascript %} {% warning %} -To help keep your information secure, we highly recommend setting an expiration for your personal access tokens. +**Warning**: Treat your access token like a password. + +To keep your token secure, you can store your token as a secret and run your script through {% data variables.product.prodname_actions %}. For more information, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." + +{% ifversion ghec or fpt %}You can also store your token as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} + +If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. {% endwarning %} -{% ifversion fpt or ghes or ghec %} -![Personal Token selection](/assets/images/personal_token.png) +To authenticate with the Octokit.js library, you can pass your token when you create an instance of `Octokit`. Replace `YOUR-TOKEN` with your token.{% ifversion ghes or ghae %} Replace `[hostname]` with the name of {% data variables.product.product_location %}.{% endif %} + +```javascript +const octokit = new Octokit({ {% ifversion ghes or ghae %} + baseUrl: "{% data variables.product.api_url_code %}",{% endif %} + auth: 'YOUR-TOKEN', +}); +``` + +{% endjavascript %} + +{% curl %} + +{% warning %} + +**Warning**: Treat your access token like a password. + +To help keep your account secure, you can use {% data variables.product.prodname_cli %} instead of cURL. {% data variables.product.prodname_cli %} will take care of authentication for you. For more information, see the {% data variables.product.prodname_cli %} version of this page. + +{% ifversion ghec or fpt %}You can also store your token as a {% data variables.product.prodname_codespaces %} secret and use the command line through {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} + +If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. + +{% endwarning %} + +With cURL, you will send an `Authorization` header with your token. Replace `YOUR-TOKEN` with your token: + +```shell +curl --request GET \ +--url "https://api.github.com/octocat" \ +--header "Authorization: Bearer YOUR-TOKEN" +``` + +{% note %} + +**Note:** In most cases, you can use `Authorization: Bearer` or `Authorization: token`. JSON web tokens (JWTs) will only work with `Authorization: Bearer`. + +{% endnote %} + +{% endcurl %} + +### Authentication example for {% data variables.product.prodname_actions %} + +{% cli %} + +You can also use the `run` keyword to execute {% data variables.product.prodname_cli %} commands in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." + +Instead of using the `gh auth login` command, pass your token as an environment variable called `GH_TOKEN`. {% data variables.product.prodname_dotcom %} recommends that you authenticate with the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." + +```yaml +jobs: + use_api: + runs-on: ubuntu-latest + permissions: {} + steps: + - env: + GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + gh api /octocat +``` + +{% endcli %} + +{% javascript %} + +You can also use the `run` keyword to execute your JavaScript scripts in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." + +{% data variables.product.prodname_dotcom %} recommends that you authenticate with the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." + +The following example workflow: + +1. Checks out the repository content +1. Sets up Node.js +1. Installs `octokit` +1. Stores the value of `GITHUB_TOKEN` as an environment variable called `TOKEN` and runs `.github/actions-scripts/use-the-api.mjs`, which can access that environment variable as `process.env.TOKEN` + +Example workflow: + +```yaml +on: + workflow_dispatch: +jobs: + use_api_via_script: + runs-on: ubuntu-latest + permissions: {} + steps: + - name: Check out repo content + uses: {% data reusables.actions.action-checkout %} + + - name: Setup Node + uses: {% data reusables.actions.action-setup-node %} + with: + node-version: '16.15.0' + cache: npm + + - name: Install dependencies + run: npm install octokit + + - name: Run script + env: + TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + node .github/actions-scripts/use-the-api.mjs +``` + +Example JavaScript script, with the file path `.github/actions-scripts/use-the-api.mjs`: + +```javascript +import { Octokit } from "octokit"; + +const octokit = new Octokit({ {% ifversion ghes or ghae %} + baseUrl: "{% data variables.product.api_url_code %}",{% endif %} + auth: process.env.TOKEN, +}); + +await octokit.request("GET /octocat", {}); +``` + +Instead of storing your script in a separate file and executing the script from your workflow, you can use the `actions/github-script` action to run a script. For more information, see the [actions/github-script README](https://github.com/actions/github-script). + +```yaml +jobs: + use_api_via_script: + runs-on: ubuntu-latest + permissions: {} + steps: + - uses: {% data reusables.actions.action-github-script %} + with: + github-token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + script: | + await github.request('GET /octocat', {}) +``` + +{% endjavascript %} + +{% curl %} + +You can also use the `run` keyword to execute cURL commands in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." + +{% data variables.product.prodname_dotcom %} recommends that you authenticate with the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." + +```yaml +jobs: + use_api: + runs-on: ubuntu-latest + permissions: {} + steps: + - env: + GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + curl --request GET \ + --url "https://api.github.com/octocat" \ + --header "Authorization: Bearer $GH_TOKEN" +``` + +{% endcurl %} + +## Using headers + +Most operations specify that you should pass an `Accept` header with a value of `application/vnd.github.v3+json`. Other operations may specify that you should send a different `Accept` header or additional headers. + +{% cli %} + +To send a header with {% data variables.product.prodname_cli %}, use the `--header` or `-H` flag followed by the header in `key: value` format. + +```shell +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /octocat +``` + +{% endcli %} + +{% javascript %} + +The Octokit.js library automatically passes the `Accept: application/vnd.github.v3+json` header. To pass additional headers or a different `Accept` header, add a `headers` property to the object that is passed as a second argument to the `request` method. The value of the `headers` property is an object with the header names as keys and header values as values. For example, to send a `content-type` header with a value of `text/plain`: + +```javascript +await octokit.request("GET /octocat", { + headers: { + "content-type": "text/plain", + }, +}); +``` + +{% endjavascript %} + +{% curl %} + +To send a header with cURL, use the `--header` or `-H` flag followed by the header in `key: value` format. + +```shell +curl --request GET \ +--url "https://api.github.com/octocat" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" +``` + +{% endcurl %} + +## Using path parameters + +Path parameters modify the operation path. For example, the "List repository issues" path is `/repos/{owner}/{repo}/issues`. The curly brackets `{}` denote path parameters that you need to specify. In this case, you must specify the repository owner and name. For the reference documentation for this operation, see "[List repository issues](/rest/issues/issues#list-repository-issues)." + +{% cli %} + +{% ifversion ghes or ghae %} +{% note %} + +**Note:** In order for this command to work for {% data variables.product.product_location %}, replace `octocat/Spoon-Knife` with a repository owned by {% data variables.product.product_location %}. Otherwise, rerun the `gh auth login` command to authenticate to {% data variables.product.prodname_dotcom_the_website %} instead of {% data variables.product.product_location %}. + +{% endnote %} {% endif %} -{% ifversion ghae %} -![Personal Token selection](/assets/images/help/personal_token_ghae.png) +To get issues from the `octocat/Spoon-Knife` repository, replace `{owner}` with `octocat` and `{repo}` with `Spoon-Knife`. + +```shell +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues +``` + +{% endcli %} + +{% javascript %} + +{% ifversion ghes or ghae %} +{% note %} + +**Note:** In order for this example to work for {% data variables.product.product_location %}, replace `octocat/Spoon-Knife` with a repository owned by {% data variables.product.product_location %}. Otherwise, create a new `Octokit` instance and do not specify `baseURL`. + +{% endnote %} {% endif %} -API requests using an expiring personal access token will return that token's expiration date via the `GitHub-Authentication-Token-Expiration` header. You can use the header in your scripts to provide a warning message when the token is close to its expiration date. +When you make a request with Octokit.js, all parameters, including path parameters, are passed in an object as the second argument to the `request` method. To get issues from the `octocat/Spoon-Knife` repository, specify `owner` as `octocat` and `repo` as `Spoon-Knife`. -### Get your own user profile - -When properly authenticated, you can take advantage of the permissions -associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. For example, try getting -[your own user profile][auth user api]: - -```shell -$ curl -i -u your_username:your_token {% data variables.product.api_url_pre %}/user - -> { -> ... -> "plan": { -> "space": 2516582, -> "collaborators": 10, -> "private_repos": 20, -> "name": "medium" -> } -> ... -> } +```javascript +await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife" +}); ``` -This time, in addition to the same set of public information we -retrieved for [@defunkt][defunkt github] earlier, you should also see the non-public information for your user profile. For example, you'll see a `plan` object in the response which gives details about the {% data variables.product.product_name %} plan for the account. +{% endjavascript %} -### Using OAuth tokens for apps +{% curl %} -Apps that need to read or write private information using the API on behalf of another user should use [OAuth][oauth]. +To get issues from the `octocat/Spoon-Knife` repository, replace `{owner}` with `octocat` and `{repo}` with `Spoon-Knife`. To build the full path, prepend the base URL for the {% data variables.product.prodname_dotcom %} REST API, `https://api.github.com`: `https://api.github.com/repos/octocat/Spoon-Knife/issues`. -OAuth uses _tokens_. Tokens provide two big features: +{% ifversion ghes or ghae %} +{% note %} -* **Revokable access**: users can revoke authorization to third party apps at any time -* **Limited access**: users can review the specific access that a token - will provide before authorizing a third party app +**Note:** If you want to use {% data variables.product.product_location %} instead of {% data variables.product.prodname_dotcom_the_website %}, use `{% data variables.product.api_url_code %}` instead of `https://api.github.com` and replace `[hostname]` with the name of {% data variables.product.product_location %}. Replace `octocat/Spoon-Knife` with a repository owned by {% data variables.product.product_location %}. -Tokens should be created via a [web flow][webflow]. An application -sends users to {% data variables.product.product_name %} to log in. {% data variables.product.product_name %} then presents a dialog -indicating the name of the app, as well as the level of access the app -has once it's authorized by the user. After a user authorizes access, {% data variables.product.product_name %} -redirects the user back to the application: - -![GitHub's OAuth Prompt](/assets/images/oauth_prompt.png) - -**Treat OAuth tokens like passwords!** Don't share them with other users or store -them in insecure places. The tokens in these examples are fake and the names have -been changed to protect the innocent. - -Now that we've got the hang of making authenticated calls, let's move along to -the [Repositories API][repos-api]. - -## Repositories - -Almost any meaningful use of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API will involve some level of Repository -information. We can [`GET` repository details][get repo] in the same way we fetched user -details earlier: +{% endnote %} +{% endif %} ```shell -$ curl -i {% data variables.product.api_url_pre %}/repos/twbs/bootstrap +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" ``` -In the same way, we can [view repositories for the authenticated user][user repos api]: +{% endcurl %} + +The operation returns a list of issues and data about each issue. For more information about using the response, see the "[Using the response](#using-the-response)" section. + +## Using query parameters + +Query parameters allow you to control what data is returned for a request. For example, a query parameter may let you specify how many items are returned when the response is paginated. + +By default, the "List repository issues" operation returns thirty issues, sorted in descending order by the date they were created. You can use the `per_page` parameter to return two issues instead of 30. You can use the `sort` parameter to sort the issues by the date they were last updated instead of by the date they were created. You can use the `direction` parameter to sort the results in ascending order instead of descending order. + +{% cli %} + +For {% data variables.product.prodname_cli %}, use the `-F` flag to pass a parameter that is a number, Boolean, or null. Use `-f` to pass string parameters. + +{% note %} + +**Note**: {% data variables.product.prodname_cli %} does not currently accept parameters that are arrays. For more information, see [this issue](https://github.com/cli/cli/issues/1484). + +{% endnote %} ```shell -$ curl -i -H "Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a" \ - {% data variables.product.api_url_pre %}/user/repos +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 -f sort=updated -f direction=asc ``` -Or, we can [list repositories for another user][other user repos api]: +{% endcli %} + +{% javascript %} + +When you make a request with Octokit.js, all parameters, including query parameters, are passed in an object as the second argument to the `request` method. + +```javascript +await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + per_page: 2, + sort: "updated", + direction: "asc", +}); +``` + +{% endjavascript %} + +{% curl %} + +For cURL, add a `?` to the end of the path, then append your query parameter name and value in the form `parameter_name=value`. Separate multiple query parameters with `&`. ```shell -$ curl -i {% data variables.product.api_url_pre %}/users/octocat/repos +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2&sort=updated&direction=asc" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" ``` -Or, we can [list repositories for an organization][org repos api]: +{% endcurl %} + +The operation returns a list of issues and data about each issue. For more information about using the response, see the "[Using the response](#using-the-response)" section. + +## Using body parameters + +Body parameters allow you to pass additional data to the API. For example, the "Create an issue" operation requires you to specify a title for the new issue. It also lets you specify other information, such as text to put in the issue body. For the full reference documentation for this operation, see "[Create an issue](/rest/issues/issues#create-an-issue)." + +The "Create an issue" operation uses the same path as the "List repository issues" operation in the examples above, but it uses a `POST` method instead of a `GET` method. + +{% cli %} + +For {% data variables.product.prodname_cli %}, use the `-F` flag to pass a parameter that is a number, Boolean, or null. Use `-f` to pass string parameters. + +{% note %} + +**Note**: {% data variables.product.prodname_cli %} does not currently accept parameters that are arrays. For more information, see [this issue](https://github.com/cli/cli/issues/1484). + +{% endnote %} ```shell -$ curl -i {% data variables.product.api_url_pre %}/orgs/octo-org/repos +gh api --header 'Accept: application/vnd.github.v3+json' --method POST /repos/octocat/Spoon-Knife/issues -f title="Created with the REST API" -f body="This is a test issue created by the REST API" ``` -The information returned from these calls will depend on which scopes our token has when we authenticate: +{% endcli %} -{%- ifversion fpt or ghec or ghes %} -* A token with `public_repo` [scope][scopes] returns a response that includes all public repositories we have access to see on {% data variables.product.product_location %}. -{%- endif %} -* A token with `repo` [scope][scopes] returns a response that includes all {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories we have access to see on {% data variables.product.product_location %}. +{% javascript %} -As the [docs][repos-api] indicate, these methods take a `type` parameter that -can filter the repositories returned based on what type of access the user has -for the repository. In this way, we can fetch only directly-owned repositories, -organization repositories, or repositories the user collaborates on via a team. +When you make a request with Octokit.js, all parameters, including body parameters, are passed in an object as the second argument to the `request` method. + +```javascript +await octokit.request("POST /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + title: "Created with the REST API", + body: "This is a test issue created by the REST API", +}); +``` + +{% endjavascript %} + +{% curl %} + +For cURL, use the `--data` flag to pass the body parameters in a JSON object. ```shell -$ curl -i "{% data variables.product.api_url_pre %}/users/octocat/repos?type=owner" +curl --request POST \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" \ +--data '{ + "title": "Created with the REST API", + "body": "This is a test issue created by the REST API" +}' ``` -In this example, we grab only those repositories that octocat owns, not the -ones on which she collaborates. Note the quoted URL above. Depending on your -shell setup, cURL sometimes requires a quoted URL or else it ignores the -query string. +{% endcurl %} -### Create a repository +The operation creates an issue and returns data about the new issue. In the response, find the `html_url` of your issue and navigate to your issue in the browser. For more information about using the response, see the "[Using the response](#using-the-response)" section. -Fetching information for existing repositories is a common use case, but the -{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API supports creating new repositories as well. To [create a repository][create repo], -we need to `POST` some JSON containing the details and configuration options. +## Using the response + +### About the response code and headers + +Every request will return an HTTP status code that indicates the success of the response. For more information about response codes, see [the MDN HTTP response status code documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status). + +Additionally, the response will include headers that give more details about the response. Headers that start with `X-` or `x-` are custom to {% data variables.product.company_short %}. For example, the `x-ratelimit-remaining` and `x-ratelimit-reset` headers tell you how many requests you can make in a time period. + +{% cli %} + +To view the status code and headers, use the `--include` or `--i` flag when you send your request. + +For example, this request: ```shell -$ curl -i -H "Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a" \ - -d '{ - "name": "blog", - "auto_init": true, - "private": true, - "gitignore_template": "nanoc" - }' \ - {% data variables.product.api_url_pre %}/user/repos +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 --include ``` -In this minimal example, we create a new private repository for our blog (to be served -on [GitHub Pages][pages], perhaps). Though the blog {% ifversion not ghae %}will be public{% else %}is accessible to all enterprise members{% endif %}, we've made the repository private. In this single step, we'll also initialize it with a README and a [nanoc][nanoc]-flavored [.gitignore template][gitignore templates]. - -The resulting repository will be found at `https://github.com//blog`. -To create a repository under an organization for which you're -an owner, just change the API method from `/user/repos` to `/orgs//repos`. - -Next, let's fetch our newly created repository: +returns the response code and headers like: ```shell -$ curl -i {% data variables.product.api_url_pre %}/repos/pengwynn/blog - -> HTTP/2 404 - -> { -> "message": "Not Found" -> } +HTTP/2.0 200 OK +Access-Control-Allow-Origin: * +Access-Control-Expose-Headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset +Cache-Control: private, max-age=60, s-maxage=60 +Content-Security-Policy: default-src 'none' +Content-Type: application/json; charset=utf-8 +Date: Thu, 04 Aug 2022 19:56:41 GMT +Etag: W/"a63dfbcfdb73621e9d2e89551edcf9856731ced534bd7f1e114a5da1f5f73418" +Link: ; rel="next", ; rel="last" +Referrer-Policy: origin-when-cross-origin, strict-origin-when-cross-origin +Server: GitHub.com +Strict-Transport-Security: max-age=31536000; includeSubdomains; preload +Vary: Accept, Authorization, Cookie, X-GitHub-OTP, Accept-Encoding, Accept, X-Requested-With +X-Accepted-Oauth-Scopes: repo +X-Content-Type-Options: nosniff +X-Frame-Options: deny +X-Github-Api-Version-Selected: 2022-08-09 +X-Github-Media-Type: github.v3; format=json +X-Github-Request-Id: 1C73:26D4:E2E500:1EF78F4:62EC2479 +X-Oauth-Client-Id: 178c6fc778ccc68e1d6a +X-Oauth-Scopes: gist, read:org, repo, workflow +X-Ratelimit-Limit: 15000 +X-Ratelimit-Remaining: 14996 +X-Ratelimit-Reset: 1659645499 +X-Ratelimit-Resource: core +X-Ratelimit-Used: 4 +X-Xss-Protection: 0 ``` -Oh noes! Where did it go? Since we created the repository as _private_, we need -to authenticate in order to see it. If you're a grizzled HTTP user, you might -expect a `403` instead. Since we don't want to leak information about private -repositories, the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API returns a `404` in this case, as if to say "we can -neither confirm nor deny the existence of this repository." +In this example, the response code is `200`, which indicates a successful request. -## Issues +{% endcli %} -The UI for Issues on {% data variables.product.product_name %} aims to provide 'just enough' workflow while -staying out of your way. With the {% data variables.product.product_name %} [Issues API][issues-api], you can pull -data out or create issues from other tools to create a workflow that works for -your team. +{% javascript %} -Just like github.com, the API provides a few methods to view issues for the -authenticated user. To [see all your issues][get issues api], call `GET /issues`: +When you make a request with Octokit.js, the `request` method returns a promise. If the request was successful, the promise resolves to an object that includes the HTTP status code of the response (`status`) and the response headers (`headers`). If an error occurs, the promise resolves to an object that includes the HTTP status code of the response (`status`) and the response headers (`response.headers`). + +You can use a `try/catch` block to catch an error if it occurs. For example, if the request in the following script is successful, the script will log the status code and the value of the `x-ratelimit-remaining` header. If the request was not successful, the script will log the status code, the value of the `x-ratelimit-remaining` header, and the error message. + +```javascript +try { + const result = await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + per_page: 2, + }); + + console.log(`Success! Status: ${result.status}. Rate limit remaining: ${result.headers["x-ratelimit-remaining"]}`) + +} catch (error) { + console.log(`Error! Status: ${error.status}. Rate limit remaining: ${error.headers["x-ratelimit-remaining"]}. Message: ${error.response.data.message}`) +} +``` + +{% endjavascript %} + +{% curl %} + +To view the status code and headers, use the `--include` or `--i` flag when you send your request. + +For example, this request: ```shell -$ curl -i -H "Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a" \ - {% data variables.product.api_url_pre %}/issues +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" \ +--include ``` -To get only the [issues under one of your {% data variables.product.product_name %} organizations][get issues api], call `GET -/orgs//issues`: +returns the response code and headers like: ```shell -$ curl -i -H "Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a" \ - {% data variables.product.api_url_pre %}/orgs/rails/issues +HTTP/2 200 +server: GitHub.com +date: Thu, 04 Aug 2022 20:07:51 GMT +content-type: application/json; charset=utf-8 +cache-control: public, max-age=60, s-maxage=60 +vary: Accept, Accept-Encoding, Accept, X-Requested-With +etag: W/"7fceb7e8c958d3ec4d02524b042578dcc7b282192e6c939070f4a70390962e18" +x-github-media-type: github.v3; format=json +link: ; rel="next", ; rel="last" +access-control-expose-headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset +access-control-allow-origin: * +strict-transport-security: max-age=31536000; includeSubdomains; preload +x-frame-options: deny +x-content-type-options: nosniff +x-xss-protection: 0 +referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin +content-security-policy: default-src 'none' +x-ratelimit-limit: 15000 +x-ratelimit-remaining: 14996 +x-ratelimit-reset: 1659645535 +x-ratelimit-resource: core +x-ratelimit-used: 4 +accept-ranges: bytes +content-length: 4936 +x-github-request-id: 14E0:4BC6:F1B8BA:208E317:62EC2715 ``` -We can also get [all the issues under a single repository][repo issues api]: +In this example, the response code is `200`, which indicates a successful request. + +{% endcurl %} + +### About the response body + +Many operations will return a response body. Unless otherwise specified, the response body is in JSON format. For example, this request returns a list of issues with data about each issue: + +{% cli %} ```shell -$ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 ``` -### Pagination +{% endcli %} -A project the size of Rails has thousands of issues. We'll need to [paginate][pagination], -making multiple API calls to get the data. Let's repeat that last call, this -time taking note of the response headers: +{% javascript %} + +```javascript +await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + per_page: 2, +}); +``` + +{% endjavascript %} + +{% curl %} ```shell -$ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues - -> HTTP/2 200 - -> ... -> Link: <{% data variables.product.api_url_pre %}/repositories/8514/issues?page=2>; rel="next", <{% data variables.product.api_url_pre %}/repositories/8514/issues?page=30>; rel="last" -> ... +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" ``` -The [`Link` header][link-header] provides a way for a response to link to -external resources, in this case additional pages of data. Since our call found -more than thirty issues (the default page size), the API tells us where we can -find the next page and the last page of results. +{% endcurl %} -### Creating an issue +Unlike the GraphQL API where you specify what information you want, the REST API typically returns more information than you need. If desired, you can parse the response to pull out specific pieces of information. -Now that we've seen how to paginate lists of issues, let's [create an issue][create issue] from -the API. +{% cli %} -To create an issue, we need to be authenticated, so we'll pass an -OAuth token in the header. Also, we'll pass the title, body, and labels in the JSON -body to the `/issues` path underneath the repository in which we want to create -the issue: +For example, you can use `>` to redirect the response to a file: ```shell -$ curl -i -H 'Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a' \ -$ -d '{ \ -$ "title": "New logo", \ -$ "body": "We should have one", \ -$ "labels": ["design"] \ -$ }' \ -$ {% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/issues - -> HTTP/2 201 -> Location: {% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/issues/17 -> X-RateLimit-Limit: 5000 - -> { -> "pull_request": { -> "patch_url": null, -> "html_url": null, -> "diff_url": null -> }, -> "created_at": "2012-11-14T15:25:33Z", -> "comments": 0, -> "milestone": null, -> "title": "New logo", -> "body": "We should have one", -> "user": { -> "login": "pengwynn", -> "gravatar_id": "7e19cd5486b5d6dc1ef90e671ba52ae0", -> "avatar_url": "https://secure.gravatar.com/avatar/7e19cd5486b5d6dc1ef90e671ba52ae0?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", -> "id": 865, -> "url": "{% data variables.product.api_url_pre %}/users/pengwynn" -> }, -> "closed_at": null, -> "updated_at": "2012-11-14T15:25:33Z", -> "number": 17, -> "closed_by": null, -> "html_url": "https://github.com/pengwynn/api-sandbox/issues/17", -> "labels": [ -> { -> "color": "ededed", -> "name": "design", -> "url": "{% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/labels/design" -> } -> ], -> "id": 8356941, -> "assignee": null, -> "state": "open", -> "url": "{% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/issues/17" -> } +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 > data.json ``` -The response gives us a couple of pointers to the newly created issue, both in -the `Location` response header and the `url` field of the JSON response. - -## Conditional requests - -A big part of being a good API citizen is respecting rate limits by caching information that hasn't changed. The API supports [conditional -requests][conditional-requests] and helps you do the right thing. Consider the -first call we made to get defunkt's profile: +Then you can use jq to get the title and author ID of each issue: ```shell -$ curl -i {% data variables.product.api_url_pre %}/users/defunkt - -> HTTP/2 200 -> etag: W/"61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0" +jq '.[] | {title: .title, authorID: .user.id}' data.json ``` -In addition to the JSON body, take note of the HTTP status code of `200` and -the `ETag` header. -The [ETag][etag] is a fingerprint of the response. If we pass that on subsequent calls, -we can tell the API to give us the resource again, only if it has changed: +The previous two commands return something like: + +``` +{ + "title": "Update index.html", + "authorID": 10701255 +} +{ + "title": "Edit index file", + "authorID": 53709285 +} +``` + +For more information about jq, see [the jq documentation](https://stedolan.github.io/jq/) and [jq play](https://jqplay.org/). + +{% endcli %} + +{% javascript %} + +For example, you can get the title and author ID of each issue: + +```javascript +try { + const result = await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + per_page: 2, + }); + + const titleAndAuthor = result.data.map(issue => {title: issue.title, authorID: issue.user.id}) + + console.log(titleAndAuthor) + +} catch (error) { + console.log(`Error! Status: ${error.status}. Message: ${error.response.data.message}`) +} +``` + +{% endjavascript %} + +{% curl %} + +For example, you can use `>` to redirect the response to a file: ```shell -$ curl -i -H 'If-None-Match: "61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0"' \ -$ {% data variables.product.api_url_pre %}/users/defunkt - -> HTTP/2 304 +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" > data.json ``` -The `304` status indicates that the resource hasn't changed since the last time -we asked for it and the response will contain no body. As a bonus, `304` responses don't count against your [rate limit][rate-limiting]. +Then you can use jq to get the title and author ID of each issue: -Now you know the basics of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API! +```shell +jq '.[] | {title: .title, authorID: .user.id}' data.json +``` -* Basic & OAuth authentication -* Fetching and creating repositories and issues -* Conditional requests +The previous two commands return something like: -Keep learning with the next API guide [Basics of Authentication][auth guide]! +``` +{ + "title": "Update index.html", + "authorID": 10701255 +} +{ + "title": "Edit index file", + "authorID": 53709285 +} +``` -[wrappers]: /libraries/ -[curl]: http://curl.haxx.se/ -[media types]: /rest/overview/media-types -[oauth]: /apps/building-integrations/setting-up-and-registering-oauth-apps/ -[webflow]: /apps/building-oauth-apps/authorizing-oauth-apps/ -[scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ -[repos-api]: /rest/reference/repos -[pages]: http://pages.github.com -[nanoc]: http://nanoc.ws/ -[gitignore templates]: https://github.com/github/gitignore -[issues-api]: /rest/reference/issues -[link-header]: https://www.w3.org/wiki/LinkHeader -[conditional-requests]: /rest#conditional-requests -[rate-limiting]: /rest/overview/resources-in-the-rest-api#rate-limit-http-headers -[users api]: /rest/reference/users#get-a-user -[auth user api]: /rest/reference/users#get-the-authenticated-user -[defunkt github]: https://github.com/defunkt -[json]: http://en.wikipedia.org/wiki/JSON -[authentication]: /rest#authentication -[2fa]: /articles/about-two-factor-authentication -[2fa header]: /rest/overview/other-authentication-methods#working-with-two-factor-authentication -[oauth section]: /rest/guides/getting-started-with-the-rest-api#oauth -[personal token]: /articles/creating-an-access-token-for-command-line-use -[tokens settings]: https://github.com/settings/tokens -[pagination]: /rest#pagination -[get repo]: /rest/reference/repos#get-a-repository -[create repo]: /rest/reference/repos#create-a-repository-for-the-authenticated-user -[create issue]: /rest/reference/issues#create-an-issue -[auth guide]: /guides/basics-of-authentication -[user repos api]: /rest/reference/repos#list-repositories-for-the-authenticated-user -[other user repos api]: /rest/reference/repos#list-repositories-for-a-user -[org repos api]: /rest/reference/repos#list-organization-repositories -[get issues api]: /rest/reference/issues#list-issues-assigned-to-the-authenticated-user -[repo issues api]: /rest/reference/issues#list-repository-issues -[etag]: http://en.wikipedia.org/wiki/HTTP_ETag -[2fa section]: /rest/guides/getting-started-with-the-rest-api#two-factor-authentication +For more information about jq, see [the jq documentation](https://stedolan.github.io/jq/) and [jq play](https://jqplay.org/). + +{% endcurl %} + +## Next steps + +This article demonstrated how to list and create issues in a repository. For more practice, try to comment on an issue, edit the title of an issue, or close an issue. For more information about these operations, see "[Create an issue comment](/rest/issues#create-an-issue-comment)" and "[Update an issue](/rest/issues/issues#update-an-issue)." + +For more information about the operations that you can use, see the [REST reference documentation](/rest). diff --git a/translations/ja-JP/content/rest/index.md b/translations/ja-JP/content/rest/index.md index d33d08bdc6..fa25d957c1 100644 --- a/translations/ja-JP/content/rest/index.md +++ b/translations/ja-JP/content/rest/index.md @@ -3,7 +3,8 @@ title: GitHubのREST API shortTitle: REST API intro: 'インテグレーションを作成し、データを取り出し、ワークフローを自動化するために、{% data variables.product.prodname_dotcom %}のREST APIで構築してください。' introLinks: - quickstart: /rest/guides/getting-started-with-the-rest-api + quickstart: /rest/quickstart + overview: /rest/guides/getting-started-with-the-rest-api featuredLinks: guides: - /rest/guides/getting-started-with-the-rest-api @@ -31,6 +32,7 @@ versions: ghae: '*' ghec: '*' children: + - /quickstart - /overview - /guides - /actions diff --git a/translations/ja-JP/content/rest/quickstart.md b/translations/ja-JP/content/rest/quickstart.md new file mode 100644 index 0000000000..b8bf64cd32 --- /dev/null +++ b/translations/ja-JP/content/rest/quickstart.md @@ -0,0 +1,351 @@ +--- +title: Quickstart for GitHub REST API +intro: 'Learn how to get started with the {% data variables.product.prodname_dotcom %} REST API.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +shortTitle: Quickstart +topics: + - API +redirect_from: + - /guides/getting-started + - /v3/guides/getting-started +miniTocMaxHeadingLevel: 3 +--- + +This article describes how to quickly get started with the {% data variables.product.prodname_dotcom %} REST API using {% data variables.product.prodname_cli %}, JavaScript, or cURL. For a more detailed guide, see "[Getting started with the REST API](/rest/guides/getting-started-with-the-rest-api)." + +{% cli %} + +## Getting started using {% data variables.product.prodname_cli %} + +### Using {% data variables.product.prodname_cli %} in the command line + +{% data variables.product.prodname_cli %} is the easiest way to use the {% data variables.product.prodname_dotcom %} REST API from the command line. + +1. Install {% data variables.product.prodname_cli %} if you haven't installed it yet. For installation instructions, see the [{% data variables.product.prodname_cli %} repository](https://github.com/cli/cli#installation). +1. Use the `auth login` subcommand to authenticate to {% data variables.product.prodname_cli %}. For more information, see the [{% data variables.product.prodname_cli %} `auth login` documentation](https://cli.github.com/manual/gh_auth_login). + + ```shell + gh auth login + ``` + +1. Use the `api` subcommand to make your API request. For more information, see the [{% data variables.product.prodname_cli %} `api` documentation](https://cli.github.com/manual/gh_api). + + ```shell + gh api repos/octocat/Spoon-Knife/issues + ``` + +### Using {% data variables.product.prodname_cli %} in {% data variables.product.prodname_actions %} + +You can also use {% data variables.product.prodname_cli %} in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Using GitHub CLI in workflows](/actions/using-workflows/using-github-cli-in-workflows)." + +Instead of using the `gh auth login` command, pass an access token as an environment variable called `GH_TOKEN`. {% data variables.product.prodname_dotcom %} recommends that you use the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." + +```yaml +on: + workflow_dispatch: +jobs: + use_api: + runs-on: ubuntu-latest + permissions: + issues: read + steps: + - env: + GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + gh api repos/octocat/Spoon-Knife/issues +``` + +If you are authenticating with a {% data variables.product.prodname_github_app %}, you can create an installation access token within your workflow: + +1. Store your {% data variables.product.prodname_github_app %}'s ID as a secret. In the following example, replace `APP_ID` with the name of the secret. You can find your app ID on the settings page for your app or through the App API. For more information, see "[Apps](/rest/apps/apps#get-an-app)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." +1. Generate a private key for your app. Store the contents of the resulting file as a secret. (Store the entire contents of the file, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`.) In the following example, replace `APP_PEM` with the name of the secret. For more information, see "[Authenticating with {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)." +1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. For example: + +```yaml +{% data reusables.actions.actions-not-certified-by-github-comment %} + +on: + workflow_dispatch: +jobs: + track_pr: + runs-on: ubuntu-latest + steps: + - name: Generate token + id: generate_token + uses: tibdex/github-app-token@36464acb844fc53b9b8b2401da68844f6b05ebb0 + with: + app_id: {% raw %}${{ secrets.APP_ID }}{% endraw %} + private_key: {% raw %}${{ secrets.APP_PEM }}{% endraw %} + + - name: Use API + env: + GH_TOKEN: {% raw %}${{ steps.generate_token.outputs.token }}{% endraw %} + run: | + gh api repos/octocat/Spoon-Knife/issues +``` + +{% endcli %} + +{% javascript %} + +## Getting started using JavaScript + +You can use Octokit.js to interact with the {% data variables.product.prodname_dotcom %} REST API in your JavaScript scripts. For more information, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). + +### Using Octokit.js + +1. Create an access token. For example, create a personal access token (PAT) or a {% data variables.product.prodname_github_app %} user-to-server access token. For more information, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)" or "[Identifying and authorizing users for GitHub Apps](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps)." + + {% warning %} + + **Warning**: Treat your access token like a password. + + To keep your token secure, you can store your token as a secret and run your script through {% data variables.product.prodname_actions %}. For more information, see the "[Using Octokit.js in {% data variables.product.prodname_actions %}](#using-octokitjs-in-github-actions)" section. + + {%- ifversion fpt or ghec %} + + You can also store your token as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} + + If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. + + {% endwarning %} + +1. Install `octokit`. For example, `npm install octokit`. For other ways to install or load `octokit`, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). +1. Import `octokit` in your script. For example, `import { Octokit } from "octokit";`. For other ways to import `octokit`, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). +1. Create an instance of `Octokit` with your token. Replace `YOUR-TOKEN` with your token. + + ```javascript + const octokit = new Octokit({ + auth: 'YOUR-TOKEN' + }); + ``` + +1. Use `octokit.request` to execute your request. Send the HTTP method and path as the first argument. Specify any path, query, and body parameters in an object as the second argument. For example, in the following request the HTTP method is `GET`, the path is `/repos/{owner}/{repo}/issues`, and the parameters are `owner: "octocat"` and `repo: "Spoon-Knife"`. + + ```javascript + await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + }); + ``` + +### Using Octokit.js in {% data variables.product.prodname_actions %} + +You can also execute your JavaScript scripts in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." + +{% data variables.product.prodname_dotcom %} recommends that you use the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." + +The following example workflow: + +1. Checks out the repository content +1. Sets up Node.js +1. Installs `octokit` +1. Stores the value of `GITHUB_TOKEN` as an environment variable called `TOKEN` and runs `.github/actions-scripts/use-the-api.mjs`, which can access that environment variable as `process.env.TOKEN` + +Example workflow: + +```yaml +on: + workflow_dispatch: +jobs: + use_api_via_script: + runs-on: ubuntu-latest + permissions: + issues: read + steps: + - name: Check out repo content + uses: {% data reusables.actions.action-checkout %} + + - name: Setup Node + uses: {% data reusables.actions.action-setup-node %} + with: + node-version: '16.15.0' + cache: npm + + - name: Install dependencies + run: npm install octokit + + - name: Run script + run: | + node .github/actions-scripts/use-the-api.mjs + env: + TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} +``` + +Example JavaScript script, with the file path `.github/actions-scripts/use-the-api.mjs`: + +```javascript +import { Octokit } from "octokit" + +const octokit = new Octokit({ + auth: process.env.TOKEN +}); + +try { + const result = await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + }); + + const titleAndAuthor = result.data.map(issue => {title: issue.title, authorID: issue.user.id}) + + console.log(titleAndAuthor) + +} catch (error) { + console.log(`Error! Status: ${error.status}. Message: ${error.response.data.message}`) +} +``` + +If you are authenticating with a {% data variables.product.prodname_github_app %}, you can create an installation access token within your workflow: + +1. Store your {% data variables.product.prodname_github_app %}'s ID as a secret. In the following example, replace `APP_ID` with the name of the secret. You can find your app ID on the settings page for your app or through the App API. For more information, see "[Apps](/rest/apps/apps#get-an-app)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." +1. Generate a private key for your app. Store the contents of the resulting file as a secret. (Store the entire contents of the file, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`.) In the following example, replace `APP_PEM` with the name of the secret. For more information, see "[Authenticating with {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)." +1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. For example: + +```yaml +{% data reusables.actions.actions-not-certified-by-github-comment %} + +on: + workflow_dispatch: +jobs: + use_api_via_script: + runs-on: ubuntu-latest + steps: + - name: Check out repo content + uses: {% data reusables.actions.action-checkout %} + + - name: Setup Node + uses: {% data reusables.actions.action-setup-node %} + with: + node-version: '16.15.0' + cache: npm + + - name: Install dependencies + run: npm install octokit + + - name: Generate token + id: generate_token + uses: tibdex/github-app-token@36464acb844fc53b9b8b2401da68844f6b05ebb0 + with: + app_id: {% raw %}${{ secrets.APP_ID }}{% endraw %} + private_key: {% raw %}${{ secrets.APP_PEM }}{% endraw %} + + - name: Run script + run: | + node .github/actions-scripts/use-the-api.mjs + env: + TOKEN: {% raw %}${{ steps.generate_token.outputs.token }}{% endraw %} +``` + +{% endjavascript %} + +{% curl %} + +## Getting started using cURL + +### Using cURL in the command line + +{% note %} + +**Note:** If you want to make API requests from the command line, {% data variables.product.prodname_dotcom %} recommends that you use {% data variables.product.prodname_cli %}, which simplifies authentication and requests. For more information about getting started with the REST API using {% data variables.product.prodname_cli %}, see the {% data variables.product.prodname_cli %} version of this article. + +{% endnote %} + +1. Install cURL if cURL isn't already installed on your machine. To check if cURL is installed, execute `curl --version` in the command line. If the output is information about the cURL version, cURL is installed. If you get a message similar to `command not found: curl`, you need to download and install cURL. For more information, see [the cURL project download page](https://curl.se/download.html). +1. Create an access token. For example, create a personal access token (PAT) or a {% data variables.product.prodname_github_app %} user-to-server access token. For more information, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)" or "[Identifying and authorizing users for GitHub Apps](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps)." + + {% warning %} + + **Warning**: Treat your access token like a password. + + {%- ifversion fpt or ghec %} + + To keep your token secure, you can store your token as a {% data variables.product.prodname_codespaces %} secret and use the command line through {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} + + You can also use {% data variables.product.prodname_cli %} instead of cURL. {% data variables.product.prodname_cli %} will take care of authentication for you. For more information, see the {% data variables.product.prodname_cli %} version of this page. + + If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. + + {% endwarning %} + +1. Use the `cURL` command to make your request. Pass your token in an `Authorization` header. Replace `YOUR-TOKEN` with your token. + + ```shell + curl --request GET \ + --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ + --header "Accept: application/vnd.github.v3+json" \ + --header "Authorization: Bearer YOUR-TOKEN" + ``` + + {% note %} + + **Note:** In most cases, you can use `Authorization: Bearer` or `Authorization: token`. JSON web tokens (JWTs) only work with `Authorization: Bearer`. + + {% endnote %} + +### Using cURL in {% data variables.product.prodname_actions %} + +You can also use cURL in your {% data variables.product.prodname_actions %} workflows. + +{% data variables.product.prodname_dotcom %} recommends that you use the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." + +```yaml +on: + workflow_dispatch: +jobs: + use_api: + runs-on: ubuntu-latest + permissions: + issues: read + steps: + - env: + GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + curl --request GET \ + --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ + --header "Accept: application/vnd.github.v3+json" \ + --header "Authorization: Bearer $GH_TOKEN" +``` + +If you are authenticating with a {% data variables.product.prodname_github_app %}, you can create an installation access token within your workflow: + +1. Store your {% data variables.product.prodname_github_app %}'s ID as a secret. In the following example, replace `APP_ID` with the name of the secret. You can find your app ID on the settings page for your app or through the App API. For more information, see "[Apps](/rest/apps/apps#get-an-app)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." +1. Generate a private key for your app. Store the contents of the resulting file as a secret. (Store the entire contents of the file, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`.) In the following example, replace `APP_PEM` with the name of the secret. For more information, see "[Authenticating with {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)." +1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. For example: + +```yaml +{% data reusables.actions.actions-not-certified-by-github-comment %} + +on: + workflow_dispatch: +jobs: + use_api: + runs-on: ubuntu-latest + steps: + - name: Generate token + id: generate_token + uses: tibdex/github-app-token@36464acb844fc53b9b8b2401da68844f6b05ebb0 + with: + app_id: {% raw %}${{ secrets.APP_ID }}{% endraw %} + private_key: {% raw %}${{ secrets.APP_PEM }}{% endraw %} + + - name: Use API + env: + GH_TOKEN: {% raw %}${{ steps.generate_token.outputs.token }}{% endraw %} + run: | + curl --request GET \ + --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ + --header "Accept: application/vnd.github.v3+json" \ + --header "Authorization: Bearer $GH_TOKEN" +``` + +{% endcurl %} + +## Next steps + +For a more detailed guide, see "[Getting started with the REST API](/rest/guides/getting-started-with-the-rest-api)." diff --git a/translations/ja-JP/content/rest/teams/external-groups.md b/translations/ja-JP/content/rest/teams/external-groups.md index de118fd6e8..d79dc3d769 100644 --- a/translations/ja-JP/content/rest/teams/external-groups.md +++ b/translations/ja-JP/content/rest/teams/external-groups.md @@ -19,7 +19,7 @@ miniTocMaxHeadingLevel: 3 **ノート:** -- 外部グループAPIは、{% data variables.product.prodname_emus %}を使用しているEnterpriseの一部であるOrganizationでのみ利用できます。 詳しい情報については「[Enterpriseが管理しているユーザ](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)」を参照してください。 +- The external groups API is only available for organizations that are part of an enterprise using {% data variables.product.prodname_emus %}. 詳しい情報については「[Enterpriseが管理しているユーザ](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)」を参照してください。 - OrganizationがTeam同期を使用している場合、Team Synchronization APIが利用できます。 詳しい情報については「[Team synchronization API](#team-synchronization)」を参照してください。 {% endnote %} diff --git a/translations/ja-JP/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md b/translations/ja-JP/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md index facad55b14..1824ba49a9 100644 --- a/translations/ja-JP/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md +++ b/translations/ja-JP/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md @@ -25,7 +25,7 @@ shortTitle: Sponsor a contributor You can sponsor an account on behalf of your personal account to invest in projects that you personally benefit from. Organization に代わってアカウントをスポンサーできますが、それには多くの理由があります。 - Organization の作業が依存する特定のライブラリを維持する -- Organization として依存しているエコシステム (たとえばブロックチェーン) に投資する +- Investing in the ecosystem you rely on as an organization (such as blockchain) - オープンソースを大切にする Organization としてブランド認知度を確立する - Organization が提供する製品を補完するライブラリを構築しているオープンソース開発者に感謝する diff --git a/translations/ja-JP/data/features/actions-oidc-hardening-config.yml b/translations/ja-JP/data/features/actions-oidc-hardening-config.yml new file mode 100644 index 0000000000..f3048bac8b --- /dev/null +++ b/translations/ja-JP/data/features/actions-oidc-hardening-config.yml @@ -0,0 +1,6 @@ +#Reference: #7336 +#General versioning for oidc hardening options +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' diff --git a/translations/ja-JP/data/features/actions-reusable-workflow-matrix.yml b/translations/ja-JP/data/features/actions-reusable-workflow-matrix.yml new file mode 100644 index 0000000000..6ab9b12b6b --- /dev/null +++ b/translations/ja-JP/data/features/actions-reusable-workflow-matrix.yml @@ -0,0 +1,7 @@ +#Reference: #7094 +#Documentation for allowing matrix jobs to call reusable workflows. +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7094' diff --git a/translations/ja-JP/data/features/bypass-branch-protections.yml b/translations/ja-JP/data/features/bypass-branch-protections.yml new file mode 100644 index 0000000000..d955962e56 --- /dev/null +++ b/translations/ja-JP/data/features/bypass-branch-protections.yml @@ -0,0 +1,7 @@ +#Issue: 6667 +#Description: Allow merging pull requests without complying with branch protection rules. +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-6667' diff --git a/translations/ja-JP/data/features/dependabot-alerts-dismissal-comment.yml b/translations/ja-JP/data/features/dependabot-alerts-dismissal-comment.yml new file mode 100644 index 0000000000..e2c2294cea --- /dev/null +++ b/translations/ja-JP/data/features/dependabot-alerts-dismissal-comment.yml @@ -0,0 +1,6 @@ +#Reference: Issue #7673 - Dependabot alerts: optional comment with dismissal - [GA] +versions: + fpt: '*' + ghec: '*' + ghes: '>3.6' + ghae: 'issue-7673' diff --git a/translations/ja-JP/data/features/dependabot-alerts-vulnerable-calls.yml b/translations/ja-JP/data/features/dependabot-alerts-vulnerable-calls.yml index 84825c368b..a7f772a7c5 100644 --- a/translations/ja-JP/data/features/dependabot-alerts-vulnerable-calls.yml +++ b/translations/ja-JP/data/features/dependabot-alerts-vulnerable-calls.yml @@ -3,5 +3,4 @@ versions: fpt: '*' ghec: '*' - ghes: '>3.5' ghae: 'issue-6076' diff --git a/translations/ja-JP/data/features/enterprise-namespace-repo-setting.yml b/translations/ja-JP/data/features/enterprise-namespace-repo-setting.yml new file mode 100644 index 0000000000..e20549f3ea --- /dev/null +++ b/translations/ja-JP/data/features/enterprise-namespace-repo-setting.yml @@ -0,0 +1,6 @@ +#Reference: #7757 +#Setting to disable personal namespace repo creation for EMUs, GHES 3.7+ and GHAE 3.7+ users +versions: + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7757' diff --git a/translations/ja-JP/data/features/ip-allow-list-address-check.yml b/translations/ja-JP/data/features/ip-allow-list-address-check.yml new file mode 100644 index 0000000000..c4dda87a70 --- /dev/null +++ b/translations/ja-JP/data/features/ip-allow-list-address-check.yml @@ -0,0 +1,3 @@ +versions: + ghec: '*' + ghae: 'issue-7818' diff --git a/translations/ja-JP/data/features/multiple-accounts-one-workstation.yml b/translations/ja-JP/data/features/multiple-accounts-one-workstation.yml new file mode 100644 index 0000000000..9fce93b34e --- /dev/null +++ b/translations/ja-JP/data/features/multiple-accounts-one-workstation.yml @@ -0,0 +1,5 @@ +#Issue #7330 +#Documentation for managing multiple GitHub accounts on one workstation +versions: + fpt: '*' + ghec: '*' diff --git a/translations/ja-JP/data/features/nested-reusable-workflow.yml b/translations/ja-JP/data/features/nested-reusable-workflow.yml new file mode 100644 index 0000000000..95d7cb5a56 --- /dev/null +++ b/translations/ja-JP/data/features/nested-reusable-workflow.yml @@ -0,0 +1,7 @@ +#Issues 7093 +#Reusable workflows can call other reusable workflows +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7093' diff --git a/translations/ja-JP/data/features/packages-npm-v2.yml b/translations/ja-JP/data/features/packages-npm-v2.yml new file mode 100644 index 0000000000..572e412e4a --- /dev/null +++ b/translations/ja-JP/data/features/packages-npm-v2.yml @@ -0,0 +1,5 @@ +#Issue 7039 +#npm Package Registry Improvements (v2) GA +versions: + fpt: '*' + ghec: '*' diff --git a/translations/ja-JP/data/features/push-protection-custom-link-orgs-beta.yml b/translations/ja-JP/data/features/push-protection-custom-link-orgs-beta.yml new file mode 100644 index 0000000000..509caa9fb4 --- /dev/null +++ b/translations/ja-JP/data/features/push-protection-custom-link-orgs-beta.yml @@ -0,0 +1,8 @@ +#Issue 7299 +#Push protection custom links beta flags +#See "push-protection-custom-link-orgs" for the feature +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7299' diff --git a/translations/ja-JP/data/features/push-protection-custom-link-orgs.yml b/translations/ja-JP/data/features/push-protection-custom-link-orgs.yml new file mode 100644 index 0000000000..fce23efa96 --- /dev/null +++ b/translations/ja-JP/data/features/push-protection-custom-link-orgs.yml @@ -0,0 +1,8 @@ +#Issue 7299 +#Push protection custom links +#See "push-protection-custom-link-orgs-beta" for the beta flags +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7299' diff --git a/translations/ja-JP/data/features/ssh-commit-verification.yml b/translations/ja-JP/data/features/ssh-commit-verification.yml new file mode 100644 index 0000000000..7851b1c8b7 --- /dev/null +++ b/translations/ja-JP/data/features/ssh-commit-verification.yml @@ -0,0 +1,8 @@ +#Reference: github/docs-content#6709 +#Initial docs for showing SSH signed commits as verified and +#uploading SSH signing keys +versions: + fpt: '*' + ghec: '*' + ghes: '>= 3.7' + ghae: '*' diff --git a/translations/ja-JP/data/features/streaming-datadog.yml b/translations/ja-JP/data/features/streaming-datadog.yml new file mode 100644 index 0000000000..ab90546c8d --- /dev/null +++ b/translations/ja-JP/data/features/streaming-datadog.yml @@ -0,0 +1,4 @@ +#Reference #7495 +#Documentation for audit log streaming to a Datadog endpoint +versions: + ghec: '*' diff --git a/translations/ja-JP/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml b/translations/ja-JP/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml index c89bd0c1cd..10abd35353 100644 --- a/translations/ja-JP/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml +++ b/translations/ja-JP/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml @@ -154,13 +154,6 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: 破壊的 owner: lukewar - - - location: ProjectNextFieldType.TASKS - description: '`TASKS`は削除されます。適切な置き換えを見つけるには、https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ にあるProjectV2ガイドに従ってください。' - reason: '`ProjectNext`は、より多機能な`ProjectV2`に置き換えられて非推奨になりました。' - date: '2022-10-01T00:00:00+00:00' - criticality: 破壊的 - owner: lukewar - location: ProjectNextFieldType.TEXT description: '`TEXT`は削除されます。適切な置き換えを見つけるには、https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ にあるProjectV2ガイドに従ってください。' @@ -175,6 +168,13 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: 破壊的 owner: lukewar + - + location: ProjectNextFieldType.TRACKS + description: '`TRACKS`は削除されます。適切な置き換えを見つけるには、https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ にあるProjectV2ガイドに従ってください。' + reason: '`ProjectNext`は、より多機能な`ProjectV2`に置き換えられて非推奨になりました。' + date: '2022-10-01T00:00:00+00:00' + criticality: 破壊的 + owner: lukewar - location: RemovePullRequestFromMergeQueueInput.branch description: '`branch`は削除されます。' diff --git a/translations/ja-JP/data/graphql/ghec/graphql_upcoming_changes.public.yml b/translations/ja-JP/data/graphql/ghec/graphql_upcoming_changes.public.yml index f61e36258e..4973103e87 100644 --- a/translations/ja-JP/data/graphql/ghec/graphql_upcoming_changes.public.yml +++ b/translations/ja-JP/data/graphql/ghec/graphql_upcoming_changes.public.yml @@ -574,13 +574,6 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: 破壊的 owner: lukewar - - - location: ProjectNextFieldType.TASKS - description: '`TASKS`は削除されます。適切な置き換えを見つけるには、https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ にあるProjectV2ガイドに従ってください。' - reason: '`ProjectNext`は、より多機能な`ProjectV2`に置き換えられて非推奨になりました。' - date: '2022-10-01T00:00:00+00:00' - criticality: 破壊的 - owner: lukewar - location: ProjectNextFieldType.TEXT description: '`TEXT`は削除されます。適切な置き換えを見つけるには、https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ にあるProjectV2ガイドに従ってください。' @@ -595,6 +588,13 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: 破壊的 owner: lukewar + - + location: ProjectNextFieldType.TRACKS + description: '`TRACKS`は削除されます。適切な置き換えを見つけるには、https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ にあるProjectV2ガイドに従ってください。' + reason: '`ProjectNext`は、より多機能な`ProjectV2`に置き換えられて非推奨になりました。' + date: '2022-10-01T00:00:00+00:00' + criticality: 破壊的 + owner: lukewar - location: ProjectNextItem.content description: '`content`は削除されます。適切な置き換えを見つけるには、https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ にあるProjectV2ガイドに従ってください。' @@ -994,6 +994,13 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: 破壊的 owner: lukewar + - + location: ProjectView.groupedItems + description: '`groupedItems`は削除されます。適切な置き換えを見つけるには、https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ にあるProjectV2ガイドに従ってください。' + reason: '`ProjectNext`は、より多機能な`ProjectV2`に置き換えられて非推奨になりました。' + date: '2022-10-01T00:00:00+00:00' + criticality: 破壊的 + owner: lukewar - location: ProjectView.items description: '`items`は削除されます。適切な置き換えを見つけるには、https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ にあるProjectV2ガイドに従ってください。' diff --git a/translations/ja-JP/data/graphql/graphql_upcoming_changes.public.yml b/translations/ja-JP/data/graphql/graphql_upcoming_changes.public.yml index f61e36258e..4973103e87 100644 --- a/translations/ja-JP/data/graphql/graphql_upcoming_changes.public.yml +++ b/translations/ja-JP/data/graphql/graphql_upcoming_changes.public.yml @@ -574,13 +574,6 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: 破壊的 owner: lukewar - - - location: ProjectNextFieldType.TASKS - description: '`TASKS`は削除されます。適切な置き換えを見つけるには、https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ にあるProjectV2ガイドに従ってください。' - reason: '`ProjectNext`は、より多機能な`ProjectV2`に置き換えられて非推奨になりました。' - date: '2022-10-01T00:00:00+00:00' - criticality: 破壊的 - owner: lukewar - location: ProjectNextFieldType.TEXT description: '`TEXT`は削除されます。適切な置き換えを見つけるには、https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ にあるProjectV2ガイドに従ってください。' @@ -595,6 +588,13 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: 破壊的 owner: lukewar + - + location: ProjectNextFieldType.TRACKS + description: '`TRACKS`は削除されます。適切な置き換えを見つけるには、https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ にあるProjectV2ガイドに従ってください。' + reason: '`ProjectNext`は、より多機能な`ProjectV2`に置き換えられて非推奨になりました。' + date: '2022-10-01T00:00:00+00:00' + criticality: 破壊的 + owner: lukewar - location: ProjectNextItem.content description: '`content`は削除されます。適切な置き換えを見つけるには、https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ にあるProjectV2ガイドに従ってください。' @@ -994,6 +994,13 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: 破壊的 owner: lukewar + - + location: ProjectView.groupedItems + description: '`groupedItems`は削除されます。適切な置き換えを見つけるには、https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ にあるProjectV2ガイドに従ってください。' + reason: '`ProjectNext`は、より多機能な`ProjectV2`に置き換えられて非推奨になりました。' + date: '2022-10-01T00:00:00+00:00' + criticality: 破壊的 + owner: lukewar - location: ProjectView.items description: '`items`は削除されます。適切な置き換えを見つけるには、https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ にあるProjectV2ガイドに従ってください。' diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-2/17.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-2/17.yml index b1224a00b0..c6c7c33aa7 100644 --- a/translations/ja-JP/data/release-notes/enterprise-server/3-2/17.yml +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-2/17.yml @@ -7,3 +7,12 @@ sections: **高**: ユーザアカウントに以前にインストールされたアプリケーションは、ユーザアカウントがOrganizationアカウントに変換されたあとに、スコープ付きのアクセストークンでOrganizationにアクセスする権限を自動的に付与されました。この脆弱性は[GitHub Bug Bountyプログラム](https://bounty.github.com)から報告されました。 bugs: - カスタムの休眠の閾値がインスタンスに設定された場合、すべての休眠ユーザをサスペンドしても、その閾値を確実に踏まえません。休眠に関する詳しい情報については「[休眠ユーザの管理](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)」を参照してください。 + known_issues: + - 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。 + - アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。 + - Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。 + - 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。 + - '{% data variables.product.prodname_github_connect %}で"Users can search GitHub.com（ユーザはGitHub.comの検索が可能）" が有効化されたとき、プライベート及びインターナルリポジトリのIssueが{% data variables.product.prodname_dotcom_the_website %}の検索結果に含まれません。' + - '{% data variables.product.prodname_registry %}のnpmレジストリは、メタデータのレスポンス中で時間の値を返さなくなります。これは、大きなパフォーマンス改善のために行われました。メタデータレスポンスの一部として時間の値を返すために必要なすべてのデータは保持し続け、既存のパフォーマンスの問題を解決した将来に、この値を返すことを再開します。' + - pre-receive フックの処理に固有のリソース制限によって、pre-receive フックに失敗するものが生じることがあります。 + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-3/12.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-3/12.yml index 176101ffd9..45c31db642 100644 --- a/translations/ja-JP/data/release-notes/enterprise-server/3-3/12.yml +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-3/12.yml @@ -9,3 +9,14 @@ sections: - カスタムの休眠の閾値がインスタンスに設定された場合、すべての休眠ユーザをサスペンドしても、その閾値を確実に踏まえません。休眠に関する詳しい情報については「[休眠ユーザの管理](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)」を参照してください。 changes: - 'Enterprise Audit logには、`project.create`といったより多くのユーザ生成イベントが含まれるようになりました。REST APIも、`repo.create`といった追加のユーザ生成イベントを返します。詳しい情報については「[EnterpriseのAudit logへのアクセス](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)」及び「[EnterpriseでのAudit log APIの利用](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)」を参照してください。' + known_issues: + - '{% data variables.product.prodname_ghe_server %} 3.3にアップグレード後、{% data variables.product.prodname_actions %}が自動起動に失敗することがあります。この問題を解決するためには、アプライアンスにSSHで接続し、`ghe-actions-start`コマンドを実行してください。' + - 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。 + - アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。 + - Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。 + - 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。 + - '{% data variables.product.prodname_github_connect %}で"Users can search GitHub.com（ユーザはGitHub.comの検索が可能）" が有効化されたとき、プライベート及びインターナルリポジトリのIssueが{% data variables.product.prodname_dotcom_the_website %}の検索結果に含まれません。' + - '{% data variables.product.prodname_registry %}のnpmレジストリは、メタデータのレスポンス中で時間の値を返さなくなります。これは、大きなパフォーマンス改善のために行われました。メタデータレスポンスの一部として時間の値を返すために必要なすべてのデータは保持し続け、既存のパフォーマンスの問題を解決した将来に、この値を返すことを再開します。' + - pre-receive フックの処理に固有のリソース制限によって、pre-receive フックに失敗するものが生じることがあります。 + - '{% data variables.product.prodname_actions %}のストレージ設定は、"Force Path Style（パススタイルの強制）"が選択されている場合、検証できず{% data variables.enterprise.management_console %}に保存できません。その代わりに、`ghe-actions-precheck`コマンドラインユーティリティで設定しなければなりません。' + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-4/7.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-4/7.yml index cd1fabfc3f..c38d20d8af 100644 --- a/translations/ja-JP/data/release-notes/enterprise-server/3-4/7.yml +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-4/7.yml @@ -12,3 +12,15 @@ sections: changes: - '`pre_receive_hook.rejected_push`イベントはEnterprise Audit logに表示されませんでした。' - リポジトリの移行アーカイブとユーザアカウントのアーカイブエクスポートのどちらもリリースリアクションを含みます。 + known_issues: + - 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。 + - アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。 + - Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。 + - 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。 + - '{% data variables.product.prodname_github_connect %}で"Users can search GitHub.com（ユーザはGitHub.comの検索が可能）" が有効化されたとき、プライベート及びインターナルリポジトリのIssueが{% data variables.product.prodname_dotcom_the_website %}の検索結果に含まれません。' + - '{% data variables.product.prodname_registry %}のnpmレジストリは、メタデータのレスポンス中で時間の値を返さなくなります。これは、大きなパフォーマンス改善のために行われました。メタデータレスポンスの一部として時間の値を返すために必要なすべてのデータは保持し続け、既存のパフォーマンスの問題を解決した将来に、この値を返すことを再開します。' + - pre-receive フックの処理に固有のリソース制限によって、pre-receive フックに失敗するものが生じることがあります。 + - | + セルフホストランナーを--ephemeral`パラメータ付きで複数レベル（たとえばEnterpriseとOrganizationというように）に登録したあと、ランナーがアイドル状態で停止し、再登録が必要になることがあります。[更新: 2022年6月17日] + - '{% data variables.product.prodname_ghe_server %} 3.4にアップグレードしたあと、リリースがリポジトリから失われたように見えることがあります。これは、必要なElasticsearchのインデックスの移行が成功終了していない場合に起こります。' + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-5/4.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-5/4.yml index d4b01f5919..fc2a3d07b1 100644 --- a/translations/ja-JP/data/release-notes/enterprise-server/3-5/4.yml +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-5/4.yml @@ -18,3 +18,13 @@ sections: - 明るい高コントラストテーマはGitHub Enterprise Server 3.5.0、3.5.1、3.5.2、3.5.3では利用できませんでしたが、3.5.4で利用可能になりました。詳しい情報については「[テーマ設定の管理](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings)」を参照してください。 changes: - '`pre_receive_hook.rejected_push`イベントはEnterprise Audit logに表示されませんでした。' + known_issues: + - 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。 + - アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。 + - Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。 + - 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。 + - GitHub Connectで"Users can search GitHub.com"が有効化されている場合、GitHub.comの検索結果にプライベート及びインターナルリポジトリのIssueが含まれません。 + - '{% data variables.product.prodname_registry %}のnpmレジストリは、メタデータのレスポンス中で時間の値を返さなくなります。これは、大きなパフォーマンス改善のために行われました。メタデータレスポンスの一部として時間の値を返すために必要なすべてのデータは保持し続け、既存のパフォーマンスの問題を解決した将来に、この値を返すことを再開します。' + - pre-receive フックの処理に固有のリソース制限によって、pre-receive フックに失敗するものが生じることがあります。 + - 別のホスト上で取られたバックアップからのアプライアンスのリストア後、Actionsサービスを再起動する必要があります。 + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-6/0-rc1.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-6/0-rc1.yml index 1bd280b62f..82086a18cd 100644 --- a/translations/ja-JP/data/release-notes/enterprise-server/3-6/0-rc1.yml +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-6/0-rc1.yml @@ -80,8 +80,6 @@ sections: notes: - | GitHub Advanced Securityのライセンスがあるインスタンス上のEnterpriseオーナーは、リポジトリ中心のアプリケーションセキュリティリスクのビュー、すべてのSecret scanning及びDependabotアラートのアラート中心のビューを含む、インスタンス全体に対するDependabotアラートの概要を見ることができます。このビューはベータであり、変更されることがあり、アラート中心のCode scanningのビューはGitHub Enterprise Serverの将来のリリースで計画されています。詳しい情報については「[セキュリティの概要の表示](/code-security/security-overview/viewing-the-security-overview#viewing-the-security-overview-for-an-enterprise)」を参照してください。 - - | - Dependabotアラートは、リポジトリのコードが脆弱性のある関数を呼び出すかをユーザに示します。個々のアラートは"vulnerable call"ラベルとコード片を表示し、ユーザは`has:vulnerable-calls`で検索をすればフィルタリングできます。脆弱性のある関数は、[GitHub Advisory Database](https://github.com/advisories)への公開の間にキュレーションされます。新しくやってくるPythonのアドバイザリはサポートされ、GitHubは過去のPythonのアドバイザリに対する既知の脆弱性のある関数をさかのぼっていきます。Pythonでのベータテストのあと、GitHubは他のエコシステムのサポートを追加していきます。詳しい情報については「[Dependabotアラートの表示と更新](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts)」を参照してください。 - | ユーザは複数のDependabotアラートを選択し、それらを却下もしくは再オープンできます。たとえば**Closed alerts**タブから以前に却下された複数のアラートを選択し、一度にそれらを再オープンできます。詳しい情報については「[Dependabotアラートについて](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies)」を参照してください。 - | diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-6/0.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-6/0.yml index 75134dd708..0aa9ef1b94 100644 --- a/translations/ja-JP/data/release-notes/enterprise-server/3-6/0.yml +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-6/0.yml @@ -61,10 +61,10 @@ sections: -「[Secret scanningでのプッシュの保護](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)」 -「[EnterpriseのAudit logイベント](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise#secret_scanning_push_protection-category-actions)」 - -「[OrganizationのAudit logのレビュー]/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#secret_scanning_push_protection-category-actions)」 + -「[OrganizationのAudit logのレビュー](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#secret_scanning_push_protection-category-actions)」 -REST APIドキュメンテーションの「[Secret scanning](/rest/secret-scanning#list-secret-scanning-alerts-for-an-enterprise)」 - | - GitHub Advanced Securityのライセンスがあるインスタンス上のEnterpriseのオーナーは、EntepriseのカスタムのSecret scanningパターンのdry runを実行でき、すべてのユーザはパターンを編集する際にdry runを実行できます。dry runを行うことによって、パターンがインスタンス全体に与える影響を理解し、公開してアラートを生成する前にパターンを磨き上げることができます。詳しい情報については「Secret scanningのカスタムパターンの定義](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)」を参照してください。 + GitHub Advanced Securityのライセンスがあるインスタンス上のEnterpriseのオーナーは、EntepriseのカスタムのSecret scanningパターンのdry runを実行でき、すべてのユーザはパターンを編集する際にdry runを実行できます。dry runを行うことによって、パターンがインスタンス全体に与える影響を理解し、公開してアラートを生成する前にパターンを磨き上げることができます。詳しい情報については「[Secret scanningのカスタムパターンの定義](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)」を参照してください。 - | GitHub Advanced Securityのライセンスがあるインスタンス上のユーザは、Secret scanningのアラートを取得する際にREST APIで`sort`及び`direction`パラメータを使い、アラートの`created`あるいは`updated`フィールドに基づいてソートすることができます。この新しいパラメータはインスタンス全体で、あるいは個々のOrganizationあるいはリポジトリで使用できます。詳しい情報については以下のドキュメンテーションを参照してください。 @@ -79,8 +79,6 @@ sections: notes: - | GitHub Advanced Securityのライセンスがあるインスタンス上のEnterpriseオーナーは、リポジトリ中心のアプリケーションセキュリティリスクのビュー、すべてのSecret scanning及びDependabotアラートのアラート中心のビューを含む、インスタンス全体に対するDependabotアラートの概要を見ることができます。このビューはベータであり、変更されることがあり、アラート中心のCode scanningのビューはGitHub Enterprise Serverの将来のリリースで計画されています。詳しい情報については「[セキュリティの概要の表示](/code-security/security-overview/viewing-the-security-overview#viewing-the-security-overview-for-an-enterprise)」を参照してください。 - - | - Dependabotアラートは、リポジトリのコードが脆弱性のある関数を呼び出すかをユーザに示します。個々のアラートは"vulnerable call"ラベルとコード片を表示し、ユーザは`has:vulnerable-calls`で検索をすればフィルタリングできます。脆弱性のある関数は、[GitHub Advisory Database](https://github.com/advisories)への公開の間にキュレーションされます。新しくやってくるPythonのアドバイザリはサポートされ、GitHubは過去のPythonのアドバイザリに対する既知の脆弱性のある関数をさかのぼっていきます。Pythonでのベータテストのあと、GitHubは他のエコシステムのサポートを追加していきます。詳しい情報については「[Dependabotアラートの表示と更新](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts)」を参照してください。 - | ユーザは複数のDependabotアラートを選択し、それらを却下もしくは再オープンできます。たとえば**Closed alerts**タブから以前に却下された複数のアラートを選択し、一度にそれらを再オープンできます。詳しい情報については「[Dependabotアラートについて](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies)」を参照してください。 - | @@ -96,7 +94,7 @@ sections: インスタンスでGitHub Connectが有効化されているなら、ユーザは[GitHub Advisory Database](https://github.com/advisories)内のセキュリティアドバイザリの改善に貢献できます。貢献するには、アドバイザリの詳細を表示しているときに**Suggest improvements for this vulnerability（この脆弱性に改善を提案）**をクリックしてください。詳しい情報については以下の記事を参照してください。 - 「[GitHub Connectの管理](/admin/configuration/configuring-github-connect/managing-github-connect)」 - - GitHub Enterprise Cloudのドキュメンテーションの「「GitHub Advisory Database内のセキュリティ脆弱性の閲覧](/enterprise-cloud@latest/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database)」 + - GitHub Enterprise Cloudのドキュメンテーションの「[GitHub Advisory Database内のセキュリティ脆弱性の閲覧](/enterprise-cloud@latest/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database)」 - GitHub Enterprise Cloudのドキュメンテーションの「[リポジトリのGitHub Security Advisoriesについて](/enterprise-cloud@latest/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)」 - GitHub Enterprise Cloudのドキュメンテーションの「[GitHub Advisory Database中のセキュリティアドバイザリの編集](/enterprise-cloud@latest/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/editing-security-advisories-in-the-github-advisory-database)」 - @@ -152,7 +150,7 @@ sections: - | ユーザは、**Restrict pushes that create matching branches（マッチするブランチを作成するプッシュの制限）**ブランチ保護ルールで、設定された名前のパターンにマッチするブランチの作成をブロックできます。たとえば、リポジトリのデフォルトブランチを`master`から`main`に変更した場合、リポジトリの管理者はそれ以降`master`ブランチの作成やプッシュを防ぐことができます。詳しい情報については「[保護されたブランチについて](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#restrict-who-can-push-to-matching-branches)」及び[ブランチの保護ルールの管理](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule#creating-a-branch-protection-rule)」を参照してください。 - | - ユーザは、リポジトリの**Branches（ブランチ）**ページから、**New branch（新規ブランチ）**をクリックすることで直接ブランチを作成できます。詳しい情報については「[リポジトリ内でのブランチの作成と削除(/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)」を参照してください。 + ユーザは、リポジトリの**Branches（ブランチ）**ページから、**New branch（新規ブランチ）**をクリックすることで直接ブランチを作成できます。詳しい情報については「[リポジトリ内でのブランチの作成と削除](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)」を参照してください。 - | ユーザはオープンなPull Requestに関連づけられたブランチを削除できます。詳しい情報については「[リポジトリ内でのブランチの作成と削除](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)」を参照してください。 - | @@ -175,7 +173,7 @@ sections: heading: プルリクエスト notes: - | - Pull Requestの**Files changed（変更されたファイル）**タブにあるファイルツリーを使って、ユーザは変更されたファイルに見ていき、変更のサイズとスコープを理解し、レビューに集中できます。このファイルツリーは、Pull Requestが少なくとも2つのファイルを変更しており、ブラウザのウィンドウが十分に広いときに表示されます。詳しい情報については「[Pull Requestで提案された変更のレビュー(/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)」及び「[Pull Requestのファイルのフィルタリング](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request)」を参照してください。 + Pull Requestの**Files changed（変更されたファイル）**タブにあるファイルツリーを使って、ユーザは変更されたファイルに見ていき、変更のサイズとスコープを理解し、レビューに集中できます。このファイルツリーは、Pull Requestが少なくとも2つのファイルを変更しており、ブラウザのウィンドウが十分に広いときに表示されます。詳しい情報については「[Pull Requestで提案された変更のレビュー](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)」及び「[Pull Requestのファイルのフィルタリング](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request)」を参照してください。 - | ユーザは、すべてのsquashマージでPull Requestのタイトルをコミットメッセージとして使うことをデフォルトにできます。詳しい情報については「[Pull Requestのコミットsquashの設定](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests)」を参照してください。 - @@ -212,3 +210,4 @@ sections: - リポジトリの設定で、読み取りアクセスを持つユーザにディスカッションの作成を許可するオプションを有効化しても、この機能は有効化されません。 - ユーザが既存のIssueをディスカッションに変換できないことがあります。 - Secret scanningのカスタムパターンは、特に"After secret"パターンにおいて`.*`を終了の区切り文字として持ちます。この区切り文字は、リポジトリにまたがるシークレットのスキャンにおいて矛盾を生じさせ、スキャンがまったく完了していないというリポジトリの履歴のギャップに気づくかもしれません。インクリメンタルなスキャンにも影響があるかもしれません。スキャンの問題を回避するために、パターンの終わりから`.*`という区切り文字を取り除く修正をしてください。 + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/ja-JP/data/reusables/accounts/create-personal-access-tokens.md b/translations/ja-JP/data/reusables/accounts/create-personal-access-tokens.md new file mode 100644 index 0000000000..fef12d84dd --- /dev/null +++ b/translations/ja-JP/data/reusables/accounts/create-personal-access-tokens.md @@ -0,0 +1 @@ +1. 各アカウントに`repo`スコープを持つ専用のPATを作成してください。 詳しい情報については、「[個人アクセストークンを作成する](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)」を参照してください。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/contacting-support.md b/translations/ja-JP/data/reusables/actions/contacting-support.md index b8d9451425..56623f757b 100644 --- a/translations/ja-JP/data/reusables/actions/contacting-support.md +++ b/translations/ja-JP/data/reusables/actions/contacting-support.md @@ -5,5 +5,5 @@ あなたの利用方法、もしくは意図する利用方法が利用制限のカテゴリに当てはまるかどうかに関わらず、以下のいずれかの場合は{% data variables.contact.contact_support %}に連絡してください。 * アカウントに間違った制約が課されていると思われる場合 -* たとえばユニークIDのような予想外のエラーに、アクションの実行時に遭遇した場合 +* いずれかのアクションを実行した際に予想外のエラーが生じた場合 * 既存の動作が期待される、ただし必ずしもドキュメント化されてはいない動作と矛盾するような状況に遭遇した場合 diff --git a/translations/ja-JP/data/reusables/actions/github_sha_description.md b/translations/ja-JP/data/reusables/actions/github_sha_description.md new file mode 100644 index 0000000000..d1f1daf768 --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/github_sha_description.md @@ -0,0 +1 @@ +ワークフローをトリガーしたコミットSHA。 このコミットSHAの値は、ワークフローをトリガーしたイベントに依存します。 詳しい情報については「[ワークフローをトリガーするイベント](/actions/using-workflows/events-that-trigger-workflows)」 たとえば、`ffac537e6cbbf934b08745a378932722df287a53`です。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/use-request-body-api.md b/translations/ja-JP/data/reusables/actions/use-request-body-api.md new file mode 100644 index 0000000000..716669acfd --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/use-request-body-api.md @@ -0,0 +1 @@ +この設定を適用するには、APIエンドポイントにリクエストをサブミットし、そのリクエストのボディに必要な設定を含めてください。 詳しい情報については「[OrganizationのOIDCサブジェクトクレームのカスタマイズテンプレートの設定](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization)」を参照してください。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/advanced-security/custom-link-beta.md b/translations/ja-JP/data/reusables/advanced-security/custom-link-beta.md new file mode 100644 index 0000000000..030762649a --- /dev/null +++ b/translations/ja-JP/data/reusables/advanced-security/custom-link-beta.md @@ -0,0 +1,5 @@ +{% note %} + +**ノート:** ブロックされたプッシュメッセージにリソースリンクを追加する機能は、現在パブリックベータであり、変更されることがあります。 + +{% endnote %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/advanced-security/secret-scanning-push-protection-org.md b/translations/ja-JP/data/reusables/advanced-security/secret-scanning-push-protection-org.md index 03b7a69cb8..a3af2685e3 100644 --- a/translations/ja-JP/data/reusables/advanced-security/secret-scanning-push-protection-org.md +++ b/translations/ja-JP/data/reusables/advanced-security/secret-scanning-push-protection-org.md @@ -1,2 +1,6 @@ 1. "{% data variables.product.prodname_secret_scanning_caps %}"の下の"Push protection（プッシュ保護）"の下で、**Enable all（すべて有効化）**をクリックしてください。 ![任意のOrganizationで{% data variables.product.prodname_secret_scanning %}のプッシュ保護を有効化する方法を示しているスクリーンショット](/assets/images/help/organizations/secret-scanning-enable-push-protection.png) -1. あるいは、"Automatically enable for private repositories added to {% data variables.product.prodname_secret_scanning %}"をクリックしてください。 +1. あるいは、"Automatically enable for private repositories added to {% data variables.product.prodname_secret_scanning %}"をクリックしてください。{% ifversion push-protection-custom-link-orgs %} +1. あるいは、シークレットをプッシュしようとしたときにメンバーに表示されるメッセージにカスタムリンクを含めるには、**Add a resource link in the CLI and web UI when a commit is blocked（コミットがブロックされた場合CLIやWeb UIにリソースリンクを追加）**を選択し、続いてURLを入力し、**Save link（リンクを保存）**をクリックしてください。 + {% ifversion push-protection-custom-link-orgs-beta %}{% indented_data_reference reusables.advanced-security.custom-link-beta spaces=3 %}{% endif %} + + ![カスタムリンクを有効化するチェックボックスとテキストフィールドのスクリーンショット](/assets/images/help/organizations/secret-scanning-custom-link.png){% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/code-scanning/licensing-note.md b/translations/ja-JP/data/reusables/code-scanning/licensing-note.md index 8a1df37865..a893b88321 100644 --- a/translations/ja-JP/data/reusables/code-scanning/licensing-note.md +++ b/translations/ja-JP/data/reusables/code-scanning/licensing-note.md @@ -1,8 +1,12 @@ {% note %} **ノート:** {% ifversion fpt %} -{% data variables.product.prodname_codeql_cli %}はパブリックリポジトリでは無料で使用できます。 {% data variables.product.prodname_codeql_cli %}は、{% data variables.product.prodname_ghe_cloud %}を使用し、{% data variables.product.prodname_GH_advanced_security %}のライセンスを持っているOrganizationが所有するプライベートリポジトリでも使用できます。 詳細については「[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %}の利用規約](https://securitylab.github.com/tools/codeql/license)」及び「[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)」を参照してください。 -{%- elsif ghec %}{% data variables.product.prodname_codeql_cli %}は{% data variables.product.prodname_dotcom_the_website %}でメンテナンスされているパブリックリポジトリでは無料で使用でき、{% data variables.product.prodname_advanced_security %}ライセンスを持っているお客様が所有するプライベートリポジトリでも使用できます。 詳細については「[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %}の利用規約](https://securitylab.github.com/tools/codeql/license)」及び「[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)」を参照してください。 -{%- elsif ghes or ghae %}{% data variables.product.prodname_codeql_cli %}は、{% data variables.product.prodname_advanced_security %}ライセンスを持つお客様にご利用いただけます。 +- {% data variables.product.prodname_codeql_cli %}は、パブリックリポジトリでは無料で利用できます。 {% data variables.product.prodname_codeql_cli %}は、{% data variables.product.prodname_ghe_cloud %}を使用し、{% data variables.product.prodname_GH_advanced_security %}のライセンスを持っているOrganizationが所有するプライベートリポジトリでも使用できます。 詳細については「[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %}の利用規約](https://securitylab.github.com/tools/codeql/license)」及び「[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)」を参照してください。 +{%- elsif ghec %} +- {% data variables.product.prodname_codeql_cli %}は{% data variables.product.prodname_dotcom_the_website %}でメンテナンスされているパブリックリポジトリでは無料で使用でき、{% data variables.product.prodname_advanced_security %}ライセンスを持っているお客様が所有するプライベートリポジトリでも使用できます。 詳細については「[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %}の利用規約](https://securitylab.github.com/tools/codeql/license)」及び「[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)」を参照してください。 +{%- elsif ghes or ghae %} +- {% data variables.product.prodname_codeql_cli %}は{% data variables.product.prodname_advanced_security %}ライセンスを持つお客様にご利用いただけます。 {% endif %} +- {% data reusables.code-scanning.non-glibc-linux-support %} + {% endnote %} diff --git a/translations/ja-JP/data/reusables/code-scanning/non-glibc-linux-support.md b/translations/ja-JP/data/reusables/code-scanning/non-glibc-linux-support.md new file mode 100644 index 0000000000..e53d59424f --- /dev/null +++ b/translations/ja-JP/data/reusables/code-scanning/non-glibc-linux-support.md @@ -0,0 +1 @@ +{% data variables.product.prodname_codeql_cli %}は現時点で、（muslベースの）Alpine Linuxなどの非glibc Linuxディストリビューションとは互換性がありません。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/codespaces/availability.md b/translations/ja-JP/data/reusables/codespaces/availability.md deleted file mode 100644 index 6e70aae964..0000000000 --- a/translations/ja-JP/data/reusables/codespaces/availability.md +++ /dev/null @@ -1 +0,0 @@ -Codespacesは、{% data variables.product.prodname_team %}及び{% data variables.product.prodname_ghe_cloud %}を使用するOrganizationが所有するリポジトリで利用できます。 diff --git a/translations/ja-JP/data/reusables/codespaces/click-remote-explorer-icon-vscode.md b/translations/ja-JP/data/reusables/codespaces/click-remote-explorer-icon-vscode.md index 4e76a26911..351b36a5b8 100644 --- a/translations/ja-JP/data/reusables/codespaces/click-remote-explorer-icon-vscode.md +++ b/translations/ja-JP/data/reusables/codespaces/click-remote-explorer-icon-vscode.md @@ -1 +1,5 @@ -1. {% data variables.product.prodname_vscode_shortname %}の左サイドバーで、 Remote Explorerのアイコンをクリックしてください。 ![{% data variables.product.prodname_vscode %}のRemote Explorerアイコン](/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png) +1. {% data variables.product.prodname_vscode_shortname %}の左サイドバーで、 Remote Explorerのアイコンをクリックしてください。 + + ![{% data variables.product.prodname_vscode %}のRemote Explorerアイコン](/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png) + +{% indented_data_reference reusables.codespaces.remote-explorer spaces=3 %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/codespaces/codespaces-disabling-org-billing.md b/translations/ja-JP/data/reusables/codespaces/codespaces-disabling-org-billing.md new file mode 100644 index 0000000000..2f638bed7e --- /dev/null +++ b/translations/ja-JP/data/reusables/codespaces/codespaces-disabling-org-billing.md @@ -0,0 +1,5 @@ +{% note %} + +**ノート**: Organizationで課金されるcodespacesの利用を無効化した場合でも、個人ユーザとしてcodespacesを作成でき、Organization内のリポジトリをクローンできるユーザは、引き続きそのリポジトリに対してcodespaceを作成できます。 しかし、これによってOrganizationに対する課金が生じることはありません。 リポジトリへのアクセスの制限に関する情報については「[リポジトリへのアクセスを持つTeamや人の管理](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)」を参照してください。 + +{% endnote %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/codespaces/codespaces-org-policies-note.md b/translations/ja-JP/data/reusables/codespaces/codespaces-org-policies-note.md new file mode 100644 index 0000000000..c0da4777b0 --- /dev/null +++ b/translations/ja-JP/data/reusables/codespaces/codespaces-org-policies-note.md @@ -0,0 +1,5 @@ +{% note %} + +**ノート**: {% data variables.product.prodname_codespaces %}に対して定義するOrganizationのポリシーは、そのOrganizationに対して課金されるcodespacesにのみ適用されます。 個人ユーザがOrganization内のリポジトリに対してcodespaceを作成し、Organizationが課金されない場合は、そのcodespaceはそれらのポリシーによる制約を受けません。 Organizationに課金されるcodespaceを作成できるユーザの選択方法に関する情報については「[Organizationでの{% data variables.product.prodname_github_codespaces %}の有効化](https://docs-internal-29134-ad7bd8.preview.ghdocs.com/en/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization#choose-who-can-create-codespaces-that-are-billed-to-your-organization)」を参照してください。 + +{% endnote %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/codespaces/codespaces-spending-limit-requirement.md b/translations/ja-JP/data/reusables/codespaces/codespaces-spending-limit-requirement.md index 8f72ade561..8ead919aff 100644 --- a/translations/ja-JP/data/reusables/codespaces/codespaces-spending-limit-requirement.md +++ b/translations/ja-JP/data/reusables/codespaces/codespaces-spending-limit-requirement.md @@ -1,9 +1,9 @@ {% note %} -**ノート:** {% data variables.product.prodname_codespaces %}を利用するには、利用上限を設定しなければなりません。 +**ノート:** {% data variables.product.prodname_codespaces %}を利用するには、0ではない利用上限を設定しなければなりません。 {% endnote %} -デフォルトでは、OrganizationもしくはEnterpriseは$0の{% data variables.product.prodname_github_codespaces %}の利用上限を持っており、これは新しいcodespaceの作成や、既存のcodespaceのオープンを禁止します。 Organiationでユーザがcodespaceを作成できるようにするには、この上限を$0よりも大きな値に設定してください。 +デフォルトでは、OrganizationもしくはEnterpriseは、$0の{% data variables.product.prodname_github_codespaces %}利用上限を持ちます。 これによって、OrganizationやEntepriseへの課金が発生する場合に、新しいcodespaceが作成されたり、既存のcodespacesがオープンされることを防げます。 Organiationでユーザがcodespaceを作成できるようにするには、この上限を$0よりも大きな値に設定してください。 {% data reusables.billing.overages-billed-monthly %} diff --git a/translations/ja-JP/data/reusables/codespaces/concurrent-codespace-limit.md b/translations/ja-JP/data/reusables/codespaces/concurrent-codespace-limit.md index eb028709a2..229d5e955b 100644 --- a/translations/ja-JP/data/reusables/codespaces/concurrent-codespace-limit.md +++ b/translations/ja-JP/data/reusables/codespaces/concurrent-codespace-limit.md @@ -1 +1 @@ -リポジトリごと、さらにはブランチごとに1つ以上のcodespaceを作成できます。 However, each personal account has a limit of 10 codespaces. この制限に達した場合に新しいcodespaceを作成したいなら、まずcodespaceを削除しなければなりません。 +リポジトリごと、さらにはブランチごとに1つ以上のcodespaceを作成できます。 diff --git a/translations/ja-JP/data/reusables/codespaces/remote-explorer.md b/translations/ja-JP/data/reusables/codespaces/remote-explorer.md new file mode 100644 index 0000000000..0d95df797e --- /dev/null +++ b/translations/ja-JP/data/reusables/codespaces/remote-explorer.md @@ -0,0 +1,9 @@ +{% note %} + +**ノート**: Remote Explorerがアクティビティバーに表示されない場合: + +1. コマンドパレットにアクセスしてください。 たとえばShift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linuxを押します。 +1. `codespaces`と入力してください。 +1. **Codespaces: Details（Codespacesの詳細）**をクリックしてください。 + +{% endnote %} diff --git a/translations/ja-JP/data/reusables/dependabot/dependabot-alerts-filters.md b/translations/ja-JP/data/reusables/dependabot/dependabot-alerts-filters.md new file mode 100644 index 0000000000..f2e1222930 --- /dev/null +++ b/translations/ja-JP/data/reusables/dependabot/dependabot-alerts-filters.md @@ -0,0 +1,17 @@ +`key:value`ペアとしてフィルタを検索バーに入力することで、{% data variables.product.prodname_dependabot_alerts %}のソートとフィルタリングが行えます。 + +| オプション | 説明 | サンプル | +|:------------ |:------------------------------------------------------------------------------------------------------------------------------------------------------------------ |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `ecosystem` | 選択されたエコシステムのアラートを表示 | `ecosystem:npm`を使ってnpmの{% data variables.product.prodname_dependabot_alerts %}を表示 |{% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-7891 %} +| `has` | 選択されたフィルタ条件を満たすアラートを表示 | `has:patch`を使ってパッチを持つアドバイザリに関連したアラートを表示{% ifversion dependabot-alerts-vulnerable-calls %}
    `has:vulnerable-calls`を使って脆弱性のある関数の呼び出しに関連したアラートを表示{% endif %} +{% endif %} +| `is` | 状態に基づいてアラートを表示 | `is:open`を使ってオープンなアラートを表示 | +| `manifest` | 選択されたマニフェストのアラートを表示 | `manifest:webwolf/pom.xml`を使ってwebwolfアプリケーションのpom.xmlに対するアラートを表示 | +| `package` | 選択されたパッケージに対するアラートを表示 | `package:django`を使ってdjangoに対するアラートを表示 | +| `resolution` | 選択された解決のステータスに対するアラートを表示 | `resolution:no-bandwidth`を使って、以前にリソース不足あるいは修正する時間が無いことから置かれたアラートを表示 | +| `repo` | 関連するリポジトリに基づいてアラートを表示
    このフィルタはセキュリティの概要でのみ利用できることに注意してください。 詳しい情報については「[セキュリティの概要について](/code-security/security-overview/about-the-security-overview)」を参照してください。 | `repo:octocat-repo`を使って`octocat-repo`というリポジトリ内のアラートを表示 |{%- ifversion dependabot-alerts-development-label %} +| `scope` | 関連する依存関係のスコープに基づいてアラートを表示 | `scope:development`を使って開発の間にだけ使われた依存関係に対するアラートを表示 +{% endif %} +| `severity` | 重要度のレベルに基づいてアラートを表示 | `severity:high`を使って重要度がHighのアラートを表示 |{%- ifversion dependabot-most-important-sort-option %} +| `sort` | 選択されたソート順に従ってアラートを表示 | アラートのデフォルトのソートオプションは、アラートを重要度でランク付けする`sort:most-important`
    `sort:newest`を使って、{% data variables.product.prodname_dependabot %}が報告した最新のアラートを表示 +{% endif %} diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/advanced-security-security-features.md b/translations/ja-JP/data/reusables/enterprise-accounts/advanced-security-security-features.md index fd65ca0801..5c8b140118 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/advanced-security-security-features.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/advanced-security-security-features.md @@ -1 +1 @@ -1. Under "GitHub Advanced Security", click the **Security features** tab. +1. "GitHub Advanced Security"の下で、 **Security features（セキュリティの機能）**タブをクリックしてください。 diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/billing-microsoft-ea-overview.md b/translations/ja-JP/data/reusables/enterprise-accounts/billing-microsoft-ea-overview.md index f50a5571c8..2b2bc18068 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/billing-microsoft-ea-overview.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/billing-microsoft-ea-overview.md @@ -1 +1 @@ -If you purchased {% data variables.product.prodname_enterprise %} through a Microsoft Enterprise Agreement, you can connect your Azure Subscription ID to your enterprise account to enable and pay for any {% data variables.product.prodname_codespaces %} usage, and for {% data variables.product.prodname_actions %} or {% data variables.product.prodname_registry %} usage beyond the amounts included with your account. +{% data variables.product.prodname_enterprise %}をMicrosoft Enterprise Agreementを通じて購入した場合、AzureのサブスクリプションIDをEnterpriseアカウントに接続し、アカウントに含まれている額を超えて{% data variables.product.prodname_codespaces %}及び{% data variables.product.prodname_actions %}あるいは{% data variables.product.prodname_registry %}の支払いを行えるようにすることができます。 diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/dormant-user-activity-threshold.md b/translations/ja-JP/data/reusables/enterprise-accounts/dormant-user-activity-threshold.md index 534d9c25e0..1dfdec3806 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/dormant-user-activity-threshold.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/dormant-user-activity-threshold.md @@ -1 +1 @@ -{% ifversion not ghec%}By default, a{% else %}A{% endif %} user account is considered to be dormant if it has not been active for 90 days. {% ifversion not ghec %}You can configure the length of time a user must be inactive to be considered dormant{% ifversion ghes%} and choose to suspend dormant users to release user licenses{% endif %}.{% endif %} +{% ifversion not ghec%}デフォルトでは、{% else %}{% endif %}ユーザアカウントは90日間アクティブでなかった場合に休眠状態と見なされます。 {% ifversion not ghec %}ユーザが休眠状態と見なされ{% ifversion ghes%}、休眠ユーザをサスペンドしてユーザライセンスを解放す{% endif %}るまでに非アクティブでなければならない期間を設定できます。{% endif %} diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/dormant-user-activity.md b/translations/ja-JP/data/reusables/enterprise-accounts/dormant-user-activity.md index 82453eb0b0..d1ec887110 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/dormant-user-activity.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/dormant-user-activity.md @@ -1,23 +1,23 @@ -A user is considered active if the user has performed any of the following activities on {% ifversion fpt or ghec or ghes %}{% data variables.product.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %}. +ユーザは、以下のいずれかのアクティビティを{% ifversion fpt or ghec or ghes %}{% data variables.product.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %}上で行った場合にアクティブと見なされます。 -- Signing into {% data variables.product.product_location %} +- {% data variables.product.product_location %}へのサインイン - リポジトリを作成する -- Pushing to a repository -- Being added to a repository -- Changing the visibility of a repository +- リポジトリへのプッシュ +- リポジトリに追加される +- リポジトリの可視性の変更 - Issueもしくはプルリクエストの作成 -- Commenting on an issue or pull request -- Closing or reopening an issue or pull request -- Applying a label to an issue or pull request, or removing a label -- Assigning or unassigning an issue or pull request -- Requesting a review of a pull request, or removing a review request -- Creating or editing a comment in a pull request review -- Dismissing a comment in a pull request -- Synchronizing a pull request -- Commenting on a commit -- Publishing a release -- Pushing to a wiki +- IssueあるいはPull Requestへのコメント +- IssueもしくはPull Requestのクローズもしくは再オープン +- IssueもしくはPull Requestへのラベルの適用、あるいはラベルの削除 +- IssueもしくはPull Requestの割り当てあるいは割り当て解除 +- Pull Requestへのレビューのリクエスト、あるいはレビューリクエストの削除 +- Pull Requestレビューのコメントの作成もしくは編集 +- Pull Requestのコメントの却下 +- Pull Requestの同期 +- コミットへのコメント +- リリースの公開 +- Wikiへのプッシュ - リポジトリを Watch する -- Starring a repository +- リポジトリのStar付け - リポジトリの削除 -- Accessing resources by using a personal access token or SSH key +- 個人アクセストークンもしくはSSHキーを使ったリソースへのアクセス diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/dormant-user-release-phase.md b/translations/ja-JP/data/reusables/enterprise-accounts/dormant-user-release-phase.md index 3ac13f7607..f4075d0953 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/dormant-user-release-phase.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/dormant-user-release-phase.md @@ -1,5 +1,5 @@ {% note %} -**Note:** The Dormant Users report is currently in beta and subject to change. During the beta, ongoing improvements to the report download feature may limit its availability. +**ノート:** 休眠ユーザレポートは現在ベータであり、変更されることがあります。 ベータの期間中、レポートダウンロード機能への継続的な改善により、その可能性が制限されることがあります。 {% endnote %} diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/download-recovery-codes.md b/translations/ja-JP/data/reusables/enterprise-accounts/download-recovery-codes.md index 3481a78d76..5aa7db2dac 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/download-recovery-codes.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/download-recovery-codes.md @@ -1,3 +1,3 @@ -1. To ensure you can still access your enterprise in the event that your identity provider is ever unavailable in the future, click **Download**, **Print**, or **Copy** to save your recovery codes. For more information, see "[Downloading your enterprise account's single sign-on recovery codes](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes)." +1. 将来的にアイデンティティプロバイダが利用できなくなった場合にもEnterpriseへのアクセスが確実にできるようにするため、**Download**、**Print**もしくは**Copy**をクリックしてリカバリコードを保存してください。 詳しい情報については「[Enterpriseアカウントのシングルサインオンリカバリコードのダウンロード](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes)」を参照してください。 - ![Screenshot of the buttons to download, print, or copy your recovery codes](/assets/images/help/saml/saml_recovery_code_options.png) + ![リカバリコードのダウンロード、印刷、コピーのボタンのスクリーンショット](/assets/images/help/saml/saml_recovery_code_options.png) diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/emu-azure-admin-consent.md b/translations/ja-JP/data/reusables/enterprise-accounts/emu-azure-admin-consent.md index 4e56f795e2..ee84284803 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/emu-azure-admin-consent.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/emu-azure-admin-consent.md @@ -1,6 +1,6 @@ -1. When redirected, sign in to your identity provider, then follow the instructions to give consent and install the {% data variables.product.prodname_emu_idp_oidc_application %} application. +1. リダイレクトされたら、アイデンティティプロバイダにサインインし、{% data variables.product.prodname_emu_idp_oidc_application %}アプリケーションに同意してインストールする指示に従ってください。 {% warning %} - **Warning:** You must sign in to Azure AD as a user with global admin rights in order to consent to the installation of the {% data variables.product.prodname_emu_idp_oidc_application %} application. + **警告:** {% data variables.product.prodname_emu_idp_oidc_application %}アプリケーションに同意してインストールするには、Azure ADにグローバル管理権限を持つユーザとしてサインインしなければなりません。 {% endwarning %} diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/emu-cap-validates.md b/translations/ja-JP/data/reusables/enterprise-accounts/emu-cap-validates.md index 0f5e2fb0f4..7295ea7a2c 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/emu-cap-validates.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/emu-cap-validates.md @@ -1 +1 @@ -When your enterprise uses OIDC SSO, {% data variables.product.prodname_dotcom %} will automatically use your IdP's conditional access policy (CAP) IP conditions to validate user interactions with {% data variables.product.prodname_dotcom %}, when members change IP addresses, and each time a personal access token or SSH key is used. +EnterpriseがOIDC SSOを使用するなら、メンバーがIPアドレスを変更したとき、そして個人アクセストークンもしくはSSHキーが使われたとき、{% data variables.product.prodname_dotcom %}は自動的にIdPの条件付きアクセスポリシー（CAP） IP条件を使用して{% data variables.product.prodname_dotcom %}とのユーザのやりとりを検証します。 diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/emu-forks.md b/translations/ja-JP/data/reusables/enterprise-accounts/emu-forks.md index 5393e5378b..3695276eda 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/emu-forks.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/emu-forks.md @@ -1 +1 @@ -{% data variables.product.prodname_managed_users_caps %} cannot fork repositories from outside of the enterprise or fork internal repositories. {% data variables.product.prodname_managed_users_caps %} can fork private repositories owned by organizations in the enterprise into other organizations owned by the enterprise, or as a fork owned by the {% data variables.product.prodname_managed_user %}. +{% data variables.product.prodname_managed_users_caps %}は、Enteprise外からリポジトリをフォークしたり、インターナルリポジトリをフォークしたりすることはできません。 {% data variables.product.prodname_managed_users_caps %}は、Enterprise内のOrganizationが所有するプライベートリポジトリを、そのEnterpriseが所有する他のOrganizationに、あるいは{% data variables.product.prodname_managed_user %}が所有するフォークとしてフォークできます。 diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/emu-more-info-account.md b/translations/ja-JP/data/reusables/enterprise-accounts/emu-more-info-account.md index 862daa3317..537e5bae1c 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/emu-more-info-account.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/emu-more-info-account.md @@ -1 +1 @@ -For more information, see "[Types of GitHub accounts](/get-started/learning-about-github/types-of-github-accounts#enterprise-managed-users)." +詳しい情報については「[GitHubアカウントの種類](/get-started/learning-about-github/types-of-github-accounts#enterprise-managed-users)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-follow.md b/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-follow.md index 2f8f57f652..bb0265152c 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-follow.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-follow.md @@ -1 +1 @@ -{% ifversion ghec %} Members of an {% data variables.product.prodname_emu_enterprise %} can only follow other members of their enterprise. {% endif %} +{% ifversion ghec %}{% data variables.product.prodname_emu_enterprise %}のメンバーは、所属するEntepriseの他のメンバーだけをフォローできます。 {% endif %} diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-fork.md b/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-fork.md index 4676332b48..510be6132c 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-fork.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-fork.md @@ -1 +1 @@ -{% ifversion ghec %}Members of an {% data variables.product.prodname_emu_enterprise %} cannot fork repositories from outside of the enterprise or fork internal repositories.{% endif %} +{% ifversion ghec %}{% data variables.product.prodname_emu_enterprise %}のメンバーは、Enteprrise外からリポジトリをフォークしたり、インターナルリポジトリをフォークしたりすることはできません。{% endif %} diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-gist.md b/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-gist.md index 83a7ef0ed5..27f4ee54eb 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-gist.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-gist.md @@ -1 +1 @@ -{% ifversion ghec %}Members of an {% data variables.product.prodname_emu_enterprise %} cannot create gists and have read-only access to gists.{% endif %} +{% ifversion ghec %}{% data variables.product.prodname_emu_enterprise %}のメンバーはgistsを作成できず、gistsへは読み取りのみのアクセスを持ちます。{% endif %} diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-interact.md b/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-interact.md index 1cacf9ffa4..4d7a8c3a16 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-interact.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-interact.md @@ -1 +1 @@ -{% ifversion ghec %} Members of an {% data variables.product.prodname_emu_enterprise %} can only interact with repositories within their enterprise. {% endif %} +{% ifversion ghec %}{% data variables.product.prodname_emu_enterprise %}のメンバーは、所属するEnteprise内のリポジトリだけを操作できます。 {% endif %} diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-propose.md b/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-propose.md index 7a796b726b..049dfac9e8 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-propose.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-propose.md @@ -1 +1 @@ -{% ifversion ghec %} Members of an {% data variables.product.prodname_emu_enterprise %} can only propose changes in repositories that are part of their enterprise. {% endif %} +{% ifversion ghec %}{% data variables.product.prodname_emu_enterprise %}のメンバーは、所属するEnterpriseの一部であるリポジトリ内の変更だけを提案できます。 {% endif %} diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-repo.md b/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-repo.md index 0802199c70..cd27c9c722 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-repo.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/emu-permission-repo.md @@ -1 +1 @@ -{% ifversion ghec %} Members of an {% data variables.product.prodname_emu_enterprise %} can only make changes in repositories that are part of their enterprise. {% endif %} +{% ifversion ghec %}{% data variables.product.prodname_emu_enterprise %}のメンバーは、所属するEnterpriseの一部であるリポジトリ内でのみ変更を行えます。 {% endif %} diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/emu-saml-note.md b/translations/ja-JP/data/reusables/enterprise-accounts/emu-saml-note.md index 4d9daa1067..3fb06e1bd5 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/emu-saml-note.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/emu-saml-note.md @@ -1,7 +1,7 @@ {% ifversion ghec%} {% note %} -**Note**: If your enterprise uses {% data variables.product.prodname_emus %}, you must follow a different process to configure SAML single sign-on. For more information, see "[Configuring SAML single sign-on for Enterprise Managed Users](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/configuring-saml-single-sign-on-for-enterprise-managed-users)." +**ノート**: Enterpriseが{% data variables.product.prodname_emus %}を使っているなら、SAMLシングルサインオンの設定には異なるプロセスに従わなければなりません。 詳しい情報については「[Enterprise管理ユーザのためのSAMLシングルサインオンの設定](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/configuring-saml-single-sign-on-for-enterprise-managed-users)」を参照してください。 {% endnote %} {% endif %} diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/emu-scim-note.md b/translations/ja-JP/data/reusables/enterprise-accounts/emu-scim-note.md index 6188b5adc3..5b7227635e 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/emu-scim-note.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/emu-scim-note.md @@ -1,7 +1,7 @@ {% ifversion ghec%} {% note %} -**Note**: If your enterprise uses {% data variables.product.prodname_emus %}, you cannot use team synchronization and must instead configure SCIM to manage membership with your identity provider. For more information, see "[Configuring SCIM provisioning for Enterprise Managed Users](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/configuring-scim-provisioning-for-enterprise-managed-users)." +**ノート**: Enterpriseが{% data variables.product.prodname_emus %}を使っているなら、Team同期を使うことはできず、その代わりにSCIMを設定してアイデンティティプロバイダでメンバーシップを管理しなければなりません。 詳しい情報については「[Enterprise管理ユーザのためのSCIMプロビジョニングの設定](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/configuring-scim-provisioning-for-enterprise-managed-users)」を参照してください。 {% endnote %} {% endif %} diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/emu-shortcode.md b/translations/ja-JP/data/reusables/enterprise-accounts/emu-shortcode.md index bd4ba9e995..1ffae7e9bc 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/emu-shortcode.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/emu-shortcode.md @@ -1 +1 @@ -The short code must be unique to your enterprise, a three-to-eight character alphanumeric string, and contain no special characters. +ショートコードはEnterpriseに固有出なければならず、3から8文字の英数字の文字列であり、特殊文字が含まれていてはなりません。 diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/enterprise-accounts-compliance-tab.md b/translations/ja-JP/data/reusables/enterprise-accounts/enterprise-accounts-compliance-tab.md index a16d7459ab..6a7e54fb6d 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/enterprise-accounts-compliance-tab.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/enterprise-accounts-compliance-tab.md @@ -1 +1 @@ -1. In the enterprise account sidebar, click {% octicon "checklist" aria-label="The Compliance icon" %} **Compliance**. ![Compliance tab in the enterprise account sidebar](/assets/images/help/business-accounts/enterprise-accounts-compliance-tab.png) +1. Enterpriseアカウントのサイドバーで{% octicon "checklist" aria-label="The Compliance icon" %} **Compliance（コンプライアンス）**をクリックしてください。 ![Enterpriseアカウントサイドバーのコンプライアンスタブ](/assets/images/help/business-accounts/enterprise-accounts-compliance-tab.png) diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/github-connect-tab.md b/translations/ja-JP/data/reusables/enterprise-accounts/github-connect-tab.md index 74b591c23b..3965cfae3a 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/github-connect-tab.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/github-connect-tab.md @@ -1 +1 @@ -1. In the enterprise account sidebar, click {% octicon "plug" aria-label="The GitHub Connect gear" %} **{% data variables.product.prodname_github_connect %}**. ![GitHub Connect tab in the enterprise account sidebar](/assets/images/help//business-accounts/enterprise-account-github-connect-tab.png) +1. Enterpriseアカウントのサイドバーで、{% octicon "plug" aria-label="The GitHub Connect gear" %} **{% data variables.product.prodname_github_connect %}**をクリックしてください。 ![EnterpriseアカウントサイドバーのGitHub Connectタブ](/assets/images/help//business-accounts/enterprise-account-github-connect-tab.png) diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/invite-organization.md b/translations/ja-JP/data/reusables/enterprise-accounts/invite-organization.md index cff5560722..72312cab3e 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/invite-organization.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/invite-organization.md @@ -1 +1 @@ -Enterprise account owners can invite existing organization accounts to join their enterprise. For more information, see "[Inviting an organization to join your enterprise account](/enterprise-cloud@latest/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise#inviting-an-organization-to-join-your-enterprise-account)." +Enterpriseアカウントのオーナーは、既存のOrganizationアカウントをEnterpriseに参加するよう招待できます。 詳しい情報については「[OrganizationをEnterpriseアカウントへ参加するよう招待する](/enterprise-cloud@latest/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise#inviting-an-organization-to-join-your-enterprise-account)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/oidc-beta-notice.md b/translations/ja-JP/data/reusables/enterprise-accounts/oidc-beta-notice.md index 3fd2297267..74768b2a76 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/oidc-beta-notice.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/oidc-beta-notice.md @@ -1,5 +1,5 @@ {% note %} -**Note:** OpenID Connect (OIDC) and Conditional Access Policy (CAP) support for {% data variables.product.prodname_emus %} is in public beta and only available for Azure AD. +**ノート:** {% data variables.product.prodname_emus %}のOpenID Connect (OIDC)及び 条件付きアクセスポリシー (CAP)サポートはパブリックベータであり、Azure ADに対してのみ利用可能です。 {% endnote %} diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/oidc-gei-warning.md b/translations/ja-JP/data/reusables/enterprise-accounts/oidc-gei-warning.md index 440961984d..6b9116ba75 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/oidc-gei-warning.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/oidc-gei-warning.md @@ -1,5 +1,5 @@ {% warning %} -**Warning:** If you use {% data variables.product.prodname_importer_proper_name %} to migrate an organization from {% data variables.product.product_location_enterprise %}, make sure to use a service account that is exempt from Azure AD's CAP otherwise your migration may be blocked. +**警告:** {% data variables.product.prodname_importer_proper_name %}を使ってOrganizationを{% data variables.product.product_location_enterprise %}から移行する場合、必ずAzure ADのCAPから除外されているサービスアカウントを使ってください。そうしない場合、移行がブロックされることがあります。 {% endwarning %} diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/repo-creation-policy.md b/translations/ja-JP/data/reusables/enterprise-accounts/repo-creation-policy.md index 900d63c2a9..0352e6f347 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/repo-creation-policy.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/repo-creation-policy.md @@ -1 +1,6 @@ -1. "Repository creation（リポジトリの作成）"の下で、ポリシーを選択してください。 ![リポジトリ作成ポリシーオプションのドロップダウンメニュー](/assets/images/help/business-accounts/repository-creation-policy-drop-down.png) +1. "Repository creation（リポジトリの作成）"の下で、ポリシーを選択してください。 + {% ifversion enterprise-namespace-repo-setting %} + ![リポジトリ作成ポリシーオプションのドロップダウンメニュー](/assets/images/help/business-accounts/restrict-personal-namespace-setting.png) + {% else %} + ![リポジトリ作成ポリシーオプションのドロップダウンメニュー](/assets/images/help/business-accounts/repository-creation-policy-drop-down.png) + {% endif %} diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/repository-visibility-policy.md b/translations/ja-JP/data/reusables/enterprise-accounts/repository-visibility-policy.md deleted file mode 100644 index ea691fa5ba..0000000000 --- a/translations/ja-JP/data/reusables/enterprise-accounts/repository-visibility-policy.md +++ /dev/null @@ -1 +0,0 @@ -1. "Repository visibility change（リポジトリの可視性の変更）"の下で、ドロップダウンメニューを使ってポリシーを選択してください。 ![リポジトリの可視性のポリシーの選択肢があるドロップダウンメニュー](/assets/images/help/business-accounts/repository-visibility-policy-drop-down.png) diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/restrict-email-notifications-enterprise.md b/translations/ja-JP/data/reusables/enterprise-accounts/restrict-email-notifications-enterprise.md index 5b0511423c..40df7e294e 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/restrict-email-notifications-enterprise.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/restrict-email-notifications-enterprise.md @@ -1 +1 @@ -1. Under "Notification preferences", select **Restrict email notifications to only approved or verified domains**. ![メール通知を検証済みドメインのメールに制限するためのチェックボックス](/assets/images/help/enterprises/restrict-email-notifications-to-domain-enterprise.png) +1. "Notification preferences（通知設定）"の下で、**Restrict email notifications to only approved or verified domains（メール通知を承認済みもしくは検証済みドメインに制限する）**を選択してください。 ![メール通知を検証済みドメインのメールに制限するためのチェックボックス](/assets/images/help/enterprises/restrict-email-notifications-to-domain-enterprise.png) diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/security-tab.md b/translations/ja-JP/data/reusables/enterprise-accounts/security-tab.md index 3814053ef8..5eaf02ca19 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/security-tab.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/security-tab.md @@ -1,2 +1,7 @@ +{%- ifversion ghec or ghes > 3.4 or ghae-issue-7875 %} +1. 左のサイドバーで**Authentication security（認証のセキュリティ）**をクリックしてください。 + {% ifversion ghae %}![Security tab in the enterprise account settings sidebar](/assets/images/enterprise/github-ae/enterprise-account-settings-authentication-security-tab.png){% else %}![Security tab in the enterprise account settings sidebar](/assets/images/help/business-accounts/enterprise-account-settings-authentication-security-tab.png){% endif %} +{%- else %} 1. 左のサイドバーで**Security（セキュリティ）**をクリックしてください。 {% ifversion ghae %}![Security tab in the enterprise account settings sidebar](/assets/images/enterprise/github-ae/enterprise-account-settings-security-tab.png){% else %}![Security tab in the enterprise account settings sidebar](/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png){% endif %} +{%- endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/support-entitlements.md b/translations/ja-JP/data/reusables/enterprise-accounts/support-entitlements.md index 2da2e18b79..4ce740ecfc 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/support-entitlements.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/support-entitlements.md @@ -1 +1 @@ -To open, view, and comment on support tickets associated with an enterprise account or organization owned by an enterprise account, you must have support entitlements for the account. Enterpriseのオーナー及び支払マネージャーは自動的にサポート資格を持ち、Enterpriseオーナーはサポート資格をEnterpriseのメンバーに追加できます。 詳しい情報については「[Enterpriseのサポート資格の管理](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise)」を参照してください。 +EntepriseアカウントもしくはEnterpriseアカウントが所有するOrganizationに関連づけられたサポートチケットのオープン、表示、コメントをするには、そのアカウントのサポート資格が必要です。 Enterpriseのオーナー及び支払マネージャーは自動的にサポート資格を持ち、Enterpriseオーナーはサポート資格をEnterpriseのメンバーに追加できます。 詳しい情報については「[Enterpriseのサポート資格の管理](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/view-current-policy-config-orgs.md b/translations/ja-JP/data/reusables/enterprise-accounts/view-current-policy-config-orgs.md index 8b6f2b9b58..63083ab38d 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/view-current-policy-config-orgs.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/view-current-policy-config-orgs.md @@ -1 +1 @@ -Optionally, to view the current configuration for all organizations in the enterprise account before you change the setting, click {% octicon "eye" aria-label="The eye octicon" %} **View your organizations' current configurations**. ![ビジネス内のOrganizationの現在のポリシー設定を表示するリンク](/assets/images/help/business-accounts/view-current-policy-implementation-link.png) +あるいは、設定を変更する前にEnterpriseアカウント内のすべてのOrganizationの現在の設定を見たいなら、{% octicon "eye" aria-label="The eye octicon" %} **View your organizations' current configurations（Organizationの現在の設定の表示）**をクリックしてください。 ![ビジネス内のOrganizationの現在のポリシー設定を表示するリンク](/assets/images/help/business-accounts/view-current-policy-implementation-link.png) diff --git a/translations/ja-JP/data/reusables/enterprise-licensing/about-license-sync.md b/translations/ja-JP/data/reusables/enterprise-licensing/about-license-sync.md index 38750baa04..7c979cc38b 100644 --- a/translations/ja-JP/data/reusables/enterprise-licensing/about-license-sync.md +++ b/translations/ja-JP/data/reusables/enterprise-licensing/about-license-sync.md @@ -1 +1 @@ -For a person using multiple {% data variables.product.prodname_enterprise %} environments to only consume a single license, you must synchronize license usage between environments. Then, {% data variables.product.company_short %} will deduplicate users based on the email addresses associated with their user accounts. For more information, see "[Troubleshooting license usage for {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise#about-the-calculation-of-consumed-licenses)." \ No newline at end of file +複数の{% data variables.product.prodname_enterprise %}環境を使う人が1つのライセンスだけしか消費しないようにするには 環境間でライセンスの利用状況を同期しなければなりません。 そうすれば、{% data variables.product.company_short %}はユーザアカウントに関連づけられたメールアドレスに基づいてユーザの重複排除を行います。 詳しい情報については「[{% data variables.product.prodname_enterprise %}のライセンス利用状況のトラブルシューティング](/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise#about-the-calculation-of-consumed-licenses)」を参照してください。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/enterprise-licensing/contact-sales-for-renewals-or-seats.md b/translations/ja-JP/data/reusables/enterprise-licensing/contact-sales-for-renewals-or-seats.md index fca6ba0851..8e56cd2eb0 100644 --- a/translations/ja-JP/data/reusables/enterprise-licensing/contact-sales-for-renewals-or-seats.md +++ b/translations/ja-JP/data/reusables/enterprise-licensing/contact-sales-for-renewals-or-seats.md @@ -1 +1 @@ -If you'd like to renew or add user licenses to {% data variables.product.prodname_enterprise %}, or if you have questions about your license, contact {% data variables.contact.contact_enterprise_sales %}. 注文完了したら、新しいライセンスのファイルが直ちにダウンロード可能となります。 +{% data variables.product.prodname_enterprise %}のユーザライセンスの更新もしくは追加を行いたい場合、あるいはライセンスに関する質問がある場合は、{% data variables.contact.contact_enterprise_sales %}にお問い合わせください。 注文完了したら、新しいライセンスのファイルが直ちにダウンロード可能となります。 diff --git a/translations/ja-JP/data/reusables/enterprise-licensing/unique-user-licensing-model.md b/translations/ja-JP/data/reusables/enterprise-licensing/unique-user-licensing-model.md index c7a1f3b150..1530763795 100644 --- a/translations/ja-JP/data/reusables/enterprise-licensing/unique-user-licensing-model.md +++ b/translations/ja-JP/data/reusables/enterprise-licensing/unique-user-licensing-model.md @@ -1,3 +1,3 @@ -{% data variables.product.company_short %} uses a unique-user licensing model. For enterprise products that include multiple deployment options, {% data variables.product.company_short %} determines how many licensed seats you're consuming based on the number of unique users across all your deployments. +{% data variables.product.company_short %}はユニークユーザライセンスモデルを使用しています。 複数デプロイメントのオプションを含むEnterprise製品では、{% data variables.product.company_short %}は消費しているライセンスシート数を、すべてのデプロイメントに渡るユニークユーザ数に基づいて決定します。 -Each user only consumes one license, no matter how many {% data variables.product.prodname_ghe_server %} instances the user uses, or how many organizations the user is a member of on {% data variables.product.prodname_ghe_cloud %}. This model allows each person to use multiple {% data variables.product.prodname_enterprise %} deployments without incurring extra costs. +各ユーザは、使用している{% data variables.product.prodname_ghe_server %}インスタンス数、あるいはユーザが{% data variables.product.prodname_ghe_cloud %}上でメンバーになっているOrganization数にかかわらず、1つのライセンスのみを消費します。 このモデルによって、各ユーザは追加コストなしに複数の{% data variables.product.prodname_enterprise %}デプロイメントを使用できます。 diff --git a/translations/ja-JP/data/reusables/enterprise-licensing/view-consumed-licenses.md b/translations/ja-JP/data/reusables/enterprise-licensing/view-consumed-licenses.md index 79e443ac95..a4ed686f79 100644 --- a/translations/ja-JP/data/reusables/enterprise-licensing/view-consumed-licenses.md +++ b/translations/ja-JP/data/reusables/enterprise-licensing/view-consumed-licenses.md @@ -1 +1 @@ -After you synchronize license usage, you can see a report of consumed licenses across all your environments in the enterprise settings on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Viewing license usage for {% data variables.product.prodname_enterprise %}](/enterprise-cloud@latest/billing/managing-your-license-for-github-enterprise/viewing-license-usage-for-github-enterprise)." +ライセンスの利用状況を同期すると、{% data variables.product.prodname_dotcom_the_website %}のEnterprise設定で、すべての環境に渡る消費されているライセンスのレポートを見ることができます。 詳しい情報については「[{% data variables.product.prodname_enterprise %}のライセンス利用状況の表示](/enterprise-cloud@latest/billing/managing-your-license-for-github-enterprise/viewing-license-usage-for-github-enterprise)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/enterprise_enterprise_support/sign-in-to-support.md b/translations/ja-JP/data/reusables/enterprise_enterprise_support/sign-in-to-support.md index 0ba2652a00..76e0cd6932 100644 --- a/translations/ja-JP/data/reusables/enterprise_enterprise_support/sign-in-to-support.md +++ b/translations/ja-JP/data/reusables/enterprise_enterprise_support/sign-in-to-support.md @@ -1 +1 @@ -1. If a support engineer has given you an upload link for your support bundle, use this link. Otherwise, visit https://support.github.com/ and sign in (if prompted) to an enterprise account that is entitled to support. +1. サポートエンジニアがSupport Bundleのアップロードリンクを伝えたなら、そのリンクを使ってください。 そうでない場合はhttps://support.github.com/にアクセスし、サポートを受ける権利があるEnterpriseアカウントにサインインしてください（求められた場合）。 diff --git a/translations/ja-JP/data/reusables/enterprise_installation/download-appliance.md b/translations/ja-JP/data/reusables/enterprise_installation/download-appliance.md index ee31ea374d..fe33f4dfd0 100644 --- a/translations/ja-JP/data/reusables/enterprise_installation/download-appliance.md +++ b/translations/ja-JP/data/reusables/enterprise_installation/download-appliance.md @@ -1,5 +1,5 @@ -1. Navigate to the image you want to use for your new instance. +1. 新しいインスタンスで使用したいイメージにアクセスしてください。 - - Navigate to [Release notes](/admin/release-notes). - - In the right sidebar, click the version you want to download. - - Click **Download {% data variables.product.prodname_ghe_server %} X.X.X**. + - [リリースノート](/admin/release-notes)にアクセスしてください。 + - 右のサイドバーで、ダウンロードしたいバージョンをクリックしてください。 + - **Download {% data variables.product.prodname_ghe_server %} X.X.X**をクリックしてください。 diff --git a/translations/ja-JP/data/reusables/enterprise_installation/preventing-nameservers-change.md b/translations/ja-JP/data/reusables/enterprise_installation/preventing-nameservers-change.md index c90d54c03a..be9dc21735 100644 --- a/translations/ja-JP/data/reusables/enterprise_installation/preventing-nameservers-change.md +++ b/translations/ja-JP/data/reusables/enterprise_installation/preventing-nameservers-change.md @@ -1,5 +1,5 @@ {% note %} - **Note**: The 127.0.0.1 entry is required to be the first entry in the list. Do not remove the 127.0.0.1 entry, add another entry above the 127.0.0.1 entry, or use options that affect the ordering of entries, such as "options rotate". + **ノート**: 127.0.0.1のエントリは、リスト中の最初のエントリでなければなりません。 127.0.0.1のエントリを削除したり、127.0.0.1のエントリよりも上に他のエントリを追加したり、"options rotate"のようなエントリの順序に影響するオプションを使用したりしないでください。 {% endnote %} diff --git a/translations/ja-JP/data/reusables/enterprise_installation/proxy-incompatible-with-aws-nlbs.md b/translations/ja-JP/data/reusables/enterprise_installation/proxy-incompatible-with-aws-nlbs.md index 1927e06e43..55730ab766 100644 --- a/translations/ja-JP/data/reusables/enterprise_installation/proxy-incompatible-with-aws-nlbs.md +++ b/translations/ja-JP/data/reusables/enterprise_installation/proxy-incompatible-with-aws-nlbs.md @@ -1,5 +1,5 @@ {% note %} -**Note:** {% data variables.product.prodname_ghe_server %} supports PROXY Protocol V1, which is incompatible with AWS Network Load Balancers. If you use AWS Network Load Balancers with {% data variables.product.prodname_ghe_server %}, do not enable PROXY support. +**ノート:** {% data variables.product.prodname_ghe_server %}はPROXY Protocol V1をサポートしており、これはAWS Network Load Balancerとは非互換です。 もしもAWS Network Load Balancerを{% data variables.product.prodname_ghe_server %}とともに使うなら、PROXYサポートは有効化しないでください。 {% endnote %} diff --git a/translations/ja-JP/data/reusables/enterprise_installation/replication-command.md b/translations/ja-JP/data/reusables/enterprise_installation/replication-command.md index 3bb3d79808..8f881078aa 100644 --- a/translations/ja-JP/data/reusables/enterprise_installation/replication-command.md +++ b/translations/ja-JP/data/reusables/enterprise_installation/replication-command.md @@ -4,6 +4,6 @@ ``` {% warning %} - **警告：** `ghe-repl-start`を使うとプライマリサーバーは短期間利用できなくなり、その間ユーザにはinternal server errorが返されます。 もっと親切なメッセージを提供するには、`ghe-repl-start`をレプリカノードで実行する前にプライマリノード上で`ghe-maintenance -s`を実行し、アプライアンスをメンテナンスモードにしてください。 レプリケーションを開始したら、`ghe-maintenance -u`でメンテナンスモードを無効化してください。 Git replication will not progress while the primary node is in maintenance mode. + **警告：** `ghe-repl-start`を使うとプライマリサーバーは短期間利用できなくなり、その間ユーザにはinternal server errorが返されます。 もっと親切なメッセージを提供するには、`ghe-repl-start`をレプリカノードで実行する前にプライマリノード上で`ghe-maintenance -s`を実行し、アプライアンスをメンテナンスモードにしてください。 レプリケーションを開始したら、`ghe-maintenance -u`でメンテナンスモードを無効化してください。 Gitレプリケーションは、プライマリノードがメンテナンスモードの間は進行しません。 {% endwarning %} diff --git a/translations/ja-JP/data/reusables/enterprise_installation/software-license.md b/translations/ja-JP/data/reusables/enterprise_installation/software-license.md index 8e56f157db..c8e1ec01a4 100644 --- a/translations/ja-JP/data/reusables/enterprise_installation/software-license.md +++ b/translations/ja-JP/data/reusables/enterprise_installation/software-license.md @@ -1 +1 @@ -{% data variables.product.prodname_enterprise %}のライセンスファイルを持っていなければなりません。 For more information, see "[Setting up a trial of {% data variables.product.prodname_ghe_server %}](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server#setting-up-your-trial-of-github-enterprise-server)" and "[About licenses for {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise)." +{% data variables.product.prodname_enterprise %}のライセンスファイルを持っていなければなりません。 詳しい情報については「[{% data variables.product.prodname_ghe_server %}のトライアルのセットアップ](/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server#setting-up-your-trial-of-github-enterprise-server)」及び「[{% data variables.product.prodname_enterprise %}のライセンスについて](/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/enterprise_installation/ssh-into-instance.md b/translations/ja-JP/data/reusables/enterprise_installation/ssh-into-instance.md index 2878e9c49b..060300b753 100644 --- a/translations/ja-JP/data/reusables/enterprise_installation/ssh-into-instance.md +++ b/translations/ja-JP/data/reusables/enterprise_installation/ssh-into-instance.md @@ -1,4 +1,4 @@ -1. {% data variables.product.product_location %}にSSHでアクセスしてください。 If your instance comprises multiple nodes, for example if high availability or geo-replication are configured, SSH into the primary node. If you use a cluster, you can SSH into any node. For more information about SSH access, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)." +1. {% data variables.product.product_location %}にSSHでアクセスしてください。 たとえばHigh availabilityやGeo-replicationが設定されている場合のように、インスタンスが複数のノードで構成されているなら、プライマリノードにSSHで接続してください。 クラスタを使用しているなら、任意のノードにSSH接続できます。 SSHアクセスに関する詳しい情報については「[管理シェル（SSH）へのアクセス](/admin/configuration/accessing-the-administrative-shell-ssh)」を参照してください。 ```shell $ ssh -p 122 admin@HOSTNAME diff --git a/translations/ja-JP/data/reusables/enterprise_installation/upload-a-license-file.md b/translations/ja-JP/data/reusables/enterprise_installation/upload-a-license-file.md index b6c95f3f1e..03bf7fe56b 100644 --- a/translations/ja-JP/data/reusables/enterprise_installation/upload-a-license-file.md +++ b/translations/ja-JP/data/reusables/enterprise_installation/upload-a-license-file.md @@ -1 +1 @@ -2. プロンプトでライセンスファイルをアップロードし、管理コンソールのパスワードを設定してください。 For more information, see "[Managing your license for {% data variables.product.prodname_enterprise %}](/billing/managing-your-license-for-github-enterprise)." +2. プロンプトでライセンスファイルをアップロードし、管理コンソールのパスワードを設定してください。 詳しい情報については「[{% data variables.product.prodname_enterprise %}のライセンスの管理](/billing/managing-your-license-for-github-enterprise)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/enterprise_management_console/advanced-security-tab.md b/translations/ja-JP/data/reusables/enterprise_management_console/advanced-security-tab.md index cb51b0bc52..613df70a55 100644 --- a/translations/ja-JP/data/reusables/enterprise_management_console/advanced-security-tab.md +++ b/translations/ja-JP/data/reusables/enterprise_management_console/advanced-security-tab.md @@ -1 +1 @@ -1. 左のサイドバーで**Security（セキュリティ）**をクリックしてください。 ![Security sidebar](/assets/images/enterprise/3.2/management-console/sidebar-security.png) +1. 左のサイドバーで**Security（セキュリティ）**をクリックしてください。 ![セキュリティサイドバー](/assets/images/enterprise/3.2/management-console/sidebar-security.png) diff --git a/translations/ja-JP/data/reusables/enterprise_management_console/save-settings.md b/translations/ja-JP/data/reusables/enterprise_management_console/save-settings.md index 90d31037c5..c14c257ebd 100644 --- a/translations/ja-JP/data/reusables/enterprise_management_console/save-settings.md +++ b/translations/ja-JP/data/reusables/enterprise_management_console/save-settings.md @@ -1,10 +1,10 @@ 1. 左のサイドバーの下で**Save settings（設定の保存）**をクリックしてください。 - ![Screenshot of the save settings button in the {% data variables.enterprise.management_console %}](/assets/images/enterprise/management-console/save-settings.png) + ![{% data variables.enterprise.management_console %}の設定保存ボタンのスクリーンショット](/assets/images/enterprise/management-console/save-settings.png) {% note %} - **Note:** Saving settings in the {% data variables.enterprise.management_console %} restarts system services, which could result in user-visible downtime. + **ノート:**{% data variables.enterprise.management_console %}に設定を保存するとシステムサービスが再起動され、それによってユーザに影響するダウンタイムが発生することがあります。 {% endnote %} diff --git a/translations/ja-JP/data/reusables/enterprise_migrations/locking-repositories.md b/translations/ja-JP/data/reusables/enterprise_migrations/locking-repositories.md index ae6a976d40..21b312f590 100644 --- a/translations/ja-JP/data/reusables/enterprise_migrations/locking-repositories.md +++ b/translations/ja-JP/data/reusables/enterprise_migrations/locking-repositories.md @@ -1,6 +1,6 @@ {% tip %} -**Note:** Locking a repository prevents all write access to the repository. ロックされたリポジトリには、新しいTeamやコラボレータを関連づけることはできません。 +**ノート:** リポジトリをロックすると、そのリポジトリへのすべての書き込みアクセスが防がれます。 ロックされたリポジトリには、新しいTeamやコラボレータを関連づけることはできません。 トライアル実行をしているなら、リポジトリをロックする必要はありません。 使用中のリポジトリからデータを移行する場合、 {% data variables.product.company_short %}はそのリポジトリをロックすることを強くおすすめします。 詳細は「[移行について](/enterprise/admin/migrations/about-migrations#types-of-migrations)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/enterprise_site_admin_settings/access-settings.md b/translations/ja-JP/data/reusables/enterprise_site_admin_settings/access-settings.md index 145716846a..77fa708663 100644 --- a/translations/ja-JP/data/reusables/enterprise_site_admin_settings/access-settings.md +++ b/translations/ja-JP/data/reusables/enterprise_site_admin_settings/access-settings.md @@ -1,7 +1,7 @@ -1. From an administrative account on {% data variables.product.product_name %}, in the upper-right corner of any page, click {% octicon "rocket" aria-label="The rocket ship" %}. +1. {% data variables.product.product_name %}の管理アカウントから、任意のページの右上で{% octicon "rocket" aria-label="The rocket ship" %}をクリックしてください。 - ![Screenshot of the rocket ship icon for accessing site admin settings](/assets/images/enterprise/site-admin-settings/access-new-settings.png) + ![サイトアドミン設定にアクセスするためのロケット船のスクリーンショット](/assets/images/enterprise/site-admin-settings/access-new-settings.png) -1. If you're not already on the "Site admin" page, in the upper-left corner, click **Site admin**. +1. まだ"Site admin（サイトアドミン）"ページにいないなら、左上の**Site admin（サイトアドミン）**をクリックしてください。 - ![Screenshot of "Site admin" link](/assets/images/enterprise/site-admin-settings/site-admin-link.png) + !["Site admin"リンクのスクリーンショット](/assets/images/enterprise/site-admin-settings/site-admin-link.png) diff --git a/translations/ja-JP/data/reusables/enterprise_site_admin_settings/add-key-to-web-flow-user.md b/translations/ja-JP/data/reusables/enterprise_site_admin_settings/add-key-to-web-flow-user.md index 16a869b963..3218da38de 100644 --- a/translations/ja-JP/data/reusables/enterprise_site_admin_settings/add-key-to-web-flow-user.md +++ b/translations/ja-JP/data/reusables/enterprise_site_admin_settings/add-key-to-web-flow-user.md @@ -1,14 +1,14 @@ -1. Run the following command, replacing KEY-ID with your PGP key ID. +1. KEY-IDを自分のPGPキーIDに置き換えて、以下のコマンドを実行してください。 ```bash{:copy} gpg --armor --export KEY-ID ``` -1. Copy your PGP key, beginning with `-----BEGIN PGP PUBLIC KEY BLOCK-----` and ending with `-----END PGP PUBLIC KEY BLOCK-----`. -1. Sign into {% data variables.product.prodname_ghe_server %} as the `web-flow` user. -1. Add the public PGP key to the user's profile. For more information, see "[Adding a GPG key to your {% data variables.product.prodname_dotcom %} account](/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account)." +1. `-----BEGIN PGP PUBLIC KEY BLOCK-----`で始まり`-----END PGP PUBLIC KEY BLOCK-----`で終わる自分のPGPキーをコピーしてください。 +1. {% data variables.product.prodname_ghe_server %}に`web-flow`ユーザとしてサインインしてください。 +1. 公開PGPキーをユーザプロフィールに追加してください。 詳しい情報については「[{% data variables.product.prodname_dotcom %}アカウントへのGPGキーの追加](/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account)」を参照してください。 {% note %} - **Note:** Do not remove other public keys from the list of GPG keys. If a public key is deleted, any commits signed with the corresponding private key will no longer be marked as verified. + **ノート:** GPGキーのリストから他の公開鍵を削除しないでください。 公開鍵が削除されると、対応する秘密鍵で署名されたコミットは、検証済みとしてマークされなくなります。 {% endnote %} diff --git a/translations/ja-JP/data/reusables/enterprise_site_admin_settings/business.md b/translations/ja-JP/data/reusables/enterprise_site_admin_settings/business.md index 0f1d1ceb5a..de5ff034cf 100644 --- a/translations/ja-JP/data/reusables/enterprise_site_admin_settings/business.md +++ b/translations/ja-JP/data/reusables/enterprise_site_admin_settings/business.md @@ -1 +1 @@ -1. 左のサイドバーで、**Enterprise{% ifversion ghes or ghae %} overview（Enterpriseの概要）{% endif %}**をクリックしてください。 ![Enterprise{% ifversion ghes or ghae %} overview{% endif %} tab in the Site admin settings](/assets/images/enterprise/site-admin-settings/enterprise-tab.png) +1. 左のサイドバーで、**Enterprise{% ifversion ghes or ghae %} overview（Enterpriseの概要）{% endif %}**をクリックしてください。 ![サイトアドミン設定のEnterprise{% ifversion ghes or ghae %}概要{% endif %}タブ](/assets/images/enterprise/site-admin-settings/enterprise-tab.png) diff --git a/translations/ja-JP/data/reusables/enterprise_site_admin_settings/create-pgp-key-web-commit-signing.md b/translations/ja-JP/data/reusables/enterprise_site_admin_settings/create-pgp-key-web-commit-signing.md index a876d7be14..2540e98cf6 100644 --- a/translations/ja-JP/data/reusables/enterprise_site_admin_settings/create-pgp-key-web-commit-signing.md +++ b/translations/ja-JP/data/reusables/enterprise_site_admin_settings/create-pgp-key-web-commit-signing.md @@ -1,8 +1,8 @@ -1. In the administrative shell, create a PGP key. Make note of the email address and key ID. +1. 管理シェルでPGPキーを作成してください。 メールアドレスとキーIDをメモしてください。 ```bash{:copy} gpg --full-generate-key --pinentry-mode=loopback ``` - - Use the default key type and at least `4096` bits with no expiry. - - Use `web-flow` as the username. + - デフォルトのキータイプと、有効期限のない最小`4096`ビット長を使用してください。 + - ユーザ名として`web-flow`を使ってください。 diff --git a/translations/ja-JP/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md b/translations/ja-JP/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md index c5d6100063..d9e308eee9 100644 --- a/translations/ja-JP/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md +++ b/translations/ja-JP/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md @@ -1,4 +1,4 @@ -1. Define the key as a environment variable for {% data variables.product.product_name %}, replacing `` with the GPG key ID. +1. Define the key as an environment variable for {% data variables.product.product_name %}, replacing `` with the GPG key ID. ```bash{:copy} ghe-config "secrets.gpgverify.web-signing-key" "$(gpg --export-secret-keys -a | awk '{printf "%s\\n", $0}')" diff --git a/translations/ja-JP/data/reusables/enterprise_site_admin_settings/pgp-key-no-passphrase.md b/translations/ja-JP/data/reusables/enterprise_site_admin_settings/pgp-key-no-passphrase.md index d36ffce0fe..3f8cfa9da7 100644 --- a/translations/ja-JP/data/reusables/enterprise_site_admin_settings/pgp-key-no-passphrase.md +++ b/translations/ja-JP/data/reusables/enterprise_site_admin_settings/pgp-key-no-passphrase.md @@ -1 +1 @@ - - The PGP key **cannot** be protected by a passphrase. + - PHPキーはパスフレーズによって保護することは**できません**。 diff --git a/translations/ja-JP/data/reusables/enterprise_site_admin_settings/tls-downtime.md b/translations/ja-JP/data/reusables/enterprise_site_admin_settings/tls-downtime.md index a1cc2ae3c0..1b75e1057d 100644 --- a/translations/ja-JP/data/reusables/enterprise_site_admin_settings/tls-downtime.md +++ b/translations/ja-JP/data/reusables/enterprise_site_admin_settings/tls-downtime.md @@ -1,5 +1,5 @@ {% warning %} -**Warning:** Configuring TLS causes a small amount of downtime for {% data variables.product.product_location %}. +**警告:**TLSを設定すると、わずかなダウンタイムが{% data variables.product.product_location %}に生じます。 {% endwarning %} diff --git a/translations/ja-JP/data/reusables/enterprise_site_admin_settings/update-commit-signing-service.md b/translations/ja-JP/data/reusables/enterprise_site_admin_settings/update-commit-signing-service.md index 22f73d6fd0..fc771bbb38 100644 --- a/translations/ja-JP/data/reusables/enterprise_site_admin_settings/update-commit-signing-service.md +++ b/translations/ja-JP/data/reusables/enterprise_site_admin_settings/update-commit-signing-service.md @@ -1,4 +1,4 @@ -1. Update the settings for {% data variables.product.product_name %}'s commit signing service. +1. {% data variables.product.product_name %}のコミット署名サービスの設定を更新してください。 ```bash{:copy} sudo consul-template -once -template /etc/consul-templates/etc/nomad-jobs/gpgverify/gpgverify.hcl.ctmpl:/etc/nomad-jobs/gpgverify/gpgverify.hcl diff --git a/translations/ja-JP/data/reusables/enterprise_user_management/alternatively-enable-external-authentication.md b/translations/ja-JP/data/reusables/enterprise_user_management/alternatively-enable-external-authentication.md index b5eea1318c..c90a0840a0 100644 --- a/translations/ja-JP/data/reusables/enterprise_user_management/alternatively-enable-external-authentication.md +++ b/translations/ja-JP/data/reusables/enterprise_user_management/alternatively-enable-external-authentication.md @@ -1 +1 @@ -Alternatively, you can configure external authentication for {% data variables.product.product_location %}. If you use external authentication, you must invite people to use your instance through your authentication provider. 詳しい情報については「[Enterpriseでの認証について](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise#external-authentication)」を参照してください。 +あるいは、{% data variables.product.product_location %}の外部認証を設定することもできます。 外部認証を使う場合、認証プロバイダを通じてインスタンスを使うよう、ユーザを招待しなければなりません。 詳しい情報については「[Enterpriseでの認証について](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise#external-authentication)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/enterprise_user_management/built-in-authentication-new-accounts.md b/translations/ja-JP/data/reusables/enterprise_user_management/built-in-authentication-new-accounts.md index b79a776b0f..ee62b00efb 100644 --- a/translations/ja-JP/data/reusables/enterprise_user_management/built-in-authentication-new-accounts.md +++ b/translations/ja-JP/data/reusables/enterprise_user_management/built-in-authentication-new-accounts.md @@ -1 +1 @@ -When you use built-in authentication for {% data variables.product.product_location %}, each person creates a personal account from an invitation or by signing up. +{% data variables.product.product_location %}のビルトイン認証を使う場合、各ユーザは招待から、あるいはサインアップによって個人アカウントを作成します。 diff --git a/translations/ja-JP/data/reusables/enterprise_user_management/built-in-authentication-option.md b/translations/ja-JP/data/reusables/enterprise_user_management/built-in-authentication-option.md index a593c408b3..0a073ad7ef 100644 --- a/translations/ja-JP/data/reusables/enterprise_user_management/built-in-authentication-option.md +++ b/translations/ja-JP/data/reusables/enterprise_user_management/built-in-authentication-option.md @@ -1 +1 @@ -Optionally, to allow people without an account on your external authentication system to sign in with built-in authentication, select **Allow built-in authentication**. For more information, see "[Allowing built-in authentication for users outside your provider](/admin/identity-and-access-management/managing-iam-for-your-enterprise/allowing-built-in-authentication-for-users-outside-your-provider)." +あるいは外部の認証システムにアカウントを持たずにビルトイン認証でサインインすることを許可するには、**Allow built-in authentication（ビルトイン認証の許可）**を選択してください。 詳しい情報については「[プロバイダ外のユーザへのビルトイン認証の許可](/admin/identity-and-access-management/managing-iam-for-your-enterprise/allowing-built-in-authentication-for-users-outside-your-provider)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/enterprise_user_management/built-in-authentication.md b/translations/ja-JP/data/reusables/enterprise_user_management/built-in-authentication.md index f3dd9376bb..a3e665b9be 100644 --- a/translations/ja-JP/data/reusables/enterprise_user_management/built-in-authentication.md +++ b/translations/ja-JP/data/reusables/enterprise_user_management/built-in-authentication.md @@ -1 +1 @@ -If you want to allow authentication for some people who don't have an account on your external authentication provider, you can allow fallback authentication to local accounts on {% data variables.product.product_location %}. For more information, see "[Allowing built-in authentication for users outside your provider](/admin/identity-and-access-management/managing-iam-for-your-enterprise/allowing-built-in-authentication-for-users-outside-your-provider)." +外部認証プロバイダにアカウントを持たない一部のユーザに認証を許可したいなら、{% data variables.product.product_location %}のローカルアカウントへの認証のフォールバックを許可できます。 詳しい情報については「[プロバイダ外のユーザへのビルトイン認証の許可](/admin/identity-and-access-management/managing-iam-for-your-enterprise/allowing-built-in-authentication-for-users-outside-your-provider)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/enterprise_user_management/consider-usernames-for-external-authentication.md b/translations/ja-JP/data/reusables/enterprise_user_management/consider-usernames-for-external-authentication.md index e88fdc5bfd..72f67c42e0 100644 --- a/translations/ja-JP/data/reusables/enterprise_user_management/consider-usernames-for-external-authentication.md +++ b/translations/ja-JP/data/reusables/enterprise_user_management/consider-usernames-for-external-authentication.md @@ -1 +1 @@ -{% data variables.product.product_name %} normalizes a value from your {% ifversion ghec or ghae %}IdP{% elsif ghes %}external authentication provider{% endif %} to determine the username for each new personal account {% ifversion ghae %}on {% data variables.product.product_name %}{% elsif ghec %}in your enterprise on {% data variables.product.product_location %}{% elsif ghes %}on {% data variables.product.product_location %}{% endif %}. +{% data variables.product.product_name %}は{% ifversion ghec or ghae %}IdP{% elsif ghes %}外部認証プロバイダ{% endif %}からの値を正規化して、{% ifversion ghae %}{% data variables.product.product_name %}上の{% elsif ghec %}{% data variables.product.product_location %}上のEnteprise内の{% elsif ghes %}{% data variables.product.product_location %}上の{% endif %}それぞれの新しい個人アカウントのユーザ名を決定します。 diff --git a/translations/ja-JP/data/reusables/enterprise_user_management/disclaimer-for-git-read-access.md b/translations/ja-JP/data/reusables/enterprise_user_management/disclaimer-for-git-read-access.md index a11b1fb4f4..18a28a7745 100644 --- a/translations/ja-JP/data/reusables/enterprise_user_management/disclaimer-for-git-read-access.md +++ b/translations/ja-JP/data/reusables/enterprise_user_management/disclaimer-for-git-read-access.md @@ -1,6 +1,6 @@ {% warning %} -**警告:** +**Warnings:** - The Git protocol is unauthenticated and unencrypted. An attacker could intercept repository data transferred over connections using this protocol. - If you enable anonymous Git read access, you're responsible for all access and use of the feature. {% data variables.product.company_short %} is not responsible for any unintended access, security risks, or misuse of the feature. diff --git a/translations/ja-JP/data/reusables/enterprise_user_management/unauthenticated-sign-ups.md b/translations/ja-JP/data/reusables/enterprise_user_management/unauthenticated-sign-ups.md index 18468c0235..78df60d8ab 100644 --- a/translations/ja-JP/data/reusables/enterprise_user_management/unauthenticated-sign-ups.md +++ b/translations/ja-JP/data/reusables/enterprise_user_management/unauthenticated-sign-ups.md @@ -1 +1 @@ -By default, people who can access your instance while unauthenticated can create a new personal account on your instance. +デフォルトでは、未認証でインスタンスにアクセスできる人は、インスタンス上に新しい個人アカウントを作成できます。 diff --git a/translations/ja-JP/data/reusables/files/choose-commit-email.md b/translations/ja-JP/data/reusables/files/choose-commit-email.md index 7fafc145b0..2492e2725e 100644 --- a/translations/ja-JP/data/reusables/files/choose-commit-email.md +++ b/translations/ja-JP/data/reusables/files/choose-commit-email.md @@ -1,5 +1,5 @@ {% ifversion fpt or ghec %} -1. If you have more than one email address associated with your account on -{% data variables.product.product_location %}, click the email address drop-down menu and select the email address to use as the Git author email address. このドロップダウンメニューには、検証済みのメールアドレスだけが表示されます。 メールアドレスのプライバシーを有効化している場合、`@users.noreply.github.com`がデフォルトのコミット作者メールアドレスになります。 詳細は「[コミットメールアドレスを設定する](/articles/setting-your-commit-email-address)」を参照してください。 +1. 2つ以上の +{% data variables.product.product_location %}上のアカウントに関連づけられたメールアドレスを持っているなら、メールアドレスドロップダウンメニューをクリックし、Gitの作者のメールアドレスとして使いたいメールアドレスを選択してください。 このドロップダウンメニューには、検証済みのメールアドレスだけが表示されます。 メールアドレスのプライバシーを有効化している場合、`@users.noreply.github.com`がデフォルトのコミット作者メールアドレスになります。 詳細は「[コミットメールアドレスを設定する](/articles/setting-your-commit-email-address)」を参照してください。 ![コミットメールアドレスの選択](/assets/images/help/repository/choose-commit-email-address.png) {% endif %} diff --git a/translations/ja-JP/data/reusables/gated-features/code-review-assignment.md b/translations/ja-JP/data/reusables/gated-features/code-review-assignment.md index a3e4c21175..8afffd8722 100644 --- a/translations/ja-JP/data/reusables/gated-features/code-review-assignment.md +++ b/translations/ja-JP/data/reusables/gated-features/code-review-assignment.md @@ -1 +1 @@ -Code review settings are available in all public repositories owned by an organization, and all private repositories owned by organizations on {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_server %} 2.20+,{% ifversion ghae %} {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_cloud %}. 詳しい情報については「[GitHubの製品](/articles/githubs-products)」を参照してください。 +コードレビュー設定は、Organizationが所有するすべてのパブリックリポジトリ、そして{% data variables.product.prodname_team %}、{% data variables.product.prodname_ghe_server %} 2.20+、{% ifversion ghae %}{% data variables.product.prodname_ghe_managed %}、{% endif %}{% data variables.product.prodname_ghe_cloud %}上のOrganizationが所有するすべてのプライベートリポジトリで利用できます。 詳しい情報については「[GitHubの製品](/articles/githubs-products)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/gated-features/copilot.md b/translations/ja-JP/data/reusables/gated-features/copilot.md index 84079410cc..4acb15a9e0 100644 --- a/translations/ja-JP/data/reusables/gated-features/copilot.md +++ b/translations/ja-JP/data/reusables/gated-features/copilot.md @@ -1 +1 @@ -{% data variables.product.prodname_copilot %} is available to {% data variables.product.company_short %} customers with a personal account on {% data variables.product.prodname_dotcom_the_website %}. {% data variables.product.prodname_copilot %} is free to use for verified students and maintainers of popular open source projects. If you are not a student or maintainer of a popular open source project, you can try {% data variables.product.prodname_copilot %} for free with a one-time 60 day trial. 無料のトライアルが終わったあと、継続して使うには有料プランが必要になります。 詳しい情報については、「[{% data variables.product.prodname_copilot %}の支払いについて](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot)」を参照してください。 +{% data variables.product.prodname_copilot %} is available to {% data variables.product.company_short %} customers with a personal account on {% data variables.product.prodname_dotcom_the_website %}. {% data variables.product.prodname_copilot %} is free to use for verified students and maintainers of popular open source projects. If you are not a student or maintainer of a popular open source project, you can try {% data variables.product.prodname_copilot %} for free with a one-time 60 day trial. After the free trial, you will need a paid subscription for continued use. For more information, see "[About billing for {% data variables.product.prodname_copilot %}](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot)." diff --git a/translations/ja-JP/data/reusables/gated-features/dependency-review.md b/translations/ja-JP/data/reusables/gated-features/dependency-review.md index ffcb443503..0fe0e69750 100644 --- a/translations/ja-JP/data/reusables/gated-features/dependency-review.md +++ b/translations/ja-JP/data/reusables/gated-features/dependency-review.md @@ -1,13 +1,13 @@ {%- ifversion fpt %} -Dependency review is enabled on public repositories. Dependency review is also available in private repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}. +依存関係レビューは、パブリックリポジトリで有効化されています。 依存関係レビューは、{% data variables.product.prodname_ghe_cloud %}を使い、{% data variables.product.prodname_GH_advanced_security %}のライセンスを持っているOrganizationが所有するプライベートリポジトリでも利用できます。 {%- elsif ghec %} -依存関係レビューは、パブリックリポジトリに対して{% data variables.product.product_name %}に含まれています。 To use dependency review in private repositories owned by organizations, you must have a license for {% data variables.product.prodname_GH_advanced_security %}. +依存関係レビューは、パブリックリポジトリに対して{% data variables.product.product_name %}に含まれています。 依存関係レビューをOrganizationが所有するプライベートリポジトリで使うには、{% data variables.product.prodname_GH_advanced_security %}のライセンスを持っていなければなりません。 {%- elsif ghes %} -Dependency review is available for organization-owned repositories in {% data variables.product.product_name %}. This feature requires a license for {% data variables.product.prodname_GH_advanced_security %}. +依存関係レビューは、{% data variables.product.product_name %}のOrganizationが所有するリポジトリで利用できます。 この機能には、{% data variables.product.prodname_GH_advanced_security %}のライセンスが必要です。 {%- elsif ghae %} -Dependency review is available for organization-owned repositories in {% data variables.product.product_name %}. This is a {% data variables.product.prodname_GH_advanced_security %} feature (free during the beta release). +依存関係レビューは、{% data variables.product.product_name %}のOrganizationが所有するリポジトリで利用できます。 これは{% data variables.product.prodname_GH_advanced_security %}の機能です（ベータリリースの期間中は無料）。 {%- endif %} {% data reusables.advanced-security.more-info-ghas %} diff --git a/translations/ja-JP/data/reusables/gated-features/dependency-vulnerable-calls.md b/translations/ja-JP/data/reusables/gated-features/dependency-vulnerable-calls.md index 88823ff80c..77ec887b45 100644 --- a/translations/ja-JP/data/reusables/gated-features/dependency-vulnerable-calls.md +++ b/translations/ja-JP/data/reusables/gated-features/dependency-vulnerable-calls.md @@ -1,13 +1,13 @@ {%- ifversion fpt %} -Detection of vulnerable calls is enabled on public repositories. This analysis is also available in private repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have licensed {% data variables.product.prodname_GH_advanced_security %}. +脆弱性のある呼び出しの検出は、パブリックリポジトリで有効化されています。 この分析は、{% data variables.product.prodname_ghe_cloud %}を使用し、ライセンスされた{% data variables.product.prodname_GH_advanced_security %}を持つOrganizationが所有するプライベートリポジトリでも利用できます。 {%- elsif ghec %} -Detection of vulnerable calls is included in {% data variables.product.product_name %} for public repositories. To detect vulnerable calls in private repositories owned by organizations, your organization must have a license for {% data variables.product.prodname_GH_advanced_security %}. +脆弱性のある呼び出しの検出は、パブリックリポジトリで{% data variables.product.product_name %}に含まれています。 Organizationが所有するプライベートリポジトリで脆弱性のある呼び出しを検出するには、Organizationが{% data variables.product.prodname_GH_advanced_security %}のライセンスを持っていなければなりません。 {%- elsif ghes > 3.5 %} -Detection of vulnerable calls is available for organization-owned repositories in {% data variables.product.product_name %}. This feature requires a license for {% data variables.product.prodname_GH_advanced_security %}. +脆弱性のある呼び出しの検出は、{% data variables.product.product_name %}のOrganizationが所有するリポジトリで利用できます。 この機能には、{% data variables.product.prodname_GH_advanced_security %}のライセンスが必要です。 {%- elsif ghae-issue-6076 %} -Detection of vulnerable calls is available for organization-owned repositories in {% data variables.product.product_name %}. This is a {% data variables.product.prodname_GH_advanced_security %} feature (free during the beta release). +脆弱性のある呼び出しの検出は、{% data variables.product.product_name %}のOrganizationが所有するリポジトリで利用できます。 これは{% data variables.product.prodname_GH_advanced_security %}の機能です（ベータリリースの期間中は無料）。 {%- endif %} {% data reusables.advanced-security.more-info-ghas %} diff --git a/translations/ja-JP/data/reusables/gated-features/enterprise-accounts.md b/translations/ja-JP/data/reusables/gated-features/enterprise-accounts.md index c66cd82910..7953568f7e 100644 --- a/translations/ja-JP/data/reusables/gated-features/enterprise-accounts.md +++ b/translations/ja-JP/data/reusables/gated-features/enterprise-accounts.md @@ -1 +1 @@ -Enterpriseアカウントは、{% data variables.product.prodname_ghe_cloud %}{% ifversion ghae %}、{% data variables.product.prodname_ghe_managed %}{% endif %}、{% data variables.product.prodname_ghe_server %}で利用できます。 For more information, see "[About enterprise accounts]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/overview/about-enterprise-accounts){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} +Enterprise accounts are available with {% data variables.product.prodname_ghe_cloud %}{% ifversion ghae %}, {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %}. For more information, see "[About enterprise accounts]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/overview/about-enterprise-accounts){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} diff --git a/translations/ja-JP/data/reusables/gated-features/environments.md b/translations/ja-JP/data/reusables/gated-features/environments.md index 2e58922759..c673dab144 100644 --- a/translations/ja-JP/data/reusables/gated-features/environments.md +++ b/translations/ja-JP/data/reusables/gated-features/environments.md @@ -1 +1 @@ -Environments, environment secrets, and environment protection rules are available in **public** repositories for all products. For access to environments, environment secrets, and deployment branches in **private** or **internal** repositories, you must use {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, or {% data variables.product.prodname_enterprise %}. For access to other environment protection rules in **private** or **internal** repositories, you must use {% data variables.product.prodname_enterprise %}. {% data reusables.gated-features.more-info %} +環境、環境シークレット、環境保護ルールはすべての製品の**パブリック**リポジトリで利用できます。 **プライベート**もしくは**インターナル**リポジトリの環境、環境シークレット、デプロイメントブランチへのアクセスには、{% data variables.product.prodname_pro %}、{% data variables.product.prodname_team %}、{% data variables.product.prodname_enterprise %}のいずれかを使用する必要があります。 **プライベート**もしくは**インターナル**リポジトリのその他の環境保護ルールにアクセスするには、{% data variables.product.prodname_enterprise %}を使わなければなりません。 {% data reusables.gated-features.more-info %} diff --git a/translations/ja-JP/data/reusables/gated-features/generated-health-checks.md b/translations/ja-JP/data/reusables/gated-features/generated-health-checks.md index 242ca1e599..6f7af2c2b2 100644 --- a/translations/ja-JP/data/reusables/gated-features/generated-health-checks.md +++ b/translations/ja-JP/data/reusables/gated-features/generated-health-checks.md @@ -1 +1 @@ -Generating a Health Check is available with {% data variables.contact.premium_support %}. 詳しい情報については、「[{% data variables.contact.premium_support %} について](/support/learning-about-github-support/about-github-premium-support)」を参照してください。 +ヘルスチェックの生成は、{% data variables.contact.premium_support %}で利用できます。 詳しい情報については、「[{% data variables.contact.premium_support %} について](/support/learning-about-github-support/about-github-premium-support)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/gated-features/ghas.md b/translations/ja-JP/data/reusables/gated-features/ghas.md index b6362ec2f9..66d02ec6dc 100644 --- a/translations/ja-JP/data/reusables/gated-features/ghas.md +++ b/translations/ja-JP/data/reusables/gated-features/ghas.md @@ -1 +1 @@ -{% data variables.product.prodname_GH_advanced_security %} is available for enterprise accounts on {% data variables.product.prodname_ghe_cloud %}{% ifversion ghae %}, {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %}.{% ifversion fpt or ghec %} Some features of {% data variables.product.prodname_GH_advanced_security %} are also available for public repositories on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[About GitHub's products](/github/getting-started-with-github/githubs-products)."{% else %} For more information about upgrading your {% data variables.product.prodname_ghe_server %} instance, see "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)" and refer to the [{% data variables.enterprise.upgrade_assistant %}](https://support.github.com/enterprise/server-upgrade) to find the upgrade path from your current release version.{% endif %} +{% data variables.product.prodname_GH_advanced_security %}は{% data variables.product.prodname_ghe_cloud %}{% ifversion ghae %}、{% data variables.product.prodname_ghe_managed %}{% endif %}、{% data variables.product.prodname_ghe_server %}のEntepriseアカウントで利用できます。{% ifversion fpt or ghec %}{% data variables.product.prodname_GH_advanced_security %}の一部の機能は、{% data variables.product.prodname_dotcom_the_website %}のパブリックリポジトリでも利用できます。 詳しい情報については「[GitHubの製品について](/github/getting-started-with-github/githubs-products)」を参照してください。{% else %}{% data variables.product.prodname_ghe_server %}インスタンスのアップグレードに関する詳しい情報については「[新しいリリースへのアップグレードについて](/admin/overview/about-upgrades-to-new-releases)」を参照し、現在のリリースバージョンからのアップグレードパスを見つけるには[{% data variables.enterprise.upgrade_assistant %}](https://support.github.com/enterprise/server-upgrade)を参照してください。{% endif %} diff --git a/translations/ja-JP/data/reusables/gated-features/historical-insights-for-projects.md b/translations/ja-JP/data/reusables/gated-features/historical-insights-for-projects.md index 07502e255f..21afa5fa32 100644 --- a/translations/ja-JP/data/reusables/gated-features/historical-insights-for-projects.md +++ b/translations/ja-JP/data/reusables/gated-features/historical-insights-for-projects.md @@ -1 +1 @@ -Historical charts are available with {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} for organizations. You can save unlimited charts in private projects with {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} for organizations and {% data variables.product.prodname_pro %} for users. Users and organizations using a public project can also save unlimited charts. Users and organizations using {% data variables.product.prodname_free_team %} or a legacy plan can save two charts in private projects. {% data reusables.gated-features.more-info %} \ No newline at end of file +履歴グラフは{% data variables.product.prodname_team %}及びOrganizationの{% data variables.product.prodname_ghe_cloud %}で利用できます。 {% data variables.product.prodname_team %}及びOrganizationの{% data variables.product.prodname_ghe_cloud %}及びユーザの{% data variables.product.prodname_pro %}で、プライベートプロジェクトに無制限にグラフを保存できます。 パブリックプロジェクトを利用するユーザ及びOrganizationも、無制限にグラフを保存できます。 {% data variables.product.prodname_free_team %}もしくはレガシープランを利用しているユーザ及びOrganizationは、プライベートプロジェクトに2つのグラフを保存できます。 {% data reusables.gated-features.more-info %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/gated-features/multiple-pr-reviewers.md b/translations/ja-JP/data/reusables/gated-features/multiple-pr-reviewers.md index 275295cc25..40db88db11 100644 --- a/translations/ja-JP/data/reusables/gated-features/multiple-pr-reviewers.md +++ b/translations/ja-JP/data/reusables/gated-features/multiple-pr-reviewers.md @@ -1 +1 @@ -The ability to add multiple pull request reviewers or requests reviews from teams is available in public repositories with {% data variables.product.prodname_free_team %} for organizations and legacy per-repository billing plans, and in public and private repositories with {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_server %},{% ifversion ghae %} {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_cloud %}. {% ifversion fpt or ghec %}{% data reusables.gated-features.more-info %}{% endif %} +複数のPull Requestレビュー担当者を追加する化、Teamからのレビューをリクエストする機能は、Organizationの{% data variables.product.prodname_free_team %}及びレガシーのリポジトリ単位の支払いプランのパブリックリポジトリ、そして{% data variables.product.prodname_team %}、{% data variables.product.prodname_ghe_server %}、{% ifversion ghae %}{% data variables.product.prodname_ghe_managed %}、{% endif %}{% data variables.product.prodname_ghe_cloud %}のパブリック及びプライベートリポジトリで利用できます。 {% ifversion fpt or ghec %}{% data reusables.gated-features.more-info %}{% endif %} diff --git a/translations/ja-JP/data/reusables/gated-features/packages.md b/translations/ja-JP/data/reusables/gated-features/packages.md index ae91fb6596..1f7954da8c 100644 --- a/translations/ja-JP/data/reusables/gated-features/packages.md +++ b/translations/ja-JP/data/reusables/gated-features/packages.md @@ -1,7 +1,7 @@ {% ifversion fpt or ghec or ghes < 3.5 %} -{% data variables.product.prodname_registry %} is available with {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %} 3.0 or higher, and {% data variables.product.prodname_ghe_managed %}.{% ifversion ghes %} For more information about upgrading your {% data variables.product.prodname_ghe_server %} instance, see "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)" and refer to the [{% data variables.enterprise.upgrade_assistant %}](https://support.github.com/enterprise/server-upgrade) to find the upgrade path from your current release version.{% endif %} +{% data variables.product.prodname_registry %}は、{% data variables.product.prodname_free_user %}、{% data variables.product.prodname_pro %}、Organizationの{% data variables.product.prodname_free_team %}、{% data variables.product.prodname_team %}、{% data variables.product.prodname_ghe_cloud %}、{% data variables.product.prodname_ghe_server %} 3.0以降、{% data variables.product.prodname_ghe_managed %}で利用できます。{% ifversion ghes %}{% data variables.product.prodname_ghe_server %}インスタンスのアップグレードに関する詳しい情報については「[新しいリリースへのアップグレードについて](/admin/overview/about-upgrades-to-new-releases)」を参照し、現在のリリースバージョンからのアップグレードパスを探すことについては[{% data variables.enterprise.upgrade_assistant %}](https://support.github.com/enterprise/server-upgrade)を参照してください。{% endif %} {% ifversion fpt or ghec %}
    -{% data variables.product.prodname_registry %}は、レガシーのリポジトリごとのプランを使っているアカウントが所有しているプライベートリポジトリでは利用できません。 Also, accounts using legacy per-repository plans cannot access the {% data variables.product.prodname_container_registry %} since these accounts are billed by repository. {% data reusables.gated-features.more-info %} +{% data variables.product.prodname_registry %}は、レガシーのリポジトリごとのプランを使っているアカウントが所有しているプライベートリポジトリでは利用できません。 また、レガシーのリポジトリごとのプランを使っているアカウントは、リポジトリごとに課金されるため、{% data variables.product.prodname_container_registry %}にはアクセスできません。 {% data reusables.gated-features.more-info %} {% endif %} {% endif %} diff --git a/translations/ja-JP/data/reusables/gated-features/repository-insights.md b/translations/ja-JP/data/reusables/gated-features/repository-insights.md index 294c79fa86..3345152b1e 100644 --- a/translations/ja-JP/data/reusables/gated-features/repository-insights.md +++ b/translations/ja-JP/data/reusables/gated-features/repository-insights.md @@ -1 +1 @@ -This repository insights graph is available in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %},{% ifversion ghae %} {% data variables.product.prodname_ghe_managed %},{% endif %} and {% data variables.product.prodname_ghe_server %}.{% ifversion fpt or ghec %} For more information, see "[About repository graphs](/articles/about-repository-graphs)" and "[{% data variables.product.prodname_dotcom %}'s products](/articles/github-s-products)."{% endif %} +リポジトリインサイトグラフは、{% data variables.product.prodname_free_user %}及びOrganizationの{% data variables.product.prodname_free_team %}のパブリックリポジトリ、そして{% data variables.product.prodname_pro %}、{% data variables.product.prodname_team %}、{% data variables.product.prodname_ghe_cloud %}、{% ifversion ghae %}{% data variables.product.prodname_ghe_managed %}、{% endif %}{% data variables.product.prodname_ghe_server %}のパブリック及びプライベートリポジトリで利用できます。{% ifversion fpt or ghec %}詳しい情報については「[リポジトリグラフについて](/articles/about-repository-graphs)」及び「[{% data variables.product.prodname_dotcom %}の製品](/articles/github-s-products)」を参照してください。{% endif %} diff --git a/translations/ja-JP/data/reusables/gated-features/restrict-email-domain.md b/translations/ja-JP/data/reusables/gated-features/restrict-email-domain.md index c5349aab70..cc2e0801a2 100644 --- a/translations/ja-JP/data/reusables/gated-features/restrict-email-domain.md +++ b/translations/ja-JP/data/reusables/gated-features/restrict-email-domain.md @@ -1 +1 @@ -Restriction of email notifications to approved or verified domains is available with {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %}. 詳しい情報については「[GitHubの製品](/articles/githubs-products)」を参照してください。 +承認済みもしくは検証済みドメインへのメール通知の制限は、{% data variables.product.prodname_ghe_cloud %}及び{% data variables.product.prodname_ghe_server %}で利用できます。 詳しい情報については「[GitHubの製品](/articles/githubs-products)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/gated-features/security-overview.md b/translations/ja-JP/data/reusables/gated-features/security-overview.md index 7a4f00d780..ec25070008 100644 --- a/translations/ja-JP/data/reusables/gated-features/security-overview.md +++ b/translations/ja-JP/data/reusables/gated-features/security-overview.md @@ -1,5 +1,5 @@ {% ifversion fpt %} -The security overview is available for organizations that use {% data variables.product.prodname_enterprise %}. 詳しい情報については「[GitHubの製品](/articles/githubs-products)」を参照してください。 +The security overview is available for organizations that use {% data variables.product.prodname_enterprise %}. For more information, see "[GitHub's products](/articles/githubs-products)." {% elsif security-overview-displayed-alerts %} All organizations and enterprises have a security overview. If you use {% data variables.product.prodname_GH_advanced_security %}{% ifversion ghae %}, which is free during the beta release,{% endif %} you will see additional information. {% data reusables.advanced-security.more-info-ghas %} {% elsif ghes < 3.7 %} diff --git a/translations/ja-JP/data/reusables/gated-features/tag-protection-rules.md b/translations/ja-JP/data/reusables/gated-features/tag-protection-rules.md index 3f8d774374..ff4bba7ec7 100644 --- a/translations/ja-JP/data/reusables/gated-features/tag-protection-rules.md +++ b/translations/ja-JP/data/reusables/gated-features/tag-protection-rules.md @@ -1 +1 @@ -{% ifversion ghae %}Tag protection rules are available in internal and private repositories with {% data variables.product.prodname_ghe_managed %}, {% else%}Tag protection rules are available {% endif %}in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}. {% ifversion fpt or ghec %}{% data reusables.gated-features.more-info %}{% endif %} +{% ifversion ghae %}タグ保護ルールは、{% data variables.product.prodname_ghe_managed %}のインターナル及びプライベートリポジトリ、{% else%}タグ保護ルールは、{% endif %}{% data variables.product.prodname_free_user %}及びOrganizationの{% data variables.product.prodname_free_team %}のパブリックリポジトリ、{% data variables.product.prodname_pro %}、{% data variables.product.prodname_team %}、{% data variables.product.prodname_ghe_cloud %}、{% data variables.product.prodname_ghe_server %}のパブリック及びプライベートリポジトリで利用できます。 {% ifversion fpt or ghec %}{% data reusables.gated-features.more-info %}{% endif %} diff --git a/translations/ja-JP/data/reusables/gated-features/user-repo-collaborators.md b/translations/ja-JP/data/reusables/gated-features/user-repo-collaborators.md index 55f63f10ca..c3a3ee608a 100644 --- a/translations/ja-JP/data/reusables/gated-features/user-repo-collaborators.md +++ b/translations/ja-JP/data/reusables/gated-features/user-repo-collaborators.md @@ -1,4 +1,4 @@ {% ifversion fpt %} -If you're using -{% data variables.product.prodname_free_user %}, you can add unlimited collaborators on public and private repositories. +パブリック及びプライベートリポジトリには、 +{% data variables.product.prodname_free_user %}を使っているなら無制限にコラボレータを追加できます。 {% endif %} diff --git a/translations/ja-JP/data/reusables/gated-features/verify-and-approve-domain.md b/translations/ja-JP/data/reusables/gated-features/verify-and-approve-domain.md index 940912326c..d250041766 100644 --- a/translations/ja-JP/data/reusables/gated-features/verify-and-approve-domain.md +++ b/translations/ja-JP/data/reusables/gated-features/verify-and-approve-domain.md @@ -1 +1 @@ -Verification and approval of domains is available with {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %}. 詳しい情報については「[GitHubの製品](/articles/githubs-products)」を参照してください。 +ドメインの検証と承認は、{% data variables.product.prodname_ghe_cloud %}及び{% data variables.product.prodname_ghe_server %}で利用できます。 詳しい情報については「[GitHubの製品](/articles/githubs-products)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/gcm-core/next-time-you-clone.md b/translations/ja-JP/data/reusables/gcm-core/next-time-you-clone.md index 06e9d9479b..ea3feed886 100644 --- a/translations/ja-JP/data/reusables/gcm-core/next-time-you-clone.md +++ b/translations/ja-JP/data/reusables/gcm-core/next-time-you-clone.md @@ -1 +1 @@ -The next time you clone an HTTPS URL that requires authentication, Git will prompt you to log in using a browser window. You may first be asked to authorize an OAuth app.{% ifversion not ghae %} If your account or organization requires [two-factor auth](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa), you'll also need to complete the 2FA challenge.{% endif %} +認証が必要なHTTPS URLを次にクローンするときに、Gitはブラウザのウィンドウを使ってログインするよう求めます。 最初にOAuthアプリケーションを承認するよう求められることがあります。{% ifversion not ghae %}アカウントもしくはOrganizationが[2要素認証](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa)を要求するなら、2要素認証のチャレンジを完了させなければなりません。{% endif %} diff --git a/translations/ja-JP/data/reusables/getting-started/about-and-creating-teams.md b/translations/ja-JP/data/reusables/getting-started/about-and-creating-teams.md index 092db5a2a0..a2d54f631b 100644 --- a/translations/ja-JP/data/reusables/getting-started/about-and-creating-teams.md +++ b/translations/ja-JP/data/reusables/getting-started/about-and-creating-teams.md @@ -1,3 +1,3 @@ -Teams are groups of organization members that you can create to reflect your company or group's structure with cascading access permissions and mentions. Organization members can send notifications to a team or request reviews, and teams can be visible or secret. 詳細は「[Team について](/organizations/organizing-members-into-teams/about-teams)」を参照してください。 +TeamはOrganizationメンバーのグループで、カスケードしたアクセス権限やメンションを持たせて会社やグループの構造を反映させて作成できます。 Organizationのメンバーは、Teamに通知を送ったりレビューをリクエストしたりでき、Teamは見えるようにもシークレットにもできます。 詳細は「[Team について](/organizations/organizing-members-into-teams/about-teams)」を参照してください。 -You can create independent teams or have multiple levels of nested teams to reflect your group or company's hierarchy. For more information, see "[Creating a team](/organizations/organizing-members-into-teams/creating-a-team)." +独立したチームを作ることも、グループや会社の階層を反映した複数レベルの入れ子チームを持つこともできます。 詳しい情報については「[Teamの作成](/organizations/organizing-members-into-teams/creating-a-team)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/actions.md b/translations/ja-JP/data/reusables/getting-started/actions.md index 18f2611eb0..6fe3b20843 100644 --- a/translations/ja-JP/data/reusables/getting-started/actions.md +++ b/translations/ja-JP/data/reusables/getting-started/actions.md @@ -1 +1 @@ -With {% data variables.product.prodname_actions %}, you can automate and customize {% data variables.product.product_location %}'s development workflow on {% data variables.product.product_name %}. 独自のアクションを作成したり、{% data variables.product.prodname_dotcom %}コミュニティで共有されたアクションを利用したりカスタマイズしたりできます。 詳しい情報については、「[{% data variables.product.prodname_actions %} を学ぶ](/actions/learn-github-actions)」を参照してください。 +With {% data variables.product.prodname_actions %}, you can automate and customize {% data variables.product.product_location %}'s development workflow on {% data variables.product.product_name %}. You can create your own actions, and use and customize actions shared by the {% data variables.product.prodname_dotcom %} community. For more information, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." diff --git a/translations/ja-JP/data/reusables/getting-started/adding-members-to-organizations.md b/translations/ja-JP/data/reusables/getting-started/adding-members-to-organizations.md index 7b4b952a80..03b26b9767 100644 --- a/translations/ja-JP/data/reusables/getting-started/adding-members-to-organizations.md +++ b/translations/ja-JP/data/reusables/getting-started/adding-members-to-organizations.md @@ -1 +1 @@ -You can add members to organizations in {% data variables.product.product_location %} as long as you are an organization owner in the organizations you want to manage. You can also configure visibility of organization membership. For more information, see "[Adding people to your organization](/organizations/managing-membership-in-your-organization/adding-people-to-your-organization)" and "[Configuring visibility for organization membership](/admin/user-management/managing-organizations-in-your-enterprise/configuring-visibility-for-organization-membership)." +管理したいOrganizationのオーナーであれば、{% data variables.product.product_location %}のOrganizationにメンバーを追加できます。 Organizationのメンバーシップの可視性を設定することもできます。 詳しい情報については「[Organizationへの人の追加](/organizations/managing-membership-in-your-organization/adding-people-to-your-organization)」及び「[Organizationのメンバーシップの可視性の設定](/admin/user-management/managing-organizations-in-your-enterprise/configuring-visibility-for-organization-membership)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/being-social.md b/translations/ja-JP/data/reusables/getting-started/being-social.md index 8b4ec363f8..547256324a 100644 --- a/translations/ja-JP/data/reusables/getting-started/being-social.md +++ b/translations/ja-JP/data/reusables/getting-started/being-social.md @@ -1 +1 @@ -Each repository on {% data variables.product.prodname_dotcom %} is owned by a person or an organization. You can interact with the people, repositories, and organizations by connecting and following them on {% data variables.product.product_name %}. For more information, see "[Be social](/articles/be-social)." +{% data variables.product.prodname_dotcom %}の各リポジトリは、個人もしくはOrganizationが所有しています。 人、リポジトリ、Organizationとは、{% data variables.product.product_name %}上で接続してフォローすることによってやりとりできます。 詳しい情報については「[ソーシャル機能](/articles/be-social)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/configuring-security-features.md b/translations/ja-JP/data/reusables/getting-started/configuring-security-features.md index 872e7b4ef6..c1142dd677 100644 --- a/translations/ja-JP/data/reusables/getting-started/configuring-security-features.md +++ b/translations/ja-JP/data/reusables/getting-started/configuring-security-features.md @@ -1 +1 @@ -To keep {% ifversion ghes or ghae %}the organizations in {% data variables.product.product_location %}{% else %}your organization{% endif %} secure, you can use a variety of {% data variables.product.prodname_dotcom %} security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates. For more information, see "[Securing your organization](/code-security/getting-started/securing-your-organization)" and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +{% ifversion ghes or ghae %}{% data variables.product.product_location %}内のOrganization{% else %}Organization{% endif %}を安全に保つには、セキュリティポリシー、依存関係グラフ、Secret scanning、Dependabotセキュリティ及びバージョンアップデートを含む、{% data variables.product.prodname_dotcom %}の様々なセキュリティ機能を利用できます。 詳しい情報については「[Organizationの保護](/code-security/getting-started/securing-your-organization)」及び「[Organizationのセキュリティ及び分析設定の管理](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/contact-support-enterprise.md b/translations/ja-JP/data/reusables/getting-started/contact-support-enterprise.md index ee9871562d..7f4a694d78 100644 --- a/translations/ja-JP/data/reusables/getting-started/contact-support-enterprise.md +++ b/translations/ja-JP/data/reusables/getting-started/contact-support-enterprise.md @@ -1 +1 @@ -{% data variables.product.product_name %} includes access to {% data variables.contact.enterprise_support %}. {% data variables.contact.enterprise_support %} can help you troubleshoot issues that come up on {% data variables.product.product_name %}. {% ifversion ghes %}You can also choose to sign up for {% data variables.product.prodname_dotcom %} Premium Support for additional features. {% endif %}For more information, see "[About {% data variables.contact.enterprise_support %}](/admin/enterprise-support/overview/about-github-enterprise-support)." +{% data variables.product.product_name %}には{% data variables.contact.enterprise_support %}へのアクセスが含まれています。 {% data variables.contact.enterprise_support %}は、{% data variables.product.product_name %}で発生した問題のトラブルシューティングを支援できます。 {% ifversion ghes %}追加の機能について{% data variables.product.prodname_dotcom %} Premium Supportにサインアップすることもできます。 {% endif %}詳しい情報については「[{% data variables.contact.enterprise_support %}について](/admin/enterprise-support/overview/about-github-enterprise-support)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/contributing-to-projects.md b/translations/ja-JP/data/reusables/getting-started/contributing-to-projects.md index 1e8c2006fa..318204b6e8 100644 --- a/translations/ja-JP/data/reusables/getting-started/contributing-to-projects.md +++ b/translations/ja-JP/data/reusables/getting-started/contributing-to-projects.md @@ -1 +1 @@ -{% data variables.product.prodname_dotcom %} connects users and allows you to interact with other projects. To learn more about contributing to someone else's project, see "[Contributing to projects](/get-started/quickstart/contributing-to-projects)." +{% data variables.product.prodname_dotcom %}はユーザ同士をつなぎ、他のプロジェクトとやりとりできるようにしてくれます。 他のユーザのプロジェクトに貢献することについてさらに学ぶには、「[プロジェクトへの貢献](/get-started/quickstart/contributing-to-projects)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/create-a-repository.md b/translations/ja-JP/data/reusables/getting-started/create-a-repository.md index 83343b0b29..70b973fa39 100644 --- a/translations/ja-JP/data/reusables/getting-started/create-a-repository.md +++ b/translations/ja-JP/data/reusables/getting-started/create-a-repository.md @@ -1 +1 @@ -Creating a repository for your project allows you to store code in {% data variables.product.prodname_dotcom %}. This provides a backup of your work that you can choose to share with other developers. For more information, see “[Create a repository](/get-started/quickstart/create-a-repo)." +プロジェクトにリポジトリを作成すると、{% data variables.product.prodname_dotcom %}にコードを保存できるようになります。 これは、他の開発者と共有できる作業のバックアップを提供します。 詳しい情報については「[リポジトリの作成](/get-started/quickstart/create-a-repo)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/creating-organizations.md b/translations/ja-JP/data/reusables/getting-started/creating-organizations.md index 501935125d..4ed5a26f99 100644 --- a/translations/ja-JP/data/reusables/getting-started/creating-organizations.md +++ b/translations/ja-JP/data/reusables/getting-started/creating-organizations.md @@ -1 +1 @@ -You can create new organizations in {% data variables.product.product_location %} to reflect your company or group's structure. 詳しい情報については、「[新しい Organization をゼロから作成する](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)」を参照してください。 +{% data variables.product.product_location %}に新しいOrganizationを作成し、会社もしくはグループの構造を反映させることができます。 詳しい情報については、「[新しい Organization をゼロから作成する](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/creating-teams.md b/translations/ja-JP/data/reusables/getting-started/creating-teams.md index a86eba853a..877177fc77 100644 --- a/translations/ja-JP/data/reusables/getting-started/creating-teams.md +++ b/translations/ja-JP/data/reusables/getting-started/creating-teams.md @@ -1 +1 @@ -Teams are groups of organization members that can be granted permissions to specific repositories as a group. You can create individual teams or multiple levels of nested teams in each of your organizations. For more information, see "[Creating teams](/organizations/organizing-members-into-teams/creating-a-team)" and "[Adding people to teams](/organizations/organizing-members-into-teams/adding-organization-members-to-a-team)." +TeamはOrganizationメンバーのグループで、グループとして特定のリポジトリへの権限を付与できます。 個別のTeam、もしくはそれぞれのOrganizationに複数レベルの入れ子チームを作成できます。 詳しい情報については「[Teamの作成](/organizations/organizing-members-into-teams/creating-a-team)」及び「[Teamへの人の追加](/organizations/organizing-members-into-teams/adding-organization-members-to-a-team)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/customizing-and-automating.md b/translations/ja-JP/data/reusables/getting-started/customizing-and-automating.md index 7d36893262..1411da6d7a 100644 --- a/translations/ja-JP/data/reusables/getting-started/customizing-and-automating.md +++ b/translations/ja-JP/data/reusables/getting-started/customizing-and-automating.md @@ -1 +1 @@ -You can use tools from the {% data variables.product.prodname_marketplace %}, the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, and existing {% data variables.product.product_name %} features to customize and automate your work. +{% data variables.product.prodname_marketplace %}からのツール、{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API、既存の{% data variables.product.product_name %}機能を使って作業をカスタマイズし、自動化できます。 diff --git a/translations/ja-JP/data/reusables/getting-started/enforcing-repo-management-policies.md b/translations/ja-JP/data/reusables/getting-started/enforcing-repo-management-policies.md index bdea95883e..c64a217c6e 100644 --- a/translations/ja-JP/data/reusables/getting-started/enforcing-repo-management-policies.md +++ b/translations/ja-JP/data/reusables/getting-started/enforcing-repo-management-policies.md @@ -1 +1 @@ -As an enterprise owner, you can set repository management policies for all organizations in {% data variables.product.product_location %}, or allow policies to be set separately in each organization. 詳しい情報については、「[Enterprise でのリポジトリ管理ポリシーを適用する](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)」を参照してください。 +Enterpriseのオーナーは、{% data variables.product.product_location %}内のすべてのOrganizationにリポジトリ管理ポリシーを設定するか、各Organizationに個別のポリシーの設定を許可できます。 詳しい情報については、「[Enterprise でのリポジトリ管理ポリシーを適用する](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/enterprise-advanced-security.md b/translations/ja-JP/data/reusables/getting-started/enterprise-advanced-security.md index 12878bfda7..0629865d83 100644 --- a/translations/ja-JP/data/reusables/getting-started/enterprise-advanced-security.md +++ b/translations/ja-JP/data/reusables/getting-started/enterprise-advanced-security.md @@ -1 +1 @@ -If you have a GitHub Advanced Security license for your enterprise account, you can enforce policies to manage {% data variables.product.prodname_dotcom %} Advanced Security features for organizations owned by an enterprise account. For more information, see "[Enforcing policies for Advanced Security in your enterprise account](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-advanced-security-in-your-enterprise)." +EnterpriseアカウントでGitHub Advanced Securityライセンスを持っているなら、{% data variables.product.prodname_dotcom %}のAdvanced Securityの機能を管理するポリシーをEnterpriseが所有するOrganizationに適用できます。 詳しい情報については「[EnetrpriseアカウントでのAdvanced Securityのポリシーの適用](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-advanced-security-in-your-enterprise)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/fork-a-repository.md b/translations/ja-JP/data/reusables/getting-started/fork-a-repository.md index c1881fbe31..d793b5bf9b 100644 --- a/translations/ja-JP/data/reusables/getting-started/fork-a-repository.md +++ b/translations/ja-JP/data/reusables/getting-started/fork-a-repository.md @@ -1 +1 @@ -Forking a repository will allow you to make changes to another repository without affecting the original. For more information, see "[Fork a repository](/get-started/quickstart/fork-a-repo)." +リポジトリをフォークすると、他のリポジトリへの変更をオリジナルに影響を与えずに行えます。 詳しい情報については「[リポジトリのフォーク](/get-started/quickstart/fork-a-repo)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/github-pages-enterprise.md b/translations/ja-JP/data/reusables/getting-started/github-pages-enterprise.md index eb381f7aaf..4d8176d090 100644 --- a/translations/ja-JP/data/reusables/getting-started/github-pages-enterprise.md +++ b/translations/ja-JP/data/reusables/getting-started/github-pages-enterprise.md @@ -1 +1 @@ -{% data variables.product.prodname_pages %} is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository and publishes a website. You can enable or disable {% data variables.product.prodname_pages %} for your enterprise members at the organization level. For more information, see "[Configuring {% data variables.product.prodname_pages %} for your enterprise](/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise)" and "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." +{% data variables.product.prodname_pages %}は、HTML、CSS、JavaScriptファイルをリポジトリから直接取得してWebサイトを公開する、静的サイトホスティングサービスです。 Enterpriseメンバーに対してOrganizationのレベルで{% data variables.product.prodname_pages %}を有効化あるいは無効化できます。 詳しい情報については「[Enterpriseでの{% data variables.product.prodname_pages %}の設定](/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise)」及び「[{% data variables.product.prodname_pages %}について](/pages/getting-started-with-github-pages/about-github-pages)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/giving-access-to-repositories-projects-apps.md b/translations/ja-JP/data/reusables/getting-started/giving-access-to-repositories-projects-apps.md index a497eb258a..92dcc05324 100644 --- a/translations/ja-JP/data/reusables/getting-started/giving-access-to-repositories-projects-apps.md +++ b/translations/ja-JP/data/reusables/getting-started/giving-access-to-repositories-projects-apps.md @@ -1,3 +1,3 @@ -You can give organization members, teams, and outside collaborators different levels of access to repositories owned by your organization with repository roles. 詳しい情報については「[Organizationのリポジトリロール](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)」を参照してください。 +リポジトリロールを使い、Organizationのメンバー、Team、外部のコラボレータに対して、Organizationが所有するリポジトリへの様々なレベルのアクセスを付与できます。 詳しい情報については「[Organizationのリポジトリロール](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)」を参照してください。 -You can also customize access to your organization's project boards and allow individual organization members to manage your organization's {% data variables.product.prodname_github_apps %}. For more information, see "[Managing access to your organization's project boards](/organizations/managing-access-to-your-organizations-project-boards)" and "[Managing access to your organization's apps](/organizations/managing-access-to-your-organizations-apps)." +また、Orgtanizationのプロジェクトボードに対するアクセスをカスタマイズしたり、個々のOrganizationのメンバーにOrganizationの{% data variables.product.prodname_github_apps %}の管理を許可したりできます。 詳しい情報については「[Organizationのプロジェクトボードへのアクセスの管理](/organizations/managing-access-to-your-organizations-project-boards)」及び「[Organizationのアプリケーションへのアクセスの管理](/organizations/managing-access-to-your-organizations-apps)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/learning-enterprise.md b/translations/ja-JP/data/reusables/getting-started/learning-enterprise.md index dde4115e6e..97622036c9 100644 --- a/translations/ja-JP/data/reusables/getting-started/learning-enterprise.md +++ b/translations/ja-JP/data/reusables/getting-started/learning-enterprise.md @@ -1,3 +1,3 @@ -Your enterprise members can learn new skills by completing fun, realistic projects in their very own GitHub repository with [{% data variables.product.prodname_learning %}](https://skills.github.com/). Each course is a hands-on lesson created by the GitHub community and taught by a friendly bot. +Enterpriseのメンバーは、[{% data variables.product.prodname_learning %}](https://skills.github.com/)で自分自身のGitHubリポジトリで楽しくリアルなプロジェクトを完了することで、新しいスキルを学べます。 各コースは、GitHubのコミュニティが作成したハンズオンのレッスンで、親切なbotによって教えてもらえます。 -For more information, see "[Git and {% data variables.product.prodname_dotcom %} learning resources](/github/getting-started-with-github/quickstart/git-and-github-learning-resources)." +詳しい情報については「[Gitと{% data variables.product.prodname_dotcom %}の学習リソース](/github/getting-started-with-github/quickstart/git-and-github-learning-resources)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/learning.md b/translations/ja-JP/data/reusables/getting-started/learning.md index ac8bd20546..a8995d4f07 100644 --- a/translations/ja-JP/data/reusables/getting-started/learning.md +++ b/translations/ja-JP/data/reusables/getting-started/learning.md @@ -1,3 +1,3 @@ -You can learn new skills by completing fun, realistic projects in your very own GitHub repository with [{% data variables.product.prodname_learning %}](https://skills.github.com/). Each course is a hands-on lesson created by the GitHub community and taught by a friendly bot. +[{% data variables.product.prodname_learning %}](https://skills.github.com/)で自分自身のGitHubリポジトリで楽しくリアルなプロジェクトを完了することで、新しいスキルを学べます。 各コースは、GitHubのコミュニティが作成したハンズオンのレッスンで、親切なbotによって教えてもらえます。 -For more information, see "[Git and {% data variables.product.prodname_dotcom %} learning resources](/github/getting-started-with-github/quickstart/git-and-github-learning-resources)." +詳しい情報については「[Gitと{% data variables.product.prodname_dotcom %}の学習リソース](/github/getting-started-with-github/quickstart/git-and-github-learning-resources)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/managing-enterprise-members.md b/translations/ja-JP/data/reusables/getting-started/managing-enterprise-members.md index e178feaeb3..58f148ee00 100644 --- a/translations/ja-JP/data/reusables/getting-started/managing-enterprise-members.md +++ b/translations/ja-JP/data/reusables/getting-started/managing-enterprise-members.md @@ -1 +1 @@ -You can manage settings and audit activity for the members of {% data variables.product.product_location %}. You can {% ifversion ghes %}promote an enterprise member to be a site administrator, {% endif %}manage dormant users, view the audit log for user activity, and customize messages that enterprise members will see. For more information, see "[Managing users in your enterprise](/admin/user-management/managing-users-in-your-enterprise)." +{% data variables.product.product_location %}のメンバーの設定を管理し、アクティビティを監査できます。 {% ifversion ghes %}Enterpriseのメンバーをサイト管理者に昇格させ、{% endif %}休眠ユーザを管理し、ユーザのアクティビティのAudit logを表示させ、Enteprriseのメンバーに表示されるメッセージをカスタマイズできます。 詳しい情報については「[Enterpriseのユーザの管理](/admin/user-management/managing-users-in-your-enterprise)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/managing-org-members.md b/translations/ja-JP/data/reusables/getting-started/managing-org-members.md index e57ffb217b..c02f3c9142 100644 --- a/translations/ja-JP/data/reusables/getting-started/managing-org-members.md +++ b/translations/ja-JP/data/reusables/getting-started/managing-org-members.md @@ -1 +1 @@ -You can invite anyone to be a member of your organization, as long as they have a personal account on {% data variables.product.prodname_dotcom %}. You can also remove members and reinstate former members. For more information, see "[Managing membership in your organization](/organizations/managing-membership-in-your-organization)." +{% data variables.product.prodname_dotcom %}に個人アカウントを持っている人なら、誰でもOrganizationのメンバーになってもらうよう招待できます。 メンバーを削除したり、以前のメンバーの復帰もできます。 詳しい情報については「[Organizationのメンバーシップの管理](/organizations/managing-membership-in-your-organization)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/managing-org-policies.md b/translations/ja-JP/data/reusables/getting-started/managing-org-policies.md index 9951b2f572..1335712b3d 100644 --- a/translations/ja-JP/data/reusables/getting-started/managing-org-policies.md +++ b/translations/ja-JP/data/reusables/getting-started/managing-org-policies.md @@ -1,5 +1,5 @@ -You can manage permissions and policies for a number of different actions and features in your organization. +Organizationの様々なアクションや機能について、権限とポリシーを管理できます。 -For example, to protect your organization's data, you can restrict repository creation in your organization. You can also choose to allow or prevent the forking of private repositories owned by your organization. For more information, see "[Restricting repository creation in your organization](/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization)" and "[Managing the forking policy for your organization](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)." +たとえば、Organizationのデータを保護するために、Organizationでのリポジトリの作成を制限できます。 また、Organizationが所有するプライベートリポジトリのフォークを許可したり禁止したりすることもできます。 詳しい情報については「[Organizationでのリポジトリ作成の制限](/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization)」及び「[Organizationのフォークのポリシーの管理](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)」を参照してください。 -For the full list of settings you can configure for your organization, see "[Managing organization settings](/organizations/managing-organization-settings)." +Organizationで可能な設定の完全なリストについては「[Organizationの設定の管理](/organizations/managing-organization-settings)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/managing-repo-changes.md b/translations/ja-JP/data/reusables/getting-started/managing-repo-changes.md index a87f372c50..d0d583e676 100644 --- a/translations/ja-JP/data/reusables/getting-started/managing-repo-changes.md +++ b/translations/ja-JP/data/reusables/getting-started/managing-repo-changes.md @@ -1,3 +1,3 @@ -You can configure permissions for creating, transferring and deleting repositories in your organization, including which types members can create. For more information, see "[Restricting repository creation in your organization](/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization)" and "[Setting permissions for deleting or transferring repositories](/organizations/managing-organization-settings/setting-permissions-for-deleting-or-transferring-repositories)." +Organizationにおけるリポジトリの作成、移譲、削除の権限を、メンバーが作成できる種類も含めて設定できます。 詳しい情報については「[Organizationでのリポジトリ作成の制限](/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization)」及び「[リポジトリの削除あるいは移譲の権限の設定](/organizations/managing-organization-settings/setting-permissions-for-deleting-or-transferring-repositories)」を参照してください。 -You can also restrict or grant the ability to change repository visibility. 詳しい情報については「[Organization 内でリポジトリの可視性の変更を制限する](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)」を参照してください。 +リポジトリの可視性の変更する機能の制限もしくは許可もできます。 詳しい情報については「[Organization 内でリポジトリの可視性の変更を制限する](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/managing-team-settings.md b/translations/ja-JP/data/reusables/getting-started/managing-team-settings.md index 27a943fa4f..afd56e552e 100644 --- a/translations/ja-JP/data/reusables/getting-started/managing-team-settings.md +++ b/translations/ja-JP/data/reusables/getting-started/managing-team-settings.md @@ -1,3 +1,3 @@ -You can designate a "team maintainer" to manage team settings and discussions, among other privileges. 詳しい情報については「[Teamメンバーへのチームメンテナロールの割り当て](/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member)」を参照してください。 +Teamの設定、中でもディスカッションの権限管理を行う「チームメンテナ」を指定できます。 詳しい情報については「[Teamメンバーへのチームメンテナロールの割り当て](/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member)」を参照してください。 -You can manage code review assignments for your team, change team visibility, manage scheduled reminders for your team, and more in your team's settings. For more information, see "[Organizing members into teams](/organizations/organizing-members-into-teams)." +Teamに対するコードレビューの割り当て、Teamの可視性の変更、Teamのスケジュールされたリマインダーの管理、その他のTeamの設定も管理できます。 詳しい情報については「[Teamへのメンバーの編成](/organizations/organizing-members-into-teams)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/math-and-diagrams.md b/translations/ja-JP/data/reusables/getting-started/math-and-diagrams.md index 0b8fd102b4..3de15f75dd 100644 --- a/translations/ja-JP/data/reusables/getting-started/math-and-diagrams.md +++ b/translations/ja-JP/data/reusables/getting-started/math-and-diagrams.md @@ -1 +1 @@ -{% ifversion mermaid %}You can use Markdown to add rendered math expressions, diagrams, maps, and 3D models to your wiki. For more information on creating rendered math expressions, see "[Writing mathematical expressions](/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions)." For more information on creating diagrams, maps and 3D models, see "[Creating diagrams](/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams)."{% endif %} \ No newline at end of file +{% ifversion mermaid %}Markdownを使って描画された数式、図、マップ、3Dモデルをwikiに追加できます。 描画された数式の作成に関する詳しい情報については「[数式の作成](/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions)」を参照してください。 図、マップ、3Dモデルの作成に関する詳しい情報については「[図の作成](/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams)」を参照してください。{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/getting-started/open-source-projects.md b/translations/ja-JP/data/reusables/getting-started/open-source-projects.md index ff2bb76ec2..1276eb7b8d 100644 --- a/translations/ja-JP/data/reusables/getting-started/open-source-projects.md +++ b/translations/ja-JP/data/reusables/getting-started/open-source-projects.md @@ -1,4 +1,4 @@ -Contributing to open source projects on {% data variables.product.prodname_dotcom %} can be a rewarding way to learn, teach, and build experience in just about any skill you can imagine. For more information, see "[How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)" in the Open Source Guides. +{% data variables.product.prodname_dotcom %}上のオープンソースプロジェクトへの貢献は、想像できるいかなるスキルについても学び、教え、経験を積むことができる、やりがいのある方法です。 詳しい情報についてはオープンソースガイドの「[オープンソースに貢献する方法](https://opensource.guide/how-to-contribute/)」を参照してください。 -You can find personalized recommendations for projects and good first issues based on your past contributions, stars, and other activities in [Explore](https://github.com/explore).{% ifversion fpt or ghec %} For more information, see "[Finding ways to contribute to open source on GitHub](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)." +過去のコントリビューション、Star、その他のアクティビティに基づく、プロジェクトと優れた最初の課題についてのパーソナライズされた推奨事項を、[Explore](https://github.com/explore)で見つけることができます。{% ifversion fpt or ghec %}詳しい情報については「[GitHubでオープンソースに貢献する方法を見つける](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)」を参照してください。 {% endif %} diff --git a/translations/ja-JP/data/reusables/getting-started/org-permissions-and-roles.md b/translations/ja-JP/data/reusables/getting-started/org-permissions-and-roles.md index 95ca198f8c..fd3ff498ef 100644 --- a/translations/ja-JP/data/reusables/getting-started/org-permissions-and-roles.md +++ b/translations/ja-JP/data/reusables/getting-started/org-permissions-and-roles.md @@ -1 +1 @@ -Each person in your organization has a role that defines their level of access to the organization. The member role is the default, and you can assign owner and billing manager roles as well as "team maintainer" permissions. 詳しい情報については「[Organization内のロール](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)」を参照してください。 +Organizationの各ユーザは、Organizationへのアクセスレベルを定義するロールを持ちます。 メンバーロールがデフォルトで、「チームメンテナ」権限とともにオーナー及び支払いマネージャーのロールを割り当てることができます。 詳しい情報については「[Organization内のロール](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/participating-in-community.md b/translations/ja-JP/data/reusables/getting-started/participating-in-community.md index d5575e40e6..c0851b7a67 100644 --- a/translations/ja-JP/data/reusables/getting-started/participating-in-community.md +++ b/translations/ja-JP/data/reusables/getting-started/participating-in-community.md @@ -1 +1 @@ -There are many ways to participate in the {% data variables.product.prodname_dotcom %} community. You can contribute to open source projects, interact with people in the {% data variables.product.prodname_gcf %}, or learn with {% data variables.product.prodname_learning %}. +{% data variables.product.prodname_dotcom %}コミュニティには、多くの参加方法があります。 オープンソースのプロジェクトに貢献したり、{% data variables.product.prodname_gcf %}で人々とやりとりしたり、{% data variables.product.prodname_learning %}で学ぶことができます。 diff --git a/translations/ja-JP/data/reusables/getting-started/requiring-2fa.md b/translations/ja-JP/data/reusables/getting-started/requiring-2fa.md index 5e966e6049..c33634256b 100644 --- a/translations/ja-JP/data/reusables/getting-started/requiring-2fa.md +++ b/translations/ja-JP/data/reusables/getting-started/requiring-2fa.md @@ -1 +1 @@ -You can view whether your organization members have two-factor authentication enabled and choose to require two-factor authentication in your organization. 詳しい情報については [Organization で 2 要素認証を要求する](/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization)を参照してください。 +Organizationのメンバーが2要素認証を有効化しているかを表示させ、Organizationで2要素認証を必須にすることができます。 詳しい情報については [Organization で 2 要素認証を要求する](/organizations/keeping-your-organization-secure/requiring-two-factor-authentication-in-your-organization)を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/reviewing-org-audit-log-and-integrations.md b/translations/ja-JP/data/reusables/getting-started/reviewing-org-audit-log-and-integrations.md index 3b5757f3d1..ba391864e1 100644 --- a/translations/ja-JP/data/reusables/getting-started/reviewing-org-audit-log-and-integrations.md +++ b/translations/ja-JP/data/reusables/getting-started/reviewing-org-audit-log-and-integrations.md @@ -1,3 +1,3 @@ -The audit log for your organization allows you, as an organization owner, to review the actions performed by members of the organization within the current month and previous six months. For more information, see "[Reviewing the audit log for your organization](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization)." +OrganizationのAudit logを使うと、OrganizationのオーナーはOrganizationのメンバーが当月及び過去6ヶ月に行ったアクションをレビューできます。 詳しい情報については「[OrganizationのAudit logのレビュー](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization)」を参照してください。 -You can also review and configure the permission levels for your organization's installed integrations. For more information, see "[Reviewing your organization's installed integrations](/organizations/keeping-your-organization-secure/reviewing-your-organizations-installed-integrations)." +Organizationにインストールされたインテグレーションの権限レベルをレビューして設定することもできます。 詳しい情報については「[Organizationにインストールされたインテグレーションのレビュー](/organizations/keeping-your-organization-secure/reviewing-your-organizations-installed-integrations)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/set-up-git.md b/translations/ja-JP/data/reusables/getting-started/set-up-git.md index 4900b28f29..128c9a8558 100644 --- a/translations/ja-JP/data/reusables/getting-started/set-up-git.md +++ b/translations/ja-JP/data/reusables/getting-started/set-up-git.md @@ -1 +1 @@ -Synchronizing {% data variables.product.prodname_dotcom %} repositories with your computer allows you to work locally and push your changes to {% data variables.product.prodname_dotcom %}. For more information, see “[Set up Git](/get-started/quickstart/set-up-git).” +{% data variables.product.prodname_dotcom %}リポジトリを手元のコンピュータと同期すれば、ローカルで作業を行い変更を{% data variables.product.prodname_dotcom %}にプッシュできるようになります。 詳しい情報については「[Gitのセットアップ](/get-started/quickstart/set-up-git)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/setting-org-and-repo-permissions.md b/translations/ja-JP/data/reusables/getting-started/setting-org-and-repo-permissions.md index 7974f0a1c5..6dd581f67d 100644 --- a/translations/ja-JP/data/reusables/getting-started/setting-org-and-repo-permissions.md +++ b/translations/ja-JP/data/reusables/getting-started/setting-org-and-repo-permissions.md @@ -1,3 +1,3 @@ -We recommend giving a limited number of members in each organization an organization owner role, which provides complete administrative access for that organization. 詳しい情報については「[Organization内のロール](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)」を参照してください。 +Organizationへの完全な管理アクセスを提供するOrganizationオーナーのロールは、各Organizationの限られた数のメンバーに付与することをおすすめします。 詳しい情報については「[Organization内のロール](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)」を参照してください。 -For organizations where you have admin permissions, you can also customize access to each repository with granular permission levels. For more information, see "[Repository permissions levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)." +管理権限を持っているOrganizationでは、詳細な権限レベルで各リポジトリへのアクセスをカスタマイズできます。 詳しい情報については「[Organizationのリポジトリ権限レベル](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/sponsors.md b/translations/ja-JP/data/reusables/getting-started/sponsors.md index 387a34c73a..49a21f5035 100644 --- a/translations/ja-JP/data/reusables/getting-started/sponsors.md +++ b/translations/ja-JP/data/reusables/getting-started/sponsors.md @@ -1 +1 @@ -{% data variables.product.prodname_sponsors %} allows you to make a monthly recurring payment to a developer or organization who designs, creates, or maintains open source projects you depend on. 詳しい情報については「[{% data variables.product.prodname_sponsors %}について](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)」を参照してください。 +{% data variables.product.prodname_sponsors %}を使うと、頼りにしているオープンソースのプロジェクトを設計、作成、メンテナンスしている開発者やOrganizationに、月次の定期的な支払いを行えます。 詳しい情報については「[{% data variables.product.prodname_sponsors %}について](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/getting-started/using-org-community-files-and-moderation-tools.md b/translations/ja-JP/data/reusables/getting-started/using-org-community-files-and-moderation-tools.md index d12dc4866c..11bc6f1601 100644 --- a/translations/ja-JP/data/reusables/getting-started/using-org-community-files-and-moderation-tools.md +++ b/translations/ja-JP/data/reusables/getting-started/using-org-community-files-and-moderation-tools.md @@ -1,3 +1,3 @@ -You can create default community health files, such as a CONTRIBUTING.md file, a CODE_OF_CONDUCT.md file, or even issue and pull request templates, for your organization. These default files will be used for any repository owned by your organization that does not contain its own file of that type. 詳しい情報については「[デフォルトのコミュニティ健全性ファイルを作成する](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)」を参照してください。 +CONTRIBUTING.mdファイル、CODE_OF_CONDUCT.mdファイル、さらにはIssueやPull Requestのテンプレートファイルといったデフォルトのコミュニティ健全性ファイルを、Organizationに作成できます。 これらのデフォルトファイルは、それらのタイプの独自ファイルを含まないOrganizationが所有するリポジトリで使われます。 詳しい情報については「[デフォルトのコミュニティ健全性ファイルを作成する](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)」を参照してください。 -{% data variables.product.prodname_dotcom %} offers multiple tools for moderating and managing your community. For more information, see "[Tools for moderating your community](/communities/setting-up-your-project-for-healthy-contributions/about-community-management-and-moderation#tools-for-moderating-your-community)." +{% data variables.product.prodname_dotcom %}は、コミュニティのモデレートと管理のための複数のツールを提供します。 詳しい情報については「[コミュニティのモデレートのためのツール](/communities/setting-up-your-project-for-healthy-contributions/about-community-management-and-moderation#tools-for-moderating-your-community)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/git/cache-on-repository-path.md b/translations/ja-JP/data/reusables/git/cache-on-repository-path.md new file mode 100644 index 0000000000..cd19dc5b54 --- /dev/null +++ b/translations/ja-JP/data/reusables/git/cache-on-repository-path.md @@ -0,0 +1,5 @@ +1. リポジトリをクローンしたそれぞれのローカルディレクトリに認証情報をキャッシュするようGitを設定するには、以下のコマンドを入力してください。 + + ```shell{:copy} + git config --global credential.useHttpPath true + ``` diff --git a/translations/ja-JP/data/reusables/git/clear-stored-gcm-credentials.md b/translations/ja-JP/data/reusables/git/clear-stored-gcm-credentials.md new file mode 100644 index 0000000000..04e3de748e --- /dev/null +++ b/translations/ja-JP/data/reusables/git/clear-stored-gcm-credentials.md @@ -0,0 +1,5 @@ +- If the output is `manager-core`, you're using Git Credential Manager. To clear the credentials, run the following command. + + ```shell{:copy} + git credential-manager reject https://github.com + ``` diff --git a/translations/ja-JP/data/reusables/git/clear-the-stored-credentials.md b/translations/ja-JP/data/reusables/git/clear-the-stored-credentials.md new file mode 100644 index 0000000000..f723d7ab97 --- /dev/null +++ b/translations/ja-JP/data/reusables/git/clear-the-stored-credentials.md @@ -0,0 +1 @@ +1. If the output confirms that you're using a credential manager, clear the stored credentials for the credential manager. diff --git a/translations/ja-JP/data/reusables/git/confirm-credential-manager.md b/translations/ja-JP/data/reusables/git/confirm-credential-manager.md new file mode 100644 index 0000000000..68c6e99397 --- /dev/null +++ b/translations/ja-JP/data/reusables/git/confirm-credential-manager.md @@ -0,0 +1,5 @@ +1. To confirm your use of a credential manager, enter the following command and note the output. + + ```shell{:copy} + git config --get credential.helper + ``` diff --git a/translations/ja-JP/data/reusables/git/no-credential-manager.md b/translations/ja-JP/data/reusables/git/no-credential-manager.md new file mode 100644 index 0000000000..fe79c2ff04 --- /dev/null +++ b/translations/ja-JP/data/reusables/git/no-credential-manager.md @@ -0,0 +1 @@ +- If the output doesn't include the name of a credential manager, there is no credential manager configured, and you can proceed to the next step. \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/git/open-terminal.md b/translations/ja-JP/data/reusables/git/open-terminal.md new file mode 100644 index 0000000000..7f460ada8e --- /dev/null +++ b/translations/ja-JP/data/reusables/git/open-terminal.md @@ -0,0 +1 @@ +1. ターミナルを開きます。 diff --git a/translations/ja-JP/data/reusables/git/provide-credentials.md b/translations/ja-JP/data/reusables/git/provide-credentials.md new file mode 100644 index 0000000000..351a1e87d1 --- /dev/null +++ b/translations/ja-JP/data/reusables/git/provide-credentials.md @@ -0,0 +1,3 @@ +1. The first time that you use Git to clone a repository or access data in a repository that you've already cloned, Git will request credentials. Provide the PAT for the account with access to the repository. + + Git will cache the PAT for the directory you're in, and you'll be able to access and write repository data on {% data variables.product.product_location %} using the correct account. diff --git a/translations/ja-JP/data/reusables/github-ae/saml-idp-table.md b/translations/ja-JP/data/reusables/github-ae/saml-idp-table.md index a940fba807..baa2eda579 100644 --- a/translations/ja-JP/data/reusables/github-ae/saml-idp-table.md +++ b/translations/ja-JP/data/reusables/github-ae/saml-idp-table.md @@ -1,4 +1,4 @@ -| IdP | SAML | ユーザプロビジョニング | Team mapping | +| IdP | SAML | ユーザプロビジョニング | Teamマッピング | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Azure Active Directory (Azure AD)](/admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad) | {% octicon "check-circle-fill" aria-label="The check icon" %} | {% octicon "check-circle-fill" aria-label="The check icon" %} | {% octicon "check-circle-fill" aria-label="The check icon" %} | [Okta](/admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider/configuring-authentication-and-provisioning-for-your-enterprise-using-okta) | {% octicon "check-circle-fill" aria-label="The check icon" %}[Beta](/admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider/configuring-authentication-and-provisioning-for-your-enterprise-using-okta) | {% octicon "check-circle-fill" aria-label="The check icon" %}[Beta](/admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider/configuring-authentication-and-provisioning-for-your-enterprise-using-okta) | {% octicon "check-circle-fill" aria-label= "The check icon" %}[Beta](/admin/authentication/configuring-authentication-and-provisioning-with-your-identity-provider/mapping-okta-groups-to-teams) | diff --git a/translations/ja-JP/data/reusables/github-connect/access-dotcom-and-enterprise.md b/translations/ja-JP/data/reusables/github-connect/access-dotcom-and-enterprise.md index 2f22dbfd74..1226b5cdb2 100644 --- a/translations/ja-JP/data/reusables/github-connect/access-dotcom-and-enterprise.md +++ b/translations/ja-JP/data/reusables/github-connect/access-dotcom-and-enterprise.md @@ -1 +1 @@ -1. Sign in to {% ifversion ghes %}{% data variables.product.prodname_ghe_server %}{% else %}{% data variables.product.prodname_ghe_managed %}{% endif %} and {% data variables.product.prodname_dotcom_the_website %}. +1. {% ifversion ghes %}{% data variables.product.prodname_ghe_server %}{% else %}{% data variables.product.prodname_ghe_managed %}{% endif %}及び{% data variables.product.prodname_dotcom_the_website %}にサインインしてください。 diff --git a/translations/ja-JP/data/reusables/github-connect/access-profile-settings.md b/translations/ja-JP/data/reusables/github-connect/access-profile-settings.md index 594d515ed4..12520110ca 100644 --- a/translations/ja-JP/data/reusables/github-connect/access-profile-settings.md +++ b/translations/ja-JP/data/reusables/github-connect/access-profile-settings.md @@ -1 +1 @@ -1. On {% ifversion ghes %}{% data variables.product.prodname_ghe_server %}{% else %}{% data variables.product.prodname_ghe_managed %}{% endif %}, in the upper-right corner of any page, click your profile photo, then click **Settings**. ![ユーザバーの [Settings（設定）] アイコン](/assets/images/help/settings/userbar-account-settings.png) +1. {% ifversion ghes %}{% data variables.product.prodname_ghe_server %}{% else %}{% data variables.product.prodname_ghe_managed %}{% endif %}上で、任意のページの右上のプロフィール写真をクリックし、続いて**Settings（設定）**をクリックしてください。 ![ユーザバーの [Settings（設定）] アイコン](/assets/images/help/settings/userbar-account-settings.png) diff --git a/translations/ja-JP/data/reusables/github-connect/authorize-connection.md b/translations/ja-JP/data/reusables/github-connect/authorize-connection.md index 7f60fcb86b..f050e3c69d 100644 --- a/translations/ja-JP/data/reusables/github-connect/authorize-connection.md +++ b/translations/ja-JP/data/reusables/github-connect/authorize-connection.md @@ -1,7 +1,6 @@ -1. Review the resources that -{% data variables.product.product_name %} will access from your {% data variables.product.prodname_dotcom_the_website %} account, then click **Authorize**. +1. Review the resources that {% data variables.product.product_name %} will access from your {% data variables.product.prodname_dotcom_the_website %} account, then click **Authorize**. {% ifversion ghes %} - ![{% data variables.product.prodname_ghe_server %} と {% data variables.product.prodname_dotcom_the_website %} の間の接続を許可します。](/assets/images/help/settings/authorize-ghe-to-connect-to-dotcom.png) + ![Authorize connection between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_dotcom_the_website %}](/assets/images/help/settings/authorize-ghe-to-connect-to-dotcom.png) {% elsif ghae %} - ![{% data variables.product.prodname_ghe_managed %} と {% data variables.product.prodname_dotcom_the_website %} の間の接続を許可します。](/assets/images/enterprise/github-ae/settings/authorize-ghae-to-connect-to-dotcom.png) + ![Authorize connection between {% data variables.product.prodname_ghe_managed %} and {% data variables.product.prodname_dotcom_the_website %}](/assets/images/enterprise/github-ae/settings/authorize-ghae-to-connect-to-dotcom.png) {% endif %} diff --git a/translations/ja-JP/data/reusables/github-connect/beta.md b/translations/ja-JP/data/reusables/github-connect/beta.md index e490e69055..333b47d128 100644 --- a/translations/ja-JP/data/reusables/github-connect/beta.md +++ b/translations/ja-JP/data/reusables/github-connect/beta.md @@ -1,7 +1,7 @@ {% ifversion ghae %} {% note %} -**Note:** {% data variables.product.prodname_github_connect %} for {% data variables.product.product_name %} is currently in beta and subject to change. +**ノート:** {% data variables.product.prodname_github_connect %} for {% data variables.product.product_name %}は現在ベータであり、変更されることがあります。 {% endnote %} {% endif %} diff --git a/translations/ja-JP/data/reusables/github-connect/connect-dotcom-and-enterprise.md b/translations/ja-JP/data/reusables/github-connect/connect-dotcom-and-enterprise.md index 0485841ae1..3ceff83a69 100644 --- a/translations/ja-JP/data/reusables/github-connect/connect-dotcom-and-enterprise.md +++ b/translations/ja-JP/data/reusables/github-connect/connect-dotcom-and-enterprise.md @@ -1,6 +1,6 @@ -1. Click **Connect to {% data variables.product.prodname_dotcom_the_website %}**. +1. **Connect to {% data variables.product.prodname_dotcom_the_website %}**をクリックしてください。 {% ifversion ghes %} ![GitHub Enterprise Server設定からGitHub.comへの接続](/assets/images/help/settings/github.com_end_user_connection.png) {% else %} - ![Connect to GitHub.com from GitHub AE settings](/assets/images/enterprise/github-ae/settings/github.com-end-user-connection.png) + ![GitHub AEの設定からGitHub.comへの接続](/assets/images/enterprise/github-ae/settings/github.com-end-user-connection.png) {% endif %} diff --git a/translations/ja-JP/data/reusables/github-connect/sync-frequency.md b/translations/ja-JP/data/reusables/github-connect/sync-frequency.md index 0905f58853..a4d95bf8d4 100644 --- a/translations/ja-JP/data/reusables/github-connect/sync-frequency.md +++ b/translations/ja-JP/data/reusables/github-connect/sync-frequency.md @@ -1 +1 @@ -{% ifversion fpt or ghec %}{% data variables.product.prodname_enterprise %}{% elsif ghes or ghae %}{% data variables.product.product_name %}{% endif %} sends updates hourly. +{% ifversion fpt or ghec %}{% data variables.product.prodname_enterprise %}{% elsif ghes or ghae %}{% data variables.product.product_name %}{% endif %}は更新を1時間ごとに送信します。 diff --git a/translations/ja-JP/data/reusables/gpg/configure-ssh-signing.md b/translations/ja-JP/data/reusables/gpg/configure-ssh-signing.md new file mode 100644 index 0000000000..f0f489a73a --- /dev/null +++ b/translations/ja-JP/data/reusables/gpg/configure-ssh-signing.md @@ -0,0 +1,4 @@ +1. Configure Git to use SSH to sign commits and tags: + ```bash + $ git config --global gpg.format ssh + ``` \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/gpg/copy-gpg-key-id.md b/translations/ja-JP/data/reusables/gpg/copy-gpg-key-id.md index 34b505fd16..75470758d6 100644 --- a/translations/ja-JP/data/reusables/gpg/copy-gpg-key-id.md +++ b/translations/ja-JP/data/reusables/gpg/copy-gpg-key-id.md @@ -1,9 +1,9 @@ 1. GPGキーのリストから、使いたいGPGキーIDの長い形式をコピーしてください。 この例では、GPG キー ID は `3AA5C34371567BD2` です。 - ```shell + ```shell{:copy} $ gpg --list-secret-keys --keyid-format=long /Users/hubot/.gnupg/secring.gpg ------------------------------------ sec 4096R/3AA5C34371567BD2 2016-03-10 [expires: 2017-03-10] uid Hubot ssb 4096R/42B317FD4BA89E7A 2016-03-10 - ``` + ``` diff --git a/translations/ja-JP/data/reusables/gpg/copy-ssh-public-key.md b/translations/ja-JP/data/reusables/gpg/copy-ssh-public-key.md new file mode 100644 index 0000000000..d2710a9807 --- /dev/null +++ b/translations/ja-JP/data/reusables/gpg/copy-ssh-public-key.md @@ -0,0 +1,43 @@ +1. SSH 公開鍵をクリップボードにコピーします。 + + SSH 公開鍵のファイル名がサンプルコードと異なる場合は、現在の設定に一致するようにファイル名を変更してください。 キーをコピーする際には、改行や空白を追加しないでください。 +{% mac %} + + ```shell + $ pbcopy < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub + # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard + ``` + + {% tip %} + + **ヒント:** `pbcopy` がうまく動作しない場合は、隠れフォルダ `.ssh` にアクセスし、使い慣れたテキストエディタでこのファイルを開き、クリップボードにコピーしてください。 + + {% endtip %} +{% endmac %} +{% windows %} + + ```shell + $ clip < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub + # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard + ``` + + {% tip %} + + **ヒント:** `clip` がうまく動作しない場合は、隠しフォルダ `.ssh` にアクセスし、使い慣れたテキストエディタでこのファイルを開き、クリップボードにコピーしてください。 + + {% endtip %} +{% endwindows %} +{% linux %} + + ```shell + $ cat ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub + # Then select and copy the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file + # displayed in the terminal to your clipboard + ``` + + {% tip %} + + **Tip:** Alternatively, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. + + {% endtip %} +{% endlinux %} diff --git a/translations/ja-JP/data/reusables/gpg/desktop-support-for-commit-signing.md b/translations/ja-JP/data/reusables/gpg/desktop-support-for-commit-signing.md index 5093127a3e..f9d0e67eda 100644 --- a/translations/ja-JP/data/reusables/gpg/desktop-support-for-commit-signing.md +++ b/translations/ja-JP/data/reusables/gpg/desktop-support-for-commit-signing.md @@ -1,5 +1,5 @@ {% note %} -**Note:** [GitHub Desktop](https://desktop.github.com/) only supports commit signing if your Git client is configured to sign commits by default. +**ノート:** [GitHub Desktop](https://desktop.github.com/)はGitクライアントがデフォルトでコミットに署名するように設定されている場合にのみ、コミット署名をサポートしています。 {% endnote %} diff --git a/translations/ja-JP/data/reusables/gpg/list-keys-with-note.md b/translations/ja-JP/data/reusables/gpg/list-keys-with-note.md index 1a5a7f5729..8243508393 100644 --- a/translations/ja-JP/data/reusables/gpg/list-keys-with-note.md +++ b/translations/ja-JP/data/reusables/gpg/list-keys-with-note.md @@ -1,10 +1,11 @@ - 1. 公開鍵と秘密鍵をどちらも持っているGPGキーの長い形式のリストを表示するには、 `gpg --list-secret-keys --keyid-format=long`コマンドを使ってください。 コミットやタグに署名するには秘密鍵が必要です。 - ```shell - $ gpg --list-secret-keys --keyid-format=long -``` - {% note %} - **ノート:**LinuxのGPG環境の中には、既存のキーのリストを表示させるために`gpg2 --list-keys --keyid-format LONG`としなければならないものもあります。 この場合、`git config --global gpg.program gpg2`と実行してGitが`gpg2`を使うように設定する必要もあります。 + ```shell{:copy} + $ gpg --list-secret-keys --keyid-format=long + ``` - {% endnote %} + {% note %} + + **ノート:**LinuxのGPG環境の中には、既存のキーのリストを表示させるために`gpg2 --list-keys --keyid-format LONG`としなければならないものもあります。 この場合、`git config --global gpg.program gpg2`と実行してGitが`gpg2`を使うように設定する必要もあります。 + + {% endnote %} diff --git a/translations/ja-JP/data/reusables/gpg/paste-gpg-key-id.md b/translations/ja-JP/data/reusables/gpg/paste-gpg-key-id.md index 1dc868f06a..7ba68c51da 100644 --- a/translations/ja-JP/data/reusables/gpg/paste-gpg-key-id.md +++ b/translations/ja-JP/data/reusables/gpg/paste-gpg-key-id.md @@ -1,9 +1,9 @@ -1. To set your primary GPG signing key in Git, paste the text below, substituting in the GPG primary key ID you'd like to use. この例では、GPG キー ID は `3AA5C34371567BD2` です。 +1. プライマリGPG署名キーをGitで設定するには、使用したいGPGプライマリキーIDを置き換えて以下のテキストを貼り付けてください。 この例では、GPG キー ID は `3AA5C34371567BD2` です。 ```shell $ git config --global user.signingkey 3AA5C34371567BD2 ``` - Alternatively, when setting a subkey include the `!` suffix. In this example, the GPG subkey ID is `4BB6D45482678BE3`: + あるいは、`!`を含めてサブキーを設定する場合は以下のようにしてください。 この例では、GPGサブキーIDは`4BB6D45482678BE3`です: ```shell $ git config --global user.signingkey 4BB6D45482678BE3! ``` diff --git a/translations/ja-JP/data/reusables/gpg/paste-ssh-public-key.md b/translations/ja-JP/data/reusables/gpg/paste-ssh-public-key.md new file mode 100644 index 0000000000..1274a0acb5 --- /dev/null +++ b/translations/ja-JP/data/reusables/gpg/paste-ssh-public-key.md @@ -0,0 +1,4 @@ +1. To set your SSH signing key in Git, paste the text below, substituting the contents of your clipboard for the key you'd like to use. Since the key contains spaces, you must wrap it in quotes: + ```bash + $ git config --global user.signingkey 'ssh-ed25519 AAAAC3(...) user@example.com' + ``` \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/gpg/ssh-git-version.md b/translations/ja-JP/data/reusables/gpg/ssh-git-version.md new file mode 100644 index 0000000000..481a9df5b1 --- /dev/null +++ b/translations/ja-JP/data/reusables/gpg/ssh-git-version.md @@ -0,0 +1,6 @@ + +{% note %} + +**Note:** SSH signature verification is available in Git 2.34 or later. Gitのバージョンをアップデートするには、[Git](https://git-scm.com/downloads)のWebサイトを参照してください。 + +{% endnote %} diff --git a/translations/ja-JP/data/reusables/gpg/x-509-key.md b/translations/ja-JP/data/reusables/gpg/x-509-key.md index 7a65302459..29ca780927 100644 --- a/translations/ja-JP/data/reusables/gpg/x-509-key.md +++ b/translations/ja-JP/data/reusables/gpg/x-509-key.md @@ -1,5 +1,5 @@ -### Git にX.509 キーについて知らせる +## Git にX.509 キーについて知らせる GPGではなくS/MIMEを使ってコミットやタグに署名するために、[smimesign](https://github.com/github/smimesign)を使うことができます。 diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/about-adding-ip-allow-list-entries.md b/translations/ja-JP/data/reusables/identity-and-permissions/about-adding-ip-allow-list-entries.md new file mode 100644 index 0000000000..772581f87a --- /dev/null +++ b/translations/ja-JP/data/reusables/identity-and-permissions/about-adding-ip-allow-list-entries.md @@ -0,0 +1,3 @@ +You can create an IP allow list by adding entries that each contain an IP address or address range.{% ifversion ip-allow-list-address-check %} After you finish adding entries, you can check whether a particular IP address would be allowed by any of the enabled entries in your list.{% endif %} + +Before the list restricts access to {% ifversion ghae %}your enterprise{% else %}private assets owned by organizations in your enterprise{% endif %}, you must also enable allowed IP addresses. \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/about-checking-ip-address.md b/translations/ja-JP/data/reusables/identity-and-permissions/about-checking-ip-address.md new file mode 100644 index 0000000000..dfdc758f91 --- /dev/null +++ b/translations/ja-JP/data/reusables/identity-and-permissions/about-checking-ip-address.md @@ -0,0 +1 @@ +You can check whether a particular IP address would be allowed by any of the enabled entries in your IP allow list, even if the list is not currently enabled. \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md b/translations/ja-JP/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md new file mode 100644 index 0000000000..d646e02ec5 --- /dev/null +++ b/translations/ja-JP/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md @@ -0,0 +1,5 @@ +You can edit an entry in your IP allow list. If you edit an enabled entry, changes are enforced immediately. + +{% ifversion ip-allow-list-address-check %} +After you finish editing entries, you can check whether a particular IP address would be allowed by any of the enabled entries in your list. +{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md b/translations/ja-JP/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md new file mode 100644 index 0000000000..f886df0690 --- /dev/null +++ b/translations/ja-JP/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md @@ -0,0 +1,5 @@ +After you create an IP allow list, you can enable allowed IP addresses. When you enable allowed IP addresses, {% data variables.product.company_short %} immediately enforces any enabled entries in your IP allow list. + +{% ifversion ip-allow-list-address-check %} +Before you enable allowed IP addresses, you can check whether a particular IP address would be allowed by any of the enabled entries in your list. For more information, see "[Checking if an IP address is permitted](#checking-if-an-ip-address-is-permitted)." +{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/about-team-sync.md b/translations/ja-JP/data/reusables/identity-and-permissions/about-team-sync.md index 3e1d35ac23..bdf8fd64f2 100644 --- a/translations/ja-JP/data/reusables/identity-and-permissions/about-team-sync.md +++ b/translations/ja-JP/data/reusables/identity-and-permissions/about-team-sync.md @@ -1 +1 @@ -If team sync is enabled for your organization or enterprise account, you can synchronize a {% data variables.product.prodname_dotcom %} team with an IdP group. When you synchronize a {% data variables.product.prodname_dotcom %} team with an IdP group, membership changes to the IdP group are reflected on {% data variables.product.product_name %} automatically, reducing the need for manual updates and custom scripts. {% ifversion ghec %}For more information, see "[Managing team synchronization for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)" and "[Managing team synchronization for organizations in your enterprise](/admin/identity-and-access-management/managing-iam-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)".{% endif %} +Team同期がOrganizationもしくはEnterpriseアカウントで有効化されているなら、{% data variables.product.prodname_dotcom %}のTeamをIdPグループと同期できます。 {% data variables.product.prodname_dotcom %} TeamをIdPグループと同期すると、IdPグループへのメンバーシップの変更は{% data variables.product.product_name %}に自動的に反映され、手動での更新やカスタムスクリプトの必要性を削減してくれます。 {% ifversion ghec %}詳しい情報については「[OrganizationのTeam同期の管理](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)」及び「[Enterprise内のOrganizationのTeam同期の管理](/admin/identity-and-access-management/managing-iam-for-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise)」を参照してください。{% endif %} diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/check-ip-address-step.md b/translations/ja-JP/data/reusables/identity-and-permissions/check-ip-address-step.md new file mode 100644 index 0000000000..5e73fdddcd --- /dev/null +++ b/translations/ja-JP/data/reusables/identity-and-permissions/check-ip-address-step.md @@ -0,0 +1 @@ +1. Under "Check your IP address", enter an IP address. ![Screenshot of the "Check IP address" text field](/assets/images/help/security/check-ip-address.png) \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/check-ip-address.md b/translations/ja-JP/data/reusables/identity-and-permissions/check-ip-address.md new file mode 100644 index 0000000000..9a187752d6 --- /dev/null +++ b/translations/ja-JP/data/reusables/identity-and-permissions/check-ip-address.md @@ -0,0 +1,3 @@ +{%- ifversion ip-allow-list-address-check %} +1. Optionally, check if a particular IP address would be allowed by any of the enabled entries in your list. For more information, see "[Checking if an IP address is permitted](#checking-if-an-ip-address-is-permitted)." +{%- endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/ip-allow-lists-enable.md b/translations/ja-JP/data/reusables/identity-and-permissions/ip-allow-lists-enable.md index 9fd83f774c..2547c2bd7c 100644 --- a/translations/ja-JP/data/reusables/identity-and-permissions/ip-allow-lists-enable.md +++ b/translations/ja-JP/data/reusables/identity-and-permissions/ip-allow-lists-enable.md @@ -1 +1,3 @@ -IP許可リストを強制するには、まずIPアドレスをリストに追加し、それからIP許可リストを有効化しなければなりません。 IP 許可リストを有効にするには、現在の IP アドレスまたは一致する範囲を追加する必要があります。 +To enforce the IP allow list, you must first add IP addresses to the list, then enable the IP allow list.{% ifversion ip-allow-list-address-check %} After you complete your list, you can check whether a particular IP address would be allowed by any of the enabled entries in the list.{% endif %} + +IP 許可リストを有効にするには、現在の IP アドレスまたは一致する範囲を追加する必要があります。 diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/ip-allow-lists-example-and-restrictions.md b/translations/ja-JP/data/reusables/identity-and-permissions/ip-allow-lists-example-and-restrictions.md index 9bbe513509..6ef6563edb 100644 --- a/translations/ja-JP/data/reusables/identity-and-permissions/ip-allow-lists-example-and-restrictions.md +++ b/translations/ja-JP/data/reusables/identity-and-permissions/ip-allow-lists-example-and-restrictions.md @@ -1 +1 @@ -たとえば、自分のオフィスのネットワークのIPアドレスからのアクセスのみを許可できます。 The allow list for IP addresses will block access to private resources via the web, API, and Git from any IP addresses that are not on the allow list. +たとえば、自分のオフィスのネットワークのIPアドレスからのアクセスのみを許可できます。 IPアドレスの許可リストは、許可リストに載っていないIPアドレスからのWeb、API、Gitによるプライベートリソースへのアクセスをブロックします。 diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/ipv6-allow-lists.md b/translations/ja-JP/data/reusables/identity-and-permissions/ipv6-allow-lists.md new file mode 100644 index 0000000000..3c26491fe2 --- /dev/null +++ b/translations/ja-JP/data/reusables/identity-and-permissions/ipv6-allow-lists.md @@ -0,0 +1,7 @@ +{% ifversion fpt or ghec %} +{% note %} + +**Note:** {% data variables.product.company_short %} is gradually rolling out support for IPv6. As {% data variables.product.prodname_dotcom %} services continue to add IPv6 support, we will start recognizing IPv6 addresses of {% data variables.product.prodname_dotcom %} users. To prevent possible access interruptions, please ensure you have added any necessary IPv6 addresses to your IP allow list. + +{% endnote %} +{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-confirm-saml.md b/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-confirm-saml.md index 88ff39d6fd..73a4eeaa81 100644 --- a/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-confirm-saml.md +++ b/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-confirm-saml.md @@ -1 +1 @@ -3. Confirm that SAML SSO is enabled for your organization. 詳細は「[Organization で SAML シングルサインオンを管理する](/organizations/managing-saml-single-sign-on-for-your-organization/)」を参照してください。 +3. SAML SSOがOrganizationで有効化されていることを確認してください。 詳細は「[Organization で SAML シングルサインオンを管理する](/organizations/managing-saml-single-sign-on-for-your-organization/)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-confirm-scim.md b/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-confirm-scim.md index 93872cfd85..9585366570 100644 --- a/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-confirm-scim.md +++ b/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-confirm-scim.md @@ -1 +1 @@ -1. We recommend you confirm that your users have SAML enabled and have a linked SCIM identity to avoid potential provisioning errors. For more information, see "[Troubleshooting identity and access management for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management-for-your-organization)." +1. ユーザがSAMLを有効化しており、潜在的なプロビジョニングのエラーを回避するためにリンクされたSCIMアイデンティティを持っていることを確認するようおすすめします。 詳しい情報については「[Organizationでのアイデンティティ及びアクセス管理のトラブルシューティング](/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management-for-your-organization)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-okta-requirements.md b/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-okta-requirements.md index 38a17951ef..1c4b6e79ad 100644 --- a/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-okta-requirements.md +++ b/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-okta-requirements.md @@ -1,5 +1,5 @@ -Before you enable team synchronization for Okta, you or your IdP administrator must: +OktaのTeam同期を有効化する前に、あなたもしくはあなたのIdPの管理者は、以下のことをしなければなりません: -- Configure the SAML, SSO, and SCIM integration for your organization using Okta. 詳しい情報については「[Oktaを使用したSAMLシングルサインオンとSCIMの設定](/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta)」を参照してください。 +- Oktaを使ったOrganizatioinでのSAML、SSO、SCIMインテグレーションの設定。 詳しい情報については「[Oktaを使用したSAMLシングルサインオンとSCIMの設定](/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta)」を参照してください。 - OktaインスタンスのテナントURLを提供してください。 - Okta環境にサービスユーザとして読み取りのみの管理権限を持つ、有効なSSWSトークンを生成してください。 詳しい情報についてはOktaのドキュメンテーションの[トークンの生成](https://developer.okta.com/docs/guides/create-an-api-token/create-the-token/)及び[サービスユーザ](https://help.okta.com/asa/en-us/Content/Topics/Adv_Server_Access/docs/service-users.htm)を参照してください。 diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-usage-limits.md b/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-usage-limits.md index ab2c382f72..8e9918693e 100644 --- a/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-usage-limits.md +++ b/translations/ja-JP/data/reusables/identity-and-permissions/team-sync-usage-limits.md @@ -1,8 +1,8 @@ ### 使用制限 -There are usage limits for the team synchonization feature. Exceeding these limits will lead to a degredation in performance and may cause synchronization failures. +Team同期の機能には使用制限があります。 これらの制限を超過すると、パフォーマンスの低下が生じ、同期に失敗することがあります。 -- Maximum number of members in a GitHub team: 5,000 -- Maximum number of members in a GitHub organization: 10,000 -- Maximum number of teams in a GitHub organization: 1,500 +- GitHub Team内の最大メンバー数: 5,000 +- GitHub Organization内の最大メンバー数: 10,000 +- GitHub Organization内のTeamの最大メンバー数: 1,500 diff --git a/translations/ja-JP/data/reusables/marketplace/app-transfer-to-org-for-verification.md b/translations/ja-JP/data/reusables/marketplace/app-transfer-to-org-for-verification.md index c11be27bb2..dbc1f39458 100644 --- a/translations/ja-JP/data/reusables/marketplace/app-transfer-to-org-for-verification.md +++ b/translations/ja-JP/data/reusables/marketplace/app-transfer-to-org-for-verification.md @@ -1 +1 @@ -If you want to sell an app that's owned by your personal account, first you'll need to transfer the app to an organization, and then request verification for a listing created by the organization. +自分の個人アカウントが所有するアプリケーションを販売したいなら、まずそのアプリケーションをOrganizationに移譲し、続いてそのOrganizationが作成したリストのための検証をリクエストしてください。 diff --git a/translations/ja-JP/data/reusables/marketplace/marketplace-double-purchases.md b/translations/ja-JP/data/reusables/marketplace/marketplace-double-purchases.md index 701fee4dcc..10de46bcc9 100644 --- a/translations/ja-JP/data/reusables/marketplace/marketplace-double-purchases.md +++ b/translations/ja-JP/data/reusables/marketplace/marketplace-double-purchases.md @@ -1,5 +1,5 @@ {% warning %} -**ノート:**{% data variables.product.prodname_marketplace %}の現在のバージョンでは、アプリケーションのWebサイトで購入したアカウントをすでに持っている顧客が、{% data variables.product.prodname_marketplace %}を通じてアプリケーションを購入できてしまいます。 If you find that you already have an account set up for the customer who purchased your app, please report the "double" purchases to [GitHub Support](https://github.com/contact). +**ノート:**{% data variables.product.prodname_marketplace %}の現在のバージョンでは、アプリケーションのWebサイトで購入したアカウントをすでに持っている顧客が、{% data variables.product.prodname_marketplace %}を通じてアプリケーションを購入できてしまいます。 アプリケーションを購入した顧客に対して、すでにアカウントがセットアップされていることに気づいたら、[GitHub Support](https://github.com/contact)に「二重」購入を報告してください。 {% endwarning %} diff --git a/translations/ja-JP/data/reusables/notifications-v2/custom-notification-types.md b/translations/ja-JP/data/reusables/notifications-v2/custom-notification-types.md index edb0683ee8..564ca59722 100644 --- a/translations/ja-JP/data/reusables/notifications-v2/custom-notification-types.md +++ b/translations/ja-JP/data/reusables/notifications-v2/custom-notification-types.md @@ -1,3 +1,3 @@ -{%- ifversion fpt or ghec or ghes or ghae-issue-4910 %}issues, pull requests, releases, security alerts, or discussions -{%- else %}issues, pull requests, releases, or discussions +{%- ifversion fpt or ghec or ghes or ghae-issue-4910 %}Issue、Pull Request、リリース、セキュリティアラート、ディスカッション +{%- else %}Issue、Pull Request、リリース、ディスカッション {% endif %} diff --git a/translations/ja-JP/data/reusables/notifications/auto-watch.md b/translations/ja-JP/data/reusables/notifications/auto-watch.md index cf295dfeac..6d220bd1bb 100644 --- a/translations/ja-JP/data/reusables/notifications/auto-watch.md +++ b/translations/ja-JP/data/reusables/notifications/auto-watch.md @@ -1 +1 @@ -You automatically watch all repositories that you create and are owned by your personal account. フォークを除き、あなたがプッシュアクセスを持つすべてのリポジトリを自動的にWatchすることもできます。 その他の任意のリポジトリは手動でWatchできます。 +自分が作成したリポジトリ及び自分の個人アカウントが所有するリポジトリは、すべて自動的にWatchします。 フォークを除き、あなたがプッシュアクセスを持つすべてのリポジトリを自動的にWatchすることもできます。 その他の任意のリポジトリは手動でWatchできます。 diff --git a/translations/ja-JP/data/reusables/notifications/email-restrictions-verification.md b/translations/ja-JP/data/reusables/notifications/email-restrictions-verification.md index 04756b1f5f..cf1d4d571d 100644 --- a/translations/ja-JP/data/reusables/notifications/email-restrictions-verification.md +++ b/translations/ja-JP/data/reusables/notifications/email-restrictions-verification.md @@ -1 +1 @@ -{% ifversion fpt or ghec %}To continue receiving email notifications after you enable restrictions, members must verify any email addresses within domains that you verify or approve. 詳しい情報については、「[メールアドレスの検証](/github/getting-started-with-github/verifying-your-email-address)」を参照してください。{% endif %} +{% ifversion fpt or ghec %}制限を有効にした後にメール通知を受け続けるには、メンバーは検証あるいは承認されたドメイン内のメールアドレスを検証しなければなりません。 詳しい情報については、「[メールアドレスの検証](/github/getting-started-with-github/verifying-your-email-address)」を参照してください。{% endif %} diff --git a/translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-delivery-method-customization.md b/translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-delivery-method-customization.md index 0da5c96fb6..0aa25024aa 100644 --- a/translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-delivery-method-customization.md +++ b/translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-delivery-method-customization.md @@ -1 +1 @@ -You can choose the delivery method and frequency of notifications about {% data variables.product.prodname_dependabot_alerts %} on repositories that you are watching or where you have subscribed to notifications for security alerts. +Watchしているリポジトリあるいはセキュリティアラートの通知をサブスクライブしたところの{% data variables.product.prodname_dependabot_alerts %}に関する通知の配信方法と頻度を選択できます。 diff --git a/translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-delivery-method-customization2.md b/translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-delivery-method-customization2.md index 52b660f719..b55d515a7a 100644 --- a/translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-delivery-method-customization2.md +++ b/translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-delivery-method-customization2.md @@ -1 +1 @@ -You can choose the delivery method for notifications, as well as the frequency at which the notifications are sent to you. +通知が送信される頻度とともに、通知の配信方法を選択できます。 diff --git a/translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-enable.md b/translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-enable.md index 17ae0c368a..0e0b406939 100644 --- a/translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-enable.md +++ b/translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-enable.md @@ -1,3 +1,3 @@ {% ifversion fpt or ghes or ghec %} -To receive notifications about {% data variables.product.prodname_dependabot_alerts %} on repositories, you need to watch these repositories, and subscribe to receive "All Activity" notifications or configure custom settings to include "Security alerts." For more information, see "[Configuring your watch settings for an individual repository](/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)." +リポジトリの{% data variables.product.prodname_dependabot_alerts %}に関する通知を受け取るには、それらのリポジトリをWatchし、"All Activity"通知を受信するようサブスクライブするか、"Security alerts"を含めるようにカスタム設定をしてください。 詳しい情報については「[個々のリポジトリのWatchの設定](/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)」を参照してください。 {% endif %} diff --git a/translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-options.md b/translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-options.md index a02fa5ca11..9fbda13501 100644 --- a/translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-options.md +++ b/translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-options.md @@ -1,14 +1,14 @@ -{% ifversion fpt or ghec %}By default, you will receive notifications:{% endif %}{% ifversion ghes or ghae %}By default, if your enterprise owner has configured email for notifications on your instance, you will receive {% data variables.product.prodname_dependabot_alerts %}:{% endif %} +{% ifversion fpt or ghec %}デフォルトでは通知を受け取ります:{% endif %}{% ifversion ghes or ghae %}デフォルトでは、Enterpriseオーナーがインスタンスでメール通知を設定していれば{% data variables.product.prodname_dependabot_alerts %}を受け取ります:{% endif %} - メールについては、{% data variables.product.prodname_dependabot %}がリポジトリで有効化された場合、新しいマニフェストファイルがリポジトリにコミットされた場合、重要度が重大もしくは高の新しい脆弱性が見つかった場合に送信されます（**Email each time a vulnerability is found（脆弱性が見つかるたびにメールする）**オプション）。 -- in the user interface, a warning is shown in your repository's file and code views if there are any insecure dependencies (**UI alerts** option). -- on the command line, warnings are displayed as callbacks when you push to repositories with any insecure dependencies (**Command Line** option). -- インボックスについては、Web通知として表示されます。 A web notification is sent when {% data variables.product.prodname_dependabot %} is enabled for a repository, when a new manifest file is committed to the repository, and when a new vulnerability with a critical or high severity is found (**Web** option).{% ifversion not ghae %} -- {% data variables.product.prodname_mobile %}では、Web通知として表示されます。 For more information, see "[Enabling push notifications with GitHub Mobile](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#enabling-push-notifications-with-github-mobile)."{% endif %} +- ユーザインターフェースについては、安全ではない依存関係があった場合に、リポジトリのファイルとコードビューに警告が表示されます（**UI alerts（UIアラート）**オプション）。 +- コマンドラインについては、安全ではない依存関係を伴うプッシュをリポジトリに対して行った場合、コールバックとして警告が表示されます（**Command Line（コマンドライン）**オプション）。 +- インボックスについては、Web通知として表示されます。 Web通知は、{% data variables.product.prodname_dependabot %}がリポジトリで有効化された場合、新しいマニフェストファイルがリポジトリにコミットされた場合、重要度が重大もしくは高の新しい脆弱性が見つかった場合に送信されます（**Web**オプション）。{% ifversion not ghae %} +- {% data variables.product.prodname_mobile %}では、Web通知として表示されます。 詳しい情報については「[GitHub Mobileでのプッシュ通知の有効化](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#enabling-push-notifications-with-github-mobile)」を参照してください。{% endif %} {% note %} -**Note:** The email and web{% ifversion not ghae %}/{% data variables.product.prodname_mobile %}{% endif %} notifications are: +**ノート:** メール及びWeb{% ifversion not ghae %} / {% data variables.product.prodname_mobile %}{% endif %}通知は以下のようになります。 - _リポジトリごと_ {% data variables.product.prodname_dependabot %}がリポジトリで有効化された場合、あるいは新しいマニフェストファイルがリポジトリにコミットされた場合。 @@ -16,4 +16,4 @@ {% endnote %} -You can customize the way you are notified about {% data variables.product.prodname_dependabot_alerts %}. たとえば、**Email a digest summary of vulnerabilities（脆弱性のダイジェストサマリーメール）**及び**Weekly security email digest（週間のセキュリティメールダイジェスト）**オプションを使って、最大10件のリポジトリに関するアラートをまとめた週間のダイジェストメールを受信できます。 +{% data variables.product.prodname_dependabot_alerts %}に関する通知を受け取る方法をカスタマイズできます。 たとえば、**Email a digest summary of vulnerabilities（脆弱性のダイジェストサマリーメール）**及び**Weekly security email digest（週間のセキュリティメールダイジェスト）**オプションを使って、最大10件のリポジトリに関するアラートをまとめた週間のダイジェストメールを受信できます。 diff --git a/translations/ja-JP/data/reusables/organizations/about-following-organizations.md b/translations/ja-JP/data/reusables/organizations/about-following-organizations.md new file mode 100644 index 0000000000..52e52467fb --- /dev/null +++ b/translations/ja-JP/data/reusables/organizations/about-following-organizations.md @@ -0,0 +1 @@ +When you follow organizations on {% data variables.product.product_name %}, you'll see their {% ifversion fpt or ghec %}public{% endif %} activity on your personal dashboard. This activity includes new discussions, sponsorships, and repositories. \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/organizations/about-organizations.md b/translations/ja-JP/data/reusables/organizations/about-organizations.md index 0dbdfd0de4..4b0bd21255 100644 --- a/translations/ja-JP/data/reusables/organizations/about-organizations.md +++ b/translations/ja-JP/data/reusables/organizations/about-organizations.md @@ -1,3 +1,3 @@ -Your team can collaborate on {% data variables.product.product_name %} by using an organization account, which serves as a container for your shared work and gives the work a unique name and brand. +チームはOrganizationアカウントを使うことで{% data variables.product.product_name %}上で共同作業できます。Organizationアカウントは共有作業のコンテナとして働き、作業に固有の名前とブランドを与えます。 -Each person that uses {% data variables.product.prodname_dotcom %} always signs into a personal account, and multiple personal accounts can collaborate on shared projects by joining the same organization account. A subset of these personal accounts can be given the role of organization owner, which allows those people to granularly manage access to the organization's resources using sophisticated security and administrative features. +{% data variables.product.prodname_dotcom %}を使う各人は、常に個人アカウントにサインインし、複数の個人アカウントが同じOrganizationアカウントに参加することによって、共有されたプロジェクト上で共同作業できます。 これらの個人アカウントの一部にOrganiationオーナーのロールを与えることができます。これによって、それらの人々は洗練されたセキュリティ及び管理機能を使い、詳細にOrganizationのリソースへのアクセスを管理できるようになります。 diff --git a/translations/ja-JP/data/reusables/organizations/about-roles.md b/translations/ja-JP/data/reusables/organizations/about-roles.md index 8132b9f5bf..acdf20a198 100644 --- a/translations/ja-JP/data/reusables/organizations/about-roles.md +++ b/translations/ja-JP/data/reusables/organizations/about-roles.md @@ -1 +1 @@ -To perform any actions on {% data variables.product.prodname_dotcom %}, such as creating a pull request in a repository or changing an organization's billing settings, a person must have sufficient access to the relevant account or resource. This access is controlled by permissions. A permission is the ability to perform a specific action. For example, the ability to delete an issue is a permission. A role is a set of permissions you can assign to individuals or teams. +リポジトリでのPull Requestの作成やOrganizationの支払い設定の変更など、{% data variables.product.prodname_dotcom %}でなんらかのアクションを行うためには、ユーザは関連するアカウントやリソースに対する十分なアクセス権を持っていなければなりません。 このアクセスは、権限によって制御されます。 権限は、特定のアクションを行える能力です。 たとえばIssueを削除する能力は権限です。 ロールは、個人やTeamに割り当てることができる権限のセットです。 diff --git a/translations/ja-JP/data/reusables/organizations/about-security-managers.md b/translations/ja-JP/data/reusables/organizations/about-security-managers.md index a06de7f6e9..e340de3b2a 100644 --- a/translations/ja-JP/data/reusables/organizations/about-security-managers.md +++ b/translations/ja-JP/data/reusables/organizations/about-security-managers.md @@ -1 +1 @@ -Security manager is an organization-level role that organization owners can assign to any team in an organization. When applied, it gives every member of the team permissions to manage security alerts and settings across your organization, as well as read permissions for all repositories in the organization. +セキュリティマネージャーはOrganizationレベルのロールで、OrganizationのオーナーがOrganization内の任意のTeamに割り当てることができます。 このロールが適用されると、Teamの各メンバーにはOrganization全体のセキュリティーアラートと設定の管理権限と、Organization内のすべてのリポジトリへの読み取り権限が付与されます。 diff --git a/translations/ja-JP/data/reusables/organizations/billing-settings.md b/translations/ja-JP/data/reusables/organizations/billing-settings.md index 6456fb0651..55d509798b 100644 --- a/translations/ja-JP/data/reusables/organizations/billing-settings.md +++ b/translations/ja-JP/data/reusables/organizations/billing-settings.md @@ -1,4 +1,4 @@ {% data reusables.user-settings.access_settings %} -1. In the "Access" section of the sidebar, click **{% octicon "organization" aria-label="The organization icon" %} Organizations**. +1. サイドバーの"Access（アクセス）"セクションで、**{% octicon "organization" aria-label="The organization icon" %} Organizations**をクリックしてください。 {% data reusables.profile.org_settings %} -1. If you are an organization owner, in the "Access" section of the sidebar, click **{% octicon "credit-card" aria-label="The credit-card icon" %} Billing and plans**. +1. Organizationのオーナーは、サイドバーの"Access（アクセス）"セクションで、**{% octicon "credit-card" aria-label="The credit-card icon" %} Billing and plans（支払いとプラン）**をクリックしてください。 diff --git a/translations/ja-JP/data/reusables/organizations/billing_plans.md b/translations/ja-JP/data/reusables/organizations/billing_plans.md index b525e863e3..f4da43f9ea 100644 --- a/translations/ja-JP/data/reusables/organizations/billing_plans.md +++ b/translations/ja-JP/data/reusables/organizations/billing_plans.md @@ -1,5 +1,5 @@ {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %} -1. In the "Access" section of the sidebar, click **{% octicon "credit-card" aria-label="The credit card icon" %} Billing and plans**. +1. サイドバーの"Access（アクセス）"セクションで**{% octicon "credit-card" aria-label="The credit card icon" %} Billing and plans（支払いとプラン）**をクリックしてください。 {% else %} 1. OrganizationのSettings（設定）サイドバーで、**Billing & plans（支払いとプラン）**をクリックしてください。 ![支払い設定](/assets/images/help/billing/settings_organization_billing_plans_tab.png) {% endif %} diff --git a/translations/ja-JP/data/reusables/organizations/block_users.md b/translations/ja-JP/data/reusables/organizations/block_users.md index 60ace89469..10cc37ff4e 100644 --- a/translations/ja-JP/data/reusables/organizations/block_users.md +++ b/translations/ja-JP/data/reusables/organizations/block_users.md @@ -1 +1 @@ -1. In the sidebar, select **{% octicon "report" aria-label="The report icon" %} Moderation**, then click **Blocked users**. +1. サイドバーで**{% octicon "report" aria-label="The report icon" %}Moderation（モデレーション）**を選択して、続いて**Blocked users（ブロックされたユーザ）**をクリックしてください。 diff --git a/translations/ja-JP/data/reusables/organizations/choose-user-role.md b/translations/ja-JP/data/reusables/organizations/choose-user-role.md index c29ebdb666..63d373ffc1 100644 --- a/translations/ja-JP/data/reusables/organizations/choose-user-role.md +++ b/translations/ja-JP/data/reusables/organizations/choose-user-role.md @@ -1 +1 @@ -1. If the person you're inviting has never been a member of the organization or if you cleared their privileges, choose an organization role for the user. ![ユーザをメンバーもしくはオーナーにするオプション](/assets/images/help/organizations/choose-new-member-role.png) +1. 招待している人がOrganizationのメンバーだったことがない、あるいはその人の権限をクリア済みなら、そのユーザのOrganizationのロールを選択してください。 ![ユーザをメンバーもしくはオーナーにするオプション](/assets/images/help/organizations/choose-new-member-role.png) diff --git a/translations/ja-JP/data/reusables/organizations/click-codespaces.md b/translations/ja-JP/data/reusables/organizations/click-codespaces.md index 2f409b474f..39f620c611 100644 --- a/translations/ja-JP/data/reusables/organizations/click-codespaces.md +++ b/translations/ja-JP/data/reusables/organizations/click-codespaces.md @@ -1 +1 @@ -1. In the left sidebar, click **{% octicon "codespaces" aria-label="The codespaces icon" %} Codespaces**. +1. 左のサイドバーで**{% octicon "codespaces" aria-label="The codespaces icon" %} Codespaces**をクリックしてください。 diff --git a/translations/ja-JP/data/reusables/organizations/follow-organizations-beta.md b/translations/ja-JP/data/reusables/organizations/follow-organizations-beta.md new file mode 100644 index 0000000000..1730f73ccd --- /dev/null +++ b/translations/ja-JP/data/reusables/organizations/follow-organizations-beta.md @@ -0,0 +1,5 @@ +{% note %} + +**Note:** The ability to follow organizations is currently in public beta and subject to change. + +{% endnote %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/organizations/github-apps-settings-sidebar.md b/translations/ja-JP/data/reusables/organizations/github-apps-settings-sidebar.md index 3e1866c909..063f4d28c0 100644 --- a/translations/ja-JP/data/reusables/organizations/github-apps-settings-sidebar.md +++ b/translations/ja-JP/data/reusables/organizations/github-apps-settings-sidebar.md @@ -1,5 +1,5 @@ {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %} -1. In the left sidebar, select **{% octicon "code" aria-label="The code icon" %} Developer settings** then click **{% data variables.product.prodname_github_apps %}**. +1. 左のサイドバーで**{% octicon "code" aria-label="The code icon" %} Developer settings（開発者設定）**を選択し、続いて**{% data variables.product.prodname_github_apps %}**をクリックしてください。 {% else %} -1. 左のサイドバーで**{% data variables.product.prodname_github_apps %}**をクリックしてください。 ![{% data variables.product.prodname_github_apps %} settings](/assets/images/help/organizations/github-apps-settings-sidebar.png) +1. 左のサイドバーで**{% data variables.product.prodname_github_apps %}**をクリックしてください。 ![{% data variables.product.prodname_github_apps %}設定](/assets/images/help/organizations/github-apps-settings-sidebar.png) {% endif %} diff --git a/translations/ja-JP/data/reusables/organizations/invite-teams-or-people.md b/translations/ja-JP/data/reusables/organizations/invite-teams-or-people.md index df69110afe..0c2ca84754 100644 --- a/translations/ja-JP/data/reusables/organizations/invite-teams-or-people.md +++ b/translations/ja-JP/data/reusables/organizations/invite-teams-or-people.md @@ -1 +1 @@ -1. To the right of "Manage access", click **Add people** or **Add teams**. !["Teamあるいは人の招待" ボタン](/assets/images/help/repository/manage-access-invite-button.png) +1. "Manage access（アクセスの管理）"の右で、**Add people（人の追加）**あるいは**Add teams（Teamの追加）**をクリックしてください。 !["Teamあるいは人の招待" ボタン](/assets/images/help/repository/manage-access-invite-button.png) diff --git a/translations/ja-JP/data/reusables/organizations/member-privileges.md b/translations/ja-JP/data/reusables/organizations/member-privileges.md index f8c48625f5..d52f35e9aa 100644 --- a/translations/ja-JP/data/reusables/organizations/member-privileges.md +++ b/translations/ja-JP/data/reusables/organizations/member-privileges.md @@ -1,5 +1,5 @@ {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %} -1. In the "Access" section of the sidebar, click **{% octicon "people" aria-label="The people icon" %} Member privileges**. +1. サイドバーの"Access（アクセス）"セクションで、**{% octicon "people" aria-label="The people icon" %} Member privileges（メンバーの権限）**をクリックしてください。 {% else %} 4. 左のサイドバーで、**Member privileges（メンバーの権限）**をクリックしてください。 ![Org設定のメンバーの権限オプション](/assets/images/help/organizations/org-settings-member-privileges.png) {% endif %} diff --git a/translations/ja-JP/data/reusables/organizations/mixed-roles-warning.md b/translations/ja-JP/data/reusables/organizations/mixed-roles-warning.md index 31f89c2eab..d43e79aec0 100644 --- a/translations/ja-JP/data/reusables/organizations/mixed-roles-warning.md +++ b/translations/ja-JP/data/reusables/organizations/mixed-roles-warning.md @@ -1 +1 @@ -If a person has been given conflicting access, you'll see a warning on the repository access page. The warning appears with "{% octicon "alert" aria-label="The alert icon" %} Mixed roles" next to the person with the conflicting access. To see the source of the conflicting access, hover over the warning icon or click **Mixed roles**. +競合するアクセスがユーザに付与されると、リポジトリのアクセスページに警告が表示されます。 警告は、競合するアクセスを持つ人の隣に"{% octicon "alert" aria-label="The alert icon" %} Mixed roles（混合ロール） "と表示されます。 競合するアクセスのソースを表示するには、警告アイコンの上にカーソルを合わせるか、**Mixed roles（混合ロール）**をクリックしてください。 diff --git a/translations/ja-JP/data/reusables/organizations/new_team.md b/translations/ja-JP/data/reusables/organizations/new_team.md index 20183a885d..746538b727 100644 --- a/translations/ja-JP/data/reusables/organizations/new_team.md +++ b/translations/ja-JP/data/reusables/organizations/new_team.md @@ -1,5 +1,5 @@ -1. Organization 名の下で、クリックします -{% octicon "people" aria-label="The people icon" %} **Teams**. +1. Organization 名の下で、 +{% octicon "people" aria-label="The people icon" %} **Teams**をクリックしてください。 {% ifversion fpt or ghes > 3.2 or ghec %} ![Teamsタブ](/assets/images/help/organizations/organization-teams-tab-with-overview.png) {% else %} diff --git a/translations/ja-JP/data/reusables/organizations/oauth_app_access.md b/translations/ja-JP/data/reusables/organizations/oauth_app_access.md index a2dc8773f5..33c8dfc8c9 100644 --- a/translations/ja-JP/data/reusables/organizations/oauth_app_access.md +++ b/translations/ja-JP/data/reusables/organizations/oauth_app_access.md @@ -1 +1 @@ -1. In the "Integrations" section of the sidebar, click **{% octicon "key" aria-label="The key icon" %} Third-party access**. +1. サイドバーの「Integrations（インテグレーション）」セクションで、**{% octicon "key" aria-label="The key icon" %} Third-party access（サードパーティのアクセス）**をクリックしてください。 diff --git a/translations/ja-JP/data/reusables/organizations/org-invite-scim.md b/translations/ja-JP/data/reusables/organizations/org-invite-scim.md index cb5d723d48..bb5b6694af 100644 --- a/translations/ja-JP/data/reusables/organizations/org-invite-scim.md +++ b/translations/ja-JP/data/reusables/organizations/org-invite-scim.md @@ -1 +1 @@ -If an invitee does not accept the invitation within seven days, the pending invitation expires automatically. After expiration, {% data variables.product.company_short %} will no longer bill you for the pending invitation.{% ifversion ghec %} If a SCIM request from your identity provider (IdP) generates the invitation, the invitation will not expire.{% endif %} +招待された人が招待を7日以内に唱題しなかった場合、保留されていた招待は自動的に期限切れになります。 期限切れになると、{% data variables.product.company_short %}は保留された招待に対して課金しなくなります。{% ifversion ghec %}アイデンティティプロバイダ（IdP）からのSCIMリクエストが招待を生成した場合、その招待は期限切れになりません。{% endif %} diff --git a/translations/ja-JP/data/reusables/organizations/org-list.md b/translations/ja-JP/data/reusables/organizations/org-list.md index c63dd5d64e..45e5d566af 100644 --- a/translations/ja-JP/data/reusables/organizations/org-list.md +++ b/translations/ja-JP/data/reusables/organizations/org-list.md @@ -1 +1 @@ -1. Under "Organizations", next to the name of your organization, click **Settings**. ![Screenshot of an organization next to the "Settings" button](/assets/images/help/organizations/list-of-organizations.png) +1. "Organizations"の下で、Organization名の隣の**Settings（設定）**をクリックしてください。 !["Settings"ボタンの隣のOrganizationのスクリーンショット](/assets/images/help/organizations/list-of-organizations.png) diff --git a/translations/ja-JP/data/reusables/organizations/org-settings-repository-roles.md b/translations/ja-JP/data/reusables/organizations/org-settings-repository-roles.md index 937618670b..07151d44df 100644 --- a/translations/ja-JP/data/reusables/organizations/org-settings-repository-roles.md +++ b/translations/ja-JP/data/reusables/organizations/org-settings-repository-roles.md @@ -1 +1 @@ -1. In the "Access" section of the sidebar, click **{% octicon "id-badge" aria-label="The ID badge icon" %} Repository roles**. +1. サイドバーの"Access（アクセス）"セクションで、**{% octicon "id-badge" aria-label="The ID badge icon" %} Repository roles（リポジトリロール）**をクリックしてください。 diff --git a/translations/ja-JP/data/reusables/organizations/org_settings.md b/translations/ja-JP/data/reusables/organizations/org_settings.md index bfd643b511..87cea66ccb 100644 --- a/translations/ja-JP/data/reusables/organizations/org_settings.md +++ b/translations/ja-JP/data/reusables/organizations/org_settings.md @@ -1,5 +1,5 @@ 1. Organization 名の下で、クリックします -{% octicon "gear" aria-label="The Settings gear" %} **Settings**. +{% octicon "gear" aria-label="The Settings gear" %} **Settings（設定）** {% ifversion fpt or ghes > 3.2 or ghec %} ![Organizationの設定ボタン](/assets/images/help/organizations/organization-settings-tab-with-overview-tab.png) {% else %} diff --git a/translations/ja-JP/data/reusables/organizations/organization-plans.md b/translations/ja-JP/data/reusables/organizations/organization-plans.md index bb3822d560..2b56578116 100644 --- a/translations/ja-JP/data/reusables/organizations/organization-plans.md +++ b/translations/ja-JP/data/reusables/organizations/organization-plans.md @@ -1,5 +1,5 @@ {% ifversion fpt or ghec %} -All organizations can own an unlimited number of public and private repositories. You can use organizations for free, with {% data variables.product.prodname_free_team %}, which includes limited features on private repositories. To get the full feature set on private repositories and additional features at the organization level, including SAML single sign-on and improved support coverage, you can upgrade to {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info %} +すべてのOrganizationは、無制限の数のパブリック及びプライベートリポジトリを所有できます。 {% data variables.product.prodname_free_team %}でOrganizationは無料で使用でき、プライベートリポジトリには限定された機能が含まれます。 プライベートリポジトリで完全な機能を設定し、SAMLシングルサインオンや改善されたサポートカバレッジを含むOrganizaitonレベルで追加の機能を設定するには、{% data variables.product.prodname_team %}もしくは{% data variables.product.prodname_ghe_cloud %}にアップグレードできます。 {% data reusables.gated-features.more-info %} {% ifversion fpt %} {% data reusables.enterprise.link-to-ghec-trial %}{% endif %} diff --git a/translations/ja-JP/data/reusables/organizations/outside-collaborators-use-seats.md b/translations/ja-JP/data/reusables/organizations/outside-collaborators-use-seats.md index 7857597cad..198a28f29f 100644 --- a/translations/ja-JP/data/reusables/organizations/outside-collaborators-use-seats.md +++ b/translations/ja-JP/data/reusables/organizations/outside-collaborators-use-seats.md @@ -1 +1 @@ -Adding an outside collaborator to a private{% ifversion ghec %} or internal{% endif %} repository will use one of your paid licenses. For more information, see "{% ifversion fpt or ghec %}[About per-user pricing](/billing/managing-billing-for-your-github-account/about-per-user-pricing){% elsif ghes or ghae %}[About billing for your enterprise](/billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise){% endif %}." +プライベート{% ifversion ghec %}もしくはインターナル{% endif %}リポジトリへ外部のコラボレータを追加すると、有料ライセンスが使用されます。 詳しい情報については「{% ifversion fpt or ghec %}[ユーザごとの価格付けについて](/billing/managing-billing-for-your-github-account/about-per-user-pricing){% elsif ghes or ghae %}[Enterpriseでの支払いについて](/billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise){% endif %}」を参照してください。 diff --git a/translations/ja-JP/data/reusables/organizations/owners-team.md b/translations/ja-JP/data/reusables/organizations/owners-team.md index 4fcb55858c..9bb10d6d11 100644 --- a/translations/ja-JP/data/reusables/organizations/owners-team.md +++ b/translations/ja-JP/data/reusables/organizations/owners-team.md @@ -1,5 +1,5 @@ 1. Organization 名の下で、クリックします -{% octicon "people" aria-label="The people icon" %} **Teams**. +{% octicon "people" aria-label="The people icon" %} **Teams**をクリックしてください。 {% ifversion fpt or ghes > 3.2 or ghec %} ![Teamsタブ](/assets/images/help/organizations/organization-teams-tab-with-overview.png) {% else %} diff --git a/translations/ja-JP/data/reusables/organizations/people-export.md b/translations/ja-JP/data/reusables/organizations/people-export.md index 938ea3529f..b5f59ec000 100644 --- a/translations/ja-JP/data/reusables/organizations/people-export.md +++ b/translations/ja-JP/data/reusables/organizations/people-export.md @@ -1 +1 @@ -1. To the right of the search bar, select the Export drop-down menu and click the desired export format. ![Screenshot of the export button.](/assets/images/help/organizations/people-tab-export.png) +1. 検索バーの右で、Exportドロップダウンメニューを選択し、希望するエクスポート形式をクリックしてください。 ![エクスポートボタンのスクリーンショット](/assets/images/help/organizations/people-tab-export.png) diff --git a/translations/ja-JP/data/reusables/organizations/people.md b/translations/ja-JP/data/reusables/organizations/people.md index 56d2d6f9f2..165216037e 100644 --- a/translations/ja-JP/data/reusables/organizations/people.md +++ b/translations/ja-JP/data/reusables/organizations/people.md @@ -1,5 +1,5 @@ 1. Organization 名の下で、クリックします -{% octicon "person" aria-label="The Person icon" %} **People**. +{% octicon "person" aria-label="The Person icon" %} **People（人）** {% ifversion fpt or ghes > 3.2 or ghec %} ![人タブ](/assets/images/help/organizations/organization-people-tab-with-overview-tab.png) {% else %} diff --git a/translations/ja-JP/data/reusables/organizations/repository-defaults.md b/translations/ja-JP/data/reusables/organizations/repository-defaults.md index 28f1b30a6b..bac3a028c0 100644 --- a/translations/ja-JP/data/reusables/organizations/repository-defaults.md +++ b/translations/ja-JP/data/reusables/organizations/repository-defaults.md @@ -1,5 +1,5 @@ {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %} -1. In the "Code, planning, and automation" section of the sidebar, select **{% octicon "repo" aria-label="The repo icon" %} Repository**, then click **Repository defaults**. +1. サイドバーの"Code, planning, and automation（コード、計画、自動化）"のセクションで、**{% octicon "repo" aria-label="The repo icon" %} Repository（リポジトリ）**を選択し、続いて** Repository defaults（リポジトリのデフォルト）**をクリックしてください。 {% else %} 1. 左のサイドバーで**Repository defaults（リポジトリのデフォルト）**をクリックしてください。 ![リポジトリのデフォルトタブ](/assets/images/help/organizations/repo-defaults-tab.png) {% endif %} diff --git a/translations/ja-JP/data/reusables/organizations/restrict-email-notifications.md b/translations/ja-JP/data/reusables/organizations/restrict-email-notifications.md index eacc0bf98e..1755020632 100644 --- a/translations/ja-JP/data/reusables/organizations/restrict-email-notifications.md +++ b/translations/ja-JP/data/reusables/organizations/restrict-email-notifications.md @@ -1 +1 @@ -1. Under "Notification preferences", select **Restrict email notifications to only approved or verified domains**. ![メール通知を検証済みドメインのメールに制限するためのチェックボックス](/assets/images/help/organizations/restrict-email-notifications-to-domain.png) +1. "Notification preferences（通知設定）"の下で、**Restrict email notifications to only approved or verified domains（メール通知を承認済みもしくは検証済みドメインに制限する）**を選択してください。 ![メール通知を検証済みドメインのメールに制限するためのチェックボックス](/assets/images/help/organizations/restrict-email-notifications-to-domain.png) diff --git a/translations/ja-JP/data/reusables/organizations/security-and-analysis.md b/translations/ja-JP/data/reusables/organizations/security-and-analysis.md index 08466c36d6..67c3d4c2ef 100644 --- a/translations/ja-JP/data/reusables/organizations/security-and-analysis.md +++ b/translations/ja-JP/data/reusables/organizations/security-and-analysis.md @@ -1,5 +1,5 @@ {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %} -1. In the "Security" section of the sidebar, click **{% octicon "codescan" aria-label="The codescan icon" %} Code security and analysis**. +1. サイドバーの”Security（セキュリティ）"セクションで、**{% octicon "codescan" aria-label="The codescan icon" %} Code security and analysis（コードのセキュリティと分析）**をクリックしてください。 {% else %} 1. 左のサイドバーで、**Security & analysis（セキュリティと分析）**をクリックしてください。 ![Organization設定の"セキュリティと分析"タブ](/assets/images/help/organizations/org-settings-security-and-analysis.png) {% endif %} diff --git a/translations/ja-JP/data/reusables/organizations/security-manager-beta-note.md b/translations/ja-JP/data/reusables/organizations/security-manager-beta-note.md index 2d460ef111..5c40978443 100644 --- a/translations/ja-JP/data/reusables/organizations/security-manager-beta-note.md +++ b/translations/ja-JP/data/reusables/organizations/security-manager-beta-note.md @@ -1,5 +1,5 @@ {% note %} -**Note:** The security manager role is in public beta and subject to change. +**ノート:** セキュリティマネージャーのロールはパブリックベータであり、変更されることがあります。 {% endnote %} diff --git a/translations/ja-JP/data/reusables/organizations/security-overview-feature-specific-page.md b/translations/ja-JP/data/reusables/organizations/security-overview-feature-specific-page.md index 13f951ee2f..036be46b52 100644 --- a/translations/ja-JP/data/reusables/organizations/security-overview-feature-specific-page.md +++ b/translations/ja-JP/data/reusables/organizations/security-overview-feature-specific-page.md @@ -1 +1 @@ -1. あるいは、左のサイドバーを使ってセキュリティ機能ごとに情報をフィルタリングすることもできます。 On each page, you can use filters that are specific to that feature to fine-tune your search. +1. あるいは、左のサイドバーを使ってセキュリティ機能ごとに情報をフィルタリングすることもできます。 それぞれのページで、その機能に固有のフィルタを使って検索を微調整できます。 diff --git a/translations/ja-JP/data/reusables/organizations/security.md b/translations/ja-JP/data/reusables/organizations/security.md index 89ff33e85f..0cc94addb5 100644 --- a/translations/ja-JP/data/reusables/organizations/security.md +++ b/translations/ja-JP/data/reusables/organizations/security.md @@ -1,5 +1,5 @@ {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %} -1. In the "Security" section of the sidebar, click **{% octicon "shield-lock" aria-label="The shield-lock icon" %} Authentication security**. +1. サイドバーの”Security（セキュリティ）"セクションで、**{% octicon "shield-lock" aria-label="The shield-lock icon" %} Authentication security（認証のセキュリティ）**をクリックしてください。 {% else %} 1. 左のサイドバーで**Organization security（Organizationのセキュリティ）**をクリックしてください。 diff --git a/translations/ja-JP/data/reusables/organizations/specific_team.md b/translations/ja-JP/data/reusables/organizations/specific_team.md index b89839874c..1eff35c7eb 100644 --- a/translations/ja-JP/data/reusables/organizations/specific_team.md +++ b/translations/ja-JP/data/reusables/organizations/specific_team.md @@ -1,5 +1,5 @@ 1. Organization 名の下で、クリックします -{% octicon "people" aria-label="The people icon" %} **Teams**. +{% octicon "people" aria-label="The people icon" %} **Teams**をクリックしてください。 {% ifversion fpt or ghes > 3.2 or ghec %} ![Teamsタブ](/assets/images/help/organizations/organization-teams-tab-with-overview.png) {% else %} diff --git a/translations/ja-JP/data/reusables/organizations/ssh-ca-ghec-only.md b/translations/ja-JP/data/reusables/organizations/ssh-ca-ghec-only.md index 2c29a6bf3e..b23c3cf51b 100644 --- a/translations/ja-JP/data/reusables/organizations/ssh-ca-ghec-only.md +++ b/translations/ja-JP/data/reusables/organizations/ssh-ca-ghec-only.md @@ -1,7 +1,7 @@ {% ifversion fpt or ghec %} {% note %} -**Note:** To use SSH certificate authorities, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} +**ノート:** SSH認証局を使用するには、Organizationは{% data variables.product.prodname_ghe_cloud %}を使わなければなりません。 {% data reusables.enterprise.link-to-ghec-trial %} {% endnote %} diff --git a/translations/ja-JP/data/reusables/organizations/team_maintainers_can.md b/translations/ja-JP/data/reusables/organizations/team_maintainers_can.md index 19aae1ce72..2a5f088d27 100644 --- a/translations/ja-JP/data/reusables/organizations/team_maintainers_can.md +++ b/translations/ja-JP/data/reusables/organizations/team_maintainers_can.md @@ -11,5 +11,5 @@ - [OrganizationメンバーのTeamからの削除](/articles/removing-organization-members-from-a-team) - [既存のTeamメンバーのチームメンテナへの昇格](/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member) - リポジトリへのTeamのアクセス権の削除 -- [Manage code review settings for the team](/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team){% ifversion fpt or ghec %} +- [Teamのコードレビュー設定の管理](/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team){% ifversion fpt or ghec %} - [プルリクエストのスケジュールされたリマインダーの管理](/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-pull-requests){% endif %} diff --git a/translations/ja-JP/data/reusables/organizations/teams.md b/translations/ja-JP/data/reusables/organizations/teams.md index 2216fc95e7..24158f7cec 100644 --- a/translations/ja-JP/data/reusables/organizations/teams.md +++ b/translations/ja-JP/data/reusables/organizations/teams.md @@ -1,5 +1,5 @@ 1. Organization 名の下で、クリックします -{% octicon "people" aria-label="The people icon" %} **Teams**. +{% octicon "people" aria-label="The people icon" %} **Teams**をクリックしてください。 {% ifversion fpt or ghes > 3.2 or ghec %} ![OrganizationページのTeamsタブ](/assets/images/help/organizations/organization-teams-tab-with-overview.png) {% else %} diff --git a/translations/ja-JP/data/reusables/organizations/teams_sidebar.md b/translations/ja-JP/data/reusables/organizations/teams_sidebar.md index 5c9046cef1..dc73e47017 100644 --- a/translations/ja-JP/data/reusables/organizations/teams_sidebar.md +++ b/translations/ja-JP/data/reusables/organizations/teams_sidebar.md @@ -1,5 +1,5 @@ {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %} -1. In the "Access" section of the sidebar, click **{% octicon "comment-discussion" aria-label="The comment-discussion icon" %} Team discussions**. +1. サイドバーの"Access（アクセス）"セクションで、**{% octicon "comment-discussion" aria-label="The comment-discussion icon" %} Team discussions（Teamのディスカッション）**をクリックしてください。 {% else %} 1. Settings（設定）サイドバーで、**Teams**をクリックしてください。 ![Organizationの設定サイドバー内のTeamsタブ](/assets/images/help/settings/settings-sidebar-team-settings.png) {% endif %} diff --git a/translations/ja-JP/data/reusables/organizations/verified-domains.md b/translations/ja-JP/data/reusables/organizations/verified-domains.md index 018cf275ad..5d1e662fe3 100644 --- a/translations/ja-JP/data/reusables/organizations/verified-domains.md +++ b/translations/ja-JP/data/reusables/organizations/verified-domains.md @@ -1,5 +1,5 @@ {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %} -1. In the "Security" section of the sidebar, click **{% octicon "verified" aria-label="The verified icon" %} Verified and approved domains**. +1. サイドバーの”Security（セキュリティ）"セクションで、**{% octicon "verified" aria-label="The verified icon" %} Verified and approved domains（検証済み及び承認済みドメイン）**をクリックしてください。 {% else %} 1. 左のサイドバーで**Verified & approved domains（検証済み及び承認済みドメイン）**をクリックしてください。 !["検証済み及び承認済みドメイン"タブ](/assets/images/help/organizations/verified-domains-button.png) {% endif %} diff --git a/translations/ja-JP/data/reusables/package_registry/authenticate-packages.md b/translations/ja-JP/data/reusables/package_registry/authenticate-packages.md index a766f6e96d..5ca4e91584 100644 --- a/translations/ja-JP/data/reusables/package_registry/authenticate-packages.md +++ b/translations/ja-JP/data/reusables/package_registry/authenticate-packages.md @@ -4,4 +4,4 @@ You can use a personal access token (PAT) to authenticate to {% data variables.p To authenticate to a {% data variables.product.prodname_registry %} registry within a {% data variables.product.prodname_actions %} workflow, you can use: - `GITHUB_TOKEN` to publish packages associated with the workflow repository. -- a PAT to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). +- a PAT with at least `packages:read` scope to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). diff --git a/translations/ja-JP/data/reusables/package_registry/authenticate-to-container-registry-steps.md b/translations/ja-JP/data/reusables/package_registry/authenticate-to-container-registry-steps.md index cdd67653b4..468bb23641 100644 --- a/translations/ja-JP/data/reusables/package_registry/authenticate-to-container-registry-steps.md +++ b/translations/ja-JP/data/reusables/package_registry/authenticate-to-container-registry-steps.md @@ -1,22 +1,21 @@ -1. 実行したいタスクに対して適切なスコープを持つ新しい個人アクセストークン（PAT）を作成してください。 OrganizationがSSOを必須としている場合は、新しいトークンでSSOを有効化しなければなりません。 +1. Create a new personal access token (PAT) with the appropriate scopes for the tasks you want to accomplish. If your organization requires SSO, you must enable SSO for your new token. {% warning %} - **ノート:** デフォルトでは、ユーザインターフェース内で個人アクセストークン（PAT）に対して`write:packages`スコープを選択すると、`repo`スコープも選択されます。 `repo`は不要に広いアクセス権を提供するので、特にGitHub Actionsのワークフローでの利用は避けることをおすすめします。 詳しい情報については「[GitHub Actionsのためのセキュリティ強化](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)」を参照してください。 As a workaround, you can select just the `write:packages` scope for your PAT in the user interface with this url: `https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/settings/tokens/new?scopes=write:packages`. + **Note:** By default, when you select the `write:packages` scope for your personal access token (PAT) in the user interface, the `repo` scope will also be selected. The `repo` scope offers unnecessary and broad access, which we recommend you avoid using for GitHub Actions workflows in particular. For more information, see "[Security hardening for GitHub Actions](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)." As a workaround, you can select just the `write:packages` scope for your PAT in the user interface with this url: `https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/settings/tokens/new?scopes=write:packages`. {% endwarning %} - - コンテナイメージをダウンロードし、そのメタデータを読むためには`read:packages`スコープを選択してください。 - - コンテナイメージのダウンロードとアップロード、及びそのメタデータの読み書きのためには、`write:packages`スコープを選択してください。 - - コンテナイメージを削除するには`delete:packages`スコープを選択してください。 + - Select the `read:packages` scope to download container images and read their metadata. + - Select the `write:packages` scope to download and upload container images and read and write their metadata. + - Select the `delete:packages` scope to delete container images. - 詳しい情報については[コマンドラインのための個人のアクセストークンの作成](/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)を参照してください。 + For more information, see "[Creating a personal access token for the command line](/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)." -2. PATを保存してください。 PATは環境変数として保存することをおすすめします。 +2. Save your PAT. We recommend saving your PAT as an environment variable. ```shell $ export CR_PAT=YOUR_TOKEN ``` -3. コンテナタイプにあったCLIを利用して、 -{% data variables.product.prodname_container_registry %} service at `{% data reusables.package_registry.container-registry-hostname %}`. +3. Using the CLI for your container type, sign in to the {% data variables.product.prodname_container_registry %} service at `{% data reusables.package_registry.container-registry-hostname %}`. {% raw %} ```shell $ echo $CR_PAT | docker login {% endraw %}{% data reusables.package_registry.container-registry-hostname %}{% raw %} -u USERNAME --password-stdin diff --git a/translations/ja-JP/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md b/translations/ja-JP/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md deleted file mode 100644 index a54f9a0844..0000000000 --- a/translations/ja-JP/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md +++ /dev/null @@ -1,11 +0,0 @@ -{% ifversion fpt or ghec or ghes > 3.4 %} - -To authenticate to the {% data variables.product.prodname_container_registry %} within a {% data variables.product.prodname_actions %} workflow, use the `GITHUB_TOKEN` for the best security and experience. If your workflow is using a personal access token (PAT) to authenticate to `{% data reusables.package_registry.container-registry-hostname %}`, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. - -{% ifversion fpt or ghec %}For guidance on updating your workflows that authenticate to `{% data reusables.package_registry.container-registry-hostname %}` with a personal access token, see "[Upgrading a workflow that accesses `ghcr.io`](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#upgrading-a-workflow-that-accesses-ghcrio)."{% endif %} - -For more information about the `GITHUB_TOKEN`, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)." - -If you're using the {% data variables.product.prodname_container_registry %} in actions, follow our security best practices at "[Security hardening for GitHub Actions](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)." - -{% endif %} diff --git a/translations/ja-JP/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md b/translations/ja-JP/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md new file mode 100644 index 0000000000..d60327d06a --- /dev/null +++ b/translations/ja-JP/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md @@ -0,0 +1,7 @@ +If your workflow is using a personal access token (PAT) to authenticate to a registry, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. + +{% ifversion fpt or ghec %}For guidance on updating your workflows that authenticate to a registry with a personal access token, see "[Upgrading a workflow that accesses a registry using a PAT](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#upgrading-a-workflow-that-accesses-a-registry-using-a-pat)."{% endif %} + +`GITHUB_TOKEN`に関する詳しい情報については「[ワークフロー中の認証](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)」を参照してください。 + +For more information about the best practises when using a registry in actions, see "[Security hardening for GitHub Actions](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)." diff --git a/translations/ja-JP/data/reusables/package_registry/checksum-maven-plugin.md b/translations/ja-JP/data/reusables/package_registry/checksum-maven-plugin.md index 3d980144e1..6f6ce5940d 100644 --- a/translations/ja-JP/data/reusables/package_registry/checksum-maven-plugin.md +++ b/translations/ja-JP/data/reusables/package_registry/checksum-maven-plugin.md @@ -1,5 +1,5 @@ {%- ifversion ghae %} -1. In the `plugins` element of the *pom.xml* file, add the [checksum-maven-plugin](https://search.maven.org/artifact/net.nicoulaj.maven.plugins/checksum-maven-plugin) plugin, and configure the plugin to send at least SHA-256 checksums. +1. *pom.xml*ファイルの`plugins`要素に[checksum-maven-plugin](https://search.maven.org/artifact/net.nicoulaj.maven.plugins/checksum-maven-plugin)プラグインを追加し、そのプラグインを最低でもSHA-256のチェックサムを送信するように設定してください。 ```xml diff --git a/translations/ja-JP/data/reusables/package_registry/container-registry-benefits.md b/translations/ja-JP/data/reusables/package_registry/container-registry-benefits.md index 079a514846..37b9ce623e 100644 --- a/translations/ja-JP/data/reusables/package_registry/container-registry-benefits.md +++ b/translations/ja-JP/data/reusables/package_registry/container-registry-benefits.md @@ -1 +1 @@ -The {% data variables.product.prodname_container_registry %} stores container images within your organization or personal account, and allows you to associate an image with a repository. You can choose whether to inherit permissions from a repository, or set granular permissions independently of a repository. You can also access public container images anonymously. +{% data variables.product.prodname_container_registry %}はコンテナイメージをOrganizationもしくは個人アカウントに保存し、イメージをリポジトリに関連づけられるようにしてくれます。 リポジトリから権限を継承するか、もしくはリポジトリからは独立して詳細な権限を設定するかを選択できます。 匿名でパブリックなコンテナイメージにアクセスすることもできます。 diff --git a/translations/ja-JP/data/reusables/package_registry/container-registry-ghes-beta.md b/translations/ja-JP/data/reusables/package_registry/container-registry-ghes-beta.md index c4942faf78..83ca21a6e5 100644 --- a/translations/ja-JP/data/reusables/package_registry/container-registry-ghes-beta.md +++ b/translations/ja-JP/data/reusables/package_registry/container-registry-ghes-beta.md @@ -2,7 +2,7 @@ {% note %} -**ノート**: {% data variables.product.prodname_container_registry %}は{% data variables.product.product_name %} に対して現在ベータであり、変更されることがあります。 +**Note**: {% data variables.product.prodname_container_registry %} is currently in beta for {% data variables.product.product_name %} and subject to change. Both {% data variables.product.prodname_registry %} and subdomain isolation must be enabled to use {% data variables.product.prodname_container_registry %}. For more information, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)." diff --git a/translations/ja-JP/data/reusables/package_registry/container-registry-ghes-migration-availability.md b/translations/ja-JP/data/reusables/package_registry/container-registry-ghes-migration-availability.md index 5d685d5f4f..5f9faa2ba7 100644 --- a/translations/ja-JP/data/reusables/package_registry/container-registry-ghes-migration-availability.md +++ b/translations/ja-JP/data/reusables/package_registry/container-registry-ghes-migration-availability.md @@ -1 +1 @@ -{% data variables.product.product_name %} 3.6 supports migration for Docker images stored in organizations. A future release will support migration of user-owned images. \ No newline at end of file +{% data variables.product.product_name %} 3.6はOrganizationに保存されたDockerイメージの移行をサポートしています。 将来のリリースでは、ユーザが所有するイメージの移行がサポートされます。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/package_registry/container-registry-replaces-docker-registry.md b/translations/ja-JP/data/reusables/package_registry/container-registry-replaces-docker-registry.md index 5b6ed35c4f..a7c1cb7ca1 100644 --- a/translations/ja-JP/data/reusables/package_registry/container-registry-replaces-docker-registry.md +++ b/translations/ja-JP/data/reusables/package_registry/container-registry-replaces-docker-registry.md @@ -1 +1 @@ -The {% data variables.product.prodname_container_registry %} replaces {% data variables.product.company_short %}'s Docker registry. +{% data variables.product.prodname_container_registry %}は{% data variables.product.company_short %}のDockerレジストリを置き換えます。 diff --git a/translations/ja-JP/data/reusables/package_registry/no-graphql-to-delete-packages.md b/translations/ja-JP/data/reusables/package_registry/no-graphql-to-delete-packages.md new file mode 100644 index 0000000000..cbab609f2b --- /dev/null +++ b/translations/ja-JP/data/reusables/package_registry/no-graphql-to-delete-packages.md @@ -0,0 +1 @@ +{% ifversion fpt or ghec %} The {% data variables.product.prodname_registry %} GraphQL API does not support containers or Docker images that use the package namespace `https://ghcr.io/OWNER/PACKAGE-NAME`, or npm images that use the package namespace `https://npm.pkg.github.com/OWNER/PACKAGE-NAME`.{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/package_registry/package-settings-from-org-level.md b/translations/ja-JP/data/reusables/package_registry/package-settings-from-org-level.md index 291daa3623..1af0a18c85 100644 --- a/translations/ja-JP/data/reusables/package_registry/package-settings-from-org-level.md +++ b/translations/ja-JP/data/reusables/package_registry/package-settings-from-org-level.md @@ -1,7 +1,7 @@ 1. {% data variables.product.prodname_dotcom %}で、Organizationのメインページにアクセスしてください。 2. Organization名の下で、**Packages（パッケージ）**をクリックしてください。 {% ifversion fpt or ghes > 3.2 or ghec %} - ![Packages tab on org landing page](/assets/images/help/package-registry/org-tab-for-packages-with-overview-tab.png) + ![Organizationのランディングページのパッケージタブ](/assets/images/help/package-registry/org-tab-for-packages-with-overview-tab.png) {% else %} - ![Packages tab on org landing page](/assets/images/help/package-registry/org-tab-for-packages.png) + ![Organizationのランディングページのパッケージタブ](/assets/images/help/package-registry/org-tab-for-packages.png) {% endif %} diff --git a/translations/ja-JP/data/reusables/package_registry/package-settings-from-user-level.md b/translations/ja-JP/data/reusables/package_registry/package-settings-from-user-level.md index 26f96ee7be..eb2fe28f45 100644 --- a/translations/ja-JP/data/reusables/package_registry/package-settings-from-user-level.md +++ b/translations/ja-JP/data/reusables/package_registry/package-settings-from-user-level.md @@ -1,3 +1,3 @@ -1. On {% data variables.product.prodname_dotcom %}, navigate to the main page of your personal account. -2. In the top right corner of {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, click your profile photo, then click **Your profile**. ![プロフィール画像](/assets/images/help/profile/top_right_avatar.png) +1. {% data variables.product.prodname_dotcom %}で、個人アカウントのメインページにアクセスしてください。 +2. {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}の右上から、プロフィール写真をクリックし、続いて**Your profile（あなたのプロフィール）**をクリックしてください。 ![プロフィール画像](/assets/images/help/profile/top_right_avatar.png) 3. プロフィールページで、右上の**Packages（パッケージ）**をクリックしてください。 ![プロフィールページのパッケージオプション](/assets/images/help/package-registry/packages-from-user-profile.png) diff --git a/translations/ja-JP/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md b/translations/ja-JP/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md index 65e43b5b60..6099483240 100644 --- a/translations/ja-JP/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md +++ b/translations/ja-JP/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md @@ -1,16 +1,16 @@ -{% ifversion ghes > 3.1 or ghes < 3.5 %} +{% ifversion ghes < 3.5 %} -In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server 3.5 or later may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 when you upgrade from an earlier release to 3.5 or later. A fix for 3.5 and later will be available in an upcoming patch release. +In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server 3.5 or later may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 when you upgrade from an earlier release to 3.5 or later. A fix will be available in upcoming patch releases. -To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). [Updated: 2022-08-16] +To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). [Updated: 2022-08-26] -{% elsif ghes > 3.4 or ghes < 3.7 %} +{% elsif ghes = 3.5 or ghes = 3.6 %} -In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server {{ currentVersion }} may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 as you upgrade to the latest release. To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). +In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server {{ allVersions[currentVersion].currentRelease }} may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 as you upgrade to the latest release. To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). - To display the missing alerts for all repositories owned by an organization, organization owners can navigate to the organization's **Code security and analysis** settings, then click **Enable all** for secret scanning. 詳しい情報については、「[Organization のセキュリティおよび分析設定を管理する](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories)」を参照してください。 - To display the missing alerts for an individual repository, people with admin access to the repository can disable then enable secret scanning for the repository. 詳しい情報については「[リポジトリのセキュリティ及び分析の設定の管理](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)」を参照してください。 -A fix will be available in an upcoming patch release. [Updated: 2022-08-16] +A fix will be available in an upcoming patch release. [Updated: 2022-08-26] {% endif %} diff --git a/translations/ja-JP/data/reusables/secret-scanning/push-protection-web-ui-choice.md b/translations/ja-JP/data/reusables/secret-scanning/push-protection-web-ui-choice.md index 892e8aafe4..c6fc780e28 100644 --- a/translations/ja-JP/data/reusables/secret-scanning/push-protection-web-ui-choice.md +++ b/translations/ja-JP/data/reusables/secret-scanning/push-protection-web-ui-choice.md @@ -2,5 +2,12 @@ Web UIを使ってプッシュ保護としてのSecret scanningが有効化さ シークレットの場所に関する情報がページ上部のバナーに表示され、簡単にシークレットが見つけられるよう、ファイル内でシークレットに下線が引かれます。 +{% ifversion push-protection-custom-link-orgs %} + + ![Secret scanningのプッシュ保護のため、Web UIでコミットがブロックされていることが表示されているスクリーンショット](/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-blocked-banner-with-link.png) + +{% else %} + ![Secret scanningのプッシュ保護のため、Web UIでコミットがブロックされていることが表示されているスクリーンショット](/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-blocked-banner.png) - \ No newline at end of file + +{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/user-settings/organizations.md b/translations/ja-JP/data/reusables/user-settings/organizations.md index 416bd818e6..95541d9a17 100644 --- a/translations/ja-JP/data/reusables/user-settings/organizations.md +++ b/translations/ja-JP/data/reusables/user-settings/organizations.md @@ -1,5 +1,5 @@ {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %} -1. In the "Access" section of the sidebar, click **{% octicon "organization" aria-label="The organization icon" %} Organizations**. +1. サイドバーの"Access（アクセス）"セクションで、**{% octicon "organization" aria-label="The organization icon" %} Organizations**をクリックしてください。 {% else %} 1. ユーザ設定サイドバーで**Organizations**をクリックしてください。 ![Organization用のユーザ設定](/assets/images/help/settings/settings-user-orgs.png) {% endif %} diff --git a/translations/ja-JP/data/ui.yml b/translations/ja-JP/data/ui.yml index d4791b403e..15033b93c8 100644 --- a/translations/ja-JP/data/ui.yml +++ b/translations/ja-JP/data/ui.yml @@ -32,6 +32,9 @@ search: search_error: An error occurred trying to perform the search. description: Enter a search term to find it in the GitHub Documentation. label: Search GitHub Docs + results_found: Found {n} results in {s}ms + results_page: This is page {page} of {pages}. + nothing_found: Nothing found 😿 homepage: explore_by_product: 製品で調べる version_picker: バージョン diff --git a/translations/ja-JP/data/variables/product.yml b/translations/ja-JP/data/variables/product.yml index 6fbf7da460..50b0c6e46b 100644 --- a/translations/ja-JP/data/variables/product.yml +++ b/translations/ja-JP/data/variables/product.yml @@ -112,6 +112,10 @@ prodname_registry: 'GitHub Packages' prodname_container_registry: 'コンテナレジストリ' prodname_docker_registry_namespace: '{% ifversion fpt or ghec %}`docker.pkg.github.com`{% elsif ghes or ghae %}docker.HOSTNAME{% endif %}' prodname_container_registry_namespace: '{% ifversion fpt or ghec %}`ghcr.io`{% elsif ghes or ghae %}containers.HOSTNAME{% endif %}' +prodname_npm_registry: 'npmレジストリ' +prodname_ghcr_and_npm_registry: '{% data variables.product.prodname_container_registry %}{% ifversion packages-npm-v2 %} and {% data variables.product.prodname_npm_registry %}{% endif %}' +prodname_ghcr_or_npm_registry: '{% data variables.product.prodname_container_registry %}{% ifversion packages-npm-v2 %} or {% data variables.product.prodname_npm_registry %}{% endif %}' +prodname_ghcr_and_npm_registry_full: '{% data variables.product.prodname_container_registry %} (`ghcr.io`){% ifversion packages-npm-v2 %} and {% data variables.product.prodname_npm_registry %} (`npm.pkg.github.com`){% endif %}' #GitHub Insights prodname_insights: 'GitHub Insights' #GitHub Sponsors diff --git a/translations/log/cn-resets.csv b/translations/log/cn-resets.csv index c373d5c38f..c1f1be1dd8 100644 --- a/translations/log/cn-resets.csv +++ b/translations/log/cn-resets.csv @@ -5,10 +5,10 @@ translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-gith translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile.md,broken liquid tags translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile.md,broken liquid tags translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard.md,broken liquid tags -translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company.md,rendering error translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username.md,rendering error translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-the-default-branch-name-for-your-repositories.md,broken liquid tags translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/about-organization-membership.md,broken liquid tags +translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md,rendering error translations/zh-CN/content/actions/automating-builds-and-tests/about-continuous-integration.md,broken liquid tags translations/zh-CN/content/actions/deployment/about-deployments/deploying-with-github-actions.md,broken liquid tags translations/zh-CN/content/actions/hosting-your-own-runners/about-self-hosted-runners.md,rendering error @@ -116,7 +116,6 @@ translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/a translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md,broken liquid tags translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token.md,broken liquid tags translations/zh-CN/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md,broken liquid tags -translations/zh-CN/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md,broken liquid tags translations/zh-CN/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md,broken liquid tags translations/zh-CN/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md,broken liquid tags translations/zh-CN/content/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security.md,broken liquid tags @@ -204,7 +203,6 @@ translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/ins translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop.md,broken liquid tags translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md,broken liquid tags translations/zh-CN/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md,broken liquid tags -translations/zh-CN/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md,broken liquid tags translations/zh-CN/content/developers/apps/getting-started-with-apps/about-apps.md,broken liquid tags translations/zh-CN/content/developers/apps/getting-started-with-apps/migrating-oauth-apps-to-github-apps.md,broken liquid tags translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md,broken liquid tags @@ -290,7 +288,6 @@ translations/zh-CN/content/rest/activity/events.md,broken liquid tags translations/zh-CN/content/rest/apps/marketplace.md,broken liquid tags translations/zh-CN/content/rest/enterprise-admin/index.md,broken liquid tags translations/zh-CN/content/rest/guides/basics-of-authentication.md,Listed in localization-support#489 -translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md,broken liquid tags translations/zh-CN/content/rest/overview/other-authentication-methods.md,Listed in localization-support#489 translations/zh-CN/content/rest/overview/other-authentication-methods.md,broken liquid tags translations/zh-CN/content/rest/overview/resources-in-the-rest-api.md,Listed in localization-support#489 @@ -396,7 +393,6 @@ translations/zh-CN/data/reusables/notifications/vulnerable-dependency-notificati translations/zh-CN/data/reusables/organizations/team-synchronization.md,broken liquid tags translations/zh-CN/data/reusables/package_registry/authenticate-packages.md,broken liquid tags translations/zh-CN/data/reusables/package_registry/authenticate-to-container-registry-steps.md,broken liquid tags -translations/zh-CN/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md,broken liquid tags translations/zh-CN/data/reusables/package_registry/docker_registry_deprecation_status.md,Listed in localization-support#489 translations/zh-CN/data/reusables/package_registry/next-steps-for-packages-enterprise-setup.md,broken liquid tags translations/zh-CN/data/reusables/package_registry/packages-cluster-support.md,broken liquid tags diff --git a/translations/log/es-resets.csv b/translations/log/es-resets.csv index 5cbc661020..d561a0b00f 100644 --- a/translations/log/es-resets.csv +++ b/translations/log/es-resets.csv @@ -168,6 +168,7 @@ translations/es-ES/content/get-started/using-github/keyboard-shortcuts.md,Listed translations/es-ES/content/github-cli/github-cli/github-cli-reference.md,Listed in localization-support#489 translations/es-ES/content/graphql/overview/breaking-changes.md,Listed in localization-support#489 translations/es-ES/content/index.md,Listed in localization-support#489 +translations/es-ES/content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md,broken liquid tags translations/es-ES/content/issues/tracking-your-work-with-issues/about-task-lists.md,Listed in localization-support#489 translations/es-ES/content/issues/tracking-your-work-with-issues/creating-an-issue.md,Listed in localization-support#489 translations/es-ES/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md,Listed in localization-support#489 @@ -292,6 +293,7 @@ translations/es-ES/content/repositories/working-with-files/managing-large-files/ translations/es-ES/content/rest/activity/events.md,broken liquid tags translations/es-ES/content/rest/enterprise-admin/index.md,broken liquid tags translations/es-ES/content/rest/overview/other-authentication-methods.md,Listed in localization-support#489 +translations/es-ES/content/rest/secret-scanning.md,broken liquid tags translations/es-ES/content/search-github/searching-on-github/searching-code.md,Listed in localization-support#489 translations/es-ES/content/search-github/searching-on-github/searching-commits.md,Listed in localization-support#489 translations/es-ES/content/search-github/searching-on-github/searching-in-forks.md,Listed in localization-support#489 diff --git a/translations/log/ja-resets.csv b/translations/log/ja-resets.csv index 62d4c663f8..adcd5f479c 100644 --- a/translations/log/ja-resets.csv +++ b/translations/log/ja-resets.csv @@ -5,9 +5,9 @@ translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-gith translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile.md,broken liquid tags translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account.md,broken liquid tags translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard.md,broken liquid tags -translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company.md,broken liquid tags translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-the-default-branch-name-for-your-repositories.md,broken liquid tags translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-personal-account-repository.md,broken liquid tags +translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md,broken liquid tags translations/ja-JP/content/actions/creating-actions/about-custom-actions.md,broken liquid tags translations/ja-JP/content/actions/creating-actions/publishing-actions-in-github-marketplace.md,broken liquid tags translations/ja-JP/content/actions/hosting-your-own-runners/about-self-hosted-runners.md,broken liquid tags @@ -69,7 +69,6 @@ translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md,broken liquid tags translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md,broken liquid tags translations/ja-JP/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md,broken liquid tags -translations/ja-JP/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md,broken liquid tags translations/ja-JP/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md,Listed in localization-support#489 translations/ja-JP/content/billing/index.md,broken liquid tags translations/ja-JP/content/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security.md,broken liquid tags @@ -199,7 +198,6 @@ translations/ja-JP/content/packages/working-with-a-github-packages-registry/work translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md,broken liquid tags translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md,broken liquid tags translations/ja-JP/content/pages/getting-started-with-github-pages/about-github-pages.md,broken liquid tags -translations/ja-JP/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md,broken liquid tags translations/ja-JP/content/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site.md,broken liquid tags translations/ja-JP/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md,broken liquid tags translations/ja-JP/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md,broken liquid tags @@ -216,6 +214,7 @@ translations/ja-JP/content/rest/activity/events.md,broken liquid tags translations/ja-JP/content/rest/apps/oauth-applications.md,broken liquid tags translations/ja-JP/content/rest/enterprise-admin/index.md,broken liquid tags translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md,broken liquid tags +translations/ja-JP/content/rest/quickstart.md,broken liquid tags translations/ja-JP/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md,broken liquid tags translations/ja-JP/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md,broken liquid tags translations/ja-JP/content/support/learning-about-github-support/about-github-premium-support.md,broken liquid tags @@ -300,22 +299,40 @@ translations/ja-JP/data/reusables/dotcom_billing/lfs-remove-data.md,broken liqui translations/ja-JP/data/reusables/education/access-github-community-exchange.md,broken liquid tags translations/ja-JP/data/reusables/education/apply-for-team.md,broken liquid tags translations/ja-JP/data/reusables/enterprise-accounts/actions-tab.md,broken liquid tags +translations/ja-JP/data/reusables/enterprise-accounts/emu-password-reset-session.md,broken liquid tags +translations/ja-JP/data/reusables/enterprise-accounts/emu-short-summary.md,broken liquid tags translations/ja-JP/data/reusables/enterprise-accounts/hooks-tab.md,Listed in localization-support#489 translations/ja-JP/data/reusables/enterprise-accounts/hooks-tab.md,rendering error translations/ja-JP/data/reusables/enterprise-accounts/messages-tab.md,Listed in localization-support#489 translations/ja-JP/data/reusables/enterprise-accounts/messages-tab.md,rendering error translations/ja-JP/data/reusables/enterprise-accounts/pages-tab.md,broken liquid tags +translations/ja-JP/data/reusables/enterprise-licensing/verified-domains-license-sync.md,broken liquid tags translations/ja-JP/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md,broken liquid tags translations/ja-JP/data/reusables/enterprise_management_console/advanced-security-license.md,broken liquid tags translations/ja-JP/data/reusables/enterprise_management_console/badge_indicator.md,broken liquid tags +translations/ja-JP/data/reusables/enterprise_user_management/disclaimer-for-git-read-access.md,broken liquid tags translations/ja-JP/data/reusables/gated-features/code-scanning.md,Listed in localization-support#489 +translations/ja-JP/data/reusables/gated-features/codespaces-classroom-articles.md,broken liquid tags +translations/ja-JP/data/reusables/gated-features/codespaces.md,broken liquid tags +translations/ja-JP/data/reusables/gated-features/copilot.md,broken liquid tags +translations/ja-JP/data/reusables/gated-features/emus.md,broken liquid tags +translations/ja-JP/data/reusables/gated-features/enterprise-accounts.md,broken liquid tags +translations/ja-JP/data/reusables/gated-features/secret-scanning-partner.md,broken liquid tags +translations/ja-JP/data/reusables/gated-features/secret-scanning.md,broken liquid tags +translations/ja-JP/data/reusables/gated-features/security-overview.md,broken liquid tags +translations/ja-JP/data/reusables/getting-started/actions.md,broken liquid tags +translations/ja-JP/data/reusables/getting-started/api.md,broken liquid tags translations/ja-JP/data/reusables/getting-started/marketplace.md,broken liquid tags +translations/ja-JP/data/reusables/github-connect/authorize-connection.md,broken liquid tags translations/ja-JP/data/reusables/large_files/can-include-lfs-objects-archives.md,broken liquid tags translations/ja-JP/data/reusables/large_files/rejected_pushes.md,broken liquid tags translations/ja-JP/data/reusables/large_files/storage_assets_location.md,broken liquid tags translations/ja-JP/data/reusables/marketplace/install-buy.md,broken liquid tags +translations/ja-JP/data/reusables/organizations/team-synchronization.md,broken liquid tags translations/ja-JP/data/reusables/package_registry/authenticate-packages.md,broken liquid tags -translations/ja-JP/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md,broken liquid tags +translations/ja-JP/data/reusables/package_registry/authenticate-to-container-registry-steps.md,broken liquid tags +translations/ja-JP/data/reusables/package_registry/container-registry-ghes-beta.md,broken liquid tags +translations/ja-JP/data/reusables/package_registry/container-registry-migration-namespaces.md,broken liquid tags translations/ja-JP/data/reusables/package_registry/next-steps-for-packages-enterprise-setup.md,broken liquid tags translations/ja-JP/data/reusables/package_registry/packages-cluster-support.md,broken liquid tags translations/ja-JP/data/reusables/package_registry/public-or-private-packages.md,Listed in localization-support#489 diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md index ef70e2e6bd..1babc6b945 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md @@ -1,6 +1,6 @@ --- title: Configurar e gerenciar sua conta pessoal no GitHub -intro: 'Você pode gerenciar as configurações da sua conta pessoal em {% data variables.product.prodname_dotcom %}, incluindo preferências de e-mail, acesso do colaborador a repositórios pessoais e associações da organização.' +intro: 'Você pode gerenciar as configurações da sua conta pessoal em {% ifversion fpt or ghec or ghes %}{% data variables.product.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %}, incluindo preferências de e-mail, acesso a repositórios pessoais e associações da organização. Você também pode gerir a própria conta.' shortTitle: Contas pessoais redirect_from: - /categories/setting-up-and-managing-your-github-user-account @@ -15,6 +15,7 @@ topics: - Accounts children: - /managing-personal-account-settings + - /managing-your-personal-account - /managing-email-preferences - /managing-access-to-your-personal-repositories - /managing-your-membership-in-organizations diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md index 690f54559d..a020911dd7 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md @@ -1,6 +1,6 @@ --- title: Gerenciar configurações de conta de usuário -intro: 'Você pode alterar várias configurações de sua conta pessoal, inclusive alterar seu nome de usuário e excluir sua conta.' +intro: 'Você pode gerenciar configurações para sua conta pessoal, incluindo seu tema, nome de usuário, branchpadrão, acessibilidade e configurações de segurança.' redirect_from: - /categories/29/articles - /categories/user-accounts @@ -19,9 +19,6 @@ children: - /managing-your-theme-settings - /managing-your-tab-size-rendering-preference - /changing-your-github-username - - /merging-multiple-personal-accounts - - /converting-a-user-into-an-organization - - /deleting-your-personal-account - /permission-levels-for-a-personal-account-repository - /permission-levels-for-a-project-board-owned-by-a-personal-account - /managing-accessibility-settings @@ -29,7 +26,6 @@ children: - /managing-security-and-analysis-settings-for-your-personal-account - /managing-access-to-your-personal-accounts-project-boards - /integrating-jira-with-your-personal-projects - - /best-practices-for-leaving-your-company - /what-does-the-available-for-hire-checkbox-do shortTitle: Configurações de conta pessoal --- diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings.md index 9719068936..9d730f08f4 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings.md @@ -35,7 +35,7 @@ Você pode querer usar um tema escuro para reduzir o consumo de energia em certo {%- ifversion ghes = 3.5 %} {% note %} - **Note**: The light high contrast theme was unavailable in {% data variables.product.product_name %} 3.5.0, 3.5.1, 3.5.2, and 3.5.3. The theme is available in 3.5.4 and later. Para obter mais informações sobre atualizações, entre em contato com o administrador do site. + **Observação**: O tema de alto contraste claro não estava disponível em {% data variables.product.product_name %} 3.5.0, 3.5.1, 3.5.2 e 3.5.3. O tema está disponível na versão 3.5.4 e posterior. Para obter mais informações sobre atualizações, entre em contato com o administrador do site. Para obter mais informações sobre como determinar a versão do {% data variables.product.product_name %} que você está usando, consulte "[Sobre as versões de {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs#github-enterprise-server)" {% endnote %} diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md similarity index 96% rename from translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company.md rename to translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md index cc714f9807..e55d6f2599 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md @@ -6,6 +6,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/best-practices-for-leaving-your-company - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/best-practices-for-leaving-your-company - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/best-practices-for-leaving-your-company + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company versions: fpt: '*' ghec: '*' diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md similarity index 95% rename from translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization.md rename to translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md index 2976a52527..fdf72ae686 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md @@ -7,6 +7,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/converting-a-user-into-an-organization - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization intro: Você pode converter a sua conta pessoal em uma organização. Isso permite permissões mais granulares para repositórios que pertencem à organização. versions: fpt: '*' @@ -66,5 +67,5 @@ Você também pode converter sua conta pessoal diretamente em uma organização. ## Leia mais - "[Configurar equipes](/articles/setting-up-teams)" -{% ifversion fpt or ghec %}- "[Convidar usuários para ingressar na organização](/articles/inviting-users-to-join-your-organization)"{% endif %} +{% ifversion fpt or ghec %}- "[Convidar usuários para participar da sua organização](/articles/inviting-users-to-join-your-organization)"{% endif %} - "[Acessar uma organização](/articles/accessing-an-organization)" diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md similarity index 63% rename from translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account.md rename to translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md index 6ad4a153fd..786e626f24 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md @@ -1,39 +1,53 @@ --- title: Excluindo sua conta pessoal -intro: 'Você pode excluir sua conta pessoal em {% data variables.product.product_name %} a qualquer momento.' +intro: 'Você pode excluir sua conta pessoal em {% data variables.product.product_location %} a qualquer momento.' redirect_from: - /articles/deleting-a-user-account - /articles/deleting-your-user-account - /github/setting-up-and-managing-your-github-user-account/deleting-your-user-account - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account versions: fpt: '*' ghes: '*' ghec: '*' topics: - Accounts -shortTitle: Excluir sua conta pessoal +shortTitle: Excluir sua conta --- -A exclusão da sua conta pessoal irá remover todos os repositórios, bifurcações de repositórios privados, wikis, problemas, pull requests e páginas pertencentes à sua conta. {% ifversion fpt or ghec %} Os problemas e as pull requests que você criou e os comentários que você fez nos repositórios pertencentes a outros usuários não serão excluídos. Em vez disso, eles serão associados ao nosso [usuário fantasma](https://github.com/ghost).{% else %}Os problemas e as pull requests que você criou e os comentários que você fez nos repositórios pertencentes a outros usuários não serão excluídos.{% endif %} +## Sobre a exclusão da sua conta pessoal -{% ifversion fpt or ghec %} Ao excluir a sua conta, nós paramos de cobrar você. O endereço de e-mail associado à conta fica disponível para uso com uma conta diferente no {% data variables.product.product_location %}. Após 90 dias, o nome da conta também fica disponível para qualquer pessoa usar em uma nova conta. {% endif %} +A exclusão da sua conta pessoal irá remover todos os repositórios, bifurcações de repositórios privados, wikis, problemas, pull requests e páginas pertencentes à sua conta. {% ifversion fpt or ghec %}Os problemas e pull requests que você criou e os comentários que você fez em repositórios pertencentes a outros usuários não serão excluídos. Seus recursos e comentários serão associados ao [usuário fantasma](https://github.com/ghost).{% else %}Os problemas e pull requests que você criou e os comentários que você fez em repositórios pertencentes a outros usuários não serão excluídos.{% endif %} + +{% ifversion ghec %} + +{% note %} + +**Observação**: Se sua empresa gerencia sua conta e você efetua o login em {% data variables.product.product_location %} por meio do provedor de identidade da sua empresa (IdP), você não poderá excluir sua conta. Para obter mais informações, consulte "[Sobre {% data variables.product.prodname_emus %}](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)". + +{% endnote %} + +{% endif %} + +{% ifversion fpt or ghec %}Ao excluir a sua conta, nós cancelamos a cobrança. O endereço de e-mail associado à conta fica disponível para uso com uma conta diferente no {% data variables.product.product_location %}. Após 90 dias, o nome da conta também fica disponível para qualquer pessoa usar em uma nova conta. {% endif %} Se você é o único proprietário de uma organização, você deverá transferir a propriedade para outra pessoa ou excluir a organização antes de excluir a sua conta pessoal. Se houver outros proprietários na organização, você deverá remover-se da organização antes de excluir sua conta pessoal. -Para obter mais informações, consulte: +Para obter mais informações, consulte os seguintes artigos. + - "[Transferir a propriedade da organização](/articles/transferring-organization-ownership)" - "[Excluir uma conta de organização](/articles/deleting-an-organization-account)" - "[Remover a si mesmo de uma organização](/articles/removing-yourself-from-an-organization/)" ## Fazer backup dos dados da conta -Antes de excluir sua conta pessoal, faça uma cópia de todos os repositórios, bifurcações privadas, wikis, problemas e pull requests pertencentes à sua conta. +Antes de excluir sua conta pessoal, faça uma cópia de todos os repositórios, bifurcações privadas, wikis, problemas e pull requests pertencentes à sua conta. Para obter mais informações, consulte "[Backup de um repositório](/repositories/archiving-a-github-repository/backing-up-a-repository)". {% warning %} -**Aviso:** Uma vez que excluída a sua conta pessoal, o GitHub não poderá restaurar seu conteúdo. +**Aviso:** Após a exclusão da sua conta pessoal, {% ifversion fpt or ghec %}{% data variables.product.company_short %}{% elsif ghes or ghae %}dono de uma empresa{% endif %} não poderá restaurar seu conteúdo. {% endwarning %} diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md new file mode 100644 index 0000000000..8ac2f738ff --- /dev/null +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md @@ -0,0 +1,19 @@ +--- +title: Gerenciando sua conta pessoal +intro: 'Você pode gerenciar sua conta pessoal em {% ifversion fpt or ghec or ghes %}{% data variables.product.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %}. Por exemplo, você pode {% ifversion fpt or ghec %}gerenciar várias contas, {% endif %}converter uma conta para uma organização{% ifversion fpt or ghec or ghes %}ou excluir uma conta{% endif %}.' +shortTitle: Gerenciar conta pessoal +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - Accounts +children: + - /managing-multiple-accounts + - /merging-multiple-personal-accounts + - /converting-a-user-into-an-organization + - /best-practices-for-leaving-your-company + - /deleting-your-personal-account +--- + diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md new file mode 100644 index 0000000000..f934ef389c --- /dev/null +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md @@ -0,0 +1,105 @@ +--- +title: Gerenciando várias contas +intro: 'Se você usa uma estação de trabalho para contribuir com projetos para mais de uma conta em {% data variables.product.product_location %}, você pode modificar sua configuração do Git para simplificar o processo de contribuição.' +versions: + feature: multiple-accounts-one-workstation +topics: + - Accounts + - Git + - GitHub +shortTitle: Gerenciar várias contas +--- + +## Sobre a gestão de múltiplas contas + +Em alguns casos, é possível que você precise usar várias contas em {% data variables.product.product_location %}. Por exemplo, você pode ter uma conta pessoal para contribuições de código aberto, e seu empregador também pode criar e gerenciar uma conta de usuário para você dentro de uma empresa. + +Você não pode usar seu {% data variables.product.prodname_managed_user %} para contribuir para projetos públicos em {% data variables.product.product_location %}, portanto, você deve contribuir para esses recursos usando a sua conta pessoal. Para obter mais informações, consulte "[Sobre {% data variables.product.prodname_emus %}]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#abilities-and-restrictions-of-managed-user-accounts){% ifversion fpt %}" na documentação de {% data variables.product.prodname_ghe_cloud %}.{% elsif ghec %}{% endif %} + +Se você quiser usar uma estação de trabalho para contribuir a partir de ambas as contas, você poderá simplificar a contribuição com o Git usando uma mistura de protocolos para acessar os dados do repositório ou usando credenciais em cada repositório. + +{% warning %} + +**Aviso**: Tenha cuidado quando você usar uma estação de trabalho para contribuir com duas contas separadas. A gestão de duas ou mais contas pode aumentar a possibilidade de fuga de código interno para o público. + +{% endwarning %} + +Se você não tiver de usar um {% data variables.product.prodname_managed_user %}, {% data variables.product.company_short %} recomenda que você use uma conta pessoal para todo seu trabalho em {% data variables.product.product_location %}. Com uma única conta pessoal, você pode contribuir para uma combinação de projetos pessoais, de código aberto ou projetos profissionais usando uma identidade. Outras pessoas podem convidar a conta para contribuir tanto em repositórios individuais quanto em repositórios pertencentes a uma organização, e a conta pode ser integrante de múltiplas organizações ou empresas. + +## Contribuindo para duas contas usando HTTPS e SSH + +Se você contribuir com duas contas de uma estação de trabalho, você poderá acessar repositórios usando um protocolo e credenciais diferentes para cada conta. + +O Git pode usar o protocolo HTTPS ou SSH para acessar e atualizar os dados nos repositórios em {% data variables.product.product_location %}. O protocolo que você usa para clonar um repositório determina quais credenciais sua estação de trabalho usará para efetuar a autenticação quando você acessar o repositório. Com esta abordagem ao gerenciamento de contas, você armazena as credenciais para uma conta usar para conexões HTTPS e faz upload de uma chave SSH na outra conta para conexões SSH. + +Você pode encontrar ambos URLs HTTPS ou SSH para clonar um repositório em {% data variables.product.product_name %}. Para obter mais informações, consulte "[Clonar um repositório](/repositories/creating-and-managing-repositories/cloning-a-repository)". + +Para obter mais informações sobre o uso de SSH para acessar repositórios no {% data variables.product.product_name %}, consulte "[Conectando ao {% data variables.product.prodname_dotcom %} com SSH](/authentication/connecting-to-github-with-ssh)". + +## Contribuindo para várias contas usando HTTPS e PATs + +Como alternativa, se você quiser usar o protocolo HTTPS para ambas as contas, você pode usar diferentes tokens de acesso pessoal (PAT) para cada conta, configurando o Git para armazenar credenciais diferentes para cada repositório. + +{% mac %} + +{% data reusables.git.open-terminal %} +{% data reusables.git.confirm-credential-manager %} +{% data reusables.git.clear-the-stored-credentials %} + {% data reusables.git.no-credential-manager %} + - Se a saída for `osxkeychain`, você irá usar o keychain do macOS. Para limpar as credenciais, informe o seguinte comando. + + ```shell{:copy} + git credential-osxkeychain erase https://github.com + ``` + {% data reusables.git.clear-stored-gcm-credentials %} +{% data reusables.git.cache-on-repository-path %} +{% data reusables.accounts.create-personal-access-tokens %} +{% data reusables.git.provide-credentials %} + +{% endmac %} + +{% windows %} + +1. Abra o Git Bash. +{% data reusables.git.confirm-credential-manager %} +{% data reusables.git.clear-the-stored-credentials %} + {% data reusables.git.no-credential-manager %} + {% data reusables.git.clear-stored-gcm-credentials %} + - Se a saída for `wincred`, você irá usar o Gerenciador de Credenciais do Windows. Para limpar as credenciais, informe o seguinte comando. + + ```shell{:copy} + cmdkey /delete:LegacyGeneric:target=git:https://github.com + ``` +{% data reusables.git.cache-on-repository-path %} +{% data reusables.accounts.create-personal-access-tokens %} +{% data reusables.git.provide-credentials %} + +{% endwindows %} + +{% linux %} + +{% data reusables.git.open-terminal %} +{% data reusables.git.confirm-credential-manager %} +{% data reusables.git.clear-the-stored-credentials %} + {% data reusables.git.no-credential-manager %} + {% data reusables.git.clear-stored-gcm-credentials %} +{% data reusables.git.cache-on-repository-path %} +{% data reusables.accounts.create-personal-access-tokens %} +{% data reusables.git.provide-credentials %} + +{% endlinux %} + +## Contribuindo para várias contas usando SSH e `GIT_SSH_COMMAND` + +Se você quiser usar o protocolo SSH para ambas as contas, você poderá usar chaves SSH diferentes para cada conta. Para obter mais informações sobre como usar SSH, consulte "[Conectando a {% data variables.product.prodname_dotcom %} com SSH](/authentication/connecting-to-github-with-ssh)". + +Para usar uma chave SSH diferente para diferentes repositórios que você clonar na sua estação de trabalho, você deve escrever uma função de wrapper do shell para operações do Git. A função deve executar as seguintes etapas. +1. Determine o nome completo do repositório com proprietário, usando um comando como `git config --get remote.origin.url`. +2. Escolha a chave SSH correta para autenticação. +3. Modifique `GIT_SSH_COMMAND` apropriadamente. Para obter mais informações sobre `GIT_SSH_COMMAND`, consulte [Variáveis de Ambiente](https://git-scm.com/docs/git#Documentation/git.txt-codeGITSSHCOMMANDcode) na documentação do Git. + +Por exemplo, o comando a seguir define a variável de ambiente `GIT_SSH_COMMAND` para especificar um comando SSH que usa o arquivo de chave privada em **_PATH/TO/KEY/FILE_** para autenticação para clonar o repositório denominado **_OWNER_**/**_REPOSITORY_** em {% data variables.product.product_location %}. + +
    +GIT_SSH_COMMAND='ssh -i PATH/TO/KEY/FILE -o IdentitiesOnly=yes' git clone git@github.com:OWNER/REPOSITORY
+
    diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md similarity index 94% rename from translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts.md rename to translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md index 559408d40b..aab9ad3b60 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md @@ -8,12 +8,13 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/merging-multiple-user-accounts - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts versions: fpt: '*' ghec: '*' topics: - Accounts -shortTitle: Fazer merge de várias contas pessoais +shortTitle: Fazer merge de múltiplas contas --- {% tip %} diff --git a/translations/pt-BR/content/actions/creating-actions/metadata-syntax-for-github-actions.md b/translations/pt-BR/content/actions/creating-actions/metadata-syntax-for-github-actions.md index 875d81b681..c595ffe054 100644 --- a/translations/pt-BR/content/actions/creating-actions/metadata-syntax-for-github-actions.md +++ b/translations/pt-BR/content/actions/creating-actions/metadata-syntax-for-github-actions.md @@ -354,7 +354,7 @@ runs: #### `runs.steps[*].with` -**Opcional** Um `mapa` dos parâmetros de entrada definidos pela ação. Cada parâmetro de entrada é um par chave/valor. Parâmetros de entrada são definidos como variáveis de ambiente. A variável é precedida por INPUT_ e convertida em letras maiúsculas. +**Opcional** Um `mapa` dos parâmetros de entrada definidos pela ação. Cada parâmetro de entrada é um par chave/valor. Para obter mais informações, consulte [Exemplo: Especificando as entradas](#example-specifying-inputs). ```yaml runs: @@ -475,7 +475,7 @@ runs: ## `branding` -**Optional** You can use a color and [Feather](https://feathericons.com/) icon to create a badge to personalize and distinguish your action. Os selos são exibidos ao lado do nome da sua ação em [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=actions). +**Opcional** Você pode usar uma cor e o ícone [Pena](https://feathericons.com/) para criar um emblema para personalizar e distinguir sua ação. Os selos são exibidos ao lado do nome da sua ação em [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=actions). ### Exemplo: Configurar a marca para uma ação diff --git a/translations/pt-BR/content/actions/creating-actions/publishing-actions-in-github-marketplace.md b/translations/pt-BR/content/actions/creating-actions/publishing-actions-in-github-marketplace.md index f7fededa6b..49c4a1a9a5 100644 --- a/translations/pt-BR/content/actions/creating-actions/publishing-actions-in-github-marketplace.md +++ b/translations/pt-BR/content/actions/creating-actions/publishing-actions-in-github-marketplace.md @@ -38,8 +38,10 @@ Você pode adicionar a ação que você criou em {% data variables.product.prodn Para compartilhar uma nova versão e publicar a ação em {% data variables.product.prodname_marketplace %}, siga essas instruções: {% data reusables.repositories.navigate-to-repo %} -1. Se um repositório contiver um arquivo de metadados da ação (`action.yml` ou `action.yaml`), você verá um banner para publicar a ação em {% data variables.product.prodname_marketplace %}. Clique em **Elaborar uma versão**. ![Publique esta ação no botão marketplace](/assets/images/help/repository/publish-github-action-to-markeplace-button.png) -1. Selecione **Publicar esta ação em {% data variables.product.prodname_marketplace %}**. Se não for possível marcar a caixa de seleção **Publicar esta ação em {% data variables.product.prodname_marketplace %}**, você deverá ler e aceitar o Contrato {% data variables.product.prodname_marketplace %} primeiro. ![Selecione publicar no "Marketplace"](/assets/images/help/repository/marketplace_actions_publish.png) +1. Acesse o arquivo de metadados de ação no repositório (`action.yml` ou `. aml`), e você verá um banner para publicar a ação em {% data variables.product.prodname_marketplace %}. Clique em **Elaborar uma versão**. + + ![Publicar esta ação no botão marketplace](/assets/images/help/repository/publish-github-action-to-marketplace-button.png) +1. Em "Ação de versão", selecione a caixa de seleção para publicar a ação em {% data variables.product.prodname_marketplace %}. Se você não puder selecionar a caixa de seleção, primeiro clique no link para ler e aceitar o Contrato de Desenvolvedor de {% data variables.product.prodname_marketplace %}. ![Selecione publicar no "Marketplace"](/assets/images/help/repository/marketplace_actions_publish.png) 1. Se as etiquetas do seu arquivo de metadados tiverem algum problema, você receberá uma mensagem de erro. ![Veja a notificação](/assets/images/help/repository/marketplace_actions_fixerrors.png) 1. Se você ver alguma sugestão na tela, resolva-as atualizando o arquivo de metadados. Após a conclusão, você receberá a mensagem "Tudo está OK". ![Corrigir erros](/assets/images/help/repository/marketplace_actions_looksgood.png) 1. Escolha uma "categoria primária" e, opcionalmente, "outra categoria", que ajudará as pessoas a encontrar a sua ação em {% data variables.product.prodname_marketplace %}. ![Escolha a categoria](/assets/images/help/repository/marketplace_actions_categories.png) diff --git a/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md b/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md index de8f1ed041..869340012d 100644 --- a/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md +++ b/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md @@ -73,6 +73,7 @@ O exemplo a seguir do token do OIDC usa um assunto (`sub`) que faz referência a "repository": "octo-org/octo-repo", "repository_owner": "octo-org", "actor_id": "12", + "repo_visibility": private, "repository_id": "74", "repository_owner_id": "65", "run_id": "example-run-id", @@ -130,6 +131,7 @@ O token também inclui reivindicações personalizadas fornecidas por {% data va | `job_workflow_ref` | Este é o caminho ref para o fluxo de trabalho reutilizável usado por este trabalho. Para obter mais informações, consulte "["Usando o OpenID Connect com fluxos de trabalho reutilizáveis"](/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows). | | `ref` | _(Referência)_ A ref do git que acionou a execução do fluxo de trabalho. | | `ref_type` | O tipo de `ref`, por exemplo: "branch". | +| `repo_visibility` | A visibilidade do repositório onde o fluxo de trabalho está em execução. Aceita os seguintes valores: `interno`, `privado` ou `público`. | | `repositório` | O repositório de onde o fluxo de trabalho está sendo executado. | | `repository_id` | O ID do repositório de onde o fluxo de trabalho está sendo executado. | | `repository_owner` | O nome da organização em que o `repositório` é armazenado. | @@ -145,11 +147,11 @@ Com o OIDC, um fluxo de trabalho de {% data variables.product.prodname_actions % As reivindicações de Audiência e Assunto são normalmente usadas em combinação, ao definir as condições da função/recursos em nuvem para definir o escopo do seu acesso aos fluxos de trabalho do GitHub. - **Audiência**: Por padrão, esse valor usa a URL do proprietário da organização ou do repositório. Isto pode ser usado para definir uma condição para que apenas os fluxos de trabalho na organização específica possam acessar a função da nuvem. -- **Assunto**: Tem um formato predefinido e é uma concatenação de alguns dos metadados da chave sobre o fluxo de trabalho como, por exemplo, a organização, repositório, branch de {% data variables.product.prodname_dotcom %} ou [`trabalho`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idenvironment) associado. Consulte "[Exemplo de assunto reivindica](#example-subject-claims)" para ver como a reivindicação de assunto é montada a partir de metadados concatenados. +- **Subject**: By default, has a predefined format and is a concatenation of some of the key metadata about the workflow, such as the {% data variables.product.prodname_dotcom %} organization, repository, branch, or associated [`job`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idenvironment) environment. Consulte "[Exemplo de assunto reivindica](#example-subject-claims)" para ver como a reivindicação de assunto é montada a partir de metadados concatenados. -Há também muitas reivindicações adicionais compatíveis com o token do OIDC que também podem ser usadas para definir essas condições. +If you need more granular trust conditions, you can customize the issuer (`iss`) and subject (`sub`) claims that are included with the JWT. For more information, see "[Customizing the token claims](#customizing-the-token-claims)". -Além disso, seu provedor de nuvem poderia permitir que você atribuísse uma função aos tokens de acesso, permitindo que você especifique ainda mais permissões granulares. +There are also many additional claims supported in the OIDC token that can be used for setting these conditions. Além disso, seu provedor de nuvem poderia permitir que você atribuísse uma função aos tokens de acesso, permitindo que você especifique ainda mais permissões granulares. {% note %} @@ -240,6 +242,197 @@ curl -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" "$ACTIONS_ID_TOK {% data reusables.actions.oidc-permissions-token %} +{% ifversion actions-oidc-hardening-config %} +## Personalizando as reivindicações de token + +Você pode garantir a segurança da sua configuração do OIDC personalizando as reivindicações incluídas com a JWT. These customisations allow you to define more granular trust conditions on your cloud roles when allowing your workflows to access resources hosted in the cloud: + +{% ifversion ghec %} - For an additional layer of security, you can append the `issuer` url with your enterprise slug. This lets you set conditions on the issuer (`iss`) claim, configuring it to only accept JWT tokens from a unique `issuer` URL that must include your enterprise slug.{% endif %} +- You can standardize your OIDC configuration by setting conditions on the subject (`sub`) claim that require JWT tokens to originate from a specific repository, reusable workflow, or other source. +- You can define granular OIDC policies by using additional OIDC token claims, such as `repository_id` and `repo_visibility`. Para obter mais informações, consulte "[Compreendendo o token do OIDC](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#understanding-the-oidc-token)". + +To customize these claim formats, organization and repository admins can use the REST API endpoints described in the following sections. + +{% ifversion ghec %} + +### Mudando para um URL único de token + +Por padrão, o JWT é emitido pelo provedor de OIDC de {% data variables.product.prodname_dotcom %} em `https://token.actions.githubusercontent.com`. Esse caminho é apresentado ao seu provedor de nuvem usando o valor de `iss` no JWT. + +Os administradores da empresa podem fortalecer a configuração do OIDC, configurando as suas empresas para receber tokens de um URL único em `https://api. ithub.com/enterprises//actions/oidc/customization/issuer`. Substitua `` pelo valor slug da sua empresa. + +Essa configuração significa que sua empresa receberá o token do OIDC de uma URL exclusiva, e você poder, a em seguida, configurar seu provedor de nuvem para aceitar apenas tokens dessa URL. Isso ajuda a garantir que apenas os repositórios da empresa podem acessar seus recursos na nuvem usando OIDC. + +Para ativar essa configuração para sua empresa, um administrador da empresa deve usar o ponto de extremidade `/enterprises/{enterprise}/actions/oidc/customization/issuer` e especificar `"include_enterprise_slug": true` no texto da solicitação. Para obter mais informações, consulte "[Definir a política do emissor personalizado do OIDC de {% data variables.product.prodname_actions %} para uma empresa](/rest/actions/oidc#set-the-github-actions-oidc-custom-issuer-policy-for-an-enterprise)". + +Depois que esta configuração for aplicada, o JWT conterá o valor atualizado de `iss`. No exemplo a seguir, a chave `iss` usa `octocat-inc` como seu valor de `enterpriseSlug`: + +```json +{ + "jti": "6f4762ed-0758-4ccb-808d-ee3af5d723a8" + "sub": "repo:octocat-inc/private-server:ref:refs/heads/main" + "aud": "http://octocat-inc.example/octocat-inc" + "enterprise": "octocat-inc" + "iss": "https://api.github.com/enterprises/octocat-inc/actions/oidc/customization/issuer", + "bf": 1755350653, + "exp": 1755351553, + "iat": 1755351253 +} +``` + +{% endif %} + +### Personalizando as reivindicações de assunto para uma organização + +Para configurar a segurança, conformidade e padronização em toda a organização, você pode personalizar as reivindicações padrão que atendem às suas condições de acesso necessárias. Se seu provedor de nuvem é compatível com condições para reivindicações de objetos, você pode criar uma condição que verifica se o valor `sub` corresponde ao caminho do fluxo de trabalho reutilizável, como `"job_workflow_ref: "octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main""`. O formato exato irá variar dependendo da configuração do OIDC do seu provedor de nuvem. Para configurar a condição de correspondência em {% data variables.product.prodname_dotcom %}, você pode usar a API REST para exigir que a reivindicação do `sub` deva sempre incluir uma reivindicação personalizada, como `job_workflow_ref`. Para obter mais informações, consulte "[Definir o modelo de personalização para uma reivindicação de assunto do OIDC para uma organização](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization)". + +Customizing the claims results in a new format for the entire `sub` claim, which replaces the default predefined `sub` format in the token described in "[Example subject claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims)." + +Os modelos de exemplo a seguir demonstram várias maneiras de personalizar a reivindicação de assunto. Para configurar estas configurações em {% data variables.product.prodname_dotcom %}, os administradores da organização usam a API REST para especificar uma lista de reclamações que devem ser incluídas no assunto (`sub`) da reclamação. {% data reusables.actions.use-request-body-api %} + +To customize your subject claims, you should first create a matching condition in your cloud provider's OIDC configuration, before customizing the configuration using the REST API. Uma vez que a configuração estiver concluída, cada vez que um novo trabalho for executado, o token do OIDC gerado durante aquele trabalho seguirá o novo modelo de personalização. Se a condição de correspondência não existir na configuração do OIDC do provedor de nuvem antes de o trabalho ser executado, o token gerado poderá não ser aceito pelo provedor da nuvem, já que as condições da nuvem podem não ser sincronizadas. + +{% note %} + +**Observação**: Quando o modelo de organização é aplicado, ele não afetará nenhum repositório existente que já usa o OIDC. For existing repositories, as well as any new repositories that are created after the template has been applied, the repository owner will need to opt-in to receive this configuration. Para obter mais informações, consulte "[Definir o sinalizador da opção de participação da personalização da reivindicação de assunto do OIDC para um repositório](/rest/actions/oidc#set-the-opt-in-flag-of-an-oidc-subject-claim-customization-for-a-repository)". + +{% endnote %} + +#### Exemplo: Permitir o repositório com base na visibilidade e no proprietário + +This example template allows the `sub` claim to have a new format, using `repository_owner` and `repository_visibility`: + +```json +{ + "include_claim_keys": [ + "repository_owner", + "repository_visibility" + ] +} +``` + +Na configuração OIDC do seu provedor de nuvem, configure a condição `sub` para exigir que as reivindicações inculam valores específicos para `repository_owner` e `repository_visibility`. Por exemplo: `"repository_owner: "monalisa":repository_visibility:private"`. The approach lets you restrict cloud role access to only private repositories within an organization or enterprise. + +#### Exemplo: Permitir acesso a todos os repositórios com um proprietário específico + +This example template enables the `sub` claim to have a new format with only the value of `repository_owner`. {% data reusables.actions.use-request-body-api %} + +```json +{ + "include_claim_keys": [ + "repository_owner" + ] +} + +``` + +Na configuração OIDC do seu provedor de nuvem, configure a condição `sub` para exigir que as reivindicações incluam um valor específico para `repository_owner`. Por exemplo: `"repository_owner: "monalisa""` + +#### Exemplo: Exigindo um fluxo de trabalho reutilizável + +This example template allows the `sub` claim to have a new format that contains the value of the `job_workflow_ref` claim. This enables an enterprise to use [reusable workflows](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims) to enforce consistent deployments across its organizations and repositories. + +{% data reusables.actions.use-request-body-api %} + +```json + { + "include_claim_keys": [ + "job_workflow_ref" + ] + } +``` + +Na configuração OIDC do seu provedor de nuvem, configure a condição `sub` para exigir que as reivindicações incluam um valor específico para `job_workflow_ref`. Por exemplo: `"job_workflow_ref: "octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main""`. + +#### Exemplo: Exigindo um fluxo de trabalho reutilizável e outras reivindicações + +The following example template combines the requirement of a specific reusable workflow with additional claims. {% data reusables.actions.use-request-body-api %} + +This example also demonstrates how to use `"context"` to define your conditions. This is the part that follows the repository in the [default `sub` format](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims). For example, when the job references an environment, the context contains: `environment:`. + +```json +{ + "include_claim_keys": [ + "repo", + "context", + "job_workflow_ref" + ] +} +``` + +Na configuração OIDC do seu provedor de nuvem, configure a condição `sub` para exigir que as reivindicações inculam valores específicos para `repo`, `context` e `job_workflow_ref`. + +This customization template requires that the `sub` uses the following format: `repo::environment::job_workflow_ref:`. For example: `"sub": "repo:octo-org/octo-repo:environment:prod:job_workflow_ref:octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main"` + +#### Exemplo: Conceder acesso a um repositório específico + +Este modelo de exemplo permite conceder acesso na nuvem a todos os fluxos de trabalho em um repositório específico, em todos os branches, tags e ambientes. Para ajudar a melhorar a segurança, combine este modelo com a URL do emissor personalizado descrita em "[Personalizando a URL do token para uma empresa](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-url-for-an-enterprise)." + +{% data reusables.actions.use-request-body-api %} + +```json +{ + "include_claim_keys": [ + "repo" + ] +} +``` + +Na configuração do OIDC do seu provedor de nuvem, configure a condição `sub` para exigir uma reivindicação de `repositório` que corresponda ao valor necessário. + +#### Exemplo: Usando GUIDs gerados pelo sistema + +Este modelo de exemplo habilita as reivindicações previsíveis do OIDC com GUIDs geradas pelo sistema que não mudam entre renomeações de entidades (como renomear um repositório). {% data reusables.actions.use-request-body-api %} + +```json + { + "include_claim_keys": [ + "repository_id" + ] + } +``` + +Na configuração do OIDC do seu provedor de nuvem, configure a condição `sub` para exigir a reivindicação de `repository_id` que corresponde ao valor necessário. + +ou: + +```json +{ + "include_claim_keys": [ + "repository_owner_id" + ] +} +``` + +Na configuração do OIDC do seu provedor de nuvem, configure a condição `sub` para exigir uma reivindicação de `repository_owner_id` que corresponde ao valor necessário. + +#### Redefinindo suas personalizações + +Este modelo de exemplo redefine as reivindicações de assunto para o formato padrão. {% data reusables.actions.use-request-body-api %} Este modelo efetivamente opta por não participar de qualquer política de personalização no nível da organização. + +```json +{ + "include_claim_keys": [ + "repo", + "context" + ] +} +``` + +Na configuração do OIDC do seu provedor de nuvem, configure a condição `sub` para exigir que as reivindicações incluam valores específicos para `repo` e `contexto`. + +#### Usando as reivindicações de assunto padrão + +Para repositórios que podem receber uma política de reivindicação de assuntos da sua organização, o proprietário do repositório pode optar por não participar e, em vez disso, usar o formato padrão `sub` para solicitação. Para configurar isso, o administrador do repositório deve usar o ponto de extremidade da API REST em"[Definir o sinalizador para não participar da personalização da reivindicação de assunto do OIDC para um repositório](/rest/actions/oidc#set-the-opt-out-flag-of-an-oidc-subject-claim-customization-for-a-repository)" com o seguinte texto de solicitação: + +```json +{ + "use_default": true +} +``` + +{% endif %} + ## Atualizando seus fluxos de trabalho para o OIDC Agora você pode atualizar seus fluxos de trabalho do YAML para usar tokens de acesso do OIDC em vez de segredos. Os provedores de nuvem populares publicaram suas ações de login oficiais que facilitam o seu início de sessão com o OIDC. Para obter mais informações sobre a atualização dos seus fluxos de trabalho, consulte os guias específicos da nuvem listados abaixo em "[Habilitando o OpenID Connect para o seu provedor de nuvem](#enabling-openid-connect-for-your-cloud-provider)". diff --git a/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md b/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md index 7014cad6f4..954201a345 100644 --- a/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md +++ b/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md @@ -32,10 +32,52 @@ Este guia fornece uma visão geral sobre como configurar o cofre HashiCorp para Para usar OIDC com oHashiCorp Vault, você deverá adicionar uma configuração de confiança ao provedor do OIDC de {% data variables.product.prodname_dotcom %}. Para obter mais informações, consulte a [documentação](https://www.vaultproject.io/docs/auth/jwt) do HashiCorp Vault. -Configure o cofre para aceitar tokens web do JSON (JWT) para a autenticação: -- Para o `oidc_discovery_url`, use {% ifversion ghes %}`https://HOSTNAME/_services/token`{% else %}`https://token.actions.githubusercontent.com`{% endif %} -- Para `bound_issuer`, use {% ifversion ghes %}`https://HOSTNAME/_services/token`{% else %}`https://token.actions.githubusercontent.com`{% endif %} -- Certifique-se de que `bound_subject` esteja corretamente definido para seus requisitos de segurança. Para obter mais informações, consulte ["Configurar a confiança do OIDC com a nuvem"](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#configuring-the-oidc-trust-with-the-cloud) e [`hashicorp/vault-action`](https://github.com/hashicorp/vault-action). +Para configurar o seu servidor Vault para aceitar o JSON Web Tokens (JWT) para autenticação: + +1. Habilite o método de autenticação `JWT` e use `gravar` para aplicar a configuração do seu Vault. Para os parâmetros `oidc_discovery_url` e `bound_issuer`, use {% ifversion ghes %}`https://HOSTNAME/_services/token`{% else %}`https://token.actions.githubusercontent.com`{% endif %}. Estes parâmetros permitem que o servidor do Vault verifique os JSON Web Tokens recebidos (JWT) durante o processo de autenticação. + + ```sh{:copy} + vault auth enable jwt + ``` + + ```sh{:copy} + vault write auth/jwt/config \ + bound_issuer="{% ifversion ghes %}https://HOSTNAME/_services/token{% else %}https://token.actions.githubusercontent.com{% endif %}" \ + oidc_discovery_url="{% ifversion ghes %}https://HOSTNAME/_services/token{% else %}https://token.actions.githubusercontent.com{% endif %}" + ``` +2. Configure uma política que concede apenas acesso aos caminhos específicos que seus fluxos de trabalho serão usados para recuperar segredos. Para políticas mais avançadas, consulte o as [Políticas documentação](https://www.vaultproject.io/docs/concepts/policies) do HashiCorp Vault. + + ```sh{:copy} + vault policy write myproject-production - <`: Substitua isso pela URL do seu HashiCorp Vault. +- ``: Substitu-o pelo Namespace que você colocou no HashiCorp Vault. Por exemplo: `administrador`. - ``: Substitua isso pela função que você definiu no relacionamento de confiança do HashiCorp Vault. -- ``: Substitua isso pela audiência que você definiu no relacionamento de confiança do HashiCorp Vault. -- ``: Substitua isso pelo caminho para o segredo que você está recuperando do HashiCorp Vault. Por exemplo: `secret/data/ci npmToken`. +- ``: Substitua isso pelo caminho para o segredo que você está recuperando do HashiCorp Vault. Por exemplo: `secret/data/production/ci npmToken`. ```yaml{:copy} jobs: - retrieve-secret: - steps: - - name: Retrieve secret from Vault - uses: hashicorp/vault-action@v2.4.0 - with: - url: - role: - method: jwt - jwtGithubAudience: - secrets: + retrieve-secret: + runs-on: ubuntu-latest + permissions: + id-token: write + contents: read + steps: + - name: Retrieve secret from Vault + uses: hashicorp/vault-action@v2.4.0 + with: + method: jwt + url: + namespace: + role: + secrets: - - name: Use secret from Vault - run: | - # This step has access to the secret retrieved above; see hashicorp/vault-action for more details. + - name: Use secret from Vault + run: | + # This step has access to the secret retrieved above; see hashicorp/vault-action for more details. +``` + +{% note %} + +**Observação**: + +- Se o seu servidor do Vault não puder ser acessado a partir da rede pública, considere usar um executor auto-hospedado com outros [auth methods](https://www.vaultproject.io/docs/auth) disponíveis para o Vault. Para obter mais informações, consulte "[Sobre os executores auto-hospedados](/actions/hosting-your-own-runners/about-self-hosted-runners)." +- `` deve ser definido para uma implantação da empresa do Vault (incluindo HCP Vault). Para obter mais informações, consulte [Namespace do Vault](https://www.vaultproject.io/docs/enterprise/namespaces). + +{% endnote %} + +### Revogando o token de acesso + +Por padrão, o servidor do Vault irá revogar automaticamente os tokens de acesso quando seu TTL vencer, portanto, você não precisa revogar manualmente os tokens de acesso. No entanto, se você deseja revogar os tokens de acesso imediatamente após o seu trabalho terminar ou falhar, você poderá revogar manualmente o token emitido usando a API do Vault [](https://www.vaultproject.io/api/auth/token#revoke-a-token-self). + +1. Defina a opção `exportToken` como `verdadeiro` (padrão: `falso`). Isso exporta o token de acesso do Vault emitido como uma variável de ambiente: `VAULT_TOKEN`. +2. Adicione um passo para chamar a API do Vault [Revogar um Token (Self)](https://www.vaultproject.io/api/auth/token#revoke-a-token-self) para revogar o token de acesso. + +```yaml{:copy} +jobs: + retrieve-secret: + runs-on: ubuntu-latest + permissions: + id-token: write + contents: read + steps: + - name: Retrieve secret from Vault + uses: hashicorp/vault-action@v2.4.0 + with: + exportToken: true + method: jwt + url: + role: + secrets: + + - name: Use secret from Vault + run: | + # This step has access to the secret retrieved above; see hashicorp/vault-action for more details. + + - name: Revoke token + # This step always runs at the end regardless of the previous steps result + if: always() + run: | + curl -X POST -sv -H "X-Vault-Token: {% raw %}${{ env.VAULT_TOKEN }}{% endraw %}" \ + /v1/auth/token/revoke-self ``` diff --git a/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md b/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md index 92913fb61b..4d48131871 100644 --- a/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md +++ b/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md @@ -23,11 +23,18 @@ topics: Em vez de copiar e colar trabalhos de implantação de um fluxo de trabalho para outro, é possível criar um fluxo de trabalho reutilizável que executa as etapas de implantação. Um fluxo de trabalho reutilizável pode ser usado por outro fluxo de trabalho se ele cumprir um dos requisitos de acesso descritos em "[Reutilizando os fluxos de trabalho](/actions/learn-github-actions/reusing-workflows#access-to-reusable-workflows)". -Quando combinado com o OpenID Connect (OIDC), os fluxos de trabalho reutilizáveis permitem que você aplique implantações consistentes no seu repositório, organização ou empresa. Você pode fazer isso definindo condições de confiança nas funções da nuvem com base em fluxos de trabalho reutilizáveis. +You should be familiar with the concepts described in "\[Reusing workflows\](/actions/learn-github-actions/reusing-workflows" and "[About security hardening with OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)." -Para criar condições de confiança com base em fluxos de trabalho reutilizáveis, o seu provedor de nuvem deve ser compatível com reivindicações personalizadas para `job_workflow_ref`. Isso permite que seu provedor de nuvem identifique de qual repositório veio originalmente. Se o seu provedor de nuvem é compatível apenas as reivindicações padrão (_audiência_ e _assunto_), não poderá determinar que o trabalho teve origem no repositório do fluxo de trabalho reutilizável. Os provedores de nuvem que sao compatíveis com `job_workflow_ref` incluem Google Cloud Platform e HashiCorp Vault. +## Defining the trust conditions -Antes de prosseguir, você deve estar familiarizado com os conceitos de [fluxos de trabalho reutilizáveis](/actions/learn-github-actions/reusing-workflows) e [OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect). +Quando combinado com o OpenID Connect (OIDC), os fluxos de trabalho reutilizáveis permitem que você aplique implantações consistentes no seu repositório, organização ou empresa. Você pode fazer isso definindo condições de confiança nas funções da nuvem com base em fluxos de trabalho reutilizáveis. The available options will vary depending on your cloud provider: + +- **Using `job_workflow_ref`**: + - To create trust conditions based on reusable workflows, your cloud provider must support custom claims for `job_workflow_ref`. Isso permite que seu provedor de nuvem identifique de qual repositório veio originalmente. + - For clouds that only support the standard claims (audience (`aud`) and subject (`sub`)), you can use the API to customize the `sub` claim to include `job_workflow_ref`. For more information, see "[Customizing the token claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". Support for custom claims is currently available for Google Cloud Platform and HashiCorp Vault. + +- **Customizing the token claims**: + - You can configure more granular trust conditions by customizing the issuer (`iss`) and subject (`sub`) claims included with the JWT. For more information, see "[Customizing the token claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". ## Como o token funciona com fluxos de trabalho reutilizáveis diff --git a/translations/pt-BR/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md b/translations/pt-BR/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md index 6cfca875f7..b6f83dd5c5 100644 --- a/translations/pt-BR/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md +++ b/translations/pt-BR/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md @@ -18,15 +18,23 @@ shortTitle: Executar o executor ao iniciar {% capture service_first_step %}1. Pare o aplicativo do executor auto-hospedado se estiver em execução no momento.{% endcapture %} {% capture service_non_windows_intro_shell %}Na máquina, abra um shell no diretório onde você instalou o aplicativo do executor auto-hospedado. Use os comandos abaixo para instalar e gerenciar o serviço do executor auto-hospedado.{% endcapture %} -{% capture service_nonwindows_intro %}Você deve adicionar um executor a {% data variables.product.product_name %} antes de poder configurar o aplicativo do executor auto-hospedado um serviço. Para obter mais informações, consulte "[Adicionando executores auto-hospedados](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)".{% endcapture %} -{% capture service_win_name %}actions.runner.*{% endcapture %} +{% capture service_nonwindows_intro %} + +{% note %} + +**Observação:** Você precisa adicionar um executor a {% data variables.product.product_name %} antes de poder configurar o aplicativo do executor auto-hospedado como um serviço. Para obter mais informações, consulte "[Adicionando executores auto-hospedados](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)". + +{% endnote %} +{% endcapture %} + +{% capture service_win_name %}actions.runner.*{% endcapture %} {% linux %} {{ service_nonwindows_intro }} -Para os sistemas Linux que usam o `systemd`, você pode usar o script `svc. h` distribuído com o aplicativo do executor auto-hospedado para instalação e gerenciamento usando o aplicativo como um serviço. +Para sistemas Linux que usam `systemd`, você pode usar o `svc.sh` que é criado após adicionar com sucesso o executor para instalar e gerenciar usar o aplicativo como um serviço. {{ service_non_windows_intro_shell }} diff --git a/translations/pt-BR/content/actions/learn-github-actions/contexts.md b/translations/pt-BR/content/actions/learn-github-actions/contexts.md index 19a27228b1..9be283a94d 100644 --- a/translations/pt-BR/content/actions/learn-github-actions/contexts.md +++ b/translations/pt-BR/content/actions/learn-github-actions/contexts.md @@ -33,17 +33,13 @@ Você pode acessar contextos usando a sintaxe da expressão. Para obter mais inf {% data reusables.actions.context-injection-warning %} -| Nome do contexto | Tipo | Descrição | -| ---------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `github` | `objeto` | Informações sobre a execução do fluxo de trabalho. Para obter mais informações, consulte [contexto `github`](#github-context). | -| `env` | `objeto` | Contém variáveis de ambiente definidas em um fluxo de trabalho, trabalho ou etapa. Para obter mais informações, consulte o contexto [`env`](#env-context). | -| `trabalho` | `objeto` | Informações sobre o trabalho atualmente em execução. Para obter mais informações, consulte [contexto `trabalho`](#job-context). | -| `steps` | `objeto` | Informações sobre as etapas que foram executadas no trabalho atual. Para obter mais informações, consulte [contexto `etapas`](#steps-context). | -| `runner` | `objeto` | Informações sobre o executor do trabalho atual. Para obter mais informações, consulte [`runner` context](#runner-context). | -| `secrets` | `objeto` | Contém nomes e valores de segredos que estão disponíveis para a execução de um fluxo de trabalho. Para obter mais informações, consulte o contexto [`segredos`](#secrets-context). | -| `strategy` | `objeto` | Informações sobre a estratégia de execução da matriz para o trabalho atual. Para obter mais informações, consulte o contexto [`estratégia`](#strategy-context). | -| `matrix` | `objeto` | Contém as propriedades da matriz definidas no fluxo de trabalho que se aplicam ao trabalho atual. Para obter mais informações, consulte o contexto [`matriz`](#matrix-context). | -| `needs` | `objeto` | Contém os resultados de todos os trabalhos que são definidos como uma dependência do trabalho atual. Para obter mais informações, consulte o contexto [`needs`](#needs-context). | +| Nome do contexto | Tipo | Descrição | +| ---------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `github` | `objeto` | Informações sobre a execução do fluxo de trabalho. Para obter mais informações, consulte [contexto `github`](#github-context). | +| `env` | `objeto` | Contém variáveis de ambiente definidas em um fluxo de trabalho, trabalho ou etapa. Para obter mais informações, consulte o contexto [`env`](#env-context). | +| `trabalho` | `objeto` | Informações sobre o trabalho atualmente em execução. Para obter mais informações, consulte [contexto `trabalho`](#job-context). | +{%- ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} +| `jobs` | `object` | Para apenas para fluxos de trabalho reutilizáveis, contém saídas de trabalhos do fluxo de trabalho reutilizável. Para obter mais informações, consulte [contexto `trabalhos`](#jobs-context). |{% endif %} | `steps` | `object` | Informações sobre as etapas que foram executadas no trabalho atual. Para obter mais informações, consulte [contexto `etapas`](#steps-context). | | `runner` | `object` | Informações sobre o executor que está executando o trabalho atual. Para obter mais informações, consulte [`runner` context](#runner-context). | | `segredos` | `objeto` | Contém os nomes e valores dos segredos que estão disponíveis para uma execução de fluxo de trabalho. Para obter mais informações, consulte o contexto [`segredos`](#secrets-context). | | `strategy` | `object` | Informações sobre a estratégia de execução da matriz para o trabalho atual. Para obter mais informações, consulte o contexto [`estratégia`](#strategy-context). | | `strategy` | `object` | Contém as propriedades da matriz definidas no fluxo de trabalho que se aplicam ao trabalho atual. Para obter mais informações, consulte o contexto [`matriz`](#matrix-context). | | `needs` | `object` | Contém os resultados de todos os trabalhos que são definidos como uma dependência do trabalho atual. Para obter mais informações, consulte o contexto [`needs`](#needs-context). | {%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4757 %} | `entradas` | `objeto` | Contém as entradas de {% ifversion actions-unified-inputs %} reutilizável ou um fluxo de travalho acionado {% endif %} manualmente. Para obter mais informações, consulte o contexto [`entradas`](#inputs-context). |{% endif %} @@ -84,7 +80,7 @@ A tabela a seguir indica onde cada contexto e função especial pode ser utiliza | jobs.<job_id>.name | github, necessidades, estratégia, matriz, entradas | | | jobs.<job_id>.outputs.<output_id> | github, necessidades, estratégia, matriz, trabalho, executor, env, segredos, etapas, entradas | | | jobs.<job_id>.runs-on | github, necessidades, estratégia, matriz, entradas | | -| jobs.<job_id>.secrets.<secrets_id> | github, needs, secrets{% ifversion actions-unified-inputs %}, inputs{% endif %} | | +| jobs.<job_id>.secrets.<secrets_id> | github, necessidades, estratégia de {% ifversion actions-reusable-workflow-matrix %}, matriz,{% endif %} segredos{% ifversion actions-unified-inputs %}, entradas{% endif %} | | | jobs.<job_id>.services | github, necessidades, estratégia, matriz, entradas | | | jobs.<job_id>.services.<service_id>.credentials | github, necessidades, estratégia, matrix, env, segredos, entradas | | | jobs.<job_id>.services.<service_id>.env.<env_id> | github, necessidades, estratégia, matrix, trabalho, executor, env, segredos, entradas | | @@ -98,7 +94,7 @@ A tabela a seguir indica onde cada contexto e função especial pode ser utiliza | jobs.<job_id>.steps.working-directory | github, necessidades, estratégia, matriz, trabalho, executor, env, segredos, etapas, entradas | hashFiles | | jobs.<job_id>.strategy | github, necessidades, entradas | | | jobs.<job_id>.timeout-minutes | github, necessidades, estratégia, matriz, entradas | | -| jobs.<job_id>.with.<with_id> | github, needs{% ifversion actions-unified-inputs %}, inputs{% endif %} | | +| jobs.<job_id>.with.<with_id> | github, necessidades{% ifversion actions-reusable-workflow-matrix %}, estratégia, matriz{% endif %}{% ifversion actions-unified-inputs %}, entradas{% endif %} | | | on.workflow_call.inputs.<inputs_id>.default | github{% ifversion actions-unified-inputs %}, inputs{% endif %} | | | on.workflow_call.outputs.<output_id>.value | github, jobs, inputs | | {% else %} @@ -200,7 +196,7 @@ O contexto `github` context contém informações sobre a execução do fluxo de {%- ifversion fpt or ghec or ghes > 3.5 or ghae-issue-4722 %} | `github.run_attempt` | `string` | Um número exclusivo para cada tentativa de execução de um fluxo de trabalho específico em um repositório. Este número começa em 1 para a primeira tentativa de execução do fluxo de trabalho e aumenta a cada nova execução. | {%- endif %} -| `github.server_url` | `string` | A URL do servidor do GitHub. Por exemplo: `https://github.com`. | | `github.sha` | `string` | O SHA do commit que acionou a execução do fluxo de trabalho. | | `github.token` | `string` | Um token para efetuar a autenticação em nome do aplicativo instalado no seu repositório. Isso é funcionalmente equivalente ao segredo `GITHUB_TOKEN`. Para obter mais informações, consulte "[Autenticação automática de tokens](/actions/security-guides/automatic-token-authentication)".
    Observação: Esta propriedade de contexto é definida pelo executor do Actions e só está disponível dentro da execução `etapas` de um trabalho. Caso contrário, o valor desta propriedade será `nulo`. |{% ifversion actions-stable-actor-ids %} | `github.triggering_actor` | `string` | O nome de usuário do usuário que iniciou a execução do fluxo de trabalho. Se a execução do fluxo de trabalho for uma nova execução, este valor poderá ser diferente de `github.actor`. Qualquer repetição de fluxo de trabalho usará os privilégios de `github.actor`, mesmo se o ator que iniciar a nova execução (`github.triggering_actor`) tiver privilégios diferentes. |{% endif %} | `github.workflow` | `string` | O nome do fluxo de trabalho. Se o fluxo de trabalho não determina um `name` (nome), o valor desta propriedade é o caminho completo do arquivo do fluxo de trabalho no repositório. | | `github.workspace` | `string` | O diretório de trabalho padrão no executor para as etapas e a localidade padrão do seu repositório ao usar a ação [`checkout`](https://github.com/actions/checkout). | +| `github.server_url` | `string` | A URL do servidor do GitHub. Por exemplo: `https://github.com`. | | `github.sha` | `string` | {% data reusables.actions.github_sha_description %} | | `github.token` | `string` | Um token para efetuar a autenticação em nome do aplicativo GitHub instalado no seu repositório. Isso é funcionalmente equivalente ao segredo `GITHUB_TOKEN`. Para obter mais informações, consulte "[Autenticação automática de tokens](/actions/security-guides/automatic-token-authentication)".
    Observação: Esta propriedade de contexto é definida pelo executor do Actions e só está disponível dentro da execução `etapas` de um trabalho. Caso contrário, o valor desta propriedade será `nulo`. |{% ifversion actions-stable-actor-ids %} | `github.triggering_actor` | `string` | O nome de usuário do usuário que iniciou a execução do fluxo de trabalho. Se a execução do fluxo de trabalho for uma nova execução, este valor poderá ser diferente de `github.actor`. Qualquer repetição de fluxo de trabalho usará os privilégios de `github.actor`, mesmo se o ator que iniciar a nova execução (`github.triggering_actor`) tiver privilégios diferentes. |{% endif %} | `github.workflow` | `string` | O nome do fluxo de trabalho. Se o fluxo de trabalho não determina um `name` (nome), o valor desta propriedade é o caminho completo do arquivo do fluxo de trabalho no repositório. | | `github.workspace` | `string` | O diretório de trabalho padrão no executor para as etapas e a localidade padrão do seu repositório ao usar a ação [`checkout`](https://github.com/actions/checkout). | ### Exemplo de conteúdo do contexto `github` @@ -390,6 +386,72 @@ jobs: - run: ./run-tests ``` +{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} + +## contexto `trabalhos` + +O contexto `trabalhos` só está disponível em fluxos de trabalho reutilizáveis e só pode ser usado para definir saídas para um fluxo de trabalho reutilizável. Para obter mais informações, consulte "[Reutilizando fluxos de trabalho](/actions/using-workflows/reusing-workflows#using-outputs-from-a-reusable-workflow)". + +| Nome da propriedade | Tipo | Descrição | +| ------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `jobs` | `objeto` | Isso só está disponível em fluxos de trabalho reutilizáveis e só pode ser usado para definir saídas para um fluxo de trabalho reutilizável. Este objeto contém todas as propriedades listadas abaixo. | +| `jobs..result` | `string` | O resultado de um trabalho no fluxo de trabalho reutilizável. Os valores possíveis são: `sucesso`, `falha`, `cancelado`ou `ignorado`. | +| `jobs..outputs` | `objeto` | O conjunto de resultados de um trabalho em um fluxo de trabalho reutilizável. | +| `jobs..outputs.` | `string` | O valor de uma saída específica para um trabalho em um fluxo de trabalho reutilizável. | + +### Exemplo de conteúdo do contexto `trabalhos` + +Este exemplo do contexto `trabalhos` contém o resultado e as saídas de um trabalho de uma execução reutilizável. + +```json +{ + example_job: { + result: success, + outputs: { + output1: hello, + output2: world + } + } +} +``` + +### Exemplo de uso do contexto `trabalhos` + +Este exemplo de fluxo de trabalho reutilizável usa o contexto `trabalhos` para definir saídas para o fluxo de trabalho reutilizável. Observe como as saídas fluem das etapas, para o trabalho, e depois para o gatilho `workflow_call`. Para obter mais informações, consulte "[Reutilizando fluxos de trabalho](/actions/using-workflows/reusing-workflows#using-outputs-from-a-reusable-workflow)". + +{% raw %} +```yaml{:copy} +name: Reusable workflow + +on: + workflow_call: + # Map the workflow outputs to job outputs + outputs: + firstword: + description: "The first output string" + value: ${{ jobs.example_job.outputs.output1 }} + secondword: + description: "The second output string" + value: ${{ jobs.example_job.outputs.output2 }} + +jobs: + example_job: + name: Generate output + runs-on: ubuntu-latest + # Map the job outputs to step outputs + outputs: + output1: ${{ steps.step1.outputs.firstword }} + output2: ${{ steps.step2.outputs.secondword }} + steps: + - id: step1 + run: echo "::set-output name=firstword::hello" + - id: step2 + run: echo "::set-output name=secondword::world" +``` +{% endraw %} + +{% endif %} + ## Contexto `etapas` O contexto `etapas` contém informações sobre as etapas do trabalho atual que possuem um [`id`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsid) especificado e já executado. diff --git a/translations/pt-BR/content/actions/learn-github-actions/environment-variables.md b/translations/pt-BR/content/actions/learn-github-actions/environment-variables.md index 36ddb9a4d3..e09c667b33 100644 --- a/translations/pt-BR/content/actions/learn-github-actions/environment-variables.md +++ b/translations/pt-BR/content/actions/learn-github-actions/environment-variables.md @@ -147,7 +147,7 @@ As variáveis de ambiente padrão que os conjuntos de {% data variables.product. {%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5338 %} | `GITHUB_REF_NAME` | {% data reusables.actions.ref_name-description %} For example, `feature-branch-1`.| | `GITHUB_REF_PROTECTED` | {% data reusables.actions.ref_protected-description %} | | `GITHUB_REF_TYPE` | {% data reusables.actions.ref_type-description %} {%- endif %} -| `GITHUB_REPOSITORY` | O nome do proprietário e do repositório. Por exemplo, `octocat/Hello-World`. | | `GITHUB_REPOSITORY_OWNER` | O nome do proprietário do repositório. Por exemplo, `octocat`. | | `GITHUB_RETENTION_DAYS` | O número de dias que os registros da execução do fluxo de trabalho e os artefatos são mantidos. Por exemplo, `90`. | | `GITHUB_RUN_ATTEMPT` | Um número único para cada tentativa da execução de um fluxo de trabalho particular em um repositório. Este número começa em 1 para a primeira tentativa de execução do fluxo de trabalho e aumenta a cada nova execução. Por exemplo, `3`. | | `GITHUB_RUN_ID` | {% data reusables.actions.run_id_description %} Por exemplo, `1658821493`. | | `GITHUB_RUN_NUMBER` | {% data reusables.actions.run_number_description %} Por exemplo, `3`. | | `GITHUB_SERVER_URL`| A URL do servidor de {% data variables.product.product_name %} server. Por exemplo: `https://{% data variables.product.product_url %}`. | `GITHUB_SHA` | O SHA do commit que acionou o fluxo de trabalho. O valor do commit deste SHA depende do evento que acionou o fluxo de trabalho. Para obter mais informações, consulte [Eventos que acionam fluxos de trabalho](/actions/using-workflows/events-that-trigger-workflows). Por exemplo, `ffac537e6cbbf934b08745a378932722df287a53`. | +| `GITHUB_REPOSITORY` | O nome do proprietário e do repositório. Por exemplo, `octocat/Hello-World`. | | `GITHUB_REPOSITORY_OWNER` | O nome do proprietário do repositório. Por exemplo, `octocat`. | | `GITHUB_RETENTION_DAYS` | O número de dias que os registros da execução do fluxo de trabalho e os artefatos são mantidos. Por exemplo, `90`. | | `GITHUB_RUN_ATTEMPT` | Um número único para cada tentativa da execução de um fluxo de trabalho particular em um repositório. Este número começa em 1 para a primeira tentativa de execução do fluxo de trabalho e aumenta a cada nova execução. Por exemplo, `3`. | | `GITHUB_RUN_ID` | {% data reusables.actions.run_id_description %} Por exemplo, `1658821493`. | | `GITHUB_RUN_NUMBER` | {% data reusables.actions.run_number_description %} Por exemplo, `3`. | | `GITHUB_SERVER_URL`| A URL do servidor de {% data variables.product.product_name %} server. Por exemplo: `https://{% data variables.product.product_url %}`. | `GITHUB_SHA` | {% data reusables.actions.github_sha_description %} {%- ifversion actions-job-summaries %} | `GITHUB_STEP_SUMMARY` | O caminho no executor para o arquivo que contém resumos de trabalho dos comandos de fluxo de trabalho. Este arquivo é único para a etapa atual e alterações para cada etapa de um trabalho. Por exemplo, `/home/rob/runner/_layout/_work/_temp/_runner_file_commands/step_summary_1cb22d7f-5663-41a8-9ffc-13472605c76c`. Para obter mais informações, consulte "[Comandos do fluxo de trabalho para {% data variables.product.prodname_actions %}](/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary)." | {%- endif %} @@ -155,7 +155,7 @@ As variáveis de ambiente padrão que os conjuntos de {% data variables.product. {%- ifversion actions-runner-arch-envvars %} | `RUNNER_ARCH` | {% data reusables.actions.runner-arch-description %} {%- endif %} -| `RUNNER_DEBUG` | {% data reusables.actions.runner-debug-description %} | | `RUNNER_NAME` | {% data reusables.actions.runner-name-description %} For example, `Hosted Agent` | | `RUNNER_OS` | {% data reusables.actions.runner-os-description %} For example, `Windows` | | `RUNNER_TEMP` | {% data reusables.actions.runner-temp-directory-description %} For example, `D:\a\_temp` | +| `RUNNER_DEBUG` | {% data reusables.actions.runner-debug-description %} | | `RUNNER_NAME` | {% data reusables.actions.runner-name-description %} Por exemplo, `Hosted Agent` | | `RUNNER_OS` | {% data reusables.actions.runner-os-description %} Por exemplo, `Windows` | | `RUNNER_TEMP` | {% data reusables.actions.runner-temp-directory-description %} Por exemplo, `D:\a\_temp` | {% ifversion not ghae %}| `RUNNER_TOOL_CACHE` | {% data reusables.actions.runner-tool-cache-description %} For example, `C:\hostedtoolcache\windows` |{% endif %} {% note %} diff --git a/translations/pt-BR/content/actions/learn-github-actions/expressions.md b/translations/pt-BR/content/actions/learn-github-actions/expressions.md index e27fd2a01a..6aaef56655 100644 --- a/translations/pt-BR/content/actions/learn-github-actions/expressions.md +++ b/translations/pt-BR/content/actions/learn-github-actions/expressions.md @@ -129,17 +129,17 @@ Retorna `verdadeiro` se a `pesquisa` contiver `item`. Se a `pesquisa` for uma ar `contains('Hello world', 'llo')` retorna `true`. -#### Example using an object filter +#### Exemplo que usa um filtro de objeto -`contains(github.event.issue.labels.*.name, 'bug')` returns `true` if the issue related to the event has a label "bug". +`contains(github.event.issue.labels.*.name, 'bug')` retorna `true` se o problema relacionado ao evento tiver uma etiqueta de "erro". -For more information, see "[Object filters](#object-filters)." +Para obter mais informações, consulte "[Filtros de objeto](#object-filters)". -#### Example matching an array of strings +#### Exemplo correspondente a uma matriz de strings -Instead of writing `github.event_name == "push" || github.event_name == "pull_request"`, you can use `contains()` with `fromJson()` to check if an array of strings contains an `item`. +Em vez de escrever `github.event_name == "push" || github.event_name == "pull_request"`, você pode usar `contains()` com `fromJson()` para verificar se uma matriz de strings contém um `item`. -For example, `contains(fromJson('["push", "pull_request"]'), github.event_name)` returns `true` if `github.event_name` is "push" or "pull_request". +Por exemplo, `contains(fromJson('["push", "pull_request"]'), github.event_name)` retorna `true` se `github.event_name` for "push" ou "pull_request". ### startsWith diff --git a/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md b/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md index 3ecc33d026..0316eea71b 100644 --- a/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md +++ b/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md @@ -93,7 +93,7 @@ Para obter mais informações, consulte "[Criar ações](/actions/creating-actio - Para continuar aprendendo sobre {% data variables.product.prodname_actions %}, consulte "[Encontrar e personalizar ações](/actions/learn-github-actions/finding-and-customizing-actions)". {% ifversion fpt or ghec or ghes %} -- Para entender como a cobrança funciona para {% data variables.product.prodname_actions %}, consulte "[Sobre cobrança para {% data variables.product.prodname_actions %}](/actions/reference/usage-limits-billing-and-administration#about-billing-for-github-actions)". +- Para entender como a cobrança funciona para {% data variables.product.prodname_actions %}, consulte "[Sobre cobrança para {% data variables.product.prodname_actions %}](/actions/reference/usage-limits-billing-and-administration#about-billing-for-github-actions)." {% endif %} ## Entrar em contato com o suporte diff --git a/translations/pt-BR/content/actions/publishing-packages/publishing-nodejs-packages.md b/translations/pt-BR/content/actions/publishing-packages/publishing-nodejs-packages.md index fe4d0d6280..4a255f1e27 100644 --- a/translations/pt-BR/content/actions/publishing-packages/publishing-nodejs-packages.md +++ b/translations/pt-BR/content/actions/publishing-packages/publishing-nodejs-packages.md @@ -98,9 +98,9 @@ Cada vez que você criar uma nova versão, você poderá acionar um fluxo de tra ### Configurar o repositório de destino -Se você não fornecer a chave do `repositório` no seu arquivo *package.json*, {% data variables.product.prodname_registry %} irá publicar um pacote no repositório de {% data variables.product.prodname_dotcom %} especificado no campo `nome` do arquivo *package.json*. Por exemplo, um pacote denominado `@my-org/test` é publicado no `my-org/test` repositório de {% data variables.product.prodname_dotcom %}. +Vincular o seu pacote ao {% data variables.product.prodname_registry %} usando a chave do repositório `` é opcional. Se você optar por não fornecer a chave do `repositório` no seu arquivo *package.json*, {% data variables.product.prodname_registry %} irá publicar um pacote no repositório de {% data variables.product.prodname_dotcom %} especificado no campo `nome` do arquivo *package.json*. Por exemplo, um pacote denominado `@my-org/test` é publicado no `my-org/test` repositório de {% data variables.product.prodname_dotcom %}. Se a `url` especificada na chave do `repositório` é inválida, seu pacote ainda poderá ser publicado. No entanto ele não será vinculado à fonte do repositório, como esperado. -No entanto, se você fornecer a chave `repositório`, o repositório nessa chave será usado como o registro de npm de destino para {% data variables.product.prodname_registry %}. Por exemplo, publicar os resultados *package.json* abaixo em um pacote denominado `my-amazing-package` publicado no repositório `octocat/meu-repo` de {% data variables.product.prodname_dotcom %}. +Se você fornecer a chave do `repositório` no seu arquivo *package.json*, posteriormente, o repositório nessa chave será usado como registro npm de destino para {% data variables.product.prodname_registry %}. Por exemplo, publicar os resultados *package.json* abaixo em um pacote denominado `my-amazing-package` publicado no repositório `octocat/meu-repo` de {% data variables.product.prodname_dotcom %}. Uma vez publicada, apenas a fonte do repositório é atualizada, e o pacote não herda nenhuma permissão do repositório de destino. ```json { diff --git a/translations/pt-BR/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md b/translations/pt-BR/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md index eaf2c87860..be0cae175a 100644 --- a/translations/pt-BR/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md +++ b/translations/pt-BR/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md @@ -51,7 +51,7 @@ Para obter mais informações sobre artefatos da execução do fluxo de trabalho Um fluxo de trabalho pode acessar e restaurar um cache criado no branch atual, no branch de base (incluindo branches base de repositórios bifurcados) ou no branch-padrão (geralmente `principal`). Por exemplo, um cache criado no branch-padrão pode ser acessado a partir de qualquer pull request. Além disso, se o branch `feature-b` tiver o branch de base `feature-a`, um fluxo de trabalho acionado em `feature-b` teria acesso a caches criados no branch-padrão (`principal`), `feature-a` e `feature-b`. -As restrições de acesso fornecem o isolamento da cache e a segurança ao criar um limite lógico entre os diferentes branches. Por exemplo, um cache criado para o branch `feature-a` (com a base no `principal`) não seria acessível para um pull request para o branch `feature-b` (com a base no `principal`). +Access restrictions provide cache isolation and security by creating a logical boundary between different branches or tags. Por exemplo, um cache criado para o branch `feature-a` (com a base no `principal`) não seria acessível para um pull request para o branch `feature-b` (com a base no `principal`). On similar lines, a cache created for the tag `release-a` (from the base `main`) would not be accessible to a workflow triggered for the tag `release-b` (with the base `main`). Vários fluxos de trabalho dentro de um repositório compartilham entradas de cache. Uma cache criada para um branch de um fluxo de trabalho pode ser acessada e restaurada a partir de outro fluxo de trabalho para o mesmo repositório e branch. @@ -204,7 +204,7 @@ npm-d5ea0750 ### Usando a saída da ação do `cache` -Você pode usar a ação `cache` para fazer algo baseado em se ocorreu uma correspondência de cache ou se a falha ocorreu. When an exact match is found for a cache for the specified `key`, the `cache-hit` output is set to `true`. +Você pode usar a ação `cache` para fazer algo baseado em se ocorreu uma correspondência de cache ou se a falha ocorreu. Quando uma correspondência exata é encontrada para um cache para a tecla `especificada`, o `cache-hit` é definido como `verdadeiro`. No exemplo de fluxo de trabalho acima, há uma etapa que lista o estado dos módulos do Node se ocorrer uma falha de cache: diff --git a/translations/pt-BR/content/actions/using-workflows/events-that-trigger-workflows.md b/translations/pt-BR/content/actions/using-workflows/events-that-trigger-workflows.md index 5318e96975..9aed0e2530 100644 --- a/translations/pt-BR/content/actions/using-workflows/events-that-trigger-workflows.md +++ b/translations/pt-BR/content/actions/using-workflows/events-that-trigger-workflows.md @@ -812,6 +812,8 @@ Executa o fluxo de trabalho quando ocorre uma atividade em no pull request no re Este evento é executado no contexto da base do pull request, em vez de no contexto do commit de merge, como faz o evento `pull_request`. Isso impede a execução de código inseguro do cabeçalho do pull request que poderia alterar seu repositório ou roubar quaisquer segredos que você usa no fluxo de trabalho. Este evento permite que seu fluxo de trabalho faça coisas como etiquetar ou comentar nos pull requests a partir das bifurcações. Evite usar este evento se você precisar criar ou executar o código a partir do pull request. +Para garantir a segurança do repositório, os branches com nomes que correspondem a certos padrões (como aqueles que parecem similares ao SHAs) podem não acionar fluxos de trabalho com o evento `pull_request_target`. + {% warning %} **Aviso:** Para fluxos de trabalho acionados pelo evento `pull_request_target`, o `GITHUB_TOKEN` recebe permissão de leitura/gravação para o repositório, a menos que a chave `permissões` seja especificada e o fluxo de trabalho possa acessar segredos, mesmo quando é acionado por uma bifurcação. Embora o fluxo de trabalho seja executado no contexto da base do pull request, você deve certificar-se de que você não irá fazer checkout, construir ou executar o código não confiável do pull request com este evento. Além disso, qualquer cache compartilha o mesmo escopo do ramo de base. Para evitar envenenamento do cache, você não deve salvar o cache se houver a possibilidade de que o conteúdo do cache tenha sido alterado. Para obter mais informações, consulte "[Proteger seus GitHub Actions e fluxos de trabalho: Evitar solicitações pwn](https://securitylab.github.com/research/github-actions-preventing-pwn-requests)" no site do GitHub Security Lab. diff --git a/translations/pt-BR/content/actions/using-workflows/reusing-workflows.md b/translations/pt-BR/content/actions/using-workflows/reusing-workflows.md index 57f4ca5317..92c50fff97 100644 --- a/translations/pt-BR/content/actions/using-workflows/reusing-workflows.md +++ b/translations/pt-BR/content/actions/using-workflows/reusing-workflows.md @@ -39,7 +39,7 @@ Você pode visualizar os fluxos de trabalho referenciados nos seus fluxos de tra ### Fluxos de trabalho e fluxos de trabalho iniciais reutilizáveis -Os fluxos de trabalho iniciais permitem que todos em sua organização que têm permissão para criar fluxos de trabalho o façam de forma mais rápida e facilmente. Quando as pessoas criam um novo fluxo de trabalho, eles podem escolher um fluxo de trabalho inicial e uma parte ou todo o trabalho de escrita do fluxo de trabalho será feito para essas pessoas. Dentro de um fluxo de trabalho inicial, você também pode fazer referência a fluxos de trabalho reutilizáveis para facilitar a utilização de código de fluxo de trabalho gerenciado centralmente. Se você usar uma tag ou nome de branch ao fazer referência ao fluxo de trabalho reutilizável, você poderá garantir que todos que reutilizarem esse fluxo de trabalho sempre usarão o mesmo código YAML. No entanto, se você fizer referência a um fluxo de trabalho reutilizável por uma tag ou branch, certifique-se de que você poderá confiar nessa versão do fluxo de trabalho. Para obter mais informações, consulte "[Fortalecimento da segurança para {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions#reusing-third-party-workflows)". +Os fluxos de trabalho iniciais permitem que todos em sua organização que têm permissão para criar fluxos de trabalho o façam de forma mais rápida e facilmente. Quando as pessoas criam um novo fluxo de trabalho, eles podem escolher um fluxo de trabalho inicial e uma parte ou todo o trabalho de escrita do fluxo de trabalho será feito para essas pessoas. Dentro de um fluxo de trabalho inicial, você também pode fazer referência a fluxos de trabalho reutilizáveis para facilitar a utilização de código de fluxo de trabalho gerenciado centralmente. Se você usar um commit SHA ao fazer referência ao fluxo de trabalho reutilizável, você poderá garantir que todos que reutilizarem esse fluxo de trabalho sempre usarão o mesmo código YAML. No entanto, se você fizer referência a um fluxo de trabalho reutilizável por uma tag ou branch, certifique-se de que você poderá confiar nessa versão do fluxo de trabalho. Para obter mais informações, consulte "[Fortalecimento da segurança para {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions#reusing-third-party-workflows)". Para obter mais informações, consulte "[Criando fluxos de trabalho iniciais para a sua organização](/actions/learn-github-actions/creating-starter-workflows-for-your-organization)". @@ -69,10 +69,14 @@ Fluxos de trabalho chamados que são propriedade do mesmo usuário ou organizaç ## Limitações +{% ifversion nested-reusable-workflow %} +* Você pode se conectar a até quatro níveis de fluxos de trabalho. Para obter mais informações, consulte "[Chamando um fluxo de trabalho reutilizado aninhado](#calling-a-nested-reusable-workflow)". +{% else %} * Os fluxos de trabalho reutilizáveis não podem chamar outros fluxos de trabalho reutilizáveis. +{% endif %} * Os fluxos de trabalho armazenados dentro de um repositório privado só podem ser usados por fluxos de trabalho dentro do mesmo repositório. -* Qualquer variável de ambiente definida em um contexto `env` definido no nível do fluxo de trabalho no fluxo de trabalho da chamada não é propagada para o fluxo de trabalho chamado. Para obter mais informações sobre o contexto `env`, consulte "[Contexto e sintaxe de expressão para o GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions#env-context)". -* A propriedade `estratégia` não é compatível com nenhum trabalho que chame um fluxo de trabalho reutilizável. +* Qualquer variável de ambiente definida em um contexto `env` definido no nível do fluxo de trabalho no fluxo de trabalho da chamada não é propagada para o fluxo de trabalho chamado. Para obter mais informações sobre o contexto `env`, consulte "[Sintaxe de contexto e expressão para o GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions#env-context)".{% ifversion actions-reusable-workflow-matrix %}{% else %} +* A propriedade `estratégia` não é compatível em nenhum trabalho que chame um fluxo de trabalho reutilizável.{% endif %} ## Criar um fluxo de trabalho reutilizável @@ -105,7 +109,13 @@ Você pode definir entradas e segredos, que podem ser passados do fluxo de traba {% endraw %} Para obter detalhes da sintaxe para definir as entradas e segredos, consulte [`on.workflow_call.inputs`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callinputs) e [`on.workflow_call.secrets`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callsecrets). {% ifversion actions-inherit-secrets-reusable-workflows %} -1. No fluxo de trabalho reutilizável, faça referência à entrada ou segredo que você definiu na chave `on` chave na etapa anterior. Se os segredos são herdados usando `secrets: inherit`, você pode referenciá-los mesmo que eles não estejam definidos na chave `on`. +1. No fluxo de trabalho reutilizável, faça referência à entrada ou segredo que você definiu na chave `on` chave na etapa anterior. + + {% note %} + + **Observação**: Se os segredos são herdados pelo uso de `secrets: inherit` no fluxo de trabalho chamado, você poderá referenciá-los mesmo se eles não estiverem definidos explicitamente na chave `on`. Para obter mais informações, consulte "[Sintaxe do fluxo de trabalho para o GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit)." + + {% endnote %} {%- else %} 1. No fluxo de trabalho reutilizável, faça referência à entrada ou segredo que você definiu na chave `on` chave na etapa anterior. {%- endif %} @@ -164,7 +174,36 @@ jobs: token: ${{ secrets.token }} ``` {% endraw %} +{% ifversion actions-reusable-workflow-matrix %} +## Usando estratégia matrix com fluxo de trabalho reutilizável +Os trabalhos que usam a estratégia matrix podem chamar um fluxo de trabalho reutilizável. + +Uma estratégia de matriz permite usar variáveis em uma única definição de trabalho para criar automaticamente várias execuções de trabalho que são baseadas nas combinações das variáveis. Por exemplo, você pode usar uma estratégia da matrix para passar entradas diferentes para um fluxo de trabalho reutilizável. Para obter mais informações sobre matrizes, consulte "[Usando uma matriz para seus trabalhos](/actions/using-jobs/using-a-matrix-for-your-jobs)." + +### Exemplo de estratégia matrix com um fluxo de trabalho reutilizável + +Este arquivo de fluxo de trabalho faz referência ao contexto da matriz, definindo a variável `destino` com os valores `[dev, stage, prod]`. O fluxo de trabalho irá executar três trabalhos, um por cada valor na variável. O arquivo do fluxo de trabalho também chama um fluxo de trabalho reutilizável usando o a palavra-chave `uses`. + +{% raw %} +```yaml{:copy} +name: Reusable workflow with matrix strategy + +on: + push: + +jobs: + ReuseableMatrixJobForDeployment: + strategy: + matrix: + target: [dev, stage, prod] + uses: octocat/octo-repo/.github/workflows/deployment.yml@main + with: + target: ${{ matrix.target }} +``` +{% endraw %} + +{% endif %} ## Chamando um fluxo de trabalho reutilizável Você chama um fluxo de trabalho reutilizável usando a chave `usa`. Ao contrário de quando você usa ações em um fluxo de trabalho, você chama os fluxos de trabalho reutilizáveis diretamente em um trabalho, e não de dentro de etapas de trabalho. @@ -234,9 +273,61 @@ jobs: ``` {% endraw %} +{% ifversion nested-reusable-workflow %} +## Aninhando fluxos de trabalho reutilizáveis + +É possível conectar um máximo de quatro níveis de fluxos de trabalho, ou seja, o fluxo de trabalho de chamadas de nível superior e até três níveis de fluxos de trabalho reutilizáveis. Por exemplo: _caller-workflow.yml_ → _called-workflow-1.yml_ → _called-workflow-2.yml_ → _called-workflow-3.yml_. Não são permitidos loops na árvore de fluxo de trabalho. + +De dentro de um fluxo de trabalho reutilizável, você pode chamar outro fluxo de trabalho reutilizável. + +{% raw %} +```yaml{:copy} +name: Reusable workflow + +on: + workflow_call: + +jobs: + call-another-reusable: + uses: octo-org/example-repo/.github/workflows/another-reusable.yml@v1 +``` +{% endraw %} + +### Passando segredos para fluxos de trabalho aninhados + +Você pode usar `jobs..secrets` em um fluxo de trabalho de chamadas para passar segredos nomeados para um fluxo de trabalho diretamente chamado. Como alternativa, você pode usar `jobs..secrets.inherit` para passar todos os segredos do fluxo de trabalho para um fluxo de trabalho chamado diretamente. Para obter mais informações, consulte a seção "[Passando entradas e segredos para um fluxo de trabalho reutilizável](/actions/using-workflows/reusing-workflows#passing-inputs-and-secrets-to-a-reusable-workflow)" acima e o artigo de referência "[Sintaxe do fluxo de trabalho para o GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit)." Os segredos são passados apenas para o fluxo de trabalho diretamente, portanto, na cadeia de fluxo de trabalho A > B > C, o fluxo de trabalho C só receberá segredos de A se eles foram passados de A para B e, posteriormente, B para C. + +No exemplo a seguir, o fluxo de trabalho A passa todos os seus segredos para o fluxo de trabalho B, usando a palavra-chave `inherit`, mas o fluxo de trabalho B só passa um segredo para o fluxo de trabalho C. Qualquer um dos outros segredos passados para o fluxo de trabalho B não está disponível para o fluxo de trabalho C. + +{% raw %} +```yaml +jobs: + workflowA-calls-workflowB: + uses: octo-org/example-repo/.github/workflows/B.yml@main + secrets: inherit # pass all secrets +``` + +```yaml +jobs: + workflowB-calls-workflowC: + uses: different-org/example-repo/.github/workflows/C.yml@main + secrets: + envPAT: ${{ secrets.envPAT }} # pass just this secret +``` +{% endraw %} + +### Acesso e permissões + +Um fluxo de trabalho que contém fluxos de trabalho reutilizáveis aninhados irá falhar caso algum dos fluxos de trabalho aninhados não possa ser acessado para o fluxo de trabalho inicial de chamadas. Para obter mais informações, consulte "[Acesso para fluxos de trabalho reutilizáveis](/actions/using-workflows/reusing-workflows#access-to-reusable-workflows)". + +As permissões do `GITHUB_TOKEN` só podem ser a mesma ou mais restritivas em fluxos de trabalho aninhados. Por exemplo, na cadeia de fluxo de trabalho A > B > C, se o fluxo de trabalho A tiver a permissão do token `package: read`, logo, B e C não poderão ter a permissão `package: write`. Para obter mais informações, consulte "[Autenticação automática de tokens](/actions/security-guides/automatic-token-authentication)". +{% endif %} + ## Usando saídas de um fluxo de trabalho reutilizável -Um fluxo de trabalho reutilizável pode gerar dados que você deseja usar no fluxo de trabalho da chamada. Para usar essas saídas, você deve especificá-las como saídas do fluxo de trabalho reutilizável. +Um fluxo de trabalho reutilizável pode gerar dados que você deseja usar no fluxo de trabalho da chamada. Para usar essas saídas, você deve especificá-las como saídas do fluxo de trabalho reutilizável.{% ifversion actions-reusable-workflow-matrix %} + +Se um fluxo de trabalho reutilizável que define uma saída é executada com uma estratégia matrix, a saída será definida pela última conclusão bem-sucedida do fluxo de trabalho reutilizável da matriz que realmente define um valor. Isso significa que se a última conclusão bem sucedida de fluxo de trabalho reutilizável define uma string vazia para sua saída, e o segundo último sucesso de conclusão do fluxo de trabalho reutilizável define um valor real para sua saída, a saída conterá o valor do segundo concluindo o fluxo de trabalho reutilizável.{% endif %} O seguinte fluxo de trabalho reutilizável tem um único trabalho que contém duas etapas. Em cada uma dessas etapas, definimos uma única palavra como a saída: "olá" e "mundo". Na seção `saídas` do trabalho, nós mapeamos esses saídas de etapa para o trabalho chamada: `ouput1` e `ouput2`. Em seguida, na seção `on.workflow_call.outputs`, definimos duas saídas para o próprio fluxo de trabalho, uma chamada `firstword` que mapeamos com `output1`, e uma chamada `secondword` que mapeamos com `output2`. diff --git a/translations/pt-BR/content/actions/using-workflows/workflow-syntax-for-github-actions.md b/translations/pt-BR/content/actions/using-workflows/workflow-syntax-for-github-actions.md index 70b097c657..66e7b815a8 100644 --- a/translations/pt-BR/content/actions/using-workflows/workflow-syntax-for-github-actions.md +++ b/translations/pt-BR/content/actions/using-workflows/workflow-syntax-for-github-actions.md @@ -365,9 +365,9 @@ Nome da etapa no {% data variables.product.prodname_dotcom %}. Seleciona uma ação para executar como parte de uma etapa no trabalho. A ação é uma unidade reutilizável de código. Você pode usar uma ação definida no mesmo repositório que o fluxo de trabalho, um repositório público ou em uma [imagem publicada de contêiner Docker](https://hub.docker.com/). -É altamente recomendável incluir a versão da ação que você está usando ao especificar um número de tag Docker, SHA ou ref do Git. Se você não especificar uma versão, ela poderá interromper seus fluxos de trabalho ou causar um comportamento inesperado quando o proprietário da ação publicar uma atualização. +É altamente recomendável que você inclua a versão da ação que você está usando, especificando um ref do Git, SHA ou tag do Docker. Se você não especificar uma versão, ela poderá interromper seus fluxos de trabalho ou causar um comportamento inesperado quando o proprietário da ação publicar uma atualização. - Usar o commit SHA de uma versão de ação lançada é a maneira mais garantida de obter estabilidade e segurança. -- Usar a versão principal da ação permite receber correções importantes e patches de segurança sem perder a compatibilidade. Fazer isso também garante o funcionamento contínuo do fluxo de trabalho. +- Se a ação publicar as principais tags de versão, você deve esperar receber as correções críticas e correções de segurança mantendo a compatibilidade. Observe que esse comportamento fica a critério do autor da ação. - Usar o branch-padrão de uma ação pode ser conveniente, mas se alguém lançar uma nova versão principal com uma mudança significativa, seu fluxo de trabalho poderá ter problemas. Algumas ações requerem entradas que devem ser definidas com a palavra-chave [`with`](#jobsjob_idstepswith) (com). Revise o arquivo README da ação para determinar as entradas obrigatórias. @@ -1037,15 +1037,23 @@ Você pode usar caracteres especiais nos filtros de caminhos, branches e tags. - `[]` Corresponde a um caractere listado entre colchetes ou incluído nos intervalos. Os intervalos só podem incluir valores de `a-z`, `A-Z`, e `0-9`. Por exemplo, o intervalo`[0-9a-z]` corresponde a qualquer letra maiúscula ou minúscula. Por exemplo, `[CB]at` corresponde a `Cat` ou `Bat` e `[1-2]00` corresponde a `100` e `200`. - `!` No início de um padrão faz com que ele anule padrões positivos anteriores. Não tem nenhum significado especial caso não seja o primeiro caractere. -Os caracteres `*`, `[` e `!` são caracteres especiais em YAML. Se você iniciar um padrão com `*`, `[` ou `!`, você deverá colocá-lo entre aspas. +Os caracteres `*`, `[` e `!` são caracteres especiais em YAML. Se você iniciar um padrão com `*`, `[` ou `!`, você deverá colocá-lo entre aspas. Além disso, se você usar uma [sequência de fluxo](https://yaml.org/spec/1.2.2/#flow-sequences) com um padrão que contém `[` e/ou `]`, o padrão deverá estar entre aspas. ```yaml -# Válido -- '**/README.md' +# Valid +branches: + - '**/README.md' -# Inválido - Cria um erro de análise que -# impede que o seu fluxo de trabalho seja executado. -- **/README.md +# Invalid - creates a parse error that +# prevents your workflow from running. +branches: + - **/README.md + +# Valid +branches: [ main, 'release/v[0-9].[0-9]' ] + +# Invalid - creates a parse error +branches: [ main, release/v[0-9].[0-9] ] ``` Par aobte rmais informações sobre branch, tag e sintaxe de filtro do caminho, consulte "[`on..`](#onpushbranchestagsbranches-ignoretags-ignore)", "[`on..`](#onpull_requestpull_request_targetbranchesbranches-ignore)" e "[`on..paths`](#onpushpull_requestpull_request_targetpathspaths-ignore)." diff --git a/translations/pt-BR/content/admin/configuration/configuring-github-connect/about-github-connect.md b/translations/pt-BR/content/admin/configuration/configuring-github-connect/about-github-connect.md index e3d4efd05a..6caeabfa66 100644 --- a/translations/pt-BR/content/admin/configuration/configuring-github-connect/about-github-connect.md +++ b/translations/pt-BR/content/admin/configuration/configuring-github-connect/about-github-connect.md @@ -8,6 +8,7 @@ type: overview topics: - Enterprise - GitHub Connect +miniTocMaxHeadingLevel: 3 --- ## Sobre o {% data variables.product.prodname_github_connect %} @@ -37,6 +38,16 @@ Após configurar a conexão entre {% data variables.product.product_location %} ## Transmissão de dados para {% data variables.product.prodname_github_connect %} +Quando {% data variables.product.prodname_github_connect %} está habilitado, um registro no {% data variables.product.prodname_ghe_cloud %} armazena informações sobre conexão. Se você habilitar as funcionalidades individuais de {% data variables.product.prodname_github_connect %}, serão transmitidos dados adicionais. + +{% note %} + +**Nota:** Nenhum repositório, problema ou pull request é transmitido de {% data variables.product.product_name %} para {% data variables.product.prodname_dotcom_the_website %} por {% data variables.product.prodname_github_connect %}. + +{% endnote %} + +### Dados transmitidos quando {% data variables.product.prodname_github_connect %} está habilitado + Ao habilitar {% data variables.product.prodname_github_connect %} ou funcionalidades específicas de{% data variables.product.prodname_github_connect %}, um registro em {% data variables.product.prodname_ghe_cloud %} irá armazenar as seguintes informações sobre a conexão. {% ifversion ghes %} - A parte da chave pública da sua licença do {% data variables.product.prodname_ghe_server %}; @@ -54,23 +65,19 @@ Ao habilitar {% data variables.product.prodname_github_connect %} ou funcionalid {% data variables.product.prodname_github_connect %} sincroniza os dados de conexão acima entre {% data variables.product.product_location %} e {% data variables.product.prodname_ghe_cloud %} semanalmente, a partir do dia e tempo aproximado que {% data variables.product.prodname_github_connect %} foi habilitado. -{% note %} - -**Nota:** Nenhum repositório, problema ou pull request é transmitido de {% data variables.product.product_name %} para {% data variables.product.prodname_dotcom_the_website %} por {% data variables.product.prodname_github_connect %}. - -{% endnote %} +### Dados transmitidos por funcionalidades individuais de {% data variables.product.prodname_github_connect %} Os dados adicionais são transmitidos se você habilitar as funcionalidades individuais de {% data variables.product.prodname_github_connect %}. -| Funcionalidade | Dados | Para onde os dados são transmitidos? | Onde os dados são usados? | -| ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------- |{% ifversion ghes %} -| Sincronização automática da licença do usuário | O ID de usuário de cada {% data variables.product.product_name %} e endereço de e-mail | De {% data variables.product.product_name %} para {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %} |{% endif %}{% ifversion ghes or ghae %} -| {% data variables.product.prodname_dependabot_alerts %} | Alertas de vulnerabilidade | De {% data variables.product.prodname_dotcom_the_website %} para {% data variables.product.product_name %} | {% data variables.product.product_name %} |{% endif %}{% ifversion dependabot-updates-github-connect %} -| {% data variables.product.prodname_dependabot_updates %} | As dependências e metadados para o repositório de cada dependência

    Se uma dependência for armazenada em um repositório privado em {% data variables.product.prodname_dotcom_the_website %}, os dados só serão transmitidos se {% data variables.product.prodname_dependabot %} estiver configurado e autorizado para acessar esse repositório. | De {% data variables.product.prodname_dotcom_the_website %} para {% data variables.product.product_name %} | {% data variables.product.product_name %} {% endif %} -| Ações de {% data variables.product.prodname_dotcom_the_website %} | Nome da ação, ação (arquivo YAML de {% data variables.product.prodname_marketplace %}) | De {% data variables.product.prodname_dotcom_the_website %} para {% data variables.product.product_name %}

    De {% data variables.product.product_name %} para {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %}{% ifversion server-statistics %} -| {% data variables.product.prodname_server_statistics %} | Agrege métricas de uso de {% data variables.product.prodname_ghe_server %}
    Para a lista de métricas agregadas coletadas, consulte "[dados coletados de {% data variables.product.prodname_server_statistics %}](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)." | De {% data variables.product.product_name %} para {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %}{% endif %} -| Pesquisa unificada | Termos de pesquisa, resultados de pesquisa | De {% data variables.product.prodname_dotcom_the_website %} para {% data variables.product.product_name %}

    De {% data variables.product.product_name %} para {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %} -| Contribuições unificadas | Contagens de contribuição | De {% data variables.product.product_name %} paraa {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.prodname_dotcom_the_website %} +| Funcionalidade | Dados | Para onde os dados são transmitidos? | Onde os dados são usados? | +| ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------- |{% ifversion ghes %} +| Sincronização automática da licença do usuário | O ID de usuário de cada {% data variables.product.product_name %} e endereço de e-mail | De {% data variables.product.product_name %} para {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %} |{% endif %}{% ifversion ghes or ghae %} +| {% data variables.product.prodname_dependabot_alerts %} | Alertas de vulnerabilidade | De {% data variables.product.prodname_dotcom_the_website %} para {% data variables.product.product_name %} | {% data variables.product.product_name %} |{% endif %}{% ifversion dependabot-updates-github-connect %} +| {% data variables.product.prodname_dependabot_updates %} | As dependências e metadados para o repositório de cada dependência

    Se uma dependência for armazenada em um repositório privado em {% data variables.product.prodname_dotcom_the_website %}, os dados só serão transmitidos se {% data variables.product.prodname_dependabot %} estiver configurado e autorizado para acessar esse repositório. | De {% data variables.product.prodname_dotcom_the_website %} para {% data variables.product.product_name %} | {% data variables.product.product_name %} {% endif %} +| Ações de {% data variables.product.prodname_dotcom_the_website %} | Nome da ação, ação (arquivo YAML de {% data variables.product.prodname_marketplace %}) | De {% data variables.product.prodname_dotcom_the_website %} para {% data variables.product.product_name %}

    De {% data variables.product.product_name %} para {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %}{% ifversion server-statistics %} +| {% data variables.product.prodname_server_statistics %} | Métricas agregadas sobre o seu uso de {% data variables.product.prodname_ghe_server %}. Para obter a lista completa de métricas, consulte "[Sobre {% data variables.product.prodname_server_statistics %}](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)." | De {% data variables.product.product_name %} para {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %}{% endif %} +| Pesquisa unificada | Termos de pesquisa, resultados de pesquisa | De {% data variables.product.prodname_dotcom_the_website %} para {% data variables.product.product_name %}

    De {% data variables.product.product_name %} para {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %} +| Contribuições unificadas | Contagens de contribuição | De {% data variables.product.product_name %} paraa {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.prodname_dotcom_the_website %} ## Leia mais diff --git a/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md b/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md index d0a9de3406..c83b1356f5 100644 --- a/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md +++ b/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md @@ -673,7 +673,7 @@ Você pode adicionar o argumento opcional `--prune` para remover objetos inacess {% warning %} -**Aviso**: Antes de usar o argumento `--prune` para remover objetos Git inacessíveis, coloque {% data variables.product.product_location %} em modo de manutenção, ou certifique-se de que o repositório esteja off-line. Para obter mais informações, consulte "[Habilitar e programar o modo de manutenção](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)". +**Aviso**: Antes de usar o argumento `--prune` para remover objetos do Git inacessíveis, coloque {% data variables.product.product_location %} em modo de manutenção ou garantir que todos os repositórios da mesma rede de repositório estejam bloqueados. Para obter mais informações, consulte "[Habilitar e programar o modo de manutenção](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)". {% endwarning %} diff --git a/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md b/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md index 95b6229d4c..1e9bf643d6 100644 --- a/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md +++ b/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md @@ -31,12 +31,15 @@ Para restrições no nível da instância que usam o Azure NSGs, entre em contat ## Adicionar endereços IP permitidos +{% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} {% data reusables.identity-and-permissions.ip-allow-lists-add-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-add-description %} {% data reusables.identity-and-permissions.ip-allow-lists-add-entry %} +{% data reusables.identity-and-permissions.check-ip-address %} ## Permitindo acesso de {% data variables.product.prodname_github_apps %} @@ -44,6 +47,8 @@ Para restrições no nível da instância que usam o Azure NSGs, entre em contat ## Habilitar endereços IP permitidos +{% data reusables.identity-and-permissions.about-enabling-allowed-ip-addresses %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} @@ -52,6 +57,8 @@ Para restrições no nível da instância que usam o Azure NSGs, entre em contat ## Editar endereços IP permitidos +{% data reusables.identity-and-permissions.about-editing-ip-allow-list-entries %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} @@ -59,6 +66,18 @@ Para restrições no nível da instância que usam o Azure NSGs, entre em contat {% data reusables.identity-and-permissions.ip-allow-lists-edit-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-description %} 8. Clique em **Atualizar**. +{% data reusables.identity-and-permissions.check-ip-address %} + +{% ifversion ip-allow-list-address-check %} +## Verificando se um endereço IP é permitido + +{% data reusables.identity-and-permissions.about-checking-ip-address %} + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.security-tab %} +{% data reusables.identity-and-permissions.check-ip-address-step %} +{% endif %} ## Excluir endereços IP permitidos diff --git a/translations/pt-BR/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md b/translations/pt-BR/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md index 1507e2c2da..f7558f5eca 100644 --- a/translations/pt-BR/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md +++ b/translations/pt-BR/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md @@ -20,7 +20,7 @@ shortTitle: Criar réplica HA ## Criar réplica de alta disponibilidade 1. Configure um novo appliance do {% data variables.product.prodname_ghe_server %} na plataforma desejada. O appliance réplica deve refletir as configurações de CPU, RAM e armazenamento do appliance primário. É recomendável instalar o appliance réplica em um ambiente independente. Hardware, software e componentes de rede subjacentes devem ser isolados dos do appliance primário. Se estiver em um provedor de nuvem, use uma região ou zona separada. Para obter mais informações, consulte [Configurar uma instância do {% data variables.product.prodname_ghe_server %}](/enterprise/admin/guides/installation/setting-up-a-github-enterprise-server-instance). -1. Certifique-se de que o dispositivo primário e o novo dispositivo da réplica possam se comunicar entre si por meio das portas 122/TCP e 1194/UDP. Para obter mais informações, consulte "[Portas de rede](/admin/configuration/configuring-network-settings/network-ports#administrative-ports)". +1. Certifique-se de que o novo dispositivo possa se comunicar com todos os outros dispositivos neste ambiente de alta disponibilidade por meio das portas 122/TCP e 1194/UDP. Para obter mais informações, consulte "[Portas de rede](/admin/configuration/configuring-network-settings/network-ports#administrative-ports)". 1. Em um navegador, vá até o novo endereço IP do appliance réplica e faça o upload da sua licença do {% data variables.product.prodname_enterprise %}. {% data reusables.enterprise_installation.replica-steps %} 1. Conecte-se ao endereço IP do appliance réplica usando SSH. diff --git a/translations/pt-BR/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md b/translations/pt-BR/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md index 922a19d7ae..51302560d5 100644 --- a/translations/pt-BR/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md +++ b/translations/pt-BR/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md @@ -82,7 +82,11 @@ Estas restrições são inaceitáveis para algumas empresas. Para determinar se ### Seus desenvolvedores dependem da colaboração fora da sua empresa? -{% data variables.product.prodname_managed_users_caps %} só pode contribuir para repositórios dda sua empresa. Se seus desenvolvedores precisarem colaborar em repositórios fora da sua empresa, mesmo em repositórios privados, para concluir o trabalho deles, {% data variables.product.prodname_emus %} pode não estar certo para a sua empresa e o SAML SSO pode ser uma solução melhor. +{% data variables.product.prodname_managed_users_caps %} só pode contribuir para repositórios dda sua empresa. Se seus desenvolvedores devem contribuir para ambos repositórios dentro e fora da sua empresa, incluindo repositórios privados, {% data variables.product.prodname_emus %} pode não ser o correto para a sua empresa. O SAML SSO pode ser uma solução melhor. + +Algumas empresas mantêm repositórios de uma empresa existente usando o SAML SSO em {% data variables.product.product_location %} e também criam um {% data variables.product.prodname_emu_enterprise %}. Os desenvolvedores que contribuem para repositórios pertencentes a ambas as empresas em uma única estação de trabalho devem alternar entre as contas em {% data variables.product.product_location %} dentro de um único navegador ou usar um navegador diferente para cada conta. O desenvolvedor pode também precisar personalizar a configuração do Git da estação de trabalho para acomodar as duas contas. A complexidade desse fluxo de trabalho pode aumentar o risco de vazamento de código interno para o público de forma incorreta. + +Se você decidir criar um {% data variables.product.prodname_emu_enterprise %}, mas exigir que os desenvolvedores contribuam para recursos fora da empresa a partir de uma única estação de trabalho, você poderá fornecer suporte para alternar entre as contas na configuração local de um desenvolvedor do Git. Para obter mais informações, consulte "[Sobre {% data variables.product.prodname_emus %}](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#supporting-developers-with-multiple-user-accounts-on-githubcom)." ### A sua empresa conta com colaboradores externos? diff --git a/translations/pt-BR/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md b/translations/pt-BR/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md index 3db607a17f..1328e90a9f 100644 --- a/translations/pt-BR/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md +++ b/translations/pt-BR/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md @@ -36,8 +36,6 @@ Você pode conceder {% data variables.product.prodname_managed_users %} acesso e Os nomes de usuário do {% data variables.product.prodname_managed_users %} da empresa e as suas informações de perfil como, por exemplo, nomes de exibição e endereços de e-mail, são definidos por meio do seu IdP e não podem ser alterados pelos próprios usuários. Para obter mais informações, consulte "[Nomes de usuário e informações do perfil](#usernames-and-profile-information)". -{% data reusables.enterprise-accounts.emu-forks %} - Os proprietários de empresas podem auditar todas as ações de {% data variables.product.prodname_managed_users %}' em {% data variables.product.prodname_dotcom %}. Para obter mais informações, consulte "[Eventos de log de auditoria para a sua empresa](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise#about-audit-log-events-for-your-enterprise)". Para usar {% data variables.product.prodname_emus %}, você precisa de um tipo de conta corporativa separado com {% data variables.product.prodname_emus %} habilitado. Para obter mais informações sobre a criação desta conta, consulte "[Sobre empresas com usuários gerenciados](#about-enterprises-with-managed-users)". @@ -75,7 +73,8 @@ O {% data variables.product.prodname_managed_users_caps %} só pode contribuir p * {% data variables.product.prodname_managed_users_caps %} não pode criar gists ou comentários em gists. * {% data variables.product.prodname_managed_users_caps %} não pode instalar {% data variables.product.prodname_github_apps %} nas suas contas de usuário. * Outros usuários de {% data variables.product.prodname_dotcom %} não podem ver, mencionar ou convidar um {% data variables.product.prodname_managed_user %} para colaborar. -* {% data variables.product.prodname_managed_users_caps %} só pode criar repositórios privados e {% data variables.product.prodname_managed_users %} só pode convidar outros integrantes da empresa para colaborar nos seus próprios repositórios. +* Você pode escolher se {% data variables.product.prodname_managed_users %} consegue criar repositórios pertencentes às suas contas de usuário. Para obter mais informações, consulte "[Aplicar políticas de gerenciamento do repositório na sua empresa](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-repository-creation)". +* Se você permitir que {% data variables.product.prodname_managed_users %} crie repositórios pertencentes às suas contas de usuário, eles somente poderão ser proprietários de repositórios privados e só podem convidar outros integrantes da empresa para colaborar em seus repositórios pertencentes aos usuários. * {% data reusables.enterprise-accounts.emu-forks %} * Apenas repositórios privados e internos podem ser criados em organizações pertencentes a um {% data variables.product.prodname_emu_enterprise %}, dependendo das configurações de visibilidade da organização e do repositório corporativo. * {% data variables.product.prodname_managed_users_caps %} são limitados em seu uso de {% data variables.product.prodname_pages %}. Para obter mais informações, consulte "[Sobre {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages#limitations-for-enterprise-managed-users)". @@ -113,6 +112,8 @@ Antes que seus desenvolvedores possam usar {% data variables.product.prodname_gh 5. Uma vez configurados a autenticação e provisionamento, você pode começar a provisionar os integrantes e gerenciar as equipes. Para obter mais informações, consulte "[Gerenciar associações de equipe com grupos de provedor de identidade](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups)". +Se os membros da sua empresa tiverem de usar uma estação de trabalho para contribuir com repositórios em {% data variables.product.product_location %} de uma conta de {% data variables.product.prodname_managed_user %} e uma conta pessoal, você pode prestar suporte. Para obter mais informações, consulte "[Ajudando os desenvolvedores com várias contas de usuário no {% data variables.product.prodname_dotcom_the_website %}](#supporting-developers-with-multiple-user-accounts-on-githubcom)". + ## Efetuar a autenticação um {% data variables.product.prodname_managed_user %} {% data variables.product.prodname_managed_users_caps %} deve efetuar a autenticação por meio de seu provedor de identidade. Para efetuar a autenticação, um {% data variables.product.prodname_managed_user %} pode acessar o seu portal de aplicativo do IdP ou usar a página de login no {% data variables.product.prodname_dotcom_the_website %}. @@ -132,3 +133,9 @@ Antes que seus desenvolvedores possam usar {% data variables.product.prodname_gh Um conflito pode ocorrer quando os usuários de provisionamento das partes únicas do identificador fornecido pelo IdP são removidos durante a normalização. Se você não puder provisionar um usuário devido a um conflito de nome de usuário, você deverá modificar o nome de usuário fornecido pelo seu IdP. Para obter mais informações, consulte "[Resolvendo conflitos de nome de usuário](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication#resolving-username-conflicts). " O nome do perfil e endereço de email de um {% data variables.product.prodname_managed_user %} também é fornecido pelo IdP. {% data variables.product.prodname_managed_users_caps %} não pode alterar seu nome de perfil ou endereço de e-mail em {% data variables.product.prodname_dotcom %}, e o IdP só pode fornecer um único endereço de e-mail. + +## Ajudando os desenvolvedores com várias contas de usuário em {% data variables.product.product_location %} + +As pessoas da sua equipe talvez precisem contribuir com recursos em {% data variables.product.product_location %} que estão fora do seu {% data variables.product.prodname_emu_enterprise %}. Por exemplo, você pode desejar manter uma empresa separada para os projetos de código aberto da sua empresa. Como {% data variables.product.prodname_managed_user %} não pode contribuir para recursos públicos, os usuários deverão manter uma conta pessoal separada para este trabalho. + +As pessoas que devem contribuir com de duas contas de usuário em {% data variables.product.product_location %} usando uma estação de trabalho podem configurar o Git para simplificar o processo. Para obter mais informações, consulte "[Gerenciando várias contas](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts)". diff --git a/translations/pt-BR/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md b/translations/pt-BR/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md index 66c1726cca..b0ca5f2ab7 100644 --- a/translations/pt-BR/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md +++ b/translations/pt-BR/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md @@ -22,9 +22,11 @@ O suporte ao CAP é habilitado automaticamente para qualquer {% data variables.p Para obter mais informações sobre o uso do OIDC com {% data variables.product.prodname_emus %}, consulte "[Configurando o OIDC para usuários gerenciados corporativos](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-oidc-for-enterprise-managed-users)" e "[Migrando do SAML para o OIDC](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc)." -## Sobre o uso do CAP com listas de permissão de IP +{% note %} -Recomendamos deasabilitar a lista de permissão da sua conta corporativa e confiar no CAP do seu IdP. Se você habilitar as listas de permissão do IP para sua empresa e também fizer uso do CAP do seu IdP, tanto a lista de permissões de IP quanto o CAP serão aplicados. Se alguma restrição rejeitar o endereço IP de um usuário, ocorrerá uma falha na solicitação. Para obter mais informações sobre a lista de permissão de IP, consulte "[Aplicando políticas de segurança na sua empresa](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)". +**Observação:** Se você usar as políticas de localização da rede de acesso condicional (CA) no seu inquilino do Azure AD, não use a funcionalidade da lista de permissão de IP em {% data variables.product.prodname_dotcom_the_website %}, com a conta corporativa ou com qualquer uma das organizações pertencentes à empresa. A utilização de ambas não é compatível e pode resultar na aplicação de uma política errada. Para mais informações sobre listas de permissão de IPs, consulte "[Aplicando as configurações de segurança na sua empresa](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)" e "[Gerenciando endereços IP permitidos para a sua organização](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization)". + +{% endnote %} ## Considerações para integrações e automações diff --git a/translations/pt-BR/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md b/translations/pt-BR/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md index e24e704e21..e5ba120f02 100644 --- a/translations/pt-BR/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md +++ b/translations/pt-BR/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md @@ -31,6 +31,7 @@ Se você for novo em {% data variables.product.prodname_emus %} e ainda não con {% endnote %} 1. Antes de iniciar a migração, inicie sessão no Azure e desabilite o provisionamento no aplicativo de {% data variables.product.prodname_emu_idp_application %} existente. +1. Se você usar [as políticas de localização de rede de Acesso Condicional (CA)](https://docs.microsoft.com/en-us/azure/active-directory/conditional-access/location-condition) no Azure AD, e você estiver usando uma lista de permissões de IP com a sua conta corporativa ou qualquer uma das organizações pertencentes à conta corporativa em {% data variables.product.prodname_dotcom_the_website %}, desabilite as listas de permissão de IP. Para obter mais informações, consulte, "[Aplicando as configurações de segurança na sua empresa](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)" e "[Gerenciando endereços IP permitidos para a sua organização](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization)". 1. Efetue o login em {% data variables.product.prodname_dotcom_the_website %} como usuário de configuração da sua empresa com o nome de usuário **@SHORT-CODE_admin**. 1. Quando solicitado para continuar com o provedor de identidade, clique em **Usar um código de recuperação** e efetue o login usando um dos códigos de recuperação da empresa. {% data reusables.enterprise-accounts.access-enterprise %} diff --git a/translations/pt-BR/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md b/translations/pt-BR/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md index 7c23f797f1..03521a2aa0 100644 --- a/translations/pt-BR/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md +++ b/translations/pt-BR/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md @@ -75,10 +75,12 @@ Os metadados de SP para a sua empresa em {% data variables.product.product_name Os seguintes atributos o SAML estão disponíveis para {% data variables.product.product_name %}.{% ifversion ghes %} Você pode alterar os nomes de atributo no console de gerenciamento, com exceção do atributo `administrador`. Para obter mais informações, consulte "[Acessando o console de gerenciamento](/admin/configuration/configuring-your-enterprise/accessing-the-management-console)".{% endif %} -| Nome | Obrigatório? | Descrição | -|:--------------------- |:------------ |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `NameID` | Sim | Identificador de usuário persistente. Qualquer formato de identificador de nome persistente pode ser usado. {% ifversion ghec %}Se você usa uma empresa com {% data variables.product.prodname_emus %}, {% endif %}{% data variables.product.product_name %} irá normalizar o elemento `NameID` para usar como um nome de usuário, a menos que seja fornecida uma das declarações alternativas. Para obter mais informações, consulte "[Considerações de nome de usuário para autenticação externa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication)". | -| `SessionNotOnOrAfter` | Não | A data que {% data variables.product.product_name %} invalida a sessão associada. Após a invalidação, a pessoa deve efetuar a autenticação novamente para acessar {% ifversion ghec or ghae %}os recursos da sua empresa{% elsif ghes %}{% data variables.product.product_location %}{% endif %}. Para obter mais informações, consulte "[Duração da sessão e fim do tempo](#session-duration-and-timeout)". | +| Nome | Obrigatório? | Descrição | +|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |:------------ |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `NameID` | Sim | Identificador de usuário persistente. Qualquer formato de identificador de nome persistente pode ser usado. | +| {% ifversion ghec %}Se você usa uma empresa com {% data variables.product.prodname_emus %}, {% endif %}{% data variables.product.product_name %} irá normalizar o elemento `NameID` para usar como um nome de usuário, a menos que seja fornecida uma das declarações alternativas. Para obter mais informações, consulte "[Considerações de nome de usuário para autenticação externa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication).

    {% note %}**Observação:** é importante usar um identificador persistente e legível por humanos. O uso de um formato de identificador transitório como `urn:oasis:names:tc:SAML:2.0:nameid-format:transient` resultará na revinculação de contas a cada acesso, o que pode ser prejudicial para a gestão de autorização.{% endnote %} | | | +| | | | +| `SessionNotOnOrAfter` | Não | A data que {% data variables.product.product_name %} invalida a sessão associada. Após a invalidação, a pessoa deve efetuar a autenticação novamente para acessar {% ifversion ghec or ghae %}os recursos da sua empresa{% elsif ghes %}{% data variables.product.product_location %}{% endif %}. Para obter mais informações, consulte "[Duração da sessão e fim do tempo](#session-duration-and-timeout)". | {%- ifversion ghes or ghae %} | `administrator` | Nçao | Quando o valor for `verdadeiro`, {% data variables.product.product_name %} promoverá automaticamente o usuário para ser um {% ifversion ghes %}administrador de site{% elsif ghae %}proprietário empresarial{% endif %}. Definir esse atributo para qualquer coisa menos `verdadeiro` resultará em demonstração, desde que o valor não esteja em branco. Omitir este atributo ou deixar o valor em branco não irá alterar a função do usuário. | | `username` | Não | O nome de usuário para {% data variables.product.product_location %}. | {%- endif %} diff --git a/translations/pt-BR/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md b/translations/pt-BR/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md index aeaa44588d..6bad5f0002 100644 --- a/translations/pt-BR/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md +++ b/translations/pt-BR/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md @@ -44,7 +44,8 @@ Você configurou o fluxo do log de auditoria em {% data variables.product.produc - [Amazon S3](#setting-up-streaming-to-amazon-s3) - [Armazenamento do Azure Blob](#setting-up-streaming-to-azure-blob-storage) -- [Centros de evento do Azure](#setting-up-streaming-to-azure-event-hubs) +- [Azure Event Hubs](#setting-up-streaming-to-azure-event-hubs){% ifversion streaming-datadog %} +- [Datadog](#setting-up-streaming-to-datadog){% endif %} - [Armazenamento do Google Cloud](#setting-up-streaming-to-google-cloud-storage) - [Splunk](#setting-up-streaming-to-splunk) @@ -231,6 +232,32 @@ Você precisa de duas informações sobre seu centro de eventos: o nome da sua i {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +{% ifversion streaming-datadog %} +### Setting up streaming to Datadog + +To set up streaming to Datadog, you must create a client token or an API key in Datadog, then configure audit log streaming in {% data variables.product.product_name %} using the token for authentication. You do not need to create a bucket or other storage container in Datadog. + +After you set up streaming to Datadog, you can see your audit log data by filtering by "github.audit.streaming." For more information, see [Log Management](https://docs.datadoghq.com/logs/). + +1. If you don't already have a Datadog account, create one. +1. In Datadog, generate a client token or an API key, then click **Copy key**. For more information, see [API and Application Keys](https://docs.datadoghq.com/account_management/api-app-keys/) in Datadog Docs. +{% data reusables.enterprise.navigate-to-log-streaming-tab %} +1. Select the **Configure stream** dropdown menu and click **Datadog**. + + ![Screenshot of the "Configure stream" dropdown menu with "Datadog" highlighted](/assets/images/help/enterprises/audit-stream-choice-datadog.png) +1. Under "Token", paste the token you copied earlier. + + ![Screenshot of the "Token" field](/assets/images/help/enterprises/audit-stream-datadog-token.png) +1. Select the "Site" dropdown menu and click your Datadog site. To determine your Datadog site, compare your Datadog URL to the table in [Datadog sites](https://docs.datadoghq.com/getting_started/site/) in Datadog Docs. + + ![Screenshot of the "Site" dropdown menu](/assets/images/help/enterprises/audit-stream-datadog-site.png) +1. To verify that {% data variables.product.prodname_dotcom %} can connect and write to the Datadog endpoint, click **Check endpoint**. + + ![Verificar o ponto de extremidade](/assets/images/help/enterprises/audit-stream-check.png) +{% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +1. After a few minutes, confirm that audit log data is appearing on the **Logs** tab in Datadog. If audit log data is not appearing, confirm that your token and site are correct in {% data variables.product.prodname_dotcom %}. +{% endif %} + ### Configurando a transmissão para o Google Cloud Storage Para configurar a transmissão para o Google Cloud Storage, você deve criar uma conta de serviço no Google Cloud com as credenciais e permissões apropriadas e, em seguida, configurar a transmissão do log de auditoria em {% data variables.product.product_name %} usando as credenciais da conta de serviço para autenticação. @@ -291,6 +318,10 @@ Para transmitir os logs de auditoria para o Coletor de Eventos HTTP (HEC) do Spl A pausa da transmissão permite que você execute a manutenção no aplicativo de recebimento sem perder dados de auditoria. Os logs de auditoria são armazenados por até sete dias em {% data variables.product.product_location %} e, em seguida, são exportados quando você suspender a pausa da transmissão. +{% ifversion streaming-datadog %} +Datadog only accepts logs from up to 18 hours in the past. If you pause a stream to a Datadog endpoint for more than 18 hours, you risk losing logs that Datadog won't accept after you resume streaming. +{% endif %} + {% data reusables.enterprise.navigate-to-log-streaming-tab %} 1. Clique **Pausar transmissão**. diff --git a/translations/pt-BR/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md b/translations/pt-BR/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md index 04f2b70214..9a1c399fb2 100644 --- a/translations/pt-BR/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md +++ b/translations/pt-BR/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md @@ -77,12 +77,17 @@ Você também pode configurar endereços IP permitidos para uma organização in ### Adicionar endereços IP permitidos +{% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} + +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} {% data reusables.identity-and-permissions.ip-allow-lists-add-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-add-description %} {% data reusables.identity-and-permissions.ip-allow-lists-add-entry %} +{% data reusables.identity-and-permissions.check-ip-address %} ### Permitindo acesso de {% data variables.product.prodname_github_apps %} @@ -90,6 +95,8 @@ Você também pode configurar endereços IP permitidos para uma organização in ### Habilitar endereços IP permitidos +{% data reusables.identity-and-permissions.about-enabling-allowed-ip-addresses %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} @@ -98,6 +105,8 @@ Você também pode configurar endereços IP permitidos para uma organização in ### Editar endereços IP permitidos +{% data reusables.identity-and-permissions.about-editing-ip-allow-list-entries %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} @@ -105,6 +114,18 @@ Você também pode configurar endereços IP permitidos para uma organização in {% data reusables.identity-and-permissions.ip-allow-lists-edit-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-description %} 8. Clique em **Atualizar**. +{% data reusables.identity-and-permissions.check-ip-address %} + +{% ifversion ip-allow-list-address-check %} +### Verificando se um endereço IP é permitido + +{% data reusables.identity-and-permissions.about-checking-ip-address %} + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.security-tab %} +{% data reusables.identity-and-permissions.check-ip-address-step %} +{% endif %} ### Excluir endereços IP permitidos diff --git a/translations/pt-BR/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md b/translations/pt-BR/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md index 3807a22b51..df2a517cd4 100644 --- a/translations/pt-BR/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md +++ b/translations/pt-BR/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md @@ -71,24 +71,28 @@ Se um proprietário corporativo impedir que os integrantes criem certos tipos de {% endif %} -## Aplicar uma política de {% ifversion ghec or ghes or ghae %}base{% else %}permissões padrão{% endif %} do repositório +## Aplicando uma política para as permissões básicas do repositório -Em todas as organizações pertencentes à sua empresa, você pode definir um {% ifversion ghec or ghes or ghae %}base{% else %}padrão{% endif %} nível de permissão de repositório (nenhum leitura, gravação ou administrador) para integrantes da organização, ou permitir que os proprietários administrem a configuração no nível da organização. +Em todas as organizações pertencentes à sua empresa, você pode definir um nível de permissão básica do repositório (nenhum leitura, gravação ou administrador) para integrantes da organização, ou permitir que os proprietários administrem a configuração no nível da organização. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} -4. Em "{% ifversion ghec or ghes or ghae %}Base{% else %}Default{% endif %} permissões", revise as informações sobre como alterar a configuração. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -5. Em "{% ifversion ghec or ghes or ghae %}Base{% else %}Padrão{% endif %} permissões", use o menu suspenso e escolha uma política. - {% ifversion ghec or ghes or ghae %} - ![Menu suspenso com opções de políticas de permissões de repositório](/assets/images/help/business-accounts/repository-permissions-policy-drop-down.png) - {% else %} - ![Menu suspenso com opções de políticas de permissões de repositório](/assets/images/enterprise/business-accounts/repository-permissions-policy-drop-down.png) - {% endif %} +4. Em "Permissões básicas", revise as informações sobre como alterar a configuração. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +5. Em "Permissões básicas", use o menu suspenso e escolha uma política. ![Menu suspenso com opções de políticas de permissões de repositório](/assets/images/help/business-accounts/repository-permissions-policy-drop-down.png) + ## Aplicando uma política para a criação do repositório -Em todas as organizações pertencentes à sua empresa, é possível permitir que os integrantes criem repositórios, restringir a criação de repositórios a proprietários da organização ou permitir que os proprietários administrem a configuração no nível da organização. Caso você permita que os integrantes criem repositórios, escolha se eles poderão criar qualquer combinação de repositórios internos, privados e públicos. O {% data reusables.repositories.internal-repo-default %} Para obter mais informações sobre repositórios internos, consulte "[Criar um repositório interno](/articles/creating-an-internal-repository)". +Em todas as organizações pertencentes à sua empresa, é possível permitir que os integrantes criem repositórios, restringir a criação de repositórios a proprietários da organização ou permitir que os proprietários administrem a configuração no nível da organização. + +Se você permitir que os integrantes criem repositórios em suas organizações, você poderá escolher quais tipos de repositórios (públicos, privados e internos) que os integrantes poderão criar. + +{% ifversion enterprise-namespace-repo-setting %} +{% ifversion ghec %}Se a empresa usa {% data variables.product.prodname_emus %}, você{% else %}Você{% endif %} também pode impedir que os usuários criem repositórios pertencentes às contas de usuário deles. +{% endif %} + +O {% data reusables.repositories.internal-repo-default %} Para obter mais informações sobre repositórios internos, consulte "[Criar um repositório interno](/articles/creating-an-internal-repository)". {% data reusables.organizations.repo-creation-constants %} @@ -96,33 +100,32 @@ Em todas as organizações pertencentes à sua empresa, é possível permitir qu {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} 5. Em "Repository creation" (Criação de repositório), revise as informações sobre como alterar a configuração. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -{% ifversion ghes or ghae or ghec %} {% data reusables.enterprise-accounts.repo-creation-policy %} -{% data reusables.enterprise-accounts.repo-creation-types %} -{% else %} -6. Em "Repository creation" (Criação de repositórios), use o menu suspenso e escolha uma política. - - ![Menu suspenso com opções de políticas de criação de repositórios](/assets/images/enterprise/site-admin-settings/repository-creation-drop-down.png) -{% endif %} +{% data reusables.enterprise-accounts.repo-creation-types %}{% ifversion enterprise-namespace-repo-setting %} +1. Opcionalmente, {% ifversion ghec %}se sua empresa usa {% data variables.product.prodname_emus %} e você quer {% endif %}que impeça que os integrantes da empresa criem repositórios pertencentes às suas contas de usuário, Selecione **Bloquear a criação de repositórios de namespace do usuário**. ![Screenshot showing the list of disabled options from forking policy](/assets/images/help/business-accounts/restrict-personal-namespace-enabled-setting.png){% endif %} ## Aplicar uma política para a bifurcação de repositórios internos ou privados Em todas as organizações pertencentes à sua empresa, é possível permitir que pessoas com acesso a um repositório privado o bifurquem, nunca permitir a bifurcação de repositórios privados ou permitir que os proprietários administrem a configuração no nível da organização. +{% ifversion enterprise-namespace-repo-setting %} +{% note %} + +**Observação:** Se {% ifversion ghec %}sua empresa usa {% data variables.product.prodname_emus %} e {% endif %}sua política de "Criação do repositório" impede que os integrantes corporativos criem repositórios pertencentes às suas contas de usuário, os integrantes não terão permissão para bifurcar um repositório nas contas de usuários, independentemente da política de "bifurcação do repositório". + +{% endnote %} +{% endif %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} 3. Em "Bifurcação de repositório", revise as informações sobre como alterar a configuração. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} 4. Em "Repository forking" (Bifurcação de repositórios), use o menu suspenso e escolha uma política. - ![Menu suspenso com opções de políticas de bifurcação de repositórios](/assets/images/help/business-accounts/repository-forking-policy-drop-down.png) - -{% ifversion innersource-fork-policies %} + ![Menu suspenso com opções de políticas de bifurcação de repositórios](/assets/images/help/business-accounts/repository-forking-policy-drop-down.png){% ifversion innersource-fork-policies %} 5. Se a bifurcação estiver habilitada, você poderá especificar onde os usuários podem fazer a bifurcação de repositórios. Revise as informações sobre como alterar a configuração e escolha uma política. - ![Captura de tela que mostra a lista de opções de política de bifurcação de repositório](/assets/images/help/business-accounts/repository-forking-policy-settings.png) -{% endif %} - + ![Captura de tela que mostra a lista de opções de política de bifurcação de repositório](/assets/images/help/business-accounts/repository-forking-policy-settings.png){% endif %} ## Aplicando uma política para convidar{% ifversion ghec %} colaboradores{% endif %} externos para repositórios @@ -140,8 +143,6 @@ Em todas as organizações pertencentes à sua empresa, você pode permitir que ![Menu suspenso com opções de política de convites](/assets/images/enterprise/business-accounts/repository-invitation-policy-drop-down.png) {% endif %} -{% ifversion ghec or ghes or ghae %} - ## Aplicando uma política para o nome padrão do branch Em todas as organizações pertencentes à sua empresa, você pode definir o nome padrão da branch para quaisquer novos repositórios que os integrantes criarem. Você pode optar por aplicar esse nome do branch-padrão em todas as organizações ou permitir que as organizações individuais definam um nome diferente. @@ -152,8 +153,6 @@ Em todas as organizações pertencentes à sua empresa, você pode definir o nom 4. Opcionalmente, para aplicar o nome do branch-padrão para todas as organizações da empresa, selecione **Aplicar em toda a empresa**. ![Caixa de aplicação](/assets/images/help/business-accounts/default-branch-name-enforce.png) 5. Clique em **Atualizar**. ![Botão de atualizar](/assets/images/help/business-accounts/default-branch-name-update.png) -{% endif %} - ## Aplicando uma política de alterações à visibilidade do repositório Em todas as organizações pertencentes à sua empresa, é possível permitir que integrantes com acesso administrativo alterem a visibilidade de um repositório, restringir alterações na visibilidade do repositório a proprietários da organização ou permitir que os proprietários administrem a configuração no nível da organização. Quando você impede que os integrantes alterem a visibilidade do repositório, somente os proprietários corporativos podem alterar a visibilidade de um repositório. @@ -163,9 +162,8 @@ Se um proprietário corporativo tiver restringido a criação de repositório ap {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} -5. Em "Repository visibility change" (Alteração da visibilidade do repositório), revise as informações sobre a alteração da configuração. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} - -{% data reusables.enterprise-accounts.repository-visibility-policy %} +1. Em "Repository visibility change" (Alteração da visibilidade do repositório), revise as informações sobre a alteração da configuração. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +1. Em "Repository visibility change" (Mudança de visibilidade do repositório), use o menu suspenso e escolha uma política. ![Menu suspenso com opções de política de visibilidade do repositório](/assets/images/help/business-accounts/repository-visibility-policy-drop-down.png) ## Aplicando uma política de exclusão e transferência de repositório diff --git a/translations/pt-BR/content/authentication/connecting-to-github-with-ssh/about-ssh.md b/translations/pt-BR/content/authentication/connecting-to-github-with-ssh/about-ssh.md index bd37fe1258..622177cedc 100644 --- a/translations/pt-BR/content/authentication/connecting-to-github-with-ssh/about-ssh.md +++ b/translations/pt-BR/content/authentication/connecting-to-github-with-ssh/about-ssh.md @@ -1,6 +1,6 @@ --- title: Sobre o SSH -intro: 'Usando o protocolo SSH, você pode se conectar a servidores e serviços remotos e se autenticar neles. Com chaves SSH, você pode conectar-se a {% data variables.product.product_name %} sem inserir seu nome de usuário e token de acesso pessoal em cada visita.' +intro: 'Usando o protocolo SSH, você pode se conectar a servidores e serviços remotos e se autenticar neles. Com chaves SSH, você pode se conectar a {% data variables.product.product_name %} sem fornecer seu nome de usuário e token de acesso pessoal em cada acesso.{% ifversion ssh-commit-verification %} Você também pode usar uma chave SSH para assinar commits.{% endif %}' redirect_from: - /articles/about-ssh - /github/authenticating-to-github/about-ssh @@ -16,7 +16,7 @@ topics: {% data reusables.ssh.about-ssh %} Para obter mais informações sobre SSH, consulte [Secure Shell](https://en.wikipedia.org/wiki/Secure_Shell) na Wikipédia. -Ao configurar o SSH, você deverá gerar uma nova chave SSH privada e adicioná-la ao agente SSH. Você também deve adicionar a chave SSH pública à sua conta no {% data variables.product.product_name %} antes de usar a chave para efetuar a autenticação. Para mais informações consulte "[Gerar uma nova chave SSH e adicioná-la ao ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)" e "[Adicionar uma nova chave SSH à sua conta de {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)". +Ao configurar o SSH, você deverá gerar uma nova chave SSH privada e adicioná-la ao agente SSH. Você também deve adicionar a chave SSH pública à sua conta em {% data variables.product.product_name %} antes de usar a chave para efetuar a autenticação em {% ifversion ssh-commit-verification %} ou assinar commits{% endif %}. Para obter mais informações, consulte "[Gerando uma nova chave SSH e adicionando-a ao ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)"{% ifversion ssh-commit-verification %}, {% else %} e{% endif %} "[Adicionando uma nova chave SSH à sua conta de {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account){% ifversion ssh-commit-verification %}" e "[Sobre a verificação de assinatura do commit](/articles/about-commit-signature-verification){% endif %}." Você pode proteger ainda mais sua chave SSH usando uma chave de segurança de hardware, o que exige que a chave de segurança física do hardware seja conectada ao seu computador quando o par de chaves é usado para efetuar a autenticação com SSH. Você também pode proteger sua chave SSH, adicionando sua chave ao agente do ssh-agent e usando uma frase secreta. Para obter mais informações, consulte "[Trabalhar com frases secretas da chave SSH](/github/authenticating-to-github/working-with-ssh-key-passphrases)". @@ -33,7 +33,6 @@ As organizações que usam {% data variables.product.prodname_ghe_cloud %} podem {% else ghec or ghes or ghae %} Se você for integrante de uma organização que fornece certificados SSH, você poderá usar seu certificado para acessar os repositórios da organização sem adicionar o certificado à sua conta em {% data variables.product.product_name %}. Você não pode usar seu certificado para acessar as bifurcações dos repositórios da organização, se as bifurcações pertencerem à sua conta pessoal. Para obter mais informações, consulte "[Sobre autoridades certificadas de SSH](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities)". {% endif %} - ## Leia mais - "[Solucionar problemas de SSH](/articles/troubleshooting-ssh)" diff --git a/translations/pt-BR/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md b/translations/pt-BR/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md index d0582bf8b8..8d21dfd87b 100644 --- a/translations/pt-BR/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md +++ b/translations/pt-BR/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md @@ -19,6 +19,8 @@ shortTitle: Adicionar uma nova chave SSH {% data reusables.ssh.about-ssh %} Para obter mais informações, consulte "[Sobre SSH](/authentication/connecting-to-github-with-ssh/about-ssh)". +{% ifversion ssh-commit-verification %}Você também pode usar SSH para assinar commits e etiquetas. Para obter mais informações sobre a assinatura de commit, consulte "[Sobre a verificação de assinatura de commit](/articles/about-commit-signature-verification)".{% endif %} + Após gerar um par de chaves SSH, você deve adicionar a chave pública em {% ifversion fpt or ghec or ghes %}{% data variables.product.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %} para habilitar o acesso SSH para a sua conta. ## Pré-requisitos @@ -30,111 +32,45 @@ Antes de adicionar uma nova chave SSH à sua conta em {% ifversion ghae %}{% dat ## Adicionando uma nova chave SSH à sua conta -Depois de adicionar uma nova chave SSH à sua conta em {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, você poderá reconfigurar quaisquer repositórios locais para usar SSH. Para obter mais informações, consulte "[Alternar URLs remotos de HTTPS para SSH](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-https-to-ssh)". +Depois de adicionar uma nova autenticação da chave SSH à sua conta em {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, você poderá reconfigurar quaisquer repositórios locais para usar SSH. Para obter mais informações, consulte "[Alternar URLs remotos de HTTPS para SSH](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-https-to-ssh)". {% data reusables.ssh.key-type-support %} -{% mac %} - {% webui %} -1. Copie a chave pública SSH para a sua área de transferência. - - Se o seu arquivo de chave pública SSH tiver um nome diferente do código de exemplo, modifique o nome do arquivo para corresponder à sua configuração atual. Ao copiar sua chave, não adicione novas linhas nem espaços em branco. - - ```shell - $ pbcopy < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub - # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard - ``` - - {% tip %} - - **Dica:** se `pbcopy` não estiver funcionando, você poderá localizar a pasta `.ssh` oculta, abrir o arquivo no seu editor de texto de preferência e copiá-lo na área de transferência. - - {% endtip %} - +{% data reusables.gpg.copy-ssh-public-key %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.ssh %} -4. Clique em **New SSH key** (Nova chave SSH) ou **Add SSH key** (Adicionar chave SSH). ![Botão SSH Key (Chave SSH)](/assets/images/help/settings/ssh-add-ssh-key.png) -5. No campo "Title" (Título), adicione uma etiqueta descritiva para a nova chave. Por exemplo, se estiver usando um Mac pessoal, você poderá chamar essa chave de "MacBook Air Pessoal". -6. Cole sua chave no campo "Key" (Chave). ![O campo de chave](/assets/images/help/settings/ssh-key-paste.png) -7. Clique em **Add SSH key** (Adicionar chave SSH). ![O botão Add key (Adicionar chave)](/assets/images/help/settings/ssh-add-key.png) +4. Clique em **New SSH key** (Nova chave SSH) ou **Add SSH key** (Adicionar chave SSH). +{% ifversion ssh-commit-verification %} + ![Botão SSH Key (Chave SSH)](/assets/images/help/settings/ssh-add-ssh-key-with-auth.png) +{% else %} + ![Botão SSH Key (Chave SSH)](/assets/images/help/settings/ssh-add-ssh-key.png) +{% endif %} +5. No campo "Title" (Título), adicione uma etiqueta descritiva para a nova chave. Por exemplo, se você estiver usando um laptop pessoal, você pode chamar essa chave de "laptop pessoal". +{% ifversion ssh-commit-verification %} +6. Selecione o tipo de chave, autenticação ou assinatura. Para obter mais informações sobre a assinatura de commit, consulte "[Sobre a verificação de assinatura de commit](/articles/about-commit-signature-verification)". +{% endif %} +7. Cole sua chave no campo "Key" (Chave). +{% ifversion ssh-commit-verification %} + ![O campo de chave](/assets/images/help/settings/ssh-key-paste-with-type.png) +{% else %} + ![O campo de chave](/assets/images/help/settings/ssh-key-paste.png) +{% endif %} +8. Clique em **Add SSH key** (Adicionar chave SSH). ![O botão Add key (Adicionar chave)](/assets/images/help/settings/ssh-add-key.png) {% data reusables.user-settings.sudo-mode-popup %} {% endwebui %} -{% endmac %} - -{% windows %} - -{% webui %} - -1. Copie a chave pública SSH para a sua área de transferência. - - Se o seu arquivo de chave pública SSH tiver um nome diferente do código de exemplo, modifique o nome do arquivo para corresponder à sua configuração atual. Ao copiar sua chave, não adicione novas linhas nem espaços em branco. - - ```shell - $ clip < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub - # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard - ``` - - {% tip %} - - **Dica:** se `clip` não estiver funcionando, você poderá localizar a pasta `.ssh` oculta, abrir o arquivo no seu editor de texto de preferência e copiá-lo na área de transferência. - - {% endtip %} - -{% data reusables.user-settings.access_settings %} -{% data reusables.user-settings.ssh %} -4. Clique em **New SSH key** (Nova chave SSH) ou **Add SSH key** (Adicionar chave SSH). ![Botão SSH Key (Chave SSH)](/assets/images/help/settings/ssh-add-ssh-key.png) -5. No campo "Title" (Título), adicione uma etiqueta descritiva para a nova chave. Por exemplo, se estiver usando um Mac pessoal, você poderá chamar essa chave de "MacBook Air Pessoal". -6. Cole sua chave no campo "Key" (Chave). ![O campo de chave](/assets/images/help/settings/ssh-key-paste.png) -7. Clique em **Add SSH key** (Adicionar chave SSH). ![O botão Add key (Adicionar chave)](/assets/images/help/settings/ssh-add-key.png) -{% data reusables.user-settings.sudo-mode-popup %} - -{% endwebui %} - -{% endwindows %} - -{% linux %} - -{% webui %} - -1. Copie a chave pública SSH para a sua área de transferência. - - Se o seu arquivo de chave pública SSH tiver um nome diferente do código de exemplo, modifique o nome do arquivo para corresponder à sua configuração atual. Ao copiar sua chave, não adicione novas linhas nem espaços em branco. - - ```shell - $ cat ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub - # Then select and copy the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file - # displayed in the terminal to your clipboard - ``` - - {% tip %} - - **Dica:** Como alternativa, você pode localizar a pasta oculta de `.ssh`, abrir o arquivo no seu editor de texto favorito e copiá-lo na sua área de transferência. - - {% endtip %} - -{% data reusables.user-settings.access_settings %} -{% data reusables.user-settings.ssh %} -4. Clique em **New SSH key** (Nova chave SSH) ou **Add SSH key** (Adicionar chave SSH). ![Botão SSH Key (Chave SSH)](/assets/images/help/settings/ssh-add-ssh-key.png) -5. No campo "Title" (Título), adicione uma etiqueta descritiva para a nova chave. Por exemplo, se estiver usando um Mac pessoal, você poderá chamar essa chave de "MacBook Air Pessoal". -6. Cole sua chave no campo "Key" (Chave). ![O campo de chave](/assets/images/help/settings/ssh-key-paste.png) -7. Clique em **Add SSH key** (Adicionar chave SSH). ![O botão Add key (Adicionar chave)](/assets/images/help/settings/ssh-add-key.png) -{% data reusables.user-settings.sudo-mode-popup %} - -{% endwebui %} - -{% endlinux %} - {% cli %} {% data reusables.cli.cli-learn-more %} Antes de poder usar o {% data variables.product.prodname_cli %} para adicionar uma chave SSH à sua conta, você deve efetuar a autenticação no {% data variables.product.prodname_cli %}. Para obter mais informações, consulte [`login login gh`](https://cli.github.com/manual/gh_auth_login) na documentação do {% data variables.product.prodname_cli %}. -Para adicionar uma chave SSH à sua conta do GitHub, use o subcomando `ssh-key add`, especificando a sua chave pública. +{% ifversion ssh-commit-verification %}, atualmente você só pode usar {% data variables.product.prodname_cli %} para adicionar chaves de autenticação SSH, você não pode adicionar chaves de assinatura SSH.{% endif %} + +Para adicionar uma chave de autenticação SSH à sua conta do GitHub, use o subcomando `ssh-key add`, especificando sua chave pública. ```shell gh ssh-key add key-file diff --git a/translations/pt-BR/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md b/translations/pt-BR/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md index 300d985ccf..3a653af08d 100644 --- a/translations/pt-BR/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md +++ b/translations/pt-BR/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md @@ -1,6 +1,6 @@ --- title: Sobre a verificação de assinatura de commit -intro: 'Ao usar GPG ou S/MIME, você pode assinar tags e commits localmente. Essas tags ou commits estão marcadas como verificadas em {% data variables.product.product_name %} para que outras pessoas possam estar confiantes de que as alterações vêm de uma fonte de confiança.' +intro: 'Ao usar o GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} ou S/MIME, você pode assinar tags e commits localmente. Essas tags ou commits estão marcadas como verificadas em {% data variables.product.product_name %} para que outras pessoas possam estar confiantes de que as alterações vêm de uma fonte de confiança.' redirect_from: - /articles/about-gpg-commit-and-tag-signatures - /articles/about-gpg @@ -20,16 +20,24 @@ shortTitle: Fazer commit da verificação de assinatura ## Sobre a verificação de assinatura de commit -Você pode assinar commits e tags localmente para dar a outras pessoas confiança sobre a origem de uma alteração que você fez. Se um commit ou tag tiver uma assinatura GPG ou S/MIME que seja verificável criptograficamente, o GitHub marcará o commit ou a tag {% ifversion fpt or ghec %}"Verificado" ou "Verificado parcialmente."{% else %}"Verificado."{% endif %} +Você pode assinar commits e tags localmente para dar a outras pessoas confiança sobre a origem de uma alteração que você fez. If a commit or tag has a GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME signature that is cryptographically verifiable, {% data variables.product.product_name %} marks the commit or tag {% ifversion fpt or ghec %}"Verified" or "Partially verified."{% else %}"Verified."{% endif %} ![Commit verificado](/assets/images/help/commits/verified-commit.png) +{% ifversion ghes or ghae %} +If a commit or tag has a signature that can't be verified, {% data variables.product.product_name %} marks the commit or tag "Unverified." +{% endif %} + +{% ifversion ssh-commit-verification %} +For most individual users, GPG or SSH will be the best choice for signing commits. S/MIME signatures are usually required in the context of a larger organization. SSH signatures are the simplest to generate. You can even upload your existing authentication key to {% data variables.product.product_name %} to also use as a signing key. Generating a GPG signing key is more involved than generating an SSH key, but GPG has features that SSH does not. A GPG key can expire or be revoked when no longer used. {% data variables.product.product_name %} shows commits that were signed with such a key as "Verified" unless the key was marked as compromised. SSH keys don't have this capability. +{% endif %} + {% ifversion fpt or ghec %} -Os commits e tags têm o seguinte status de verificação, dependendo se você habilitou o modo vigilante. Por padrão, o modo vigilante não está habilitado. Para obter informações sobre como habilitar o modo vigilante, consulte "[Exibir status de verificação para todos os seus commits](/github/authenticating-to-github/displaying-verification-statuses-for-all-of-your-commits)". +Commits and tags have the following verification statuses, depending on whether you have enabled vigilant mode. By default vigilant mode is not enabled. For information on how to enable vigilant mode, see "[Displaying verification statuses for all of your commits](/github/authenticating-to-github/displaying-verification-statuses-for-all-of-your-commits)." {% data reusables.identity-and-permissions.vigilant-mode-beta-note %} -A assinatura de commits difere encerrar a sessão em um commit. Para obter mais informações sobre a encerrar sessão nos commits, consulte "[Gerenciando a política de encerramento de sessão do commit do seu repositório](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository). " +Signing commits differs from signing off on a commit. For more information about signing off on commits, see "[Managing the commit signoff policy for your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository)." ### Status padrão @@ -42,34 +50,33 @@ A assinatura de commits difere encerrar a sessão em um commit. Para obter mais ### Verificação de assinatura para rebase e merge {% data reusables.pull_requests.rebase_and_merge_verification %} -Para obter mais informações, consulte "[Fazendo rebase e merge dos seus commits](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github#rebasing-and-merging-your-commits)." +For more information, see "[Rebasing and merging your commits](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github#rebasing-and-merging-your-commits)." ### Status com modo vigilante habilitado {% data reusables.identity-and-permissions.vigilant-mode-verification-statuses %} -{% else %} -Se um commit ou tag tiver uma assinatura que não pode ser verificada, {% data variables.product.product_name %} marca o commit ou a tag "não verificada". {% endif %} -Os administradores do repositório podem impor a assinatura de commit obrigatória em um branch para bloquear todos os commits que não estejam assinados e verificados. Para obter mais informações, consulte "[Sobre branches protegidos](/github/administering-a-repository/about-protected-branches#require-signed-commits)." + +Repository administrators can enforce required commit signing on a branch to block all commits that are not signed and verified. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-signed-commits)." {% data reusables.identity-and-permissions.verification-status-check %} {% ifversion fpt or ghec or ghes > 3.4 %} -{% ifversion ghes %}Se um administrador do site tiver habilitado a assinatura de commit da web, {% data variables.product.product_name %} usará automaticamente o GPG para assinar os commits que você criar usando a interface da web. Os commits assinados por {% data variables.product.product_name %} terão um status verificado. Você pode verificar a assinatura localmente usando a chave pública disponível em `https://HOSTNAME/web-flow.gpg`. Para obter mais informações, consulte "[Configurando a assinatura de commit da web](/admin/configuration/configuring-your-enterprise/configuring-web-commit-signing). " -{% else %}{% data variables.product.prodname_dotcom %} usará automaticamente o GPG para assinar os commits que você criar usando a interface da web. Os commits assinados por {% data variables.product.prodname_dotcom %} terão um status verificado. É possível verificar a assinatura localmente usando a chave pública disponível em https://github.com/web-flow.gpg. A impressão digital completa da chave é `5DE3 E050 9C47 EA3C F04A 42D3 4AEE 18F8 3AFD EB23`. +{% ifversion ghes %}If a site administrator has enabled web commit signing, {% data variables.product.product_name %} will automatically use GPG to sign commits you make using the web interface. Os commits assinados por {% data variables.product.product_name %} terão um status verificado. You can verify the signature locally using the public key available at `https://HOSTNAME/web-flow.gpg`. For more information, see "[Configuring web commit signing](/admin/configuration/configuring-your-enterprise/configuring-web-commit-signing)." +{% else %}{% data variables.product.prodname_dotcom %} will automatically use GPG to sign commits you make using the web interface. Commits signed by {% data variables.product.prodname_dotcom %} will have a verified status. You can verify the signature locally using the public key available at https://github.com/web-flow.gpg. The full fingerprint of the key is `5DE3 E050 9C47 EA3C F04A 42D3 4AEE 18F8 3AFD EB23`. -Opcionalmente, você pode escolher que {% data variables.product.prodname_dotcom %} assine os commits que você fizer em {% data variables.product.prodname_github_codespaces %}. Para obter mais informações sobre como habilitar a verificação do GPG para os seus codespaces, consulte "[Gerenciando a verificação do GPG para {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)."{% endif %} +You can optionally choose to have {% data variables.product.prodname_dotcom %} GPG sign commits you make in {% data variables.product.prodname_github_codespaces %}. For more information about enabling GPG verification for your codespaces, see "[Managing GPG verification for {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)."{% endif %} {% endif %} ## Verificação da assinatura de commit GPG -É possível usar GPG para assinar commits com uma chave GPG que você mesmo gera. +You can use GPG to sign commits with a GPG key that you generate yourself. -{% data variables.product.product_name %} usa bibliotecas OpenPGP para confirmar que seus commits e tags assinados localmente são verificáveis criptograficamente com base em uma chave pública que você adicionou à sua conta em {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. +{% data variables.product.product_name %} uses OpenPGP libraries to confirm that your locally signed commits and tags are cryptographically verifiable against a public key you have added to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. -Para assinar commits usando GPG e para que esses commits sejam verificados no {% data variables.product.product_name %}, siga estas etapas: +To sign commits using GPG and have those commits verified on {% data variables.product.product_name %}, follow these steps: 1. [Verificar se há chaves GPG existentes](/articles/checking-for-existing-gpg-keys) 2. [Gerar uma nova chave GPG](/articles/generating-a-new-gpg-key) @@ -78,28 +85,47 @@ Para assinar commits usando GPG e para que esses commits sejam verificados no {% 5. [Assinar commits](/articles/signing-commits) 6. [Assinar tags](/articles/signing-tags) -## Verificação da assinatura de commit S/MIME +{% ifversion ssh-commit-verification %} +## SSH commit signature verification -Você pode usar S/MIME para assinar commits com uma chave X.509 emitida pela organização. +You can use SSH to sign commits with an SSH public key that you generate yourself. If you already use an SSH key to authenticate with {% data variables.product.product_name %}, you can also upload that same key again for use as a signing key. There's no limit on the number of signing keys you can add to your account. -O {% data variables.product.product_name %} usa [o pacote Debian ca-certificates](https://packages.debian.org/bullseye/ca-certificates), a mesma loja confiável usada pelos navegadores Mozilla, para confirmar se seus commits e tags localmente assinados são criptograficamente verificáveis em uma chave pública em um certificado raiz confiável. +{% data variables.product.product_name %} uses [ssh_data](https://github.com/github/ssh_data), an open source Ruby library, to confirm that your locally signed commits and tags are cryptographically verifiable against a public key you have added to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. + +{% data reusables.gpg.ssh-git-version %} + +To sign commits using SSH and have those commits verified on {% data variables.product.product_name %}, follow these steps: + +1. [Check for existing SSH keys](/articles/checking-for-existing-ssh-keys) +2. [Generate a new SSH key](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) +3. [Add a SSH signing key to your GitHub account](/articles/adding-a-new-ssh-key-to-your-github-account) +4. [Informar o Git sobre a chave de assinatura](/articles/telling-git-about-your-signing-key) +5. [Assinar commits](/articles/signing-commits) +6. [Assinar tags](/articles/signing-tags) + +{% endif %} +## S/MIME commit signature verification + +You can use S/MIME to sign commits with an X.509 key issued by your organization. + +{% data variables.product.product_name %} uses [the Debian ca-certificates package](https://packages.debian.org/bullseye/ca-certificates), the same trust store used by Mozilla browsers, to confirm that your locally signed commits and tags are cryptographically verifiable against a public key in a trusted root certificate. {% data reusables.gpg.smime-git-version %} -Para assinar commits usando S/MIME e para que esses commits sejam verificados no {% data variables.product.product_name %}, siga estas etapas: +To sign commits using S/MIME and have those commits verified on {% data variables.product.product_name %}, follow these steps: 1. [Informar o Git sobre a chave de assinatura](/articles/telling-git-about-your-signing-key) 2. [Assinar commits](/articles/signing-commits) 3. [Assinar tags](/articles/signing-tags) -Não é preciso fazer upload da chave pública no {% data variables.product.product_name %}. +You don't need to upload your public key to {% data variables.product.product_name %}. {% ifversion fpt or ghec %} -## Verificação de assinatura para bots +## Signature verification for bots -As organizações e {% data variables.product.prodname_github_apps %} que exigem a assinatura de commit podem usar bots para assinar commits. Se um commit ou uma tag tiver uma assinatura de bot que possa ser verificada de maneira criptográfica, o {% data variables.product.product_name %} marcará o commit ou tag como verificado. +Organizations and {% data variables.product.prodname_github_apps %} that require commit signing can use bots to sign commits. If a commit or tag has a bot signature that is cryptographically verifiable, {% data variables.product.product_name %} marks the commit or tag as verified. -A verificação de assinatura para bots somente funcionará se a solicitação for verificada e autenticada como o {% data variables.product.prodname_github_app %} ou bot e se não tiver informações de autor personalizadas, informações de committer personalizadas e nenhuma informação de assinatura personalizada, como API de commits. +Signature verification for bots will only work if the request is verified and authenticated as the {% data variables.product.prodname_github_app %} or bot and contains no custom author information, custom committer information, and no custom signature information, such as Commits API. {% endif %} ## Leia mais diff --git a/translations/pt-BR/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md b/translations/pt-BR/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md index 118c195d3a..b954898815 100644 --- a/translations/pt-BR/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md +++ b/translations/pt-BR/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md @@ -19,7 +19,7 @@ redirect_from: Ao trabalhar localmente no seu computador, o Git permite que você defina o autor das suas alterações e a identidade do autor do autor do autor do committer. Isso torna potencialmente difícil para outras pessoas estarem confiantes de que os commits e tags que você cria foram realmente criados por você. Para ajudar a resolver esse problema, você pode assinar seus commits e tags. Para obter mais informações, consulte "[Assinar commits](/github/authenticating-to-github/signing-commits)" e "[Assinar tags](/github/authenticating-to-github/signing-tags)". {% data variables.product.prodname_dotcom %} marca commits e tags assinadas com um status de verificação. -Por padrão, os commits e tags são marcados como "Verificados" se forem assinadas com uma chave GPG ou S/MIME que foi verificada com sucesso. Se um commit ou tag tiver uma assinatura que não pode ser verificada por {% data variables.product.prodname_dotcom %}, nós marcaremos o commit ou a tag como "não verificado". Em todos os outros casos, não se exibe nenhum status de verificação. +Por padrão os commits e tags são marcados como "Verificados" se forem assinados com um GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} ou chave S/MIME que foi verificada com sucesso. Se um commit ou tag tiver uma assinatura que não pode ser verificada por {% data variables.product.prodname_dotcom %}, nós marcaremos o commit ou a tag como "não verificado". Em todos os outros casos, não se exibe nenhum status de verificação. No entanto, você pode dar a outros usuários maior confiança na identidade atribuída aos seus commits e tags, habilitando o modo vigilante nas configurações do seu {% data variables.product.prodname_dotcom %} Com o modo vigilante habilitado, todos os seus commits e tags são marcados com um de três status de verificação. diff --git a/translations/pt-BR/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md b/translations/pt-BR/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md index a4af5448ea..37449ac202 100644 --- a/translations/pt-BR/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md +++ b/translations/pt-BR/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md @@ -29,11 +29,11 @@ topics: {% data reusables.command_line.open_the_multi_os_terminal %} 3. Gere um par de chaves GPG. Já que existem várias versões do GPG, é possível que você tenha de consultar a [_página man_](https://en.wikipedia.org/wiki/Man_page) relevante para encontrar o comando de geração de chaves apropriado. A sua chave deve usar RSA. - Se a sua versão for 2.1.17 ou posterior, cole o texto abaixo para gerar um par de chaves GPG. - ```shell + ```shell{:copy} $ gpg --full-generate-key ``` - Se a sua versão não for 2.1.17 ou posterior, o comando `gpg --full-generate-key` não funcionará. Cole o texto abaixo e passe para a etapa 6. - ```shell + ```shell{:copy} $ gpg --default-new-key-algo rsa4096 --gen-key ``` 4. Mediante instrução, especifique o tipo de tecla que você deseja ou pressione `Enter` para aceitar o padrão. @@ -52,10 +52,10 @@ topics: {% data reusables.gpg.list-keys-with-note %} {% data reusables.gpg.copy-gpg-key-id %} 10. Cole o texto abaixo, substituindo o ID da chave GPG que você quer usar. Neste exemplo, o ID da chave GPG é `3AA5C34371567BD2`: - ```shell - $ gpg --armor --export 3AA5C34371567BD2 - # Prints the GPG key ID, in ASCII armor format - ``` + ```shell{:copy} + $ gpg --armor --export 3AA5C34371567BD2 + # Prints the GPG key ID, in ASCII armor format + ``` 11. Copie sua chave GPG, que inicia com `-----BEGIN PGP PUBLIC KEY BLOCK-----` e termina com `-----END PGP PUBLIC KEY BLOCK-----`. 12. [Adicione a chave GPG à sua conta GitHub](/articles/adding-a-gpg-key-to-your-github-account). diff --git a/translations/pt-BR/content/authentication/managing-commit-signature-verification/index.md b/translations/pt-BR/content/authentication/managing-commit-signature-verification/index.md index 9da2d2a911..b27a93b90e 100644 --- a/translations/pt-BR/content/authentication/managing-commit-signature-verification/index.md +++ b/translations/pt-BR/content/authentication/managing-commit-signature-verification/index.md @@ -1,6 +1,6 @@ --- title: Gerenciar a verificação de assinatura de commit -intro: 'Você pode assinar seu trabalho localmente usando GPG ou S/MIME. O {% data variables.product.product_name %} verificará essas assinaturas, assim as pessoas saberão que seus commits tem origem em uma fonte confiável.{% ifversion fpt %} O {% data variables.product.product_name %} assinará automaticamente os commits que você fez com a interface web do {% data variables.product.product_name %}.{% endif %}' +intro: '{% data variables.product.product_name %} verificará as assinaturas do GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} ou do S/MIME para que outras pessoas saibam que seus commits vêm de uma fonte confiável.{% ifversion fpt %} {% data variables.product.product_name %} assinará automaticamente os commits que você criar usando a interface web de {% data variables.product.product_name %}.{% endif %}' redirect_from: - /articles/generating-a-gpg-key - /articles/signing-commits-with-gpg diff --git a/translations/pt-BR/content/authentication/managing-commit-signature-verification/signing-commits.md b/translations/pt-BR/content/authentication/managing-commit-signature-verification/signing-commits.md index e0ec52ed19..ff012071cc 100644 --- a/translations/pt-BR/content/authentication/managing-commit-signature-verification/signing-commits.md +++ b/translations/pt-BR/content/authentication/managing-commit-signature-verification/signing-commits.md @@ -1,6 +1,6 @@ --- title: Assinar commits -intro: Você pode assinar commits localmente usando GPG ou S/MIME. +intro: 'Você pode assinar commits localmente usando GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} ou S/MIME.' redirect_from: - /articles/signing-commits-and-tags-using-gpg - /articles/signing-commits-using-gpg @@ -52,9 +52,5 @@ Se você tiver várias chaves ou estiver tentando assinar commits ou tags com um ## Leia mais -* "[Verificar se há chaves GPG existentes](/articles/checking-for-existing-gpg-keys)" -* "[Gerar uma nova chave GPG](/articles/generating-a-new-gpg-key)" -* "[Adicionar uma chave GPG à sua conta do GitHub](/articles/adding-a-gpg-key-to-your-github-account)" * "[Avisar o Git sobre sua chave de assinatura](/articles/telling-git-about-your-signing-key)" -* "[Associar um e-mail à sua chave GPG](/articles/associating-an-email-with-your-gpg-key)" * "[Assinar tags](/articles/signing-tags)" diff --git a/translations/pt-BR/content/authentication/managing-commit-signature-verification/signing-tags.md b/translations/pt-BR/content/authentication/managing-commit-signature-verification/signing-tags.md index da4d6b8fc4..df242be566 100644 --- a/translations/pt-BR/content/authentication/managing-commit-signature-verification/signing-tags.md +++ b/translations/pt-BR/content/authentication/managing-commit-signature-verification/signing-tags.md @@ -1,6 +1,6 @@ --- title: Assinar tags -intro: Você pode assinar as tags localmente usando GPG ou S/MIME. +intro: 'Você pode assinar as tags localmente usando GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} ou S/MIME.' redirect_from: - /articles/signing-tags-using-gpg - /articles/signing-tags @@ -32,9 +32,6 @@ topics: ## Leia mais - "[Exibir tags do seu repositório](/articles/viewing-your-repositorys-tags)" -- "[Verificar se há chaves GPG existentes](/articles/checking-for-existing-gpg-keys)" -- "[Gerar uma nova chave GPG](/articles/generating-a-new-gpg-key)" -- "[Adicionar uma chave GPG à sua conta do GitHub](/articles/adding-a-gpg-key-to-your-github-account)" - "[Avisar o Git sobre sua chave de assinatura](/articles/telling-git-about-your-signing-key)" - "[Associar um e-mail à sua chave GPG](/articles/associating-an-email-with-your-gpg-key)" - "[Assinar commits](/articles/signing-commits)" diff --git a/translations/pt-BR/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md b/translations/pt-BR/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md index a3f04d5f61..2b2ced2515 100644 --- a/translations/pt-BR/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md +++ b/translations/pt-BR/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md @@ -1,6 +1,6 @@ --- title: Informar ao Git sobre a chave de assinatura -intro: 'Para assinar commits localmente, você precisa informar ao Git que há uma chave GPG ou X.509 que você gostaria de usar.' +intro: 'Para assinar os commits localmente, você deve informar ao Git que há uma chave GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} ou X.509 que você gostaria de usar.' redirect_from: - /articles/telling-git-about-your-gpg-key - /articles/telling-git-about-your-signing-key @@ -52,8 +52,6 @@ Se você tiver várias chaves GPG, precisará informar ao Git qual deve ser usad $ killall gpg-agent ``` -{% data reusables.gpg.x-509-key %} - {% endmac %} {% windows %} @@ -75,8 +73,6 @@ Se você tiver várias chaves GPG, precisará informar ao Git qual deve ser usad {% data reusables.gpg.copy-gpg-key-id %} {% data reusables.gpg.paste-gpg-key-id %} -{% data reusables.gpg.x-509-key %} - {% endwindows %} {% linux %} @@ -101,15 +97,25 @@ Se você tiver várias chaves GPG, precisará informar ao Git qual deve ser usad ```bash $ [ -f ~/.bashrc ] && echo 'export GPG_TTY=$(tty)' >> ~/.bashrc ``` - {% endlinux %} +{% ifversion ssh-commit-verification %} +## Informando ao Git sobre sua chave SSH + +Você pode usar uma chave SSH existente para assinar commits e tags ou gerar uma nova especificamente para fazer o login. Para obter mais informações, consulte "[Gerar uma nova chave SSH e adicioná-la ao ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)". + +{% data reusables.gpg.ssh-git-version %} + +{% data reusables.command_line.open_the_multi_os_terminal %} +{% data reusables.gpg.configure-ssh-signing %} +{% data reusables.gpg.copy-ssh-public-key %} +{% data reusables.gpg.paste-ssh-public-key %} + +{% endif %} + +{% data reusables.gpg.x-509-key %} ## Leia mais -- "[Verificar se há chaves GPG existentes](/articles/checking-for-existing-gpg-keys)" -- "[Gerar uma nova chave GPG](/articles/generating-a-new-gpg-key)" -- "[Usar um endereço de e-mail verificado na chave GPG](/articles/using-a-verified-email-address-in-your-gpg-key)" -- "[Adicionar uma chave GPG à sua conta do GitHub](/articles/adding-a-gpg-key-to-your-github-account)" -- "[Associar um e-mail à sua chave GPG](/articles/associating-an-email-with-your-gpg-key)" +- "[Adicionando uma nova chave SSH à sua conta do GitHub](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)". - "[Assinar commits](/articles/signing-commits)" - "[Assinar tags](/articles/signing-tags)" diff --git a/translations/pt-BR/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md b/translations/pt-BR/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md index c303e793d3..cfadee7cef 100644 --- a/translations/pt-BR/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md +++ b/translations/pt-BR/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md @@ -22,7 +22,10 @@ shortTitle: Verificar status da verificação 1. No {% data variables.product.product_name %}, navegue até sua pull request. {% data reusables.repositories.review-pr-commits %} 3. Ao lado do hash do commit abreviado do seu commit, há uma caixa que mostra se a assinatura do seu commit foi verificada{% ifversion fpt or ghec %}, parcialmente verificada{% endif %} ou não verificada. ![Commit assinado](/assets/images/help/commits/gpg-signed-commit-verified-without-details.png) -4. Para ver informações mais detalhadas sobre a assinatura de commit, clique em **Verificado**{% ifversion fpt or ghec %}, **Parcialmente verificado**,{% endif %} ou **Não verificado**. ![Commit assinado verificado](/assets/images/help/commits/gpg-signed-commit_verified_details.png) +4. Para ver informações mais detalhadas sobre a assinatura de commit, clique em **Verificado**{% ifversion fpt or ghec %}, **Parcialmente verificado**,{% endif %} ou **Não verificado**. Os commits do GPG assinados mostrarão o ID da chave que foi usada. ![Commit assinado do GPG verificado](/assets/images/help/commits/gpg-signed-commit_verified_details.png) +{% ifversion ssh-commit-verification %} + Os commits assinados do SSH mostrarão a assinatura da chave pública usada. ![Commit assinado do SSH verificado](/assets/images/help/commits/ssh-signed-commit-verified-details.png) +{% endif %} ## Confirmar o status de verificação da assinatura da tag diff --git a/translations/pt-BR/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md b/translations/pt-BR/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md index 86db0fd86c..9b43c4f136 100644 --- a/translations/pt-BR/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md +++ b/translations/pt-BR/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md @@ -50,9 +50,9 @@ Todos os dados transferidos, quando acionados por {% data variables.product.prod O uso do armazenamento é compartilhado com artefatos de construção produzidos por {% data variables.product.prodname_actions %} para repositórios de sua conta. Para obter mais informações, consulte "[Sobre a cobrança do {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)." -O {% data variables.product.prodname_dotcom %} cobra o uso da conta que possui o repositório onde o pacote é publicado. Se o uso da sua conta ultrapassar esses limites e você definir um limite de gastos acima de US$ 0, você pagará US$ 25por GB de armazenamento por dia e US$ 0,50 por GB de transferência de dados. +O {% data variables.product.prodname_dotcom %} cobra o uso da conta que possui o repositório onde o pacote é publicado. Se o uso da sua conta ultrapassar esses limites e você definir um limite de gastos acima de US$ 0, você pagará US$ 0,008 por GB de armazenamento por dia e US$ 0,50 por GB de transferência de dados. -Por exemplo, se sua organização usa {% data variables.product.prodname_team %}, permite gastos ilimitados, usa 150GB de armazenamento, e possui 50GB de transferência de dados durante um mês, a organização teria excessos de 148GB para armazenamento e 40GB para transferência de dados para esse mês. O excesso de armazenamento custaria US$ 25 por GB por dia ou US$ 37. O excesso para transferência de dados custaria US$ 0,50 ou US$ 20 por GB. +Por exemplo, se sua organização usa {% data variables.product.prodname_team %}, permite gastos ilimitados, usa 150GB de armazenamento, e possui 50GB de transferência de dados durante um mês, a organização teria excessos de 148GB para armazenamento e 40GB para transferência de dados para esse mês. A sobrecarga de armazenamento custa US$ 0,008 por GB por dia ou, aproximadamente, US$ 7 dólares por mês de 31 dias. O excesso para transferência de dados custaria US$ 0,50 ou US$ 20 por GB. {% data reusables.dotcom_billing.pricing_calculator.pricing_cal_packages %} diff --git a/translations/pt-BR/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md b/translations/pt-BR/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md index 1b059f695c..7e09e2b4d9 100644 --- a/translations/pt-BR/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md +++ b/translations/pt-BR/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md @@ -32,7 +32,7 @@ Existem algumas abordagens para lidar com as credenciais recentemente comprometi {% note %} - **Note:** You can automate this step. Para grandes empresas e organizações com centenas de repositórios, o acompanhamento manual é insustentável. Você pode incorporar automação ao processo de webhook definido na primeira etapa. A carga do webhook contém informações do repositório e da organização sobre o segredo vazado. Ao usar estas informações, você pode entrar em contato com os mantenedores atuais do repositório e criar um e-mail/mensagem para as pessoas responsáveis ou abrir um problema. + **Note:** You can automate this step. Para grandes empresas e organizações com centenas de repositórios, o acompanhamento manual é insustentável. Você pode incorporar automação ao processo de webhook definido na primeira etapa. A carga do webhook contém informações do repositório e da organização sobre o segredo vazado. Using this information, you can contact the current maintainers on the repository and create an email/message to the responsible people or open an issue. {% endnote %} 3. **Treine**: Criar um documento de treinamento interno atribuído ao desenvolvedor que fez o commit do segredo. Dentro desse documento de treinamento, você pode explicar os riscos criados por meio da inserção de segredos e direcioná-los para suas informações de melhor prática sobre o uso de segredos no desenvolvimento de forma segura. Se um desenvolvedor não aprender com a experiência e continuar a fazer commit de segredos, você poderia criar um processo de escalada, mas o treinamento geralmente funciona bem. diff --git a/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md b/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md index 66a636187e..346ae5349a 100644 --- a/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md +++ b/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md @@ -42,8 +42,8 @@ Por padrão, a página de verificação de código de alertas é filtrada para m ![Resumo dos alertas](/assets/images/help/repository/code-scanning-click-alert.png) {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %} - {% data reusables.code-scanning.alert-default-branch %} - ![The "Affected branches" section in an alert](/assets/images/help/repository/code-scanning-affected-branches.png){% endif %} + {% data reusables.code-scanning.alert-default-branch %} + ![The "Affected branches" section in an alert](/assets/images/help/repository/code-scanning-affected-branches.png){% endif %} 1. Opcionalmente, se o alerta destacar um problema com o fluxo de dados, clique em **Mostrar caminhos** para exibir o caminho da fonte de dados até o destino onde é usado. {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %} ![O link "Exibir caminhos" em um alerta](/assets/images/help/repository/code-scanning-show-paths.png) diff --git a/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md b/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md index aa2e73b1d1..b4bfdc45f4 100644 --- a/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md +++ b/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md @@ -32,6 +32,12 @@ Se você estiver configurando {% data variables.product.prodname_code_scanning % Você deve executar {% data variables.product.prodname_codeql %} dentro do contêiner no qual você constrói seu código. Isso se aplica se você estiver usando o {% data variables.product.prodname_codeql_cli %}{% ifversion codeql-runner-supported %}, o {% data variables.product.prodname_codeql_runner %},{% endif %} ou {% data variables.product.prodname_actions %}. Para o {% data variables.product.prodname_codeql_cli %} {% ifversion codeql-runner-supported %}ou o {% data variables.product.prodname_codeql_runner %}{% endif %}, consulte "[Instalando {% data variables.product.prodname_codeql_cli %} no seu sistema de CI](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)"{% ifversion codeql-runner-supported %} or "[Executando {% data variables.product.prodname_codeql_runner %} no seu sistema de CI](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)"{% endif %} para obter mais informações. Se estiver usando {% data variables.product.prodname_actions %}, configure seu fluxo de trabalho para executar todas as ações no mesmo contêiner. Para obter mais informações, consulte "[Exemplo de fluxo de trabalho](#example-workflow)". +{% note %} + +**Observação:** {% data reusables.code-scanning.non-glibc-linux-support %} + +{% endnote %} + ## Dependências Você pode ter dificuldade para executar {% data variables.product.prodname_code_scanning %} se o contêiner que você está usando estiver com certas dependências ausentes (por exemplo, o Git deve ser instalado e adicionado à variável PATH). Se você encontrar problemas de dependência, revise a lista de software normalmente incluída nas imagens do executor de {% data variables.product.prodname_dotcom %}. Para obter mais informações, consulte os arquivos de `readme` específicos da versão nesses locais: diff --git a/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md b/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md index 986883acb4..3584f1e328 100644 --- a/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md +++ b/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md @@ -143,25 +143,29 @@ Os nomes das verificações de análise de {% data variables.product.prodname_co ![Verificações de pull request de {% data variables.product.prodname_code_scanning %}](/assets/images/help/repository/code-scanning-pr-checks.png) -Quando os trabalhos de {% data variables.product.prodname_code_scanning %} forem concluídos, {% data variables.product.prodname_dotcom %} calcula se quaisquer alertas foram adicionados pelo pull request e adiciona a entrada "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" à lista de verificações. Depois de {% data variables.product.prodname_code_scanning %} ser executado pelo menos uma vez, você poderá clicar em **Detalhes** para visualizar os resultados da análise. Se você usou um pull request para adicionar {% data variables.product.prodname_code_scanning %} ao repositório, inicialmente você verá uma mensagem de {% ifversion fpt or ghes > 3.2 or ghae or ghec %} "Análise não encontrada"{% else %}"Análise ausente"{% endif %} ao clicar em **Detalhes** na verificação de "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME". +Quando os trabalhos de {% data variables.product.prodname_code_scanning %} forem concluídos, {% data variables.product.prodname_dotcom %} calcula se quaisquer alertas foram adicionados pelo pull request e adiciona a entrada "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" à lista de verificações. Depois de {% data variables.product.prodname_code_scanning %} ser executado pelo menos uma vez, você poderá clicar em **Detalhes** para visualizar os resultados da análise. -{% ifversion fpt or ghes > 3.2 or ghae or ghec %} - ![Análise não encontrada para mensagem de commit](/assets/images/help/repository/code-scanning-analysis-not-found.png) +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-7095 %} + +{% elsif ghes < 3.5 or ghae %} +Se você usou um pull request para adicionar {% data variables.product.prodname_code_scanning %} ao repositório, inicialmente você verá uma mensagem de {% ifversion ghes > 3.2 or ghae %} "Análise não encontrada"{% elsif ghes = 3.2 %}"Análise ausente"{% endif %} ao clicar em **Detalhes** na verificação de "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME". + +{% ifversion ghes > 3.2 or ghae %} + ![Análise não encontrada para mensagem de commit](/assets/images/enterprise/3.4/repository/code-scanning-analysis-not-found.png) A tabela lista uma ou mais categorias. Cada categoria está relacionada a análises específicas, para a mesma ferramenta e commit, realizadas em uma linguagem diferente ou em uma parte diferente do código. Para cada categoria a tabela mostra as duas análises que {% data variables.product.prodname_code_scanning %} tentou comparar para determinar quais alertas foram introduzidos ou corrigidos no pull request. Por exemplo, na captura de tela acima, {% data variables.product.prodname_code_scanning %} encontrou uma análise para o commit do merge do pull request, mas não há análise para o cabeçalho do branch principal. -{% else %} - ![Análise ausente para mensagem de commit](/assets/images/enterprise/3.2/repository/code-scanning-missing-analysis.png) -{% endif %} -{% ifversion fpt or ghes > 3.2 or ghae or ghec %} ### Motivos para a mensagem "Análise não encontrada" -{% else %} + +{% elsif ghes = 3.2 %} + ![Análise ausente para mensagem de commit](/assets/images/enterprise/3.2/repository/code-scanning-missing-analysis.png) + ### Motivos para a mensagem "Análise ausente" {% endif %} -Depois que {% data variables.product.prodname_code_scanning %} analisou o código em um pull request, ele precisa comparar a análise do branch de tópico (o branch que você usou para criar o pull request) com a análise do branch de base (o branch no qual você deseja mesclar o pull request). Isso permite que {% data variables.product.prodname_code_scanning %} calcule quais alertas foram recém-introduzidos pelo pull request, que alertas já estavam presentes no branch de base e se alguns alertas existentes são corrigidos pelas alterações no pull request. Inicialmente, se você usar um pull request para adicionar {% data variables.product.prodname_code_scanning %} a um repositório, o branch de base ainda não foi analisado. Portanto, não é possível computar esses detalhes. Neste caso, quando você clicar nos resultados verificando o pull request você verá a mensagem {% ifversion fpt or ghes > 3.2 or ghae or ghec %}"Análise não encontrada"{% else %}"Análise ausente do commit base SHA-HASH"{% endif %}. +Depois que {% data variables.product.prodname_code_scanning %} analisou o código em um pull request, ele precisa comparar a análise do branch de tópico (o branch que você usou para criar o pull request) com a análise do branch de base (o branch no qual você deseja mesclar o pull request). Isso permite que {% data variables.product.prodname_code_scanning %} calcule quais alertas foram recém-introduzidos pelo pull request, que alertas já estavam presentes no branch de base e se alguns alertas existentes são corrigidos pelas alterações no pull request. Inicialmente, se você usar um pull request para adicionar {% data variables.product.prodname_code_scanning %} a um repositório, o branch de base ainda não foi analisado. Portanto, não é possível computar esses detalhes. Neste caso, quando você clicar nos resultados verificando o pull request você verá a mensagem {% ifversion ghes > 3.2 or ghae %}"Análise não encontrada"{% elsif ghes = 3.2 %}"Análise ausente do commit base SHA-HASH"{% endif %}. Há outras situações em que não pode haver análise para o último commit do branch de base para um pull request. Isso inclui: @@ -169,7 +173,7 @@ Há outras situações em que não pode haver análise para o último commit do Para verificar se um branch foi verificado, acesse a página {% data variables.product.prodname_code_scanning_capc %}, clique no menu suspenso **Branch** e selecione o branch relevante. -![Escolha um branch no menu suspenso Branch](/assets/images/help/repository/code-scanning-branch-dropdown.png) + ![Escolha um branch no menu suspenso Branch](/assets/images/help/repository/code-scanning-branch-dropdown.png) A solução nesta situação é adicionar o nome do branch de base para a especificação `on:push` e `on:pull_request` no fluxo de trabalho de {% data variables.product.prodname_code_scanning %} nesse branch e, em seguida, fazer uma alteração que atualize o pull request aberto que você deseja escanear. @@ -181,13 +185,15 @@ Há outras situações em que não pode haver análise para o último commit do Faça merge uma mudança trivial no branch de base para acionar {% data variables.product.prodname_code_scanning %} neste commit mais recente e, em seguida, faça push de uma alteração para o pull request reiniciar {% data variables.product.prodname_code_scanning %}. +{% endif %} + ## Próximas etapas Após configurar a opção {% data variables.product.prodname_code_scanning %}, e permitir que suas ações sejam concluídas, você pode: - Visualizar todos os alertas de {% data variables.product.prodname_code_scanning %} gerados para este repositório. Para obter mais informações, consulte "[Gerenciar alertas de {% data variables.product.prodname_code_scanning %} para o seu repositório](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)". - Visualizar todos os alertas gerados para um pull request enviado após configurar {% data variables.product.prodname_code_scanning %}. Para obter mais informações, consulte "[Triar alertas de {% data variables.product.prodname_code_scanning %} em pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)". -- Configurar notificações para execuções concluídas. Para obter mais informações, consulte “[Configurando notificações](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#github-actions-notification-options)". +- Configurar notificações para execuções concluídas. Para obter mais informações, consulte “[Configurar notificações](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#github-actions-notification-options)". - Visualizar os logs gerados pela análise do {% data variables.product.prodname_code_scanning %}. Para obter mais informações, consulte "[Visualizar registros de {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs)". - Investigue todos os problemas que ocorrerem com a configuração inicial de {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}. Para obter mais informações, consulte "[Solucionar problemas no fluxo de trabalho de {% data variables.product.prodname_codeql %}](/code-security/secure-coding/troubleshooting-the-codeql-workflow)". - Personalize como {% data variables.product.prodname_code_scanning %} faz a varredura de código no seu repositório. Para obter mais informações, consulte "[Configurando {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)." diff --git a/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md index daeb17e483..74df7049d2 100644 --- a/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md +++ b/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md @@ -45,9 +45,15 @@ If you upload a second SARIF file for a commit with the same category and from t If you're new to SARIF and want to learn more, see Microsoft's [`SARIF tutorials`](https://github.com/microsoft/sarif-tutorials) repository. -## Preventing duplicate alerts using fingerprints +## Providing data to track {% data variables.product.prodname_code_scanning %} alerts across runs -Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the right line of code when files are edited. +Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the correct line of code when files are edited. The `ruleID` for a result has to be the same across analysis. + +### Reporting consistent filepaths + +The filepath has to be consistent across the runs to enable a computation of a stable fingerprint. If the filepaths differ for the same result, each time there is a new analysis a new alert will be created, and the old one will be closed. This will cause having multiple alerts for the same result. + +### Including data for fingerprint generation {% data variables.product.prodname_dotcom %} uses the `partialFingerprints` property in the OASIS standard to detect when two results are logically identical. For more information, see the "[partialFingerprints property](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" entry in the OASIS documentation. @@ -77,6 +83,12 @@ You can check a SARIF file is compatible with {% data variables.product.prodname If you use a code analysis engine other than {% data variables.product.prodname_codeql %}, you can review the supported SARIF properties to optimize how your analysis results will appear on {% data variables.product.prodname_dotcom %}. +{% note %} + +**Note:** You must supply an explicit value for any property marked as "required". The empty string is not supported for required properties. + +{% endnote %} + Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.product.prodname_code_scanning %} will only use the following supported properties. ### `sarifLog` object @@ -138,7 +150,7 @@ Each `result` object contains details for one alert in the codebase. Within the | `level`| **Optional.** The severity of the result. This level overrides the default severity defined by the rule. {% data variables.product.prodname_code_scanning_capc %} uses the level to filter results by severity on {% data variables.product.prodname_dotcom %}. | `message.text`| **Required.** A message that describes the result. {% data variables.product.prodname_code_scanning_capc %} displays the message text as the title of the result. Only the first sentence of the message will be displayed when visible space is limited. | `locations[]`| **Required.** The set of locations where the result was detected up to a maximum of 10. Only one location should be included unless the problem can only be corrected by making a change at every specified location. **Note:** At least one location is required for {% data variables.product.prodname_code_scanning %} to display a result. {% data variables.product.prodname_code_scanning_capc %} will use this property to decide which file to annotate with the result. Only the first value of this array is used. All other values are ignored. -| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Preventing duplicate alerts using fingerprints](#preventing-duplicate-alerts-using-fingerprints)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. +| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Providing data to track code scanning alerts across runs](#providing-data-to-track-code-scanning-alerts-across-runs)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. | `codeFlows[].threadFlows[].locations[]`| **Optional.** An array of `location` objects for a `threadFlow` object, which describes the progress of a program through a thread of execution. A `codeFlow` object describes a pattern of code execution used to detect a result. If code flows are provided, {% data variables.product.prodname_code_scanning %} will expand code flows on {% data variables.product.prodname_dotcom %} for the relevant result. For more information, see the [`location` object](#location-object). | `relatedLocations[]`| A set of locations relevant to this result. {% data variables.product.prodname_code_scanning_capc %} will link to related locations when they are embedded in the result message. For more information, see the [`location` object](#location-object). @@ -204,7 +216,7 @@ These example SARIF output files show supported properties and example values. ### Example with minimum required properties -This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties or don't include values, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. +This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties, omit values, or use an empty string, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. ```json { diff --git a/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md b/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md index 1e03a239f3..193ee54f5a 100644 --- a/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md +++ b/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md @@ -58,7 +58,7 @@ For more information see the [`upload-sarif` action](https://github.com/github/c The `upload-sarif` action can be configured to run when the `push` and `scheduled` event occur. For more information about {% data variables.product.prodname_actions %} events, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#preventing-duplicate-alerts-using-fingerprints)." +If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#providing-data-to-track-code-scanning-alerts-across-runs)." {% data reusables.code-scanning.upload-sarif-alert-limit %} diff --git a/translations/pt-BR/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md b/translations/pt-BR/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md index 2cfd4caf88..8a4c941db3 100644 --- a/translations/pt-BR/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md +++ b/translations/pt-BR/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md @@ -37,20 +37,40 @@ A aba de {% data variables.product.prodname_dependabot_alerts %} do seu reposit {% data variables.product.product_name %} gera {% data variables.product.prodname_dependabot_alerts %} quando detectamos que sua base de código está usando dependências com riscos de segurança conhecidos. Para repositórios em que {% data variables.product.prodname_dependabot_security_updates %} estão habilitados, quando {% data variables.product.product_name %} detecta uma dependência vulnerável no branch padrão, {% data variables.product.prodname_dependabot %} cria um pull request para corrigi-la. O pull request irá atualizar a dependência para a versão minimamente segura possível, o que é necessário para evitar a vulnerabilidade. -{% ifversion dependabot-most-important-sort-option %} Por padrão, {% data variables.product.prodname_dependabot_alerts %} são exibidos na aba {% data variables.product.prodname_dependabot_alerts %} em ordem de importância, mas você pode ordenar alertas por outros critérios. {% endif %}{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5638 %}Você pode classificar e filtrar {% data variables.product.prodname_dependabot_alerts %} com os menus suspensos na aba {% data variables.product.prodname_dependabot_alerts %} ou digitando filtros como pares de `key:value` na barra de pesquisa. Os filtros disponíveis são o repositório (por exemplo, `repo:my-repository`), pacote (fpor exemplo, `package:django`), ecossistema (por exemplo, `ecosystem:npm`), manifesto (por exemplo, `manifest:webwolf/pom.xml`), status (por exemplo, `is:open`) e quando uma consultoria tem uma correção (por exemplo, `has: patch`).{% ifversion dependabot-alerts-development-label %} Você também pode filtrar alertas com dados do escopo de dependência, usando `scope`, por exemplo: `scope:development` ou `scope:runtime`. Com `escopo: desenvolvimento`, a lista de alertas mostrará apenas dependências usadas durante o desenvolvimento, não durante a produção.{% endif %} - Cada alerta de {% data variables.product.prodname_dependabot %} tem um identificador único de número e a aba de {% data variables.product.prodname_dependabot_alerts %} lista um alerta para cada vulnerabilidade detectada. O legado de {% data variables.product.prodname_dependabot_alerts %} agrupou as vulnerabilidades por dependência e gerou um único alerta por dependência. Se você acessar um alerta de legado {% data variables.product.prodname_dependabot %}, você será redirecionado para uma aba de {% data variables.product.prodname_dependabot_alerts %} filtrada para esse pacote. {% endif %} + +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5638 %} +Você pode filtrar e classificar {% data variables.product.prodname_dependabot_alerts %} usando uma série de filtros e opções de classificação disponíveis na interface do usuário. Para obter mais informações, consulte "[Priorizando {% data variables.product.prodname_dependabot_alerts %}](#prioritizing-across--data-variablesproductprodname_dependabot_alerts-)" abaixo. + +## Priorizando {% data variables.product.prodname_dependabot_alerts %} + +{% data variables.product.company_short %} ajuda você a priorizar a correção de {% data variables.product.prodname_dependabot_alerts %}. {% ifversion dependabot-most-important-sort-option %} Por padrão, {% data variables.product.prodname_dependabot_alerts %} são ordenados por importância. A ordenação "mais importante" ajuda você a priorizar na qual {% data variables.product.prodname_dependabot_alerts %} deve se concentrar primeiro. Os alertas são classificados com base no seu impacto potencial, atuabilidade e relevância. O nosso cálculo de priorização está em melhoria constante e inclui fatores como pontuação do CVSS, âmbito de dependência, e se são encontradas chamadas de função vulneráveis para o alerta. + +![Captura de tela da classificação suspensa com a classificação "mais importante"](/assets/images/help/dependabot/dependabot-alerts-sort-dropdown.png) {% endif %} +{% data reusables.dependabot.dependabot-alerts-filters %} + +Além dos filtros disponíveis na barra de pesquisa, você pode ordenar e filtrar {% data variables.product.prodname_dependabot_alerts %} usando os menus suspensos na parte superior da lista de alertas. A barra de pesquisa também permite a pesquisa por texto completo de alertas e consultorias de segurança relacionados. Você pode pesquisar parte de uma consultoria de segurança ou uma descrição para devolver os alertas no seu repositório que estejam relacionados a essa consultoria de segurança. For example, searching for `yaml.load() API could execute arbitrary code` will return {% data variables.product.prodname_dependabot_alerts %} linked to "[PyYAML insecurely deserializes YAML strings leading to arbitrary code execution](https://github.com/advisories/GHSA-rprw-h62v-c2w7)" as the search string appears in the advisory description. + +{% endif %} + +{% ifversion dependabot-bulk-alerts %} + ![Captura de tela dos menus filtro e ordenação na aba de {% data variables.product.prodname_dependabot_alerts %}](/assets/images/help/graphs/dependabot-alerts-filters-checkbox.png){% elsif ghes = 3.5 %} +Você pode selecionar um filtro em um menu suspenso na parte superior da lista e, em seguida, clicar no filtro que gostaria de aplicar. ![Screenshot of the filter and sort menus in the {% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/enterprise/3.5/dependabot/dependabot-alerts-filters.png){% endif %} + {% ifversion dependabot-alerts-development-label %} ## Ecossistemas e manifestos compatíveis com o escopo de dependência - {% data reusables.dependabot.dependabot-alerts-dependency-scope %} -Os alertas para pacotes listados como dependências de desenvolvimento estão marcados com a etiqueta `Desenvolvimento` na página {% data variables.product.prodname_dependabot_alerts %} e estão também disponíveis para filtragem através do filtro de `escopo`. ![Captura de tela que mostra a etiqueta "Desenvolvimento" na lista de alertas](/assets/images/help/repository/dependabot-alerts-development-label.png) +Os alertas para pacotes listados como dependências de desenvolvimento estão marcados com a etiqueta `Desenvolvimento` na página {% data variables.product.prodname_dependabot_alerts %} e estão também disponíveis para filtragem através do filtro de `escopo`. -A página de detalhes de alerta de alertas de pacotes com escopo de desenvolvimento mostra uma seção "Tags", que contém uma etiqueta de `Desenvolvimento`. ![Captura de tela que mostra a seção "Tags" seção na página de detalhes do alerta](/assets/images/help/repository/dependabot-alerts-tags-section.png) +![Captura de tela que mostra a etiqueta "Desenvolvimento" na lista de alertas](/assets/images/help/repository/dependabot-alerts-development-label.png) + +A página de detalhes de alerta de alertas de pacotes com escopo de desenvolvimento mostra uma seção "Tags", que contém uma etiqueta de `Desenvolvimento`. + +![Captura de tela que mostra a seção "Tags" seção na página de detalhes do alerta](/assets/images/help/repository/dependabot-alerts-tags-section.png) {% endif %} @@ -90,23 +110,10 @@ Para obter mais informações, consulte "[Revisando e corrigindo alertas](#revie {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-dependabot-alerts %} -1. Opcionalmente, para filtrar alertas, selecione o menu suspenso **Repositório**, **Pacote**, **Ecossistema** ou **Manifesto** e clique no filtro que você gostaria de aplicar. Você também pode digitar filtros na barra de pesquisa. Por exemplo, `ecosystem:npm`{% ifversion ghes < 3.7 or ghae-issue-5638 %} or `has:patch`{% endif %}{% ifversion dependabot-alerts-development-label %}, `has:patch` ou `scope:development`{% endif %}. Para classificar os alertas, selecione o menu suspenso **Ordenar** e clique na opção que deseja ordenar, ou digite `sort:` na barra de pesquisa e escolha uma opção entre as sugestões (por exemplo, `sort:newest`). - - {% ifversion dependabot-most-important-sort-option %} - {% note %} - - **Observação:** Por padrão, {% data variables.product.prodname_dependabot_alerts %} são ordenados por importância. A classificação "mais importante" ajuda você a priorizar na qual {% data variables.product.prodname_dependabot_alerts %} deve se concentrar primeiro. Os alertas são classificados com base no seu impacto potencial, atuabilidade e relevância. O nosso cálculo de priorização está em melhoria constante e inclui fatores como pontuação do CVSS, âmbito de dependência, e se são encontradas chamadas de função vulneráveis para o alerta. - {% endnote %} - - ![Captura de tela da classificação suspensa com a classificação "mais importante"](/assets/images/help/dependabot/dependabot-alerts-sort-dropdown.png) - {% endif %} - - Você também pode clicar em uma etiqueta em um alerta para mostrar apenas alertas desse tipo.{% ifversion dependabot-alerts-development-label %} Por exemplo, clicar na etiqueta de `Desenvolvimento` na lista de alertas mostrará apenas os alertas relacionados às dependências usadas em desenvolvimento, não na produção. Para obter informações sobre a lista de ecossistemas compatíveis, consulte "[Ecossistemas e manifestos compatíveis para o escopo de dependência](#supported-ecosystems-and-manifests-for-dependency-scope)". - -{% endif %} +1. Opcionalmente, para filtrar alertas, selecione um filtro no menu suspenso e, em seguida, clique no filtro que deseja aplicar. Você também pode digitar filtros na barra de pesquisa. Para obter mais informações sobre filtragem e classificação dos alertas, consulte "[Prioritizando {% data variables.product.prodname_dependabot_alerts %}](#prioritizing-across--data-variablesproductprodname_dependabot_alerts-)". {%- ifversion dependabot-bulk-alerts %} ![Captura de tela dos menus filtro e ordenação na aba de {% data variables.product.prodname_dependabot_alerts %}](/assets/images/help/graphs/dependabot-alerts-filters-checkbox.png){% else %} - ![Screenshot of the filter and sort menus in the {% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/enterprise/3.5/dependabot/dependabot-alerts-filters.png){% endif %} +![Screenshot of the filter and sort menus in the {% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/enterprise/3.5/dependabot/dependabot-alerts-filters.png){% endif %} 1. Clique no alerta que você gostaria de ver.{% ifversion dependabot-bulk-alerts %} ![Alert selected in list of alerts](/assets/images/help/graphs/click-alert-in-alerts-list-checkbox.png){% else %} ![Alert selected in list of alerts](/assets/images/enterprise/3.5/dependabot/click-alert-in-alerts-list-ungrouped.png){% endif %} @@ -156,7 +163,12 @@ Para as linguagens compatíveis, {% data variables.product.prodname_dependabot % Se você agendar um extenso trabalho para atualizar uma dependência ou decidir que um alerta não precisa ser corrigido, você poderá ignorar o alerta. Ignorando alertas que você já avaliou facilita a triagem de novos alertas conforme eles aparecem. 1. Ver detalhes de um alerta. Para obter mais informações, consulte "[Visualizando dependências vulneráveis](#viewing-dependabot-alerts)" (acima). -1. Selecione o menu suspenso "Ignorar" e clique em um motivo para ignorar o alerta.{% ifversion reopen-dependabot-alerts %} Alertas não descartados podem ser reabertos posteriormente.{% endif %} ![Escolher o motivo para ignorar o alerta a partir do menu suspenso "Ignorar"down](/assets/images/help/repository/dependabot-alert-dismiss-drop-down-ungrouped.png) +1. Selecione o menu suspenso "Ignorar" e clique em um motivo para ignorar o alerta.{% ifversion reopen-dependabot-alerts %} Alertas não descartados podem ser reabertos posteriormente.{% endif %} +{% ifversion dependabot-alerts-dismissal-comment %}1. Opcionalmente, adicione um comentário de dispensa. O comentário de dispensa será adicionado à linha do tempo de alerta e poderá ser usado como justificativa durante a auditoria e a apresentação de relatórios. Você pode recuperar ou definir um comentário usando a API do GraphQL. O comentário está contido no campo `dismissComment` Para obter mais informações, consulte "[{% data variables.product.prodname_dependabot_alerts %}](/graphql/reference/objects#repositoryvulnerabilityalert)" na documentação da API do GraphQL. + ![Captura de tela que mostra como ignorar um alerta por meio do menu suspenso "ignorar" com a opção de adicionar um comentário de dispensa](/assets/images/help/repository/dependabot-alerts-dismissal-comment.png) +1. Clique **Ignorar alerta**. +{% else %} + ![Escolher o motivo para ignorar o alerta a partir do menu suspenso "Ignorar"down](/assets/images/help/repository/dependabot-alert-dismiss-drop-down-ungrouped.png){% endif %} {% ifversion dependabot-bulk-alerts %} ### Ignorar múltiplos alertas de uma vez @@ -173,7 +185,7 @@ Se você agendar um extenso trabalho para atualizar uma dependência ou decidir ## Visualizando e atualizando alertas fechados -You can view all open alerts, and you can reopen alerts that have been previously dismissed. Os alertas fechados que já foram corrigidos não podem ser reabertos. +Você pode visualizar todos os alertas abertos e pode reabrir os alertas que foram ignorados anteriormente. Os alertas fechados que já foram corrigidos não podem ser reabertos. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} @@ -185,7 +197,7 @@ You can view all open alerts, and you can reopen alerts that have been previousl {%- else %} ![Captura de tela que mostra a opção "Fechado"](/assets/images/help/repository/dependabot-alerts-closed.png) {%- endif %} -1. Click the alert that you would like to view or update. +1. Clique no alerta que deseja ver ou atualizar. {%- ifversion dependabot-bulk-alerts %} ![Captura de tela que mostra um alerta do dependabot destacado](/assets/images/help/repository/dependabot-alerts-select-closed-alert-checkbox.png) diff --git a/translations/pt-BR/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md b/translations/pt-BR/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md index 74de2a9c91..19d4b04726 100644 --- a/translations/pt-BR/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md +++ b/translations/pt-BR/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md @@ -416,7 +416,7 @@ updates: ### `open-pull-requests-limit` -Por padrão, {% data variables.product.prodname_dependabot %} abre um máximo de cinco pull requests para atualizações de versão. Uma vez que há cinco pull requests abertos, novas solicitações serão bloqueadas até que você faça o merge ou feche alguns dos pull requests aberto, e, após esse peeríodo, novos pull requests poderão ser abertos em atualizações subsequentes. Use `open-pull-requests-limit` para alterar este limite. Isto também fornece uma maneira simples de desativar temporariamente as atualizações de versão para um gerenciador de pacotes. +Por padrão, {% data variables.product.prodname_dependabot %} abre um máximo de cinco pull requests para atualizações de versão. Como há cinco pull requests em aberto de {% data variables.product.prodname_dependabot %}, {% data variables.product.prodname_dependabot %} não abrirá nenhuma nova solicitação até que algumas das solicitações abertas sejam mescladas ou fechadas. Use `open-pull-requests-limit` para alterar este limite. Isto também fornece uma maneira simples de desativar temporariamente as atualizações de versão para um gerenciador de pacotes. Esta opção não tem impacto em atualizações de segurança, que têm um limite interno separado de dez pull requests abertas. diff --git a/translations/pt-BR/content/code-security/secret-scanning/about-secret-scanning.md b/translations/pt-BR/content/code-security/secret-scanning/about-secret-scanning.md index 481ec138e4..0110c45c23 100644 --- a/translations/pt-BR/content/code-security/secret-scanning/about-secret-scanning.md +++ b/translations/pt-BR/content/code-security/secret-scanning/about-secret-scanning.md @@ -39,7 +39,7 @@ Service providers can partner with {% data variables.product.company_short %} to {% ifversion secret-scanning-push-protection %} -You can also enable {% data variables.product.prodname_secret_scanning %} as a push protection for a repository or an organization. When you enable this feature, {% data variables.product.prodname_secret_scanning %} prevents contributors from pushing code with a detected secret. To proceed, contributors must either remove the secret(s) from the push or, if needed, bypass the protection. For more information, see "[Protecting pushes with {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." +You can also enable {% data variables.product.prodname_secret_scanning %} as a push protection for a repository or an organization. When you enable this feature, {% data variables.product.prodname_secret_scanning %} prevents contributors from pushing code with a detected secret. To proceed, contributors must either remove the secret(s) from the push or, if needed, bypass the protection. {% ifversion push-protection-custom-link-orgs %}Admins can also specify a custom link that is displayed to the contributor when a push is blocked; the link can contain resources specific to the organization to aid contributors. {% endif %}For more information, see "[Protecting pushes with {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." {% endif %} diff --git a/translations/pt-BR/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md b/translations/pt-BR/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md index e7449ab8d9..5efb3d4ac3 100644 --- a/translations/pt-BR/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md +++ b/translations/pt-BR/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md @@ -60,8 +60,20 @@ Os proprietários da organização, gerentes de segurança e administradores de Até cinco segredos detectados serão exibidos por vez na linha de comando. Se um segredo específico já foi detectado no repositório e um alerta já existe, {% data variables.product.prodname_dotcom %} não bloqueará esse segredo. +{% ifversion push-protection-custom-link-orgs %} + +Os administradores da organização podem fornecer um link personalizado que será exibido quando um push estiver bloqueado. Este link personalizado pode conter recursos e conselhos específicos da organização como, por exemplo, orientações sobre como usar um cofre de segredos recomendado ou como entrar em contato em caso de perguntas relacionadas ao segredo bloqueado. + +{% ifversion push-protection-custom-link-orgs-beta %}{% data reusables.advanced-security.custom-link-beta %}{% endif %} + +![Captura de tela que mostra que um push está bloqueado quando um usuário tenta fazer push de um segredo para um repositório](/assets/images/help/repository/secret-scanning-push-protection-with-custom-link.png) + +{% else %} + ![Captura de tela que mostra que um push está bloqueado quando um usuário tenta fazer push de um segredo para um repositório](/assets/images/help/repository/secret-scanning-push-protection-with-link.png) +{% endif %} + {% data reusables.secret-scanning.push-protection-remove-secret %} Para obter mais informações sobre correção de segredos bloqueados, consulte "[Enviando por push um branch bloqueado pela proteção de push](/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection#resolving-a-blocked-push-on-the-command-line)." Se você confirmar que um segredo é real e pretender corrigi-lo mais tarde, você deverá procurar remediar o segredo o mais rápido possível. Por exemplo, você pode revogar o segredo e remover o segredo do histórico de commit do repositório. Os verdadeiros segredos que foram expostos devem ser revogados para evitar o acesso não autorizado. Você pode considerar primeiro girar o segredo antes de revogá-lo. Para obter mais informações, consulte "[Removendo dados confidenciais de um repositório](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)". @@ -88,13 +100,21 @@ Se {% data variables.product.prodname_dotcom %} bloquear um segredo que você ac {% data variables.product.prodname_dotcom %} só exibirá um segredo detectado por vez na interface do usuário. Se um segredo específico já foi detectado no repositório e um alerta já existe, {% data variables.product.prodname_dotcom %} não bloqueará esse segredo. +{% ifversion push-protection-custom-link-orgs %} + +Os administradores da organização podem fornecer um link personalizado que será exibido quando um push estiver bloqueado. Este link personalizado pode conter recursos e conselhos específicos para sua organização. Por exemplo, o link personalizado pode apontar para um arquivo README com informações sobre o cofre secreto da organização, para quais equipes e indivíduos escalar perguntas ou a política aprovada pela organização para trabalhar com segredos e reescrever o histórico de commits. + +{% ifversion push-protection-custom-link-orgs-beta %}{% data reusables.advanced-security.custom-link-beta %}{% endif %} + +{% endif %} + Você pode remover o segredo do arquivo usando a interface de usuário da web. Depois de remover o segredo, o banner no topo da página mudará e dirá que agora você pode fazeer commit das suas alterações. ![Captura de tela que mostra o commit na interface de usuário da web, permitido após correção do segredo](/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-allowed.png) ### Ignorando a proteção de push para um segredo -{% data reusables.secret-scanning.push-protection-remove-secret %} Para obter mais informações sobre correção de segredos bloqueados, consulte "[Enviando por push um branch bloqueado pela proteção de push](/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection#resolving-a-blocked-push-in-the-web-ui)." +{% data reusables.secret-scanning.push-protection-remove-secret %} Para obter mais informações sobre correção de segredos bloqueados, consulte "[Enviando por push um branch bloqueado por proteção de push](/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection#resolving-a-blocked-push-in-the-web-ui)." Se você confirmar que um segredo é real e pretender corrigi-lo mais tarde, você deverá procurar remediar o segredo o mais rápido possível. Para obter mais informações, consulte "[Removendo dados confidenciais de um repositório](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)". diff --git a/translations/pt-BR/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md b/translations/pt-BR/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md index a71b0a2a63..da843d5f20 100644 --- a/translations/pt-BR/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md +++ b/translations/pt-BR/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md @@ -26,6 +26,14 @@ O recurso de proteção de push do {% data variables.product.prodname_secret_sca {% endtip %} +{% ifversion push-protection-custom-link-orgs %} + +Os administradores da organização podem fornecer um link personalizado que será incluído na mensagem de {% data variables.product.product_name %} quando seu push estiver bloqueado. Este link personalizado pode conter recursos e conselhos específicos para sua organização e suas políticas. + +{% ifversion push-protection-custom-link-orgs-beta %}{% data reusables.advanced-security.custom-link-beta %}{% endif %} + +{% endif %} + ## Resolvendo um push bloqueado na linha de comando {% data reusables.secret-scanning.push-protection-command-line-choice %} @@ -51,6 +59,6 @@ Você também pode remover o segredo se o segredo aparecer em um commit anterior {% data reusables.secret-scanning.push-protection-web-ui-choice %} -To resolve a blocked commit in the web UI, you need to remove the secret from the file, or use the **Bypass protection** dropdown to allow the secret. Para obter mais informações sobre como contornar a proteção de push da interface de usuário da web, consulte "[Protegendo pushes com a digitalização de segredo](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#bypassing-push-protection-for-a-secret)". +Para resolver um commit bloqueado na interface do usuário web, você deverá remover o segredo do arquivo, ou use o menu suspenso **Proteção de Bypass** para permitir o segredo. Para obter mais informações sobre como contornar a proteção de push da interface de usuário da web, consulte "[Protegendo pushes com a digitalização de segredo](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#bypassing-push-protection-for-a-secret)". Se você confirmar um segredo é real, você deverá remover o segredo do arquivo. Depois de remover o segredo, o banner no topo da página mudará e dirá que agora você pode fazeer commit das suas alterações. diff --git a/translations/pt-BR/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md b/translations/pt-BR/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md index 4f53f1678b..4fcbd86a09 100644 --- a/translations/pt-BR/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md +++ b/translations/pt-BR/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md @@ -12,25 +12,25 @@ shortTitle: Registro de imagem privada ## Sobre registros de imagens privadas e {% data variables.product.prodname_github_codespaces %} -Um registro é um espaço seguro para armazenar, gerenciar e buscar imagens privadas de contêineres. Você pode usar uma para armazenar uma ou mais imagens. Existem muitos exemplos de registros, como {% data variables.product.prodname_dotcom %} registro do contêiner, registro de contêiner do Azure ou DockerHub. +Um registro é um espaço seguro para armazenar, gerenciar e buscar imagens privadas de contêineres. Você pode usar uma para armazenar uma ou mais imagens. Existem muitos exemplos de registros, como {% data variables.product.prodname_container_registry %}, {% data variables.product.prodname_npm_registry %}, Azure Container Registry ou DockerHub. -O registro do contêiner de {% data variables.product.prodname_dotcom %} pode ser configurado para puxar imagens container sem precisar fornecer qualquer credencial para {% data variables.product.prodname_github_codespaces %}. Para outros registros de imagem, você deve criar segredos em {% data variables.product.prodname_dotcom %} para armazenar os detalhes de acesso, o que permitirá que {% data variables.product.prodname_codespaces %} acesse imagens armazenadas nesse registro. +{% data variables.product.prodname_ghcr_and_npm_registry %} pode ser configurado para permitir que as imagens do contêiner sejam enviadas perfeitamente para {% data variables.product.prodname_github_codespaces %} durante a criação do codespace sem ter que fornecer nenhuma credencial de autenticação. Para outros registros de imagem, você deve criar segredos em {% data variables.product.prodname_dotcom %} para armazenar os detalhes de acesso, o que permitirá que {% data variables.product.prodname_codespaces %} acesse imagens armazenadas nesse registro. -## Acessando imagens armazenadas no registro do contêiner de {% data variables.product.prodname_dotcom %} +## Acessando imagens armazenadas em {% data variables.product.prodname_ghcr_and_npm_registry %} -O registro de contêiner de {% data variables.product.prodname_dotcom %} é a maneira mais fácil de {% data variables.product.prodname_codespaces %} de consumir imagens de contêiner de desenvolvimento. +{% data variables.product.prodname_ghcr_and_npm_registry %} fornece a maneira mais fácil para {% data variables.product.prodname_codespaces %} consumir imagens de contêiner de desenvolvimento. -Para obter mais informações, consulte "[Trabalhando com o registro do contêiner](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)". +Para obter mais informações, consulte "[Trabalhando com o Registro do Contêiner](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)" e "[Trabalhando com o registro npm](/packages/working-with-a-github-packages-registry/working-with-the-npm-registry)". ### Acessar uma imagem publicada no mesmo repositório que o codespace -Se você publicar uma imagem de contêiner do {% data variables.product.prodname_dotcom %} no mesmo repositório em que o codespace está sendo lançado, você poderá de buscar automaticamente essa imagem na criação de um codespace. Você não terá que fornecer qualquer credencial adicional, a menos a opção **Herdar acesso do repositório** tenha sido desmarcada quando a imagem do contêiner foi publicada. +Se você publicar uma imagem do {% data variables.product.prodname_ghcr_or_npm_registry %} no mesmo repositório em que o codespace está sendo lançado, você poderá de buscar automaticamente essa imagem na criação de um codespace. Você não terá que fornecer qualquer credencial adicional, a menos a opção **Herdar acesso do repositório** tenha sido desmarcada quando a imagem do contêiner foi publicada. #### Herdando acesso a partir do repositório no qual uma imagem foi publicada -Por padrão, quando você publica uma imagem de contêiner no registro do contêiner de {% data variables.product.prodname_dotcom %}, a imagem herda a configuração de acesso do repositório no qual a imagem foi publicada. Por exemplo, se o repositório for público, a imagem também é pública. Se o repositório for privado, a imagem também é privada, mas pode ser acessada a partir do repositório. +Por padrão, ao publicar uma imagem de contêiner para {% data variables.product.prodname_ghcr_or_npm_registry %}, a imagem herda a configuração de acesso do repositório do qual a imagem foi publicada. Por exemplo, se o repositório for público, a imagem também é pública. Se o repositório for privado, a imagem também é privada, mas pode ser acessada a partir do repositório. -Este comportamento é controlado pela opção de **Herdar acesso do repositório**. O **Acesso herdado do repo** é selecionado por padrão ao publicar {% data variables.product.prodname_actions %}, mas não ao publicar diretamente no registro do contêiner de {% data variables.product.prodname_dotcom %} usando um Token de Acesso Pessoal (PAT). +Este comportamento é controlado pela opção de **Herdar acesso do repositório**. O **Acesso herdado do repo** é selecionado por padrão ao publicar {% data variables.product.prodname_actions %}, mas não ao publicar diretamente no {% data variables.product.prodname_ghcr_or_npm_registry %} usando um Token de Acesso Pessoal (PAT). Se a opção **Herdar acesso do repositório** não foi selecionada quando a imagem foi publicada, você pode adicionar o repositório manualmente aos controles de acesso da imagem de contêiner. Para obter mais informações, consulte "[Configurar o controle de acesso e visibilidade de um pacote](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#inheriting-access-for-a-container-image-from-a-repository)". @@ -46,13 +46,13 @@ Se você deseja permitir que um subconjunto de repositórios de uma organizaçã ### Publicando uma imagem de contêiner a partir de um codespace -O acesso seguro a partir de um codespace para o registro de um contêiner de {% data variables.product.prodname_dotcom %} é limitado à extração de imagens de contêineres. Se você deseja publicar a imagem de um contêiner de dentro de um codespace, você deve usar um token de acesso pessoal (PAT) com o escopo `write:packages`. +O acesso seguro a partir de um codespace para o {% data variables.product.prodname_ghcr_or_npm_registry %} é limitado à extração de imagens de contêineres. Se você deseja publicar a imagem de um contêiner de dentro de um codespace, você deve usar um token de acesso pessoal (PAT) com o escopo `write:packages`. -Recomendamos publicar imagens via {% data variables.product.prodname_actions %}. Para obter mais informações, consulte "[Publicar imagens Docker](/actions/publishing-packages/publishing-docker-images)". +Recomendamos publicar imagens via {% data variables.product.prodname_actions %}. Para obter mais informações, consulte "[Publicando imagens do Docker](/actions/publishing-packages/publishing-docker-images)" e "[Publicando pacotes do Node.js](/actions/publishing-packages/publishing-nodejs-packages)". ## Acessando as imagens armazenadas em outros registros de contêiner -Se você estiver acessando um contêiner a partir de um registro que não é registro de contêiner de {% data variables.product.prodname_dotcom %}, {% data variables.product.prodname_codespaces %} irá verificar a presença de três segredos, que define o nome de servidor, nome de usuário, e token de acesso pessoal (PAT) para um registro de contêiner. Se estes segredos forem encontrados, {% data variables.product.prodname_github_codespaces %} disponibilizará o registro dentro do seu codespace. +Se você estiver acessando uma imagem de contêiner de um registro que não é {% data variables.product.prodname_ghcr_or_npm_registry %}, {% data variables.product.prodname_codespaces %} verifica a presença de três segredos, que define o nome de servidor, nome de usuário e token de acesso pessoal (PAT) para um registro de contêiner. Se estes segredos forem encontrados, {% data variables.product.prodname_github_codespaces %} disponibilizará o registro dentro do seu codespace. - `<*>_CONTAINER_REGISTRY_SERVER` - `<*>_CONTAINER_REGISTRY_USER` diff --git a/translations/pt-BR/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md b/translations/pt-BR/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md index 3f4e6040d3..3272984eab 100644 --- a/translations/pt-BR/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md +++ b/translations/pt-BR/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md @@ -88,15 +88,13 @@ Você pode adicionar mais script, preferências e arquivos de configuração ao Se o seu código não consegue pegar as configurações nos dotfiles, consulte "[Solução de problemas para {% data variables.product.prodname_codespaces %}](/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces)". -## Outras configurações disponíveis - Você também pode personalizar {% data variables.product.prodname_codespaces %} usando [as configurações adicionais de {% data variables.product.prodname_codespaces %}de](https://github.com/settings/codespaces): -- Para definir sua região padrão, consulte "[Definindo sua região padrão para {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces)." -- Para definir seu editor, consulte "[Definindo seu editor padrão para {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces)" -- Para adicionar segredos criptografados, consulte "[Gerenciar segredos criptografados para {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces)". - Para habilitar a verificação do GPG, consulte "[Gerenciar a verificação de GPG para {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)." -- Para permitir que os seus codespaces acessem outros repositórios, consulte "[Gerenciando o acesso do repositório para os codespaces da sua organização](/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces)". +- Para definir seu editor, consulte "[Definindo seu editor padrão para {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces)" +- Para definir quanto tempo um código não pode ser utilizado antes de ser interrompido automaticamente, consulte "[Definindo seu período de tempo limite para GitHub Codespaces](/codespaces/customizing-your-codespace/setting-your-timeout-period-for-github-codespaces)." +- Para definir o período para o qual seus códigos não utilizados são mantidos, consulte "[Configurando exclusão automática de seus codespaces](/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces)". +- Para definir sua região padrão, consulte "[Definindo sua região padrão para {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces)." ## Leia mais diff --git a/translations/pt-BR/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/translations/pt-BR/content/codespaces/developing-in-codespaces/creating-a-codespace.md index 72d6f4fd75..1d5a7d0dcb 100644 --- a/translations/pt-BR/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ b/translations/pt-BR/content/codespaces/developing-in-codespaces/creating-a-codespace.md @@ -2,7 +2,6 @@ title: Criar um codespace intro: Você pode criar um codespace para uma branch em um repositório para fazer o desenvolvimento on-line. product: '{% data reusables.gated-features.codespaces %}' -permissions: '{% data reusables.codespaces.availability %}' redirect_from: - /github/developing-online-with-github-codespaces/creating-a-codespace - /github/developing-online-with-codespaces/creating-a-codespace @@ -21,7 +20,7 @@ shortTitle: Criar um codespace Você pode criar um codespace em {% data variables.product.prodname_dotcom_the_website %}, em {% data variables.product.prodname_vscode %}, ou usando {% data variables.product.prodname_cli %}. {% data reusables.codespaces.codespaces-are-personal %} -Os codespaces são associados a um branch específico de um repositório e o repositório não pode estar vazio. {% data reusables.codespaces.concurrent-codespace-limit %} Para obter mais informações, consulte "[Excluir um codespace](/github/developing-online-with-codespaces/deleting-a-codespace)". +Os codespaces são associados a um branch específico de um repositório e o repositório não pode estar vazio. {% data reusables.codespaces.concurrent-codespace-limit %} Ao criar um codespace, várias etapas acontecem para criar e conectar você ao seu ambiente de desenvolvimento: @@ -45,27 +44,22 @@ Se você quiser usar hooks do Git para o seu código, você deverá configurar h ## Acesso a {% data variables.product.prodname_github_codespaces %} -{% data reusables.codespaces.availability %} - Quando você tem acesso a {% data variables.product.prodname_github_codespaces %}, você verá uma aba "Codespace" dentro do menu suspenso ** Código de{% octicon "code" aria-label="The code icon" %} ** ao visualizar um repositório. -Você terá acesso a codespaces nas seguintes condições: +Você terá acesso ao {% data variables.product.prodname_github_codespaces %} nas seguintes condições: -* Você é um integrante de uma organização que habilitou {% data variables.product.prodname_codespaces %} e definiu um limite de gastos. -* Um proprietário da organização concedeu a você acesso a {% data variables.product.prodname_codespaces %}. -* O repositório pertence à organização que habilitou {% data variables.product.prodname_codespaces %}. +Ou todos estes são verdadeiros: +* Você é integrante, ou colaborador externo, de uma organização que permitiu {% data variables.product.prodname_codespaces %} e definiu um limite de gastos. +* O proprietário da organização permitiu que você criasse codespaces às custas da organização. +* O repositório para o qual você deseja criar um codespace pertence a esta organização. -{% note %} - -**Observação:** As pessoas que já aderiram ao beta com sua conta pessoal do {% data variables.product.prodname_dotcom %} não perderão acesso a {% data variables.product.prodname_codespaces %}. No entanto, {% data variables.product.prodname_codespaces %} para as pessoas, continuará sendo beta. - -{% endnote %} - -Os proprietários da organização podem permitir que todos os integrantes da organização criem codespaces, limitem a criação de códigos aos integrantes selecionados da organização ou desabilitem a criação de codespace. Para obter mais informações sobre como gerenciar o acesso aos codespaces dentro da sua organização, consulte "[Habilitar codespace para usuários da sua organização](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization#enable-codespaces-for-users-in-your-organization)". +Ou ambos são verdadeiros: +* Você está participando do beta de {% data variables.product.prodname_codespaces %} para usuários individuais. +* Ou você possui o repositório para o qual deseja criar um codespace ou ele pertence a uma organização da qual você é integrante ou colaborador externo. Antes de {% data variables.product.prodname_codespaces %} pode ser usado em uma organização, um proprietário ou gerente de cobrança deverá ter um limite de gastos. Para obter mais informações, consulte "[Sobre limites de gastos para codespaces](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces#about-spending-limits-for-codespaces)". -Se você deseja criar um codespace para um repositório pertencente à sua conta pessoal ou outro usuário e você tem permissão para criar repositórios em uma organização que habilitou {% data variables.product.prodname_github_codespaces %}, você poderá criar uma bifurcação de repositórios pertencentes ao usuário na organização e, em seguida, criar um codespace para a bifurcação. +Os proprietários da organização podem especificar quem pode criar e usar codespaces às expensas da organização. Os proprietários da organização também podem impedir que o uso de qualquer código seja cobrado da organização. Para obter mais informações, consulte "[Habilitando {% data variables.product.prodname_github_codespaces %} para a sua organização](/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization#choose-who-can-create-codespaces-that-are-billed-to-your-organization)". ## Criar um codespace @@ -118,7 +112,7 @@ Se você deseja criar um codespace para um repositório pertencente à sua conta {% endnote %} - 1. Clique **Iniciar sessão**. + 1. Clique em **Iniciar sessão**. {% endwebui %} @@ -132,7 +126,7 @@ Se você deseja criar um codespace para um repositório pertencente à sua conta {% data reusables.cli.cli-learn-more %} -Para criar um novo codespace, use o subcomando `gh create`. +Para criar um novo codespace, use o subcomando `gh codespace create`. ```shell gh codespace create diff --git a/translations/pt-BR/content/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace.md b/translations/pt-BR/content/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace.md index a64755ead9..42e7341fc2 100644 --- a/translations/pt-BR/content/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace.md +++ b/translations/pt-BR/content/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace.md @@ -2,7 +2,6 @@ title: Variáveis de ambiente padrão para seu codespace shortTitle: Variáveis padrão de ambiente product: '{% data reusables.gated-features.codespaces %}' -permissions: '{% data reusables.codespaces.availability %}' intro: 'O {% data variables.product.prodname_dotcom %} define variáveis de ambiente padrão para cada codespace.' versions: fpt: '*' diff --git a/translations/pt-BR/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md b/translations/pt-BR/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md index cc1e753fb9..57870464fe 100644 --- a/translations/pt-BR/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md +++ b/translations/pt-BR/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md @@ -2,7 +2,6 @@ title: Desenvolver em um codespace intro: 'Você pode abrir um codespace em {% data variables.product.product_name %} e, em seguida, desenvolver usando os recursos do {% data variables.product.prodname_vscode %}.' product: '{% data reusables.gated-features.codespaces %}' -permissions: 'You can develop in codespaces you''ve created for repositories owned by organizations using {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %}.' redirect_from: - /github/developing-online-with-github-codespaces/developing-in-a-codespace - /github/developing-online-with-codespaces/developing-in-a-codespace diff --git a/translations/pt-BR/content/codespaces/developing-in-codespaces/renaming-a-codespace.md b/translations/pt-BR/content/codespaces/developing-in-codespaces/renaming-a-codespace.md index 211035cabb..578598e01a 100644 --- a/translations/pt-BR/content/codespaces/developing-in-codespaces/renaming-a-codespace.md +++ b/translations/pt-BR/content/codespaces/developing-in-codespaces/renaming-a-codespace.md @@ -1,6 +1,6 @@ --- -title: Renaming a codespace -intro: 'You can use the {% data variables.product.prodname_cli %} to change the codespace display name to one of your choice.' +title: Renomeando um codespace +intro: 'Você pode usar o {% data variables.product.prodname_cli %} para alterar o nome de exibição do codespace para um de sua escolha.' product: '{% data reusables.gated-features.codespaces %}' versions: fpt: '*' @@ -10,45 +10,47 @@ topics: - Codespaces - Fundamentals - Developer -shortTitle: Rename a codespace +shortTitle: Renomear um codespace --- -## About renaming a codespace +## Sobre renomear um codespace -Each codespace is assigned an auto-generated display name. If you have multiple codespaces, the display name helps you to differentiate between codespaces. For example: `literate space parakeet`. You can change the display name for your codespace. +A cada codespace é atribuído um nome de exibição gerado automaticamente. Se você tiver vários codespaces, o nome de exibição ajudará você a diferenciá-los. Por exemplo: `literate space parakeet`. Você pode alterar o nome de exibição do seu codespace. -To find the display name of a codespace: +Para encontrar o nome de exibição de um codespace: -- On {% data variables.product.product_name %}, view your list of codespaces at https://github.com/codespaces. +- Em {% data variables.product.product_name %}, consulte sua lista de codespace em https://github.com/codespaces. - ![Screenshot of the list of codespaces in GitHub](/assets/images/help/codespaces/codespaces-list-display-name.png) + ![Captura de tela da lista de codespaces no GitHub](/assets/images/help/codespaces/codespaces-list-display-name.png) -- In the {% data variables.product.prodname_vscode %} desktop application, or the {% data variables.product.prodname_vscode_shortname %} web client, click the Remote Explorer. The display name is shown below the repository name. For example: `symmetrical space telegram` in the screenshot below. +- No aplicativo de área de trabalho {% data variables.product.prodname_vscode %}, ou no cliente web {% data variables.product.prodname_vscode_shortname %}, clique no Explorador Remoto. O nome de exibição é mostrado abaixo do nome do repositório. Por exemplo: `symmetrical space telegram` na captura de tela abaixo. - ![Screenshot of the Remote Explorer in VS Code](/assets/images/help/codespaces/codespaces-remote-explorer.png) + ![Captura de tela do Explorador Remoto no VS Code](/assets/images/help/codespaces/codespaces-remote-explorer.png) -- In a terminal window on your local machine, use this {% data variables.product.prodname_cli %} command: `gh codespace list`. -### Permanent codespace names +{% indented_data_reference reusables.codespaces.remote-explorer spaces=2 %} +- Em uma janela do terminal em sua máquina local, use o comando {% data variables.product.prodname_cli %}: `gh codespace list`. -In addition to the display name, when you create a codespace, a permanent name is also assigned to the codespace. The name is a combination of your {% data variables.product.company_short %} handle, the repository name, and some random characters. Por exemplo: `octocat-myrepo-gmc7`. You can't change this name. +### Nomes de codespaces permanente -To find the permanent name of a codespace: +Além do nome de exibição, ao criar um codespace, um nome permanente também é atribuído ao codespace. O nome é uma combinação do seu {% data variables.product.company_short %}, do nome do repositório e de alguns caracteres aleatórios. Por exemplo: `octocat-myrepo-gmc7`. Você não pode mudar este nome. -* On {% data variables.product.product_name %}, the permanent name is shown in a pop-up when you hover over the **Open in browser** option on https://github.com/codespaces. +Para encontrar o nome permanente de um codespace: - ![Screenshot of the codespace name shown on hover over](/assets/images/help/codespaces/find-codespace-name-github.png) +* Em {% data variables.product.product_name %}, o nome permanente é mostrado em uma janela pop-up quando você passa o mouse sobre a opção **Abrir no navegador** em https://github.com/codespaces. -* In a codespace, use this command in the terminal: `echo $CODESPACE_NAME`. -* In a terminal window on your local machine, use this {% data variables.product.prodname_cli %} command: `gh codespace list`. + ![Captura de tela do nome do código exibida ao passar o mouse](/assets/images/help/codespaces/find-codespace-name-github.png) -## Renaming a codespace +* Em um código, use este comando no terminal: `echo $CODESPACE_NAME`. +* Em uma janela do terminal em sua máquina local, use o comando {% data variables.product.prodname_cli %}: `gh codespace list`. -Changing the display name of a codespace can be useful if you have multiple codespaces that you will be using for an extended period. An appropriate name helps you identify a codespace that you use for a particular purpose. You can change the display name for your codespace by using the {% data variables.product.prodname_cli %}. +## Renomeando um codespace -To rename a codespace, use the `gh codespace edit` subcommand: +Alterar o nome de exibição de um codespace pode ser útil se você tiver vários codespaces que você irá usar por um período prolongado. Um nome apropriado ajuda você a identificar um codespace que você usa para uma finalidade específica. Você pode alterar o nome de exibição do seu codespace usando o {% data variables.product.prodname_cli %}. + +Para renomear um codespace, use o subcomando`gh codespace edit`: ```shell gh codespace edit -c permanent name of the codespace -d new display name ``` -In this example, replace `permanent name of the codespace` with the permanent name of the codespace. Replace `new display name` with the desired display name. +Neste exemplo, substitua `permanent name of the codespace` pelo nome permanente do codespace. Substitua `new display name` pelo nome de exibição desejado. diff --git a/translations/pt-BR/content/codespaces/guides.md b/translations/pt-BR/content/codespaces/guides.md index 09d9e7d3f9..72b2e974ba 100644 --- a/translations/pt-BR/content/codespaces/guides.md +++ b/translations/pt-BR/content/codespaces/guides.md @@ -40,7 +40,6 @@ includeGuides: - /codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization - /codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization - /codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces - - /codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces - /codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types - /codespaces/managing-codespaces-for-your-organization/retricting-the-idle-timeout-period - /codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces diff --git a/translations/pt-BR/content/codespaces/index.md b/translations/pt-BR/content/codespaces/index.md index bba71a0070..3649126205 100644 --- a/translations/pt-BR/content/codespaces/index.md +++ b/translations/pt-BR/content/codespaces/index.md @@ -7,11 +7,11 @@ introLinks: quickstart: /codespaces/getting-started/quickstart featuredLinks: guides: - - /billing/managing-billing-for-github-codespaces/about-billing-for-codespaces - /codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization - - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project - - /codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces - /codespaces/developing-in-codespaces/codespaces-lifecycle + - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project + - /codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces + - /billing/managing-billing-for-github-codespaces/about-billing-for-codespaces popular: - /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces - /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces diff --git a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md index 0e4e9da920..6f71eaca91 100644 --- a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md +++ b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md @@ -1,9 +1,9 @@ --- title: Habilitando o GitHub Codespaces para sua organização -shortTitle: Habilitar codespaces -intro: 'Você pode controlar quais usuários da sua organização podem usar {% data variables.product.prodname_github_codespaces %}.' +shortTitle: 'Habilite {% data variables.product.prodname_codespaces %}' +intro: 'Você pode controlar quais usuários da sua organização podem usar o {% data variables.product.prodname_github_codespaces %} às custas da organização.' product: '{% data reusables.gated-features.codespaces %}' -permissions: 'To manage user permissions for {% data variables.product.prodname_github_codespaces %} for an organization, you must be an organization owner.' +permissions: 'To alter an organization''s billing settings, you must be an organization owner.' redirect_from: - /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization - /codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization @@ -13,25 +13,23 @@ versions: type: how_to topics: - Codespaces - - Permissions + - Billing - Administrator --- - ## Sobre habilitar {% data variables.product.prodname_github_codespaces %} para a sua organização -Os proprietários da organização podem controlar quais usuários da sua organização podem criar e usar cdespaces. +Os proprietários da organização podem controlar quais usuários da sua organização podem criar e usar códigos às custas da organização. -Para usar codespaces na sua organização, você deve fazer o seguinte: +Somente as pessoas que podem clonar um repositório podem criar um codespace para esse repositório. Para permitir que as pessoas criem codespaces para repositórios pertencentes a sua organização, você deve: + +- Certificar-se de que os usuários tenham pelo menos acesso de gravação aos repositórios onde querem usar um codespace. Para obter mais informações, consulte "[Gerenciar equipes e pessoas com acesso ao seu repositório](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository). " +- Certifique-se de que a sua organização não tem um endereço IP permitir a lista habilitada. Para obter mais informações, consulte "[Gerenciar endereços IP permitidos para sua organização](/{% ifversion fpt %}enterprise-cloud@latest/{% endif %}organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization){% ifversion fpt %}" na documentação de {% data variables.product.prodname_ghe_cloud %}.{% else %}"{% endif %} + +Para permitir que as pessoas criem codespaces para os quais sua organização será cobrada, você deve: -- Certifique-se de que os usuários tenham [pelo menos acesso de gravação](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization) nos repositórios onde desejam usar um codespace. -- [Habilitar {% data variables.product.prodname_github_codespaces %} para os usuários da sua organização](#enable-codespaces-for-users-in-your-organization). Você pode escolher permitir {% data variables.product.prodname_codespaces %} para usuários selecionados ou apenas para usuários específicos. - [Definir um limite de gastos](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces) -- Certifique-se de que a sua organização não tem um endereço IP permitir a lista habilitada. Para obter mais informações, consulte "[Gerenciar endereços IP permitidos para sua organização](/{% ifversion fpt %}enterprise-cloud@latest/{% endif %}organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list){% ifversion fpt %}" na documentação de {% data variables.product.prodname_ghe_cloud %}.{% else %}"{% endif %} - -Por padrão, um codespace só pode acessar o repositório no qual ele foi criado. Se você quiser que os codespaces na sua organização possam acessar outros repositórios da organização que o criador do codespace possa acessar, consulte "[Gerenciar acesso e segurança para {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)". - -## Habilitar {% data variables.product.prodname_codespaces %} para os usuários na sua organização +- [Escolher quem pode criar codespaces que são cobrados da sua organização](#choose-who-can-create-codespaces-that-are-billed-to-your-organization) {% ifversion fpt %} {% note %} @@ -40,31 +38,44 @@ Por padrão, um codespace só pode acessar o repositório no qual ele foi criado {% endnote %} {% endif %} + +Por padrão, um codespace só pode acessar o repositório no qual ele foi criado. Se você quiser que os codespaces na sua organização possam acessar outros repositórios de organização que o criador do codespace possa acessar, consulte "[Gerenciar acesso do repositório aos codespaces da sua organização](/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces)". + +## Escolher quem pode criar codespaces que são cobrados da sua organização + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.click-codespaces %} -1. Em "Permissões de usuário", selecione uma das seguintes opções: +1. Em "cobrança", selecione uma das seguintes opções: - * **Usuários selecionados** para selecionar integrantes específicos da organização para usar {% data variables.product.prodname_codespaces %}. - * **Permitir para todos os integrantes** para permitir todos os integrantes da organização usem {% data variables.product.prodname_codespaces %}. - * **Permitir para todos os integrantes e colaboradores externos** para permitir que todos os integrantes da sua organização, bem como os colaboradores externos, usem {% data variables.product.prodname_codespaces %}. + * **Desabilitado** - Sua organização não será cobrada pelo uso de codespaces. {% data variables.product.prodname_codespaces %} criado para os repositórios da organização que serão cobrados pelos usuários que os criarem. + * **Integrantes selecionados** - {% data variables.product.prodname_codespaces %} criado para os repositórios da sua organização por integrantes selecionados e será cobradoo da organização. + * **Todos os integrantes** - {% data variables.product.prodname_codespaces %} criados para os repositórios da sua organização por integrantes da sua organização e será cobrado da organização. + * **Todos os integrantes e colaboradores externos** - {% data variables.product.prodname_codespaces %} criado para os repositórios da organização por integrantes da organização e colaboradores externos e será cobrado da organização. - ![Botões de opção para "Permissões do usuário"](/assets/images/help/codespaces/org-user-permission-settings-outside-collaborators.png) + ![Botão de opção para "cobrança"](/assets/images/help/codespaces/codespaces-org-billing-settings.png) {% note %} - **Observação:** Ao selecionar **Permitir para todos os integrantes e colaboradores externos**, todos os colaboradores externos que foram adicionados aos repositórios específicos poderão criar e usar {% data variables.product.prodname_codespaces %}. Sua organização será cobrada pelo uso de todos os colaboradores externos. Para obter mais informações sobre como gerenciar colaboradores externos, consulte "[Sobre colaboradores externos](/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization#about-outside-collaborators)". + **Observação:** Ao selecionar **Todos os integrantes e colaboradores externos**, todos os colaboradores externos que foram adicionados em repositórios específicos podem criar e usar {% data variables.product.prodname_codespaces %} para esses repositórios e sua organização será cobrada por esse uso. Para obter mais informações sobre como gerenciar colaboradores externos, consulte "[Sobre colaboradores externos](/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization#about-outside-collaborators)". {% endnote %} 1. Clique em **Salvar**. +1. Se você selecionou **integrantes selecionados**, uma caixa de entrada será exibida para você inserir os nomes de usuários que deseja selecionar. + + ![Caixa de entrada para selecionar usuários](/assets/images/help/codespaces/codespaces-org-billing-add-users.png) ## Desabilitando {% data variables.product.prodname_codespaces %} para sua organização +É possível impedir a criação e o uso de codespaces faturáveis na sua organização. + +{% data reusables.codespaces.codespaces-disabling-org-billing %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.click-codespaces %} -1. Em "Permissões de usuário", selecione **Desabilitado**. +1. Em "cobrança", selecione **Desabilitado**. ## Definindo um limite de gastos diff --git a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-github-codespaces-in-your-organization.md b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-github-codespaces-in-your-organization.md index f39c2674aa..a2f4f71a74 100644 --- a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-github-codespaces-in-your-organization.md +++ b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-github-codespaces-in-your-organization.md @@ -35,11 +35,15 @@ Você pode definir um limite de uso para os codespaces na sua organização ou r ## Desabilitando ou limitando {% data variables.product.prodname_codespaces %} -É possível desabilitar o uso de {% data variables.product.prodname_codespaces %} na sua organização ou repositório. Para obter mais informações, consulte "[Gerenciar acesso ao repositório para os codespaces da sua organização](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)". +Você pode desabilitar todo o uso de {% data variables.product.prodname_github_codespaces %} que seria cobrado da sua organização. Como alternativa, você pode especificar quais integrantes ou colaboradores da organização podem usar o {% data variables.product.prodname_codespaces %} às custas da sua organização. Para obter mais informações, consulte "[Habilitando {% data variables.product.prodname_github_codespaces %} para a sua organização](/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization)". -Você também pode limitar os usuários individuais que podem usar {% data variables.product.prodname_codespaces %}. Para obter mais informações, consulte "[Gerenciando permissões de usuário para sua organização](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)". +{% data reusables.codespaces.codespaces-disabling-org-billing %} -É possível limitar a escolha dos tipos de máquina que estão disponíveis para repositórios pertencentes à sua organização. Isso permite evitar que as pessoas usem máquinas com recursos excessivos para seus codespaces. Para obter mais informações, consulte "[Restringindo o acesso aos tipos de máquina](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types)." +Você pode configurar quais repositórios podem ser acessados a partir de codespaces criados para um repositório específico. Para obter mais informações, consulte "[Gerenciar o acesso a outros repositórios dentro de seu codespace](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)". + +Você pode limitar a escolha de tipos de máquinas que estão disponíveis para codespaces criados a partir de repositórios pertencentes à organização. Isso permite que você evite que as pessoas usem máquinas com recursos excessivos em seus codespaces e incorram em custos desnecessários. Para obter mais informações, consulte "[Restringindo o acesso aos tipos de máquina](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types)." + +Você também pode restringir quanto tempo um codespace pode não ser usado antes de ser automaticamente excluído. Isso pode ajudar a reduzir os custos de armazenamento para {% data variables.product.prodname_codespaces %}. Para obter mais informações, consulte "[Restringindo o período de retenção para codespaces](/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces)". ## Excluindo codespaces não utilizados @@ -47,6 +51,6 @@ Seus usuários podem excluir seus codespaces em https://github.com/codespaces e {% note %} -**Observação:** Somente a pessoa que criou um codespace pode excluí-lo. Atualmente, não há forma de os proprietários da organização excluírem os codespaces criados dentro de sua organização. +**Observação:** Os codespaces são excluídos automaticamente depois de terem sido interrompidos e permanecerem inativos por um número definido de dias. Para obter mais informações, consulte "[Restringindo o período de retenção para codespaces](/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces)". Um codespace só pode ser excluído manualmente pela pessoa que o criou. {% endnote %} diff --git a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md index 7f2c5d3ce1..e74fe7f955 100644 --- a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md +++ b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md @@ -20,7 +20,7 @@ redirect_from: {% warning %} -**Observação de depreciação**: A configuração de acesso e segurança descrita abaixo está obsoleta e é documentada aqui apenas por referência. Para habilitar o acesso expandido a outros repositórios, adicione as permissões solicitadas à definição do contêiner de desenvolvimento. Para obter mais informações, consulte "[Gerenciar o acesso a outros repositórios dentro de seu codespace](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)". +**Observação de depreciação**: A configuração de acesso e segurança descrita abaixo está obsoleta e é documentada aqui apenas por referência. Para habilitar o acesso expandido a outros repositórios, adicione as permissões solicitadas ao seu arquivo de configuração `devcontainer.json`. Para obter mais informações, consulte "[Gerenciar o acesso a outros repositórios dentro de seu codespace](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)". {% endwarning %} diff --git a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md index 50096e843d..fafc1d5d6e 100644 --- a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md +++ b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md @@ -43,6 +43,8 @@ Por exemplo, você poderia criar uma política para toda a organização que res Se você adicionar uma política para toda a organização, você deverá configurá-la para a maior escolha de tipos de máquina que estarão disponíveis para qualquer repositório na sua organização. Em seguida, você pode adicionar políticas específicas ao repositório para restringir ainda mais a escolha. +{% data reusables.codespaces.codespaces-org-policies-note %} + ## Adicionar uma política para limitar os tipos de máquina disponíveis {% data reusables.profile.access_org %} diff --git a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md index e23550b26d..1dd72e8373 100644 --- a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md +++ b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md @@ -40,6 +40,8 @@ Ao criar uma política, você define se ela se aplica a todos os repositórios d Se você adicionar uma política para toda a organização com uma restrição de tempo limite, você deverá definir o tempo limite como o período de tempo mais longo. Em seguida, é possível adicionar políticas separadas que definam o tempo limite máximo para um período mais curto para repositórios específicos na sua organização. +{% data reusables.codespaces.codespaces-org-policies-note %} + ## Adicionando uma política para definir um período máximo de tempo ocioso {% data reusables.profile.access_org %} diff --git a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md index 79825f9e29..278aac3a6b 100644 --- a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md +++ b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md @@ -26,6 +26,8 @@ Ao criar uma política, você define se ela se aplica a todos os repositórios d Se você adicionar uma política para toda a organização com uma restrição de retenção, você deverá definir o período de retenção para o período mais longo aceitável. Em seguida, é possível adicionar políticas separadas que definam o período de retenção máximo para um período mais curto para repositórios específicos na sua organização. +{% data reusables.codespaces.codespaces-org-policies-note %} + ## Adicionando uma política para definir um período máximo de retenção de codespace {% data reusables.profile.access_org %} diff --git a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md index 48766c04d5..357d798819 100644 --- a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md +++ b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md @@ -36,6 +36,8 @@ Por exemplo, você poderia criar uma política de toda a organização que restr Se você adicionar uma política para toda a organização, você deverá defini-la como a opção de visibilidade mais branda que estará disponível para qualquer repositório na organização. Em seguida, você pode adicionar políticas específicas ao repositório para restringir ainda mais a escolha. +{% data reusables.codespaces.codespaces-org-policies-note %} + ## Adicionando uma política para limitar as opções de visibilidade da porta {% data reusables.profile.access_org %} diff --git a/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md b/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md index c9f6f47e13..215c0485bf 100644 --- a/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md +++ b/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md @@ -132,7 +132,3 @@ Ao habilitar o acesso e a segurança de um repositório pertencente à sua conta 1. Se você escolher "repositórios selecionados", selecione o menu suspenso e clique em um repositório para permitir que os codespaces do repositório tenham acesso a outros repositórios dos quais você é proprietário. Repita para todos os repositórios cujos codespaces você deseja que acessem outros repositórios dos quais você é proprietário. ![Menu suspenso "Repositórios selecionados"](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) - -## Leia mais - -- "[Gerenciando o acesso ao repositório para os codespaces da sua organização](/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces)" diff --git a/translations/pt-BR/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md b/translations/pt-BR/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md index 55fa9830f3..b238e95d4b 100644 --- a/translations/pt-BR/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md +++ b/translations/pt-BR/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md @@ -31,6 +31,7 @@ O nome do código também está incluído em muitos dos arquivos de registro. Po Todos os codespaces também possuem um ID (identificador). Ele não é exibido por padrão em {% data variables.product.prodname_vscode %}. Portanto, é possível que você precise atualizar as configurações para a extensão {% data variables.product.prodname_github_codespaces %} antes de acessar o ID. 1. Em {% data variables.product.prodname_vscode %}, navegador ou área de trabalho, na barra de atividades à esquerda, clique em **Explorador remoto** para mostrar as informações para o codespace. -2. Se a barra lateral incluir uma seção "Desempenho do codespace", passe o mouse sobre o "ID do codespace" e clique no ícone da área de transferência para copiar o ID. -3. Se a informação não for exibida, clique em {% octicon "gear" aria-label="The gear icon" %} no canto inferior esquerdo da barra de atividade, para exibir a aba "Configurações". -4. Expanda **Extensões** e clique em **{% data variables.product.prodname_github_codespaces %}** para exibir as configurações da extensão. Em seguida, habilite o **Exibir o explorador de desempenho** para exibir a seção "Codespace" na barra lateral. ![O ID do codespace e configurações necessárias para exibir informações de desempenho](/assets/images/help/codespaces/find-codespace-id.png) +{% indented_data_reference reusables.codespaces.remote-explorer spaces=3 %} +1. Se a barra lateral incluir uma seção "Desempenho do codespace", passe o mouse sobre o "ID do codespace" e clique no ícone da área de transferência para copiar o ID. +1. Se a informação não for exibida, clique em {% octicon "gear" aria-label="The gear icon" %} no canto inferior esquerdo da barra de atividade, para exibir a aba "Configurações". +1. Expanda **Extensões** e clique em **{% data variables.product.prodname_github_codespaces %}** para exibir as configurações da extensão. Em seguida, habilite o **Exibir o explorador de desempenho** para exibir a seção "Codespace" na barra lateral. ![O ID do codespace e configurações necessárias para exibir informações de desempenho](/assets/images/help/codespaces/find-codespace-id.png) diff --git a/translations/pt-BR/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md b/translations/pt-BR/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md index 004bead23f..77116c54cc 100644 --- a/translations/pt-BR/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md +++ b/translations/pt-BR/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md @@ -539,7 +539,7 @@ Os erros com `texto` serão prefixados com `body[i]`, em que `i` representa o í ### Exemplo -``` +```yaml body: - type: dropdown attributes: @@ -552,7 +552,7 @@ body: O erro pode ser corrigido garantindo que não existam opções duplicadas na matriz de `opções`. -``` +```yaml body: - type: dropdown attributes: @@ -570,7 +570,7 @@ Os erros com `texto` serão prefixados com `body[i]`, em que `i` representa o í ### Exemplo -``` +```yaml body: - type: dropdown attributes: @@ -585,7 +585,7 @@ body: O erro pode ser corrigido removendo "Nenhum" como opção. Se você deseja que um contribuidor possa indicar que ele não gosta de nenhum desses tipos de tortas, você pode também remover a validação `necessária`. -``` +```yaml body: - type: dropdown attributes: @@ -605,7 +605,7 @@ Os erros com `texto` serão prefixados com `body[i]`, em que `i` representa o í ### Exemplo -``` +```yaml body: - type: dropdown attributes: @@ -618,7 +618,7 @@ body: O erro pode ser corrigido colocando cada opção incorreta entre aspas, para evitar que sejam processados como valores booleanos. -``` +```yaml body: - type: dropdown attributes: @@ -629,6 +629,36 @@ body: - Maybe ``` +## O texto não pode estar vazio + +O par do texto do modelo `key:value` não pode estar vazio. Para obter mais informações sobre quais chaves de nível superior são obrigatórios, consulte "[Sintaxe para os formulários do problema](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax). " + +O erro pode ser corrigido adicionando a seção `body:`. + +### Exemplo + +```yaml +name: Support Request +description: Something went wrong and you need help? +--- +body: +- type: textarea + attributes: + label: "What's wrong?" +``` + +Neste exemplo, o erro pode ser corrigido excluindo o `---` (separador do documento) entre os cabeçalhos e a seção `texto`. + +```yaml +name: Support Request +description: Something went wrong and you need help? + +body: +- type: textarea + attributes: + label: "What's wrong?" +``` + ## Leia mais - [YAML](https://yaml.org/) diff --git a/translations/pt-BR/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md b/translations/pt-BR/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md index ed2425e1fa..d24d81783f 100644 --- a/translations/pt-BR/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md +++ b/translations/pt-BR/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md @@ -23,6 +23,8 @@ Quando uma organização tem uma lista de autorizações, aplicativos de terceir ## Adicionando uma lista de endereços IP permitidos para {% data variables.product.prodname_github_app %} +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.apps.settings-step %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} diff --git a/translations/pt-BR/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md b/translations/pt-BR/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md index f476d28b5a..7a9ef814bc 100644 --- a/translations/pt-BR/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md +++ b/translations/pt-BR/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md @@ -47,7 +47,7 @@ Os limites de taxa para {% data variables.product.prodname_github_apps %} e {% d {% ifversion fpt or ghec %} -{% data variables.product.prodname_github_apps %} que estão instalados em uma organização ou um repositório dentro de uma empresa no {% data variables.product.product_location %} estão sujeitos a um limite de 15.000 solicitações por hora. +{% data variables.product.prodname_github_apps %} that are installed on an organization within an enterprise on {% data variables.product.product_location %} are subject to a limit of 15,000 requests per hour per organization that has installed the app. {% endif %} diff --git a/translations/pt-BR/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md b/translations/pt-BR/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md index f7dce21310..f89b49896e 100644 --- a/translations/pt-BR/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/translations/pt-BR/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -39,46 +39,49 @@ X-Accepted-OAuth-Scopes: user ## Escopos disponíveis -| Nome | Descrição | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |{% ifversion not ghae %} -| **`(sem escopo)`** | Concede acesso somente leitura a informações públicas (incluindo informações do perfil do usuário, informações do repositório e gists){% endif %}{% ifversion ghes or ghae %} -| **`site_admin`** | Concede acesso de administrador aos pontos de extremidades da API de administração [{% data variables.product.prodname_ghe_server %}](/rest/reference/enterprise-admin).{% endif %} -| **`repo`** | Concede acesso total a repositórios públicos{% ifversion ghec or ghes or ghae %}, internos,{% endif %} e privados, incluindo acesso de leitura e gravação ao código, status de commit, convites de repositório, colaboradores, status de implantação e webhooks do repositório. **Observação**: Além dos recursos relacionados ao repositório, o escopo `repositório` também permite acesso para gerenciar recursos pertencentes à organização, incluindo projetos, convites, associações da equipe e webhooks. Este âmbito também concede a capacidade de gerenciar projectos pertencentes a usuários. | -|  `repo:status` | Concede acesso de leitura/gravaçãopara fazer commit de status em {% ifversion fpt %}repositórios públicos, privados e internos{% elsif ghec or ghes %} privados e internos{% elsif ghae %}privados e internos{% endif %}. Esse escopo só é necessário para conceder a outros usuários ou serviços acesso a status de compromisso de repositórios privados *sem* conceder acesso ao código. | -|  `repo_deployment` | Concede acesso aos [status da implementação](/rest/reference/repos#deployments) para {% ifversion not ghae %}público{% else %}interno{% endif %} e repositórios privados. Este escopo só é necessário para conceder a outros usuários ou serviços acesso aos status de implantação, *sem* conceder acesso ao código.{% ifversion not ghae %} -|  `public_repo` | Limita o acesso a repositórios públicos. Isso inclui acesso de leitura/gravação em código, status de commit, projetos de repositório, colaboradores e status de implantação de repositórios e organizações públicos. Também é necessário para repositórios públicos marcados como favoritos.{% endif %} -|  `repo:invite` | Concede habilidades de aceitar/recusar convites para colaborar em um repositório. Este escopo só é necessário para conceder a outros usuários ou serviços acesso a convites *sem* conceder acesso ao código.{% ifversion fpt or ghes or ghec %} -|  `security_events` | Concede:
    acesso de leitura e gravação aos eventos de segurança na [API de {% data variables.product.prodname_code_scanning %}](/rest/reference/code-scanning) {%- ifversion ghec %}
    acesso de leitura e gravação aos eventos de segurança na [API de {% data variables.product.prodname_secret_scanning %}](/rest/reference/secret-scanning){%- endif %}
    Esse escopo é somente necessário para conceder aos outros usuários ou serviços acesso aos eventos de segurança *sem* conceder acesso ao código.{% endif %} -| **`admin:repo_hook`** | Concede acesso de leitura, gravação, fixação e exclusão aos hooks do repositório em {% ifversion fpt %}repositórios públicos, privados ou internos{% elsif ghec or ghes %}públicos, ou internos{% elsif ghae %}privados ou internos{% endif %}. O escopos do `repo` {% ifversion fpt or ghec or ghes %}e `public_repo` concedem{% else %}o escopo concede{% endif %} o acesso total aos repositórios, incluindo hooks de repositório. Use o escopo `admin:repo_hook` para limitar o acesso apenas a hooks de repositório. | -|  `write:repo_hook` | Concede acesso de leitura, gravação e fixação aos hooks em {% ifversion fpt %}repositórios públicos ou privados{% elsif ghec or ghes %}público, privado ou interno{% elsif ghae %}privado ou interno{% endif %}. | -|  `read:repo_hook` | Concede acesso de leitura e fixação aos hooks em {% ifversion fpt %}repositórios públicos ou privados{% elsif ghec or ghes %}público, privado ou interno{% elsif ghae %}privado ou interno{% endif %}. | -| **`admin:org`** | Gerencia totalmente a organização e suas equipes, projetos e associações. | -|  `write:org` | Acesso de leitura e gravação à associação da organização, aos projetos da organização e à associação da equipe. | -|  `read:org` | Acesso somente leitura à associação da organização, aos projetos da organização e à associação da equipe. | -| **`admin:public_key`** | Gerenciar totalmente as chaves públicas. | -|  `write:public_key` | Criar, listar e visualizar informações das chaves públicas. | -|  `read:public_key` | Listar e visualizar informações para as chaves públicas. | -| **`admin:org_hook`** | Concede acesso de leitura, gravação, ping e e exclusão de hooks da organização. **Observação:** Os tokens do OAuth só serão capazes de realizar essas ações nos hooks da organização que foram criados pelo aplicativo OAuth. Os tokens de acesso pessoal só poderão realizar essas ações nos hooks da organização criados por um usuário. | -| **`gist`** | Concede acesso de gravação aos gists. | -| **`notificações`** | Condece:
    * acesso de gravação a notificações de um usuário
    * acesso para marcar como leitura nos threads
    * acesso para inspecionar e não inspecionar um repositório e
    * acesso de leitura, gravação e exclusão às assinaturas dos threads. | -| **`usuário`** | Concede acesso de leitura/gravação apenas às informações do perfil. Observe que este escopo inclui `user:email` e `user:follow`. | -|  `read:user` | Concede acesso para ler as informações do perfil de um usuário. | -|  `usuário:email` | Concede acesso de leitura aos endereços de e-mail de um usuário. | -|  `user:follow` | Concede acesso para seguir ou deixar de seguir outros usuários.{% ifversion projects-oauth-scope %} -| **`project`** | Concede acesso de leitura/gravação ao usuário e à organização {% data variables.projects.projects_v2 %}. | -|  `read:project` | Concede acesso somente de leitura ao usuário e à organização {% data variables.projects.projects_v2 %}.{% endif %} -| **`delete_repo`** | Concede acesso para excluir repositórios administráveis. | -| **`write:discussion`** | Permite acesso de leitura e gravação para discussões da equipe. | -|  `leia:discussion` | Permite acesso de leitura para discussões em equipe. | -| **`write:packages`** | Concede acesso ao para fazer o upload ou publicação de um pacote no {% data variables.product.prodname_registry %}. Para obter mais informações, consulte "[Publicar um pacote](/github/managing-packages-with-github-packages/publishing-a-package)". | -| **`read:packages`** | Concede acesso ao download ou instalação de pacotes do {% data variables.product.prodname_registry %}. Para obter mais informações, consulte "[Instalando um pacote](/github/managing-packages-with-github-packages/installing-a-package)". | -| **`delete:packages`** | Concede acesso para excluir pacotes de {% data variables.product.prodname_registry %}. Para obter mais informações, consulte "[Excluir e restaurar um pacote](/packages/learn-github-packages/deleting-and-restoring-a-package)". | -| **`admin:gpg_key`** | Gerenciar totalmente as chaves GPG. | -|  `write:gpg_key` | Criar, listar e visualizar informações das chaves GPG. | -|  `read:gpg_key` | Listar e visualizar informações das chaves GPG.{% ifversion fpt or ghec %} -| **`codespace`** | Concede a capacidade de criar e gerenciar codespaces. Os codespaces podem expor um GITHUB_TOKEN que pode ter um conjunto diferente de escopos. Para obter mais informações, consulte "[Segurança em {% data variables.product.prodname_github_codespaces %}](/codespaces/codespaces-reference/security-in-github-codespaces#authentication)."{% endif %} -| **`fluxo de trabalho`** | Concede a capacidade de adicionar e atualizar arquivos do fluxo de trabalho do {% data variables.product.prodname_actions %}. Os arquivos do fluxo de trabalho podem ser confirmados sem este escopo se o mesmo arquivo (com o mesmo caminho e conteúdo) existir em outro branch no mesmo repositório. Os arquivos do fluxo de trabalho podem expor o `GITHUB_TOKEN` que pode ter um conjunto diferente de escopos. Para obter mais informações, consulte "[Autenticação em um fluxo de trabalho](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)". | - +| Nome | Descrição | +| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |{% ifversion not ghae %} +| **`(sem escopo)`** | Concede acesso somente leitura a informações públicas (incluindo informações do perfil do usuário, informações do repositório e gists){% endif %}{% ifversion ghes or ghae %} +| **`site_admin`** | Concede acesso de administrador aos pontos de extremidades da API de administração [{% data variables.product.prodname_ghe_server %}](/rest/reference/enterprise-admin).{% endif %} +| **`repo`** | Concede acesso total a repositórios públicos{% ifversion ghec or ghes or ghae %}, internos,{% endif %} e privados, incluindo acesso de leitura e gravação ao código, status de commit, convites de repositório, colaboradores, status de implantação e webhooks do repositório. **Observação**: Além dos recursos relacionados ao repositório, o escopo `repositório` também permite acesso para gerenciar recursos pertencentes à organização, incluindo projetos, convites, associações da equipe e webhooks. Este âmbito também concede a capacidade de gerenciar projectos pertencentes a usuários. | +|  `repo:status` | Concede acesso de leitura/gravaçãopara fazer commit de status em {% ifversion fpt %}repositórios públicos, privados e internos{% elsif ghec or ghes %} privados e internos{% elsif ghae %}privados e internos{% endif %}. Esse escopo só é necessário para conceder a outros usuários ou serviços acesso a status de compromisso de repositórios privados *sem* conceder acesso ao código. | +|  `repo_deployment` | Concede acesso aos [status da implementação](/rest/reference/repos#deployments) para {% ifversion not ghae %}público{% else %}interno{% endif %} e repositórios privados. Este escopo só é necessário para conceder a outros usuários ou serviços acesso aos status de implantação, *sem* conceder acesso ao código.{% ifversion not ghae %} +|  `public_repo` | Limita o acesso a repositórios públicos. Isso inclui acesso de leitura/gravação em código, status de commit, projetos de repositório, colaboradores e status de implantação de repositórios e organizações públicos. Também é necessário para repositórios públicos marcados como favoritos.{% endif %} +|  `repo:invite` | Concede habilidades de aceitar/recusar convites para colaborar em um repositório. Este escopo só é necessário para conceder a outros usuários ou serviços acesso a convites *sem* conceder acesso ao código.{% ifversion fpt or ghes or ghec %} +|  `security_events` | Concede:
    acesso de leitura e gravação aos eventos de segurança na [API de {% data variables.product.prodname_code_scanning %}](/rest/reference/code-scanning) {%- ifversion ghec %}
    acesso de leitura e gravação aos eventos de segurança na [API de {% data variables.product.prodname_secret_scanning %}](/rest/reference/secret-scanning){%- endif %}
    Esse escopo é somente necessário para conceder aos outros usuários ou serviços acesso aos eventos de segurança *sem* conceder acesso ao código.{% endif %} +| **`admin:repo_hook`** | Concede acesso de leitura, gravação, fixação e exclusão aos hooks do repositório em {% ifversion fpt %}repositórios públicos, privados ou internos{% elsif ghec or ghes %}públicos, ou internos{% elsif ghae %}privados ou internos{% endif %}. O escopos do `repo` {% ifversion fpt or ghec or ghes %}e `public_repo` concedem{% else %}o escopo concede{% endif %} o acesso total aos repositórios, incluindo hooks de repositório. Use o escopo `admin:repo_hook` para limitar o acesso apenas a hooks de repositório. | +|  `write:repo_hook` | Concede acesso de leitura, gravação e fixação aos hooks em {% ifversion fpt %}repositórios públicos ou privados{% elsif ghec or ghes %}público, privado ou interno{% elsif ghae %}privado ou interno{% endif %}. | +|  `read:repo_hook` | Concede acesso de leitura e fixação aos hooks em {% ifversion fpt %}repositórios públicos ou privados{% elsif ghec or ghes %}público, privado ou interno{% elsif ghae %}privado ou interno{% endif %}. | +| **`admin:org`** | Gerencia totalmente a organização e suas equipes, projetos e associações. | +|  `write:org` | Acesso de leitura e gravação à associação da organização, aos projetos da organização e à associação da equipe. | +|  `read:org` | Acesso somente leitura à associação da organização, aos projetos da organização e à associação da equipe. | +| **`admin:public_key`** | Gerenciar totalmente as chaves públicas. | +|  `write:public_key` | Criar, listar e visualizar informações das chaves públicas. | +|  `read:public_key` | Listar e visualizar informações para as chaves públicas. | +| **`admin:org_hook`** | Concede acesso de leitura, gravação, ping e e exclusão de hooks da organização. **Observação:** Os tokens do OAuth só serão capazes de realizar essas ações nos hooks da organização que foram criados pelo aplicativo OAuth. Os tokens de acesso pessoal só poderão realizar essas ações nos hooks da organização criados por um usuário. | +| **`gist`** | Concede acesso de gravação aos gists. | +| **`notificações`** | Condece:
    * acesso de gravação a notificações de um usuário
    * acesso para marcar como leitura nos threads
    * acesso para inspecionar e não inspecionar um repositório e
    * acesso de leitura, gravação e exclusão às assinaturas dos threads. | +| **`usuário`** | Concede acesso de leitura/gravação apenas às informações do perfil. Observe que este escopo inclui `user:email` e `user:follow`. | +|  `read:user` | Concede acesso para ler as informações do perfil de um usuário. | +|  `usuário:email` | Concede acesso de leitura aos endereços de e-mail de um usuário. | +|  `user:follow` | Concede acesso para seguir ou deixar de seguir outros usuários.{% ifversion projects-oauth-scope %} +| **`project`** | Concede acesso de leitura/gravação ao usuário e à organização {% data variables.projects.projects_v2 %}. | +|  `read:project` | Concede acesso somente de leitura ao usuário e à organização {% data variables.projects.projects_v2 %}.{% endif %} +| **`delete_repo`** | Concede acesso para excluir repositórios administráveis. | +| **`write:discussion`** | Permite acesso de leitura e gravação para discussões da equipe. | +|  `leia:discussion` | Permite acesso de leitura para discussões em equipe. | +| **`write:packages`** | Concede acesso ao para fazer o upload ou publicação de um pacote no {% data variables.product.prodname_registry %}. Para obter mais informações, consulte "[Publicar um pacote](/github/managing-packages-with-github-packages/publishing-a-package)". | +| **`read:packages`** | Concede acesso ao download ou instalação de pacotes do {% data variables.product.prodname_registry %}. Para obter mais informações, consulte "[Instalando um pacote](/github/managing-packages-with-github-packages/installing-a-package)". | +| **`delete:packages`** | Concede acesso para excluir pacotes de {% data variables.product.prodname_registry %}. Para obter mais informações, consulte "[Excluir e restaurar um pacote](/packages/learn-github-packages/deleting-and-restoring-a-package)". | +| **`admin:gpg_key`** | Gerenciar totalmente as chaves GPG. | +|  `write:gpg_key` | Criar, listar e visualizar informações das chaves GPG. | +|  `read:gpg_key` | Listar e visualizar informações das chaves GPG.{% ifversion fpt or ghec %} +| **`codespace`** | Concede a capacidade de criar e gerenciar codespaces. Os codespaces podem expor um GITHUB_TOKEN que pode ter um conjunto diferente de escopos. Para obter mais informações, consulte "[Segurança em {% data variables.product.prodname_github_codespaces %}](/codespaces/codespaces-reference/security-in-github-codespaces#authentication)."{% endif %} +| **`fluxo de trabalho`** | Concede a capacidade de adicionar e atualizar arquivos do fluxo de trabalho do {% data variables.product.prodname_actions %}. Os arquivos do fluxo de trabalho podem ser confirmados sem este escopo se o mesmo arquivo (com o mesmo caminho e conteúdo) existir em outro branch no mesmo repositório. Os arquivos do fluxo de trabalho podem expor o `GITHUB_TOKEN` que pode ter um conjunto diferente de escopos. Para obter mais informações, consulte "[Autenticação em um fluxo de trabalho](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)".{% ifversion not fpt %} +| **`admin:enterprise`** | Dá controle total da funcionalidade de empresa. Para obter mais informações, consulte "[Gerenciando contas corporativas](/graphql/guides/managing-enterprise-accounts)" na documentação da API do GraphQL.

    Inclui `manage_runners:enterprise`{% ifversion ghec or ghes > 3.3 %}, `manage_billing:enterprise`,{% endif %} e `read:enterprise`. | +|  `manage_runners:enterprise` | Dá controle total sobre os executores auto-hospedados dentro da empresa. Para obter mais informações, consulte "[Sobre os executores auto-hospedados](/actions/hosting-your-own-runners/about-self-hosted-runners)." {% ifversion ghec or ghes > 3.3 %} +|  `manage_billing:enterprise` | Lê e escreve os dados de cobrança da empresa. Para obter mais informações, consulte "[Cobrança](/rest/billing)" na documentação da API REST. {% endif %} +|  `read:enterprise` | Lê todos os dados em um perfil corporativo. Não inclui dados de perfil de integrantes ou organizações da empresa.{% endif %} {% note %} **Observação:** O seu aplicativo OAuth pode solicitar os escopos no redirecionamento inicial. Você pode especificar vários escopos separando-os com um espaço usando `%20`: diff --git a/translations/pt-BR/content/developers/index.md b/translations/pt-BR/content/developers/index.md index 064df9a1a4..38c18fb3ae 100644 --- a/translations/pt-BR/content/developers/index.md +++ b/translations/pt-BR/content/developers/index.md @@ -1,6 +1,29 @@ --- title: Desenvolvedores -intro: 'Aproveite o {% data variables.product.prodname_dotcom %}, ao fazer a integração com as nossas APIs, personalizando o seu fluxo de trabalho do {% data variables.product.prodname_dotcom %} e construindo e compartilhando aplicativos com a comunidade.' +intro: 'Aprofunde-se com {% data variables.product.prodname_dotcom %}, integrando nossas APIs e webhooks, personalizando seu fluxo de trabalho de {% data variables.product.prodname_dotcom %} e criando e compartilhando aplicativos com a comunidade.' +introLinks: + About apps: /developers/apps/getting-started-with-apps/about-apps +layout: product-landing +featuredLinks: + guides: + - /developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps + - /developers/apps/building-github-apps/creating-a-github-app + - /developers/apps/building-github-apps/authenticating-with-github-apps + - /developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps + popular: + - /developers/webhooks-and-events/webhooks/webhook-events-and-payloads + - /developers/apps/building-github-apps/creating-a-github-app + - /developers/apps/building-github-apps/authenticating-with-github-apps + - /developers/webhooks-and-events/webhooks/about-webhooks + - /developers/apps/building-oauth-apps/creating-an-oauth-app + - /developers/apps/building-oauth-apps/authorizing-oauth-apps + - /developers/github-marketplace/github-marketplace-overview/about-github-marketplace + guideCards: + - /developers/webhooks-and-events/webhooks/creating-webhooks + - /developers/apps/guides/using-the-github-api-in-your-app + - /developers/apps/guides/creating-ci-tests-with-the-checks-api +changelog: + label: apps versions: fpt: '*' ghes: '*' diff --git a/translations/pt-BR/content/developers/overview/about-githubs-apis.md b/translations/pt-BR/content/developers/overview/about-githubs-apis.md index afce6dd9a4..b5392876bf 100644 --- a/translations/pt-BR/content/developers/overview/about-githubs-apis.md +++ b/translations/pt-BR/content/developers/overview/about-githubs-apis.md @@ -15,17 +15,3 @@ topics: --- Existem duas versões estáveis da API do GitHub: a [API REST](/rest) e a [API do GraphQL](/graphql). - -## Versões obsoletas - -### beta - -A API beta tornou-se obsoleta em 22 de abril de 2014. - -### v2 - -Removemos o suporte à API v2 em 12 de Junho de 2012. - -### v1 - -Removemos o suporte à API v1 em 12 de Junho de 2012. diff --git a/translations/pt-BR/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md b/translations/pt-BR/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md index 99b6df1b91..10cec60594 100644 --- a/translations/pt-BR/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md +++ b/translations/pt-BR/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md @@ -37,12 +37,12 @@ $ export SECRET_TOKEN=your_token ## Validar cargas do GitHub -Quando seu token secreto está definido, {% data variables.product.product_name %} o utiliza para criar uma assinatura de hash com cada carga. Esta assinatura de hash está incluída com os cabeçalhos de cada solicitação como `X-Hub-Signature-256`. +Quando seu token secreto está definido, {% data variables.product.product_name %} o utiliza para criar uma assinatura de hash com cada carga. Esta assinatura hash está incluída nos cabeçalhos de cada solicitação como `x-hub-signature-256`. {% ifversion fpt or ghes or ghec %} {% note %} -**Observação:** Para compatibilidade com versões anteriores, também incluímos o cabeçalho `X-Hub-Signature` gerado usando a função de hash SHA-1. Se possível, recomendamos que você use o cabeçalho `X-Hub-Signature-256` para melhorar a segurança. O exemplo abaixo demonstra o uso do cabeçalho `X-Hub-Signature-256`. +**Observação:** Para compatibilidade regressiva, também incluímos o cabeçalho `x-hub-signature` que é gerado usando a função hash SHA-1. Se possível, recomendamos que você use o cabeçalho `x-hub-signature-256` para melhorar a segurança. O exemplo abaixo demonstra o uso do cabeçalho `x-hub-sigre-256`. {% endnote %} {% endif %} diff --git a/translations/pt-BR/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students.md b/translations/pt-BR/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students.md index b75a97fdb5..b2213ca573 100644 --- a/translations/pt-BR/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students.md +++ b/translations/pt-BR/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students.md @@ -31,7 +31,7 @@ Depois que o aluno de {% data variables.product.prodname_global_campus %} for ve - Explore e reivindique ofertas para ferramentas grátis no setor a partir do [pacote de desenvolvedor para estudantes](https://education.github.com/pack). - Veja os próximos eventos presenciais e virtuais para estudantes, curados por {% data variables.product.prodname_education %} e líderes estudantes. - Veja as atividades no [GitHub Classroom](https://classroom.github.com/) com as próximas datas de vencimento. -- Mantenha-se atualizado sobre o que a comunidade está interessada ao assistir os episódios recentes de [Campus TV](https://www.twitch.tv/githubeducation). Campus TV is created by {% data variables.product.prodname_dotcom %} and student community leaders and can be watched live or on demand. +- Mantenha-se atualizado sobre o que a comunidade está interessada ao assistir os episódios recentes de [Campus TV](https://www.twitch.tv/githubeducation). A Campus TV é criada por {% data variables.product.prodname_dotcom %} e líderes da comunidade estudantil e pode ser assistida ao vivo ou sob demanda. - Descubra repositórios criados pelos alunos do GitHub Community Exchange. Para obter mais informações, consulte "[Sobre o GitHub Community Exchange](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-community-exchange)". ## Leia mais diff --git a/translations/pt-BR/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/about-github-global-campus-for-teachers.md b/translations/pt-BR/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/about-github-global-campus-for-teachers.md index 4a0f792429..f6e63ad016 100644 --- a/translations/pt-BR/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/about-github-global-campus-for-teachers.md +++ b/translations/pt-BR/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/about-github-global-campus-for-teachers.md @@ -24,11 +24,11 @@ Antes de solicitar um desconto individual, verifique se sua comunidade de estudo {% data variables.product.prodname_global_campus %} é um portal a partir do qual você pode acessar seus benefícios e recursos de {% data variables.product.prodname_education %}, tudo em um só lugar. No portal de {% data variables.product.prodname_global_campus %}, os professores de todos os níveis podem: {% data reusables.education.apply-for-team %} - - View an overview of your active [{% data variables.product.prodname_classroom %}](https://classroom.github.com), including recent assignments and your class's progress at a glance, as well as links to {% data variables.product.prodname_classroom %}. - - View and interact with [{% data variables.product.prodname_discussions %}](https://github.com/orgs/community/discussions/categories/github-education) posted by your peers from around the world to discuss current trends in technology education, and see the latest posts from our [{% data variables.product.prodname_education %} blog](https://github.blog/category/education/). - - See student events curated by {% data variables.product.prodname_education %} and student leaders. - - Stay in the know on what the student community is interested in by rewatching recent [Campus TV](https://www.twitch.tv/githubeducation) episodes. Campus TV is created by {% data variables.product.prodname_dotcom %} and student community leaders and can be watched live or on demand. - - Request a {% data variables.product.prodname_dotcom %} swag bag with educational materials and goodies for your students. + - Obtenha uma visão geral do seu [{% data variables.product.prodname_classroom %} ativo](https://classroom.github.com), incluindo recomendações recentes e o resumo do progresso da sua turma, bem como links para {% data variables.product.prodname_classroom %}. + - Visualize e interaja com [{% data variables.product.prodname_discussions %}](https://github.com/orgs/community/discussions/categories/github-education) postado por seus pares de todo o mundo para discutir as tendências atuais na educação tecnológica e veja as últimas postagens do nosso blogue [{% data variables.product.prodname_education %}](https://github.blog/category/education/). + - Confira eventos de estudantes curados por {% data variables.product.prodname_education %} e líderes de estudantes. + - Mantenha-se atualizado sobre o que a comunidade de alunos está interessada ao assistir aos episódios recentes da [Campus TV](https://www.twitch.tv/githubeducation). A Campus TV é criada por {% data variables.product.prodname_dotcom %} e líderes da comunidade estudantil e pode ser assistida ao vivo ou sob demanda. + - Solicite brindes de {% data variables.product.prodname_dotcom %} com materiais educativos e benefícios para seus alunos. ## Leia mais diff --git a/translations/pt-BR/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/index.md b/translations/pt-BR/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/index.md index 6386d24345..8912b36935 100644 --- a/translations/pt-BR/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/index.md +++ b/translations/pt-BR/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/index.md @@ -9,8 +9,8 @@ redirect_from: versions: fpt: '*' children: - - /use-github-at-your-educational-institution - /github-global-campus-for-students - /github-global-campus-for-teachers + - /use-github-at-your-educational-institution --- diff --git a/translations/pt-BR/content/education/guides.md b/translations/pt-BR/content/education/guides.md index 3ccad19447..0113ff810a 100644 --- a/translations/pt-BR/content/education/guides.md +++ b/translations/pt-BR/content/education/guides.md @@ -13,15 +13,15 @@ Professores, estudantes e pesquisadores podem usar ferramentas de {% data variab - [Cadastre-se para uma nova conta de {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/signing-up-for-a-new-github-account) - [Git e início rápido de {% data variables.product.prodname_dotcom %} ](/github/getting-started-with-github/quickstart) -- [About {% data variables.product.prodname_global_campus %} for students](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students) -- [Apply to {% data variables.product.prodname_global_campus %} as a teacher](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher) -- [Apply to {% data variables.product.prodname_global_campus %} as a student](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student) +- [Sobre {% data variables.product.prodname_global_campus %} para alunos](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students) +- [Candidatar-se a {% data variables.product.prodname_global_campus %} como professor](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher) +- [Candidatar-se a {% data variables.product.prodname_global_campus %} como um aluno](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student) ## Execute um curso de desenvolvimento de software com {% data variables.product.company_short %} Administrar uma sala de aula, atribuir e revisar o trabalho de seus alunos e ensinar a nova geração de desenvolvedores de software com {% data variables.product.prodname_classroom %}. -- [About {% data variables.product.prodname_global_campus %} for teachers](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/about-github-global-campus-for-teachers) +- [Sobre {% data variables.product.prodname_global_campus %} para professores](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/about-github-global-campus-for-teachers) - [Fundamentos da configuração de {% data variables.product.prodname_classroom %} ](/education/manage-coursework-with-github-classroom/basics-of-setting-up-github-classroom) - [Gerenciar salas de aula](/education/manage-coursework-with-github-classroom/manage-classrooms) - [Use o Git e a atividade iniciante de {% data variables.product.company_short %}](/education/manage-coursework-with-github-classroom/use-the-git-and-github-starter-assignment) @@ -36,7 +36,7 @@ Administrar uma sala de aula, atribuir e revisar o trabalho de seus alunos e ens Incorpore {% data variables.product.prodname_dotcom %} na sua educação e use as mesmas ferramentas dos profissionais. - [Git e recursos de aprendizagem de {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/git-and-github-learning-resources) -- [{% data variables.product.prodname_global_campus %} for students](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students) +- [{% data variables.product.prodname_global_campus %} para alunos](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students) - [Experimente {% data variables.product.prodname_desktop %}](/desktop) - [Experimente {% data variables.product.prodname_cli %}](/github/getting-started-with-github/github-cli) @@ -45,6 +45,6 @@ Incorpore {% data variables.product.prodname_dotcom %} na sua educação e use a Participe da comunidade, receba treinamento de {% data variables.product.company_short %}, e aprenda ou ensine novas habilidades. - [{% data variables.product.prodname_education_community %}]({% data variables.product.prodname_education_forum_link %}) -- [About {% data variables.product.prodname_global_campus %} for students](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students) +- [Sobre {% data variables.product.prodname_global_campus %} para alunos](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students) - [Sobre Especialistas de campus](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/about-campus-experts) - [Contribua com o GitHub Community Exchange](/education/contribute-with-github-community-exchange) diff --git a/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md b/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md index 9574ad9afd..9572fb3b59 100644 --- a/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md +++ b/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md @@ -151,6 +151,6 @@ A página de visão geral de atividades exibe informações sobre a aceitação ## Leia mais -- [{% data variables.product.prodname_global_campus %} for teachers](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers) +- [{% data variables.product.prodname_global_campus %} para professores](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers) - "[Conecte um sistema de gerenciamento de aprendizagem para {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom)" - [Usar Equipes Existentes atividades em grupo?](https://education.github.community/t/using-existing-teams-in-group-assignments/6999) na comunidade de {% data variables.product.prodname_education %} diff --git a/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md b/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md index 0f33cb159c..accafcf6b9 100644 --- a/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md +++ b/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-individual-assignment.md @@ -130,5 +130,5 @@ A página de visão geral do trabalho fornece uma visão geral das suas aceitaç ## Leia mais -- "[{% data variables.product.prodname_global_campus %} for teachers](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers)" +- "[{% data variables.product.prodname_global_campus %} fpara professores](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers)" - "[Conecte um sistema de gerenciamento de aprendizagem para {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom)" diff --git a/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md b/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md index 9be277ee43..3a58f024de 100644 --- a/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md +++ b/translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-the-git-and-github-starter-assignment.md @@ -100,5 +100,5 @@ A atividade inicial do Git & {% data variables.product.company_short %} só est ## Leia mais -- "[{% data variables.product.prodname_global_campus %} for teachers](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers)" +- "[{% data variables.product.prodname_global_campus %} fpara professores](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers)" - "[Conecte um sistema de gerenciamento de aprendizagem para {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/connect-a-learning-management-system-to-github-classroom)" diff --git a/translations/pt-BR/content/education/quickstart.md b/translations/pt-BR/content/education/quickstart.md index a84c0b11b9..461b54714f 100644 --- a/translations/pt-BR/content/education/quickstart.md +++ b/translations/pt-BR/content/education/quickstart.md @@ -15,7 +15,7 @@ Neste guia, você começará com {% data variables.product.product_name %}, insc {% tip %} -**Tip**: If you're a student and you'd like to take advantage of an academic discount, see "[Apply to {% data variables.product.prodname_global_campus %} as a student](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student)." +**Dica**: Se você é um aluno e gostaria de aproveitar um desconto acadêmico, consulte "[Inscrever-se em {% data variables.product.prodname_global_campus %} como um aluno](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student)." {% endtip %} @@ -35,9 +35,9 @@ Depois de criar a sua conta pessoal, crie uma conta grátis de organização. Vo Para obter mais informações, consulte "[Tipos de contas de {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/types-of-github-accounts)". -## Applying for teacher benefits +## Candidatando-se aos benefícios para professores -Next, you'll sign up for teacher benefits and resources from {% data variables.product.company_short %} by applying to {% data variables.product.prodname_global_campus %}, a portal that allows you to access your education benefits all in one place. {% data reusables.education.educator-requirements %} +Em seguida, você irá inscrever-se para os benefícios e recursos dos professores de {% data variables.product.company_short %}, candidatando-se a {% data variables.product.prodname_global_campus %}, um portal que permite que você acesse todos os seus benefícios educativos em um só lugar. {% data reusables.education.educator-requirements %} {% tip %} @@ -53,7 +53,7 @@ Next, you'll sign up for teacher benefits and resources from {% data variables.p {% data reusables.education.plan-to-use-github %} {% data reusables.education.submit-application %} -Once you are a verified {% data variables.product.prodname_global_campus %} educator, you can access {% data variables.product.prodname_global_campus %} anytime by going to the [{% data variables.product.prodname_education %} website](https://education.github.com). +Depois que o educador de {% data variables.product.prodname_global_campus %} for verificado, você poderá acessar {% data variables.product.prodname_global_campus %} a qualquer momento acessando o site [{% data variables.product.prodname_education %}](https://education.github.com). ## Configurar {% data variables.product.prodname_classroom %} diff --git a/translations/pt-BR/content/get-started/exploring-projects-on-github/following-organizations.md b/translations/pt-BR/content/get-started/exploring-projects-on-github/following-organizations.md index cc6da2989c..2be7516721 100644 --- a/translations/pt-BR/content/get-started/exploring-projects-on-github/following-organizations.md +++ b/translations/pt-BR/content/get-started/exploring-projects-on-github/following-organizations.md @@ -7,15 +7,11 @@ topics: - Profile --- -{% note %} - -**Observação:** A capacidade de seguir organizações está atualmente em versão beta pública e sujeita a alterações. - -{% endnote %} +{% data reusables.organizations.follow-organizations-beta %} ## Sobre seguidores em {% data variables.product.product_name %} -Ao seguir as organizações, você verá as atividades públicas delas no seu painel pessoal. Para obter mais informações, consulte "[Sobre seu painel pessoal](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community)". +{% data reusables.organizations.about-following-organizations %} Para obter mais informações, consulte "[Sobre o seu painel pessoal](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community)." Você pode deixar de seguir uma organização se você não quiser ver sua atividade {% ifversion fpt or ghec %}pública {% endif %} em {% data variables.product.product_name %}. diff --git a/translations/pt-BR/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md b/translations/pt-BR/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md index 4d04cdaa7c..edd0827449 100644 --- a/translations/pt-BR/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md +++ b/translations/pt-BR/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md @@ -57,11 +57,21 @@ Se você tiver código-fonte ou repositórios armazenados localmente no computad 1. [Crie um repositório ](/repositories/creating-and-managing-repositories/creating-a-new-repository) no {% data variables.product.product_location %}. Para evitar erros, não inicialize o novo repositório com os arquivos *README*, de licença ou `gitignore`. É possível adicionar esses arquivos após push do projeto no {% data variables.product.product_name %}. ![Menu suspenso Create New Repository (Criar novo repositório)](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Altere o diretório de trabalho atual referente ao seu projeto local. -4. Inicialize o diretório local como um repositório Git. - ```shell - $ git init -b main - ``` +4. Use o comando `init` para inicializar o diretório local como um repositório do Git. Por padrão, o branch inicial é denominado `mestre`. + + Se você estiver usando o Git 2.28.0 ou uma versão posterior, você poderá definir o nome do branch padrão usando `-b`. + + ``` shell + $ git init -b main + ``` + + Se estiver usando o Git 2.27. ou versão anterior, você poderá definir o nome do branch padrão usando `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. Adicione os arquivos ao novo repositório local. Isso faz stage deles para o primeiro commit. + ```shell $ git add . # Adiciona os arquivos no repositório local e faz stage deles para commit. {% data reusables.git.unstage-codeblock %} @@ -92,10 +102,19 @@ Se você tiver código-fonte ou repositórios armazenados localmente no computad 1. [Crie um repositório ](/articles/creating-a-new-repository) no {% data variables.product.product_location %}. Para evitar erros, não inicialize o novo repositório com os arquivos *README*, de licença ou `gitignore`. É possível adicionar esses arquivos após push do projeto no {% data variables.product.product_name %}. ![Menu suspenso Create New Repository (Criar novo repositório)](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Altere o diretório de trabalho atual referente ao seu projeto local. -4. Inicialize o diretório local como um repositório Git. - ```shell - $ git init -b main - ``` +4. Use o comando `init` para inicializar o diretório local como um repositório do Git. Por padrão, o branch inicial é denominado `mestre`. + + Se você estiver usando o Git 2.28.0 ou uma versão posterior, você poderá definir o nome do branch padrão usando `-b`. + + ``` shell + $ git init -b main + ``` + + Se estiver usando o Git 2.27. ou versão anterior, você poderá definir o nome do branch padrão usando `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. Adicione os arquivos ao novo repositório local. Isso faz stage deles para o primeiro commit. ```shell $ git add . @@ -127,10 +146,19 @@ Se você tiver código-fonte ou repositórios armazenados localmente no computad 1. [Crie um repositório ](/articles/creating-a-new-repository) no {% data variables.product.product_location %}. Para evitar erros, não inicialize o novo repositório com os arquivos *README*, de licença ou `gitignore`. É possível adicionar esses arquivos após push do projeto no {% data variables.product.product_name %}. ![Menu suspenso Create New Repository (Criar novo repositório)](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Altere o diretório de trabalho atual referente ao seu projeto local. -4. Inicialize o diretório local como um repositório Git. - ```shell - $ git init -b main - ``` +4. Use o comando `init` para inicializar o diretório local como um repositório do Git. Por padrão, o branch inicial é denominado `mestre`. + + Se você estiver usando o Git 2.28.0 ou uma versão posterior, você poderá definir o nome do branch padrão usando `-b`. + + ``` shell + $ git init -b main + ``` + + Se estiver usando o Git 2.27. ou versão anterior, você poderá definir o nome do branch padrão usando `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. Adicione os arquivos ao novo repositório local. Isso faz stage deles para o primeiro commit. ```shell $ git add . diff --git a/translations/pt-BR/content/get-started/quickstart/be-social.md b/translations/pt-BR/content/get-started/quickstart/be-social.md index 139c148c3d..a15b60e380 100644 --- a/translations/pt-BR/content/get-started/quickstart/be-social.md +++ b/translations/pt-BR/content/get-started/quickstart/be-social.md @@ -58,7 +58,23 @@ No painel de controle, clique no menu suspenso do seu nome de usuário no lado e ![Menu suspenso de alternância de contexto da conta](/assets/images/help/overview/dashboard-contextswitcher.png) -### Explorar outros projetos no {% data variables.product.prodname_dotcom %} +{% ifversion for-you-feed %} + +## Seguindo organizações + +{% data reusables.organizations.follow-organizations-beta %} + +{% data reusables.organizations.about-following-organizations %} + +Para seguir uma organização, no cabeçalho da página, clique em **Seguir**. + +![Captura de tela do cabeçalho da organização, com o botão seguir destacado](/assets/images/help/profile/organization-profile-following.png) + +Para obter mais informações, consulte "[Seguindo as organizações](/get-started/exploring-projects-on-github/following-organizations)". + +{% endif %} + +## Explorar outros projetos no {% data variables.product.prodname_dotcom %} Você pode encontrar projetos novos e interessantes na página de explorar de {% data variables.product.prodname_dotcom %}. Você pode favoritar projetos interessantes para torná-los fáceis de encontrar mais tarde. Visite sua página de favoritos para ver todos os seus projetos favoritos. Para obter mais informações sobre estrelas, consulte "[Repositórios salvos com estrelas](/get-started/exploring-projects-on-github/saving-repositories-with-stars)". diff --git a/translations/pt-BR/content/get-started/quickstart/set-up-git.md b/translations/pt-BR/content/get-started/quickstart/set-up-git.md index 2869fa8932..434508ced1 100644 --- a/translations/pt-BR/content/get-started/quickstart/set-up-git.md +++ b/translations/pt-BR/content/get-started/quickstart/set-up-git.md @@ -42,17 +42,17 @@ Se não precisar trabalhar nos arquivos localmente, o {% data variables.product. 1. [Faça download e instale a versão mais recente do Git](https://git-scm.com/downloads). -{% note %} + {% note %} -**Observação**: Se você estiver usando um dispositivo do Chrome OS, será necessário configurar adicionalmente: + **Observação**: Se você estiver usando um dispositivo do Chrome OS, será necessário configurar adicionalmente: -2. Instale um emulador de terminais como, por exemplo, o Termux da Google Play Store no seu dispositivo Chrome OS. -3. A partir do emulador de terminal que você instalou, instale o Git. Por exemplo, no Termux, insira `apt install git` e, em seguida, digite `y` quando solicitado. + 1. Instale um emulador de terminais como, por exemplo, o Termux da Google Play Store no seu dispositivo Chrome OS. + 1. A partir do emulador de terminal que você instalou, instale o Git. Por exemplo, no Termux, insira `apt install git` e, em seguida, digite `y` quando solicitado. -{% endnote %} + {% endnote %} -2. [Configure seu nome de usuário no Git](/github/getting-started-with-github/setting-your-username-in-git). -3. [Configure seu endereço de e-mail de commit no Git](/articles/setting-your-commit-email-address). +1. [Configure seu nome de usuário no Git](/github/getting-started-with-github/setting-your-username-in-git). +1. [Configure seu endereço de e-mail de commit no Git](/articles/setting-your-commit-email-address). ## Efetuando a autenticação com {% data variables.product.prodname_dotcom %} a partir do Git diff --git a/translations/pt-BR/content/index.md b/translations/pt-BR/content/index.md index ae61dbd5b7..d8debe3845 100644 --- a/translations/pt-BR/content/index.md +++ b/translations/pt-BR/content/index.md @@ -19,6 +19,7 @@ redirect_from: - /troubleshooting-common-issues versions: '*' children: + - search - get-started - account-and-profile - authentication diff --git a/translations/pt-BR/content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md b/translations/pt-BR/content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md index 1ac017a6dc..1bb5b95e63 100644 --- a/translations/pt-BR/content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md +++ b/translations/pt-BR/content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md @@ -19,10 +19,10 @@ allowTitleToDifferFromFilename: true {% note %} -**{% ifversion classic-project-visibility-permissions %}Notes{% else %}Note{% endif %}:** {% ifversion classic-project-visibility-permissions %} +**{% ifversion classic-project-visibility-permissions %}Observações{% else %}Observação{% endif %}:** {% ifversion classic-project-visibility-permissions %} * {% data reusables.projects.owners-can-limit-visibility-permissions %} -* {% endif %}When you make your {% data variables.projects.projects_v1_board %} {% ifversion ghae %}internal{% else %}public{% endif %}, organization members are given read access by default. Você pode dar permissões de gravação ou de administrador a certos integrantes da organização, dando acesso a equipes nas quais estão ou adicionando-os ao {% data variables.projects.projects_v1_board %} como colaborador. Para obter mais informações, consulte "[Permissões de {% data variables.product.prodname_project_v1_caps %} para uma organização](/articles/project-board-permissions-for-an-organization)". +* {% endif %}Ao se tornar o seu {% data variables.projects.projects_v1_board %} {% ifversion ghae %}interno{% else %}público{% endif %}, os integrantes da organização recebem acesso de leitura por padrão. Você pode dar permissões de gravação ou de administrador a certos integrantes da organização, dando acesso a equipes nas quais estão ou adicionando-os ao {% data variables.projects.projects_v1_board %} como colaborador. Para obter mais informações, consulte "[Permissões de {% data variables.product.prodname_project_v1_caps %} para uma organização](/articles/project-board-permissions-for-an-organization)". {% endnote %} diff --git a/translations/pt-BR/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md b/translations/pt-BR/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md index 1f48927a59..32441b575c 100644 --- a/translations/pt-BR/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md +++ b/translations/pt-BR/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md @@ -37,7 +37,7 @@ Você também pode configurar automações de fluxo de trabalho para manter seu {% data reusables.profile.access_profile %} 2. No topa da página do seu perfil, na navegação principal, clique em {% octicon "project" aria-label="The project board icon" %} **Projects** (Projetos). ![Project tab](/assets/images/help/projects/user-projects-tab.png){% ifversion projects-v2 %} -1. Click **Projects (classic)**{% endif %} +1. Clique em **Projetos (clássico)**{% endif %} {% data reusables.project-management.click-new-project %} {% data reusables.project-management.create-project-name-description %} {% data reusables.project-management.choose-template %} @@ -68,7 +68,7 @@ Você também pode configurar automações de fluxo de trabalho para manter seu {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} {% data reusables.organizations.organization-wide-project %}{% ifversion projects-v2 %} -1. Click **Projects (classic)**{% endif %} +1. Clique em **Projetos (clássico)**{% endif %} {% data reusables.project-management.click-new-project %} {% data reusables.project-management.create-project-name-description %} {% data reusables.project-management.choose-template %} @@ -90,7 +90,7 @@ Você também pode configurar automações de fluxo de trabalho para manter seu {% data reusables.repositories.navigate-to-repo %} 2. Abaixo do nome do repositório, clique em {% octicon "project" aria-label="The project board icon" %} **Projects** (Projetos). ![Project tab](/assets/images/help/projects/repo-tabs-projects.png){% ifversion projects-v2 %} -1. Click **Projects (classic)**{% endif %} +1. Clique em **Projetos (clássico)**{% endif %} {% data reusables.project-management.click-new-project %} {% data reusables.project-management.create-project-name-description %} {% data reusables.project-management.choose-template %} diff --git a/translations/pt-BR/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md b/translations/pt-BR/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md index b80b65ad12..63a1fa18a9 100644 --- a/translations/pt-BR/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md +++ b/translations/pt-BR/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md @@ -24,7 +24,7 @@ Para transferir um problema aberto para outro repositório, é preciso ter acess {% endnote %} -Ao transferir um problema, os comentários, etiquetas e responsáveis são mantidos. Os marcos do problema não são mantidos. Esse problema permanecerá em qualquer quadro de projeto pertencente ao usuário ou à organização e será removido dos quadros de projeto de todos os repositórios. Para obter mais informações, consulte "[Sobre quadros de projeto](/articles/about-project-boards)". +Quando você transfere um problema, os comentários e responsáveis são mantidos. Labels and milestones are also retained if they're present in the target repository, with labels matching by name and milestones matching by both name and due date. Esse problema permanecerá em qualquer quadro de projeto pertencente ao usuário ou à organização e será removido dos quadros de projeto de todos os repositórios. Para obter mais informações, consulte "[Sobre quadros de projeto](/articles/about-project-boards)". As pessoas ou equipes mencionadas no problema receberão uma notificação informando que o problema foi transferido para um novo repositório. O URL original redirecionará para o novo URL do problema. As pessoas que não tenham permissões de leitura no novo repositório verão um banner informando que o problema foi transferido para um novo repositório ao qual elas não têm acesso. diff --git a/translations/pt-BR/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md b/translations/pt-BR/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md index 88cf8656de..8a5a45ffb3 100644 --- a/translations/pt-BR/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md +++ b/translations/pt-BR/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md @@ -36,15 +36,22 @@ Você também pode configurar endereços IP permitidos para as organizações em ## Adicionar endereços IP permitidos +{% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} + +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} {% data reusables.identity-and-permissions.ip-allow-lists-add-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-add-description %} {% data reusables.identity-and-permissions.ip-allow-lists-add-entry %} +{% data reusables.identity-and-permissions.check-ip-address %} ## Habilitar endereços IP permitidos +{% data reusables.identity-and-permissions.about-enabling-allowed-ip-addresses %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} @@ -69,6 +76,8 @@ Para mais informações sobre como criar uma lista de permissões para uma {% da ## Editar endereços IP permitidos +{% data reusables.identity-and-permissions.about-editing-ip-allow-list-entries %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} @@ -76,6 +85,18 @@ Para mais informações sobre como criar uma lista de permissões para uma {% da {% data reusables.identity-and-permissions.ip-allow-lists-edit-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-description %} 1. Clique em **Atualizar**. +{% data reusables.identity-and-permissions.check-ip-address %} + +{% ifversion ip-allow-list-address-check %} +## Verificando se um endereço IP é permitido + +{% data reusables.identity-and-permissions.about-checking-ip-address %} + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +{% data reusables.organizations.security %} +{% data reusables.identity-and-permissions.check-ip-address-step %} +{% endif %} ## Excluir endereços IP permitidos diff --git a/translations/pt-BR/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md b/translations/pt-BR/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md index d5cee8b617..686a427ea5 100644 --- a/translations/pt-BR/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md +++ b/translations/pt-BR/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md @@ -740,7 +740,7 @@ For more information, see "[Managing the publication of {% data variables.produc | Action | Description |------------------|------------------- |`create` | Triggered when an organization owner creates a new custom repository role. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." -|`destroy` | Triggered when a organization owner deletes a custom repository role. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." +|`destroy` | Triggered when an organization owner deletes a custom repository role. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." |`update` | Triggered when an organization owner edits an existing custom repository role. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." {% endif %} diff --git a/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md b/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md index 9fe03c8946..e485551052 100644 --- a/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md +++ b/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md @@ -1,6 +1,6 @@ --- -title: 'Adding an outside collaborator to a {% data variables.product.prodname_project_v1 %} in your organization' -intro: 'As an organization owner or {% data variables.projects.projects_v1_board %} admin, you can add an outside collaborator and customize their permissions to a {% data variables.projects.projects_v1_board %}.' +title: 'Adicionar um colaborador externo a um {% data variables.product.prodname_project_v1 %} na sua organização' +intro: 'Como proprietário da organização ou administrador de {% data variables.projects.projects_v1_board %}, você pode adicionar um colaborador externo e personalizar suas permissões a um {% data variables.projects.projects_v1_board %}.' redirect_from: - /articles/adding-an-outside-collaborator-to-a-project-board-in-your-organization - /github/setting-up-and-managing-organizations-and-teams/adding-an-outside-collaborator-to-a-project-board-in-your-organization @@ -18,12 +18,12 @@ allowTitleToDifferFromFilename: true {% data reusables.projects.project_boards_old %} -An outside collaborator is a person who isn't explicitly a member of your organization, but who has permissions to a {% data variables.projects.projects_v1_board %} in your organization. +Um colaborador externo é uma pessoa que não é explicitamente integrante da sua organização, mas que tem permissões para um {% data variables.projects.projects_v1_board %} na sua organização. {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} {% data reusables.organizations.organization-wide-project %}{% ifversion projects-v2 %} -1. Click **Projects (classic)**{% endif %} +1. Clique em **Projetos (clássico)**{% endif %} {% data reusables.project-management.select-project %} {% data reusables.project-management.click-menu %} {% data reusables.project-management.access-collaboration-settings %} diff --git a/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/managing-access-to-a-project-board-for-organization-members.md b/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/managing-access-to-a-project-board-for-organization-members.md index 1608506f66..ff07f33b08 100644 --- a/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/managing-access-to-a-project-board-for-organization-members.md +++ b/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/managing-access-to-a-project-board-for-organization-members.md @@ -31,7 +31,7 @@ Por padrão, os integrantes da organização têm acesso de gravação ao {% dat {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} {% data reusables.organizations.organization-wide-project %}{% ifversion projects-v2 %} -1. Click **Projects (classic)**{% endif %} +1. Clique em **Projetos (clássico)**{% endif %} {% data reusables.project-management.select-project %} {% data reusables.project-management.click-menu %} {% data reusables.project-management.access-collaboration-settings %} @@ -40,6 +40,6 @@ Por padrão, os integrantes da organização têm acesso de gravação ao {% dat ## Leia mais -- "[Managing an individual’s access to an organization {% data variables.product.prodname_project_v1 %}](/articles/managing-an-individual-s-access-to-an-organization-project-board)" -- "[Managing team access to an organization {% data variables.product.prodname_project_v1 %}](/articles/managing-team-access-to-an-organization-project-board)" +- "[Gerenciando o acesso de um indivíduo a uma organização de {% data variables.product.prodname_project_v1 %}](/articles/managing-an-individual-s-access-to-an-organization-project-board)" +- "[Gerenciando o acesso de uma equipe a uma organização de {% data variables.product.prodname_project_v1 %}](/articles/managing-team-access-to-an-organization-project-board)" - "[Permissões de {% data variables.product.prodname_project_v1_caps %} para uma organização](/articles/project-board-permissions-for-an-organization)" diff --git a/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board.md b/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board.md index d384177275..74893316ad 100644 --- a/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board.md +++ b/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board.md @@ -1,6 +1,6 @@ --- -title: 'Managing an individual’s access to an organization {% data variables.product.prodname_project_v1 %}' -intro: 'As an organization owner or {% data variables.projects.projects_v1_board %} admin, you can manage an individual member''s access to a {% data variables.projects.projects_v1_board %} owned by your organization.' +title: 'Gerenciando o acesso de um indivíduo a uma organização de {% data variables.product.prodname_project_v1 %}' +intro: 'Como proprietário da organização ou administrador de {% data variables.projects.projects_v1_board %}, você pode gerenciar o acesso de um integrante individual a um {% data variables.projects.projects_v1_board %} pertencente à sua organização.' redirect_from: - /articles/managing-an-individual-s-access-to-an-organization-project-board - /articles/managing-an-individuals-access-to-an-organization-project-board @@ -21,16 +21,16 @@ allowTitleToDifferFromFilename: true {% note %} -**Note:** {% data reusables.project-management.cascading-permissions %} For more information, see "[{% data variables.product.prodname_project_v1_caps %} permissions for an organization](/articles/project-board-permissions-for-an-organization)." +**Observação:** {% data reusables.project-management.cascading-permissions %} Para obter mais informações, consulte "[permissões de {% data variables.product.prodname_project_v1_caps %} para uma organização](/articles/project-board-permissions-for-an-organization)". {% endnote %} -## Giving an organization member access to a {% data variables.projects.projects_v1_board %} +## Aoncedendo acesso a um integrante da organização a um {% data variables.projects.projects_v1_board %} {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} {% data reusables.organizations.organization-wide-project %}{% ifversion projects-v2 %} -1. Click **Projects (classic)**{% endif %} +1. Clique em **Projetos (clássico)**{% endif %} {% data reusables.project-management.select-project %} {% data reusables.project-management.click-menu %} {% data reusables.project-management.access-collaboration-settings %} @@ -39,26 +39,26 @@ allowTitleToDifferFromFilename: true {% data reusables.project-management.add-collaborator %} {% data reusables.project-management.collaborator-permissions %} -## Changing an organization member's access to a {% data variables.projects.projects_v1_board %} +## Alterando o acesso dos integrantes de uma organização para um {% data variables.projects.projects_v1_board %} {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} {% data reusables.organizations.organization-wide-project %}{% ifversion projects-v2 %} -1. Click **Projects (classic)**{% endif %} +1. Clique em **Projetos (clássico)**{% endif %} {% data reusables.project-management.select-project %} {% data reusables.project-management.click-menu %} {% data reusables.project-management.access-collaboration-settings %} {% data reusables.project-management.collaborator-option %} {% data reusables.project-management.collaborator-permissions %} -## Removing an organization member's access to a {% data variables.projects.projects_v1_board %} +## Removendo acesso do integrante da organização a um {% data variables.projects.projects_v1_board %} -When you remove a collaborator from a {% data variables.projects.projects_v1_board %}, they may still retain access to the board based on the permissions they have for other roles. To completely remove access to a {% data variables.projects.projects_v1_board %}, you must remove access for each role the person has. For instance, a person may have access to the {% data variables.projects.projects_v1_board %} as an organization member or team member. Para obter mais informações, consulte "[Permissões de {% data variables.product.prodname_project_v1_caps %} para uma organização](/articles/project-board-permissions-for-an-organization)". +Ao remover um colaborador de um {% data variables.projects.projects_v1_board %}, ele ainda poderá manter o acesso ao quadro com base nas permissões para outras funções. Para remover completamente o acesso a um {% data variables.projects.projects_v1_board %}, você deverá remover o acesso para cada função que a pessoa possui. Por exemplo, uma pessoa pode ter acesso ao {% data variables.projects.projects_v1_board %} como integrante da organização ou integrante da equipe. Para obter mais informações, consulte "[Permissões de {% data variables.product.prodname_project_v1_caps %} para uma organização](/articles/project-board-permissions-for-an-organization)". {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} {% data reusables.organizations.organization-wide-project %}{% ifversion projects-v2 %} -1. Click **Projects (classic)**{% endif %} +1. Clique em **Projetos (clássico)**{% endif %} {% data reusables.project-management.select-project %} {% data reusables.project-management.click-menu %} {% data reusables.project-management.access-collaboration-settings %} diff --git a/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/managing-team-access-to-an-organization-project-board.md b/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/managing-team-access-to-an-organization-project-board.md index 194e2aec07..f1e0f42b45 100644 --- a/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/managing-team-access-to-an-organization-project-board.md +++ b/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/managing-team-access-to-an-organization-project-board.md @@ -1,6 +1,6 @@ --- -title: 'Managing team access to an organization {% data variables.product.prodname_project_v1 %}' -intro: 'As an organization owner or {% data variables.projects.projects_v1_board %} admin, you can give a team access to a {% data variables.projects.projects_v1_board %} owned by your organization.' +title: 'Gerenciando o acesso de equipe a uma organização de {% data variables.product.prodname_project_v1 %}' +intro: 'Como proprietário de uma organização ou administrador de {% data variables.projects.projects_v1_board %}, você pode conceder acesso a uma equipe a um {% data variables.projects.projects_v1_board %} pertencente à sua organização.' redirect_from: - /articles/managing-team-access-to-an-organization-project-board - /github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-project-board @@ -21,25 +21,25 @@ allowTitleToDifferFromFilename: true {% warning %} **Avisos:** -- You can change a team's permission level if the team has direct access to a {% data variables.projects.projects_v1_board %}. If the team's access to the {% data variables.projects.projects_v1_board %} is inherited from a parent team, you must change the parent team's access to the {% data variables.projects.projects_v1_board %}. -- If you add or remove {% data variables.projects.projects_v1_board %} access for a parent team, each of that parent's child teams will also receive or lose access to the {% data variables.projects.projects_v1_board %}. Para obter mais informações, consulte "[Sobre equipes](/articles/about-teams)". +- Você pode alterar o nível de permissão de uma equipe se a equipe tiver acesso direto a um {% data variables.projects.projects_v1_board %}. Se o acesso da equipe ao {% data variables.projects.projects_v1_board %} for herdado de uma equipe principal, você deverá alterar o acesso da equipe principal a {% data variables.projects.projects_v1_board %}. +- Se você adicionar ou remover o acesso de {% data variables.projects.projects_v1_board %} a uma equipe principal, cada uma das equipes secundárias dessa principal também receberá ou perderá acesso ao {% data variables.projects.projects_v1_board %}. Para obter mais informações, consulte "[Sobre equipes](/articles/about-teams)". {% endwarning %} -## Giving a team access to a {% data variables.projects.projects_v1_board %} +## Dando acesso a uma equipe {% data variables.projects.projects_v1_board %} -You can give an entire team the same permission level to a {% data variables.projects.projects_v1_board %}. +Você pode dar a uma equipe inteira o mesmo nível de permissão para um {% data variables.projects.projects_v1_board %}. {% note %} -**Note:** {% data reusables.project-management.cascading-permissions %} For example, if an organization owner has given a team read permissions to a {% data variables.projects.projects_v1_board %}, and a {% data variables.projects.projects_v1_board %} admin gives one of the team members admin permissions to that board as an individual collaborator, that person would have admin permissions to the {% data variables.projects.projects_v1_board %}. For more information see, "[{% data variables.product.prodname_project_v1_caps %} permissions for an organization](/articles/project-board-permissions-for-an-organization)." +**Observação:** {% data reusables.project-management.cascading-permissions %} Por exemplo, se o proprietário de uma organização concedeu permissões de leitura para um {% data variables.projects.projects_v1_board %}, e um administrador de {% data variables.projects.projects_v1_board %} conceder a um dos integrantes da equipe permissões de administrador para esse quadro como colaborador individual, essa pessoa teria permissões de administrador para o {% data variables.projects.projects_v1_board %}. Para obter mais informações, consulte "[Permissões de {% data variables.product.prodname_project_v1_caps %}para uma organização](/articles/project-board-permissions-for-an-organization)". {% endnote %} {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} {% data reusables.organizations.organization-wide-project %}{% ifversion projects-v2 %} -1. Click **Projects (classic)**{% endif %} +1. Clique em **Projetos (clássico)**{% endif %} {% data reusables.project-management.select-project %} {% data reusables.project-management.click-menu %} {% data reusables.project-management.access-collaboration-settings %} @@ -47,12 +47,12 @@ You can give an entire team the same permission level to a {% data variables.pro 9. Para adicionar uma equipe, clique em **Add a team: Select team** (Adicionar uma equipe: Selecionar equipe). Depois, escolha uma equipe no menu suspenso ou pesquise a equipe que você deseja adicionar. ![Menu suspenso Add a team (Adicionar uma equipe) com lista de equipes na organização](/assets/images/help/projects/add-a-team.png) 10. Ao lado do nome da equipe, use o menu suspenso para selecionar o nível de permissão desejado: **Read** (Leitura), **Write** (Gravação) ou **Admin** (Administrador). ![Menu suspenso Team permissions (Permissões de equipe) com opções read, write e admin (leitura, gravação e administrador)](/assets/images/help/projects/org-project-team-choose-permissions.png) -## Configuring a team's access to a {% data variables.projects.projects_v1_board %} +## Configurando o acesso de uma equipe a um {% data variables.projects.projects_v1_board %} -If a team's access to a {% data variables.projects.projects_v1_board %} is inherited from a parent team, you must change the parent team's access to the {% data variables.projects.projects_v1_board %} to update access to the child teams. +Se o acesso de uma equipe a um {% data variables.projects.projects_v1_board %} for herdado de uma equipe principal, você precisa alterar o acesso da equipe principal a {% data variables.projects.projects_v1_board %} para atualizar o acesso às equipes secundárias. {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} {% data reusables.organizations.specific_team %} 4. Acima das conversas da equipe, clique em {% octicon "project" aria-label="The Projects icon" %} **Projects** (Projetos). ![Aba repositórios da equipe](/assets/images/help/organizations/team-project-board-button.png) -5. To change permissions levels, to the right of the {% data variables.projects.projects_v1_board %} you want to update, use the drop-down. To remove a {% data variables.projects.projects_v1_board %}, click **{% octicon "trash" aria-label="The trash icon" %}**. ![Botão Trash (Lixeira) Remove a project board from your team (Remover um quadro de projeto de sua equipe)](/assets/images/help/organizations/trash-button.png) +5. Para alterar níveis de permissões, à direita de {% data variables.projects.projects_v1_board %} que você deseja atualizar, use o menu suspenso. Para remover um {% data variables.projects.projects_v1_board %}, clique em **{% octicon "trash" aria-label="The trash icon" %}**. ![Botão Trash (Lixeira) Remove a project board from your team (Remover um quadro de projeto de sua equipe)](/assets/images/help/organizations/trash-button.png) diff --git a/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization.md b/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization.md index c5c9c2c542..28d0f764cf 100644 --- a/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization.md +++ b/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization.md @@ -1,6 +1,6 @@ --- title: 'Permissões de {% data variables.product.prodname_project_v1_caps %} de para uma organização' -intro: 'Organization owners and people with {% data variables.projects.projects_v1_board %} admin permissions can customize who has read, write, and admin permissions to your organization’s {% data variables.projects.projects_v1_boards %}.' +intro: 'Os proprietários da organização e pessoas com permissões de administrador para {% data variables.projects.projects_v1_board %} podem personalizar quem leu, escreveu e as permissões de administrador para o {% data variables.projects.projects_v1_boards %} da sua organização.' redirect_from: - /articles/project-board-permissions-for-an-organization - /github/setting-up-and-managing-organizations-and-teams/project-board-permissions-for-an-organization @@ -20,32 +20,32 @@ allowTitleToDifferFromFilename: true ## Visão geral das permissões -There are three levels of permissions to a {% data variables.projects.projects_v1_board %} for people and teams: +Existem três níveis de permissões para um {% data variables.projects.projects_v1_board %} para pessoas e equipes: {% data reusables.project-management.project-board-permissions %} -Organization owners and people with admin permissions can give a person access to an organization {% data variables.projects.projects_v1_board %} individually, as an outside collaborator or organization member, or through their membership in a team or organization. Um colaborador externo é uma pessoa que não é integrante da organização mas recebeu permissões para colaborar na organização. +Os proprietários da organização e pessoas com permissões de administrador podem dar acesso a uma organização de {% data variables.projects.projects_v1_board %} individualmente, como colaborador ou integrante da organização externo, ou por meio de sua associação a uma equipe ou organização. Um colaborador externo é uma pessoa que não é integrante da organização mas recebeu permissões para colaborar na organização. -Organization owners and people with admin permissions to a {% data variables.projects.projects_v1_board %} can also: +Os proprietários da organização e as pessoas com permissões de administradores em um {% data variables.projects.projects_v1_board %} também podem: - Definir permissões de quadro de projeto padrão para todos os integrantes da organização. -- Gerenciar o acesso de integrantes, equipes e colaboradores externos da organização ao quadro de projeto. For more information, see "[Managing team access to an organization {% data variables.product.prodname_project_v1 %}](/articles/managing-team-access-to-an-organization-project-board)", "[Managing an individual’s access to an organization {% data variables.product.prodname_project_v1 %}](/articles/managing-an-individual-s-access-to-an-organization-project-board)", or "[Managing access to a {% data variables.product.prodname_project_v1 %} for organization members](/articles/managing-access-to-a-project-board-for-organization-members)." -- Gerenciar a visibilidade do quadro de projeto. For more information, see "[Managing access to a {% data variables.product.prodname_project_v1 %} for organization members](/articles/managing-access-to-a-project-board-for-organization-members)." +- Gerenciar o acesso de integrantes, equipes e colaboradores externos da organização ao quadro de projeto. Para obter mais informações, consulte "[Gerenciando o acesso da equipe a uma organização {% data variables.product.prodname_project_v1 %}](/articles/managing-team-access-to-an-organization-project-board)", "[Gerenciando o acesso de um indivíduo a uma organização {% data variables.product.prodname_project_v1 %}](/articles/managing-an-individual-s-access-to-an-organization-project-board)", ou "[Gerenciando o acesso a um {% data variables.product.prodname_project_v1 %} para os integrantes da organização](/articles/managing-access-to-a-project-board-for-organization-members)." +- Gerenciar a visibilidade do quadro de projeto. Para obter mais informações, consulte "[Gerenciando o acesso a um {% data variables.product.prodname_project_v1 %} para os integrantes da organização](/articles/managing-access-to-a-project-board-for-organization-members)". -## Cascading permissions for {% data variables.projects.projects_v1_boards %} +## Permissões em cascata para {% data variables.projects.projects_v1_boards %} {% data reusables.project-management.cascading-permissions %} -For example, if an organization owner has given all organization members read permissions to a {% data variables.projects.projects_v1_board %}, and a {% data variables.projects.projects_v1_board %} admin gives an organization member write permissions to that board as an individual collaborator, that person would have write permissions to the {% data variables.projects.projects_v1_board %}. +Por exemplo, se um proprietário da organização deu permissões de leitura a todos os integrantes da organização para um {% data variables.projects.projects_v1_board %}, e um administrador do {% data variables.projects.projects_v1_board %} conece a um integrante da organização permissões de gravação para esse quadro como colaborador individual, essa pessoa teria permissões de gravação no {% data variables.projects.projects_v1_board %}. -## {% data variables.projects.projects_v1_board_caps %} visibility +## visibilidade de {% data variables.projects.projects_v1_board_caps %} {% ifversion classic-project-visibility-permissions %}{% data reusables.projects.owners-can-limit-visibility-permissions %}{% endif %} -{% data reusables.project-management.project-board-visibility %} You can change the {% data variables.projects.projects_v1_board %}'s visibility from private to {% ifversion ghae %}internal{% else %}public{% endif %} and back again. For more information, see "[Changing {% data variables.product.prodname_project_v1 %} visibility](/articles/changing-project-board-visibility)." +{% data reusables.project-management.project-board-visibility %} Você pode alterar a visibilidade de {% data variables.projects.projects_v1_board %} de privada para {% ifversion ghae %}interna{% else %}{% endif %} e novamente para privada. Para obter mais informações, consulte "[Alterando a visibilidade de {% data variables.product.prodname_project_v1 %}](/articles/changing-project-board-visibility)". ## Leia mais -- "[Changing {% data variables.product.prodname_project_v1 %} visibility](/articles/changing-project-board-visibility)" -- "[Managing an individual’s access to an organization {% data variables.product.prodname_project_v1 %}](/articles/managing-an-individual-s-access-to-an-organization-project-board)" -- "[Managing team access to an organization {% data variables.product.prodname_project_v1 %}](/articles/managing-team-access-to-an-organization-project-board)" -- "[Managing access to a {% data variables.product.prodname_project_v1 %} for organization members](/articles/managing-access-to-a-project-board-for-organization-members)" +- "[Alterando a visibilidade de {% data variables.product.prodname_project_v1 %}](/articles/changing-project-board-visibility)" +- "[Gerenciando o acesso de um indivíduo a uma organização de {% data variables.product.prodname_project_v1 %}](/articles/managing-an-individual-s-access-to-an-organization-project-board)" +- "[Gerenciando o acesso de uma equipe a uma organização de {% data variables.product.prodname_project_v1 %}](/articles/managing-team-access-to-an-organization-project-board)" +- "[Gerenciando o acesso a um {% data variables.product.prodname_project_v1 %} para os integrantes da organização](/articles/managing-access-to-a-project-board-for-organization-members)". diff --git a/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/removing-an-outside-collaborator-from-an-organization-project-board.md b/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/removing-an-outside-collaborator-from-an-organization-project-board.md index 0da2326542..6be4322435 100644 --- a/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/removing-an-outside-collaborator-from-an-organization-project-board.md +++ b/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/removing-an-outside-collaborator-from-an-organization-project-board.md @@ -1,6 +1,6 @@ --- -title: 'Removing an outside collaborator from an organization {% data variables.product.prodname_project_v1 %}' -intro: 'As an organization owner or {% data variables.projects.projects_v1_board %} admin, you can remove an outside collaborator''s access to a {% data variables.projects.projects_v1_board %}.' +title: 'Removendo um colaborador externo de uma organização de {% data variables.product.prodname_project_v1 %}' +intro: 'Como proprietário da organização ou administrador de {% data variables.projects.projects_v1_board %}, você pode remover o acesso de um colaborador externo a um {% data variables.projects.projects_v1_board %}.' redirect_from: - /articles/removing-an-outside-collaborator-from-an-organization-project-board - /github/setting-up-and-managing-organizations-and-teams/removing-an-outside-collaborator-from-an-organization-project-board @@ -21,7 +21,7 @@ allowTitleToDifferFromFilename: true {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} {% data reusables.organizations.organization-wide-project %}{% ifversion projects-v2 %} -1. Click **Projects (classic)**{% endif %} +1. Clique em **Projetos (clássico)**{% endif %} {% data reusables.project-management.select-project %} {% data reusables.project-management.click-menu %} {% data reusables.project-management.access-collaboration-settings %} diff --git a/translations/pt-BR/content/organizations/managing-organization-settings/allowing-project-visibility-changes-in-your-organization.md b/translations/pt-BR/content/organizations/managing-organization-settings/allowing-project-visibility-changes-in-your-organization.md index 69bcc7db8f..c3fc79da7d 100644 --- a/translations/pt-BR/content/organizations/managing-organization-settings/allowing-project-visibility-changes-in-your-organization.md +++ b/translations/pt-BR/content/organizations/managing-organization-settings/allowing-project-visibility-changes-in-your-organization.md @@ -1,30 +1,30 @@ --- title: Permitindo alterações de visibilidade de projeto na sua organização -intro: 'Organization owners can allow members with admin permissions to adjust the visibility of {% data variables.projects.projects_v2_and_v1 %} in their organization.' +intro: 'Os proprietários da organização podem permitir que os integrantes com permissões de administrador ajustem a visibilidade de {% data variables.projects.projects_v2_and_v1 %} na sua organização.' versions: feature: classic-project-visibility-permissions-or-projects-v2 topics: - Organizations - Projects -shortTitle: Project visibility permissions +shortTitle: Permissões de visibilidade do projeto allowTitleToDifferFromFilename: true permissions: 'Organization owners can allow {% data variables.projects.project_v2_and_v1 %} visibility changes for an organization.' --- -You can restrict who has the ability to change the visibility of {% data variables.projects.projects_v2_and_v1 %} in your organization, such as restricting members from changing {% data variables.projects.projects_v2_and_v1 %} from private to public. +Você pode restringir quem tem a capacidade de alterar a visibilidade de {% data variables.projects.projects_v2_and_v1 %} na sua organização e impedir que os integrantes alterem {% data variables.projects.projects_v2_and_v1 %} de privado para público. -You can limit the ability to change {% data variables.projects.project_v2_and_v1 %} visibility to just organization owners, or you can allow anyone granted admin permissions to change the visibility. +Você pode limitar a capacidade de alterar a visibilidade de {% data variables.projects.project_v2_and_v1 %} para apenas os proprietários da organização ou você pode permitir que qualquer pessoa conceda permissões de administrador altere a visibilidade. {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -1. In the "Code, planning, and automation" section of the sidebar, click **{% octicon "table" aria-label="The table icon" %} Projects**. -1. To allow members to adjust project visibility, select **Allow members to change project visibilities for this organization**. ![Screenshot showing checkbox to set visibility changes](/assets/images/help/projects-v2/visibility-change-checkbox.png) +1. Na seção "código, planejamento e automação" na barra lateral, clique em **Projetos de {% octicon "table" aria-label="The table icon" %}**. +1. Para permitir que os integrantes ajustem a visibilidade do projeto, selecione **Permitir que os integrantes alterem a visibilidade do projeto para esta organização**. ![Captura de tela que mostra a caixa de seleção para definir alterações de visibilidade](/assets/images/help/projects-v2/visibility-change-checkbox.png) 1. Clique em **Salvar**. ## Leia mais {% ifversion projects-v2 %} -- "[Managing visibility of your {% data variables.projects.projects_v2 %}](/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects)" +- "[Gerenciando a visibilidade do seu {% data variables.projects.projects_v2 %}](/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects)" {%- endif %}{%- ifversion projects-v1 %} -- "[Changing {% data variables.product.prodname_project_v1 %} visibility](/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility)" +- "[Alterando a visibilidade de {% data variables.product.prodname_project_v1 %}](/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility)" {% endif %} diff --git a/translations/pt-BR/content/organizations/managing-organization-settings/disabling-insights-for-projects-in-your-organization.md b/translations/pt-BR/content/organizations/managing-organization-settings/disabling-insights-for-projects-in-your-organization.md index c3bb9cce0c..d448487bc0 100644 --- a/translations/pt-BR/content/organizations/managing-organization-settings/disabling-insights-for-projects-in-your-organization.md +++ b/translations/pt-BR/content/organizations/managing-organization-settings/disabling-insights-for-projects-in-your-organization.md @@ -1,25 +1,25 @@ --- -title: 'Disabling insights for {% data variables.projects.projects_v2 %} in your organization' -intro: 'Organization owners can turn off insights for {% data variables.product.prodname_projects_v2 %} in their organization.' +title: 'Desabilitando insights para {% data variables.projects.projects_v2 %} na sua organização' +intro: 'Os proprietários da organização podem desativar informações sobre {% data variables.product.prodname_projects_v2 %} na sua organização.' versions: feature: projects-v2 product: '{% data reusables.gated-features.historical-insights-for-projects %}' topics: - Projects -shortTitle: 'Disable {% data variables.product.prodname_projects_v2 %} insights' +shortTitle: 'Desabilitar insights de {% data variables.product.prodname_projects_v2 %}' allowTitleToDifferFromFilename: true --- -After you disable insights for projects in your organization, it won't be possible to access insights for any projects owned by the organization. +Depois que você desabilitar insights para projetos na sua organização, não será possível acessar os insights para projetos pertencentes à organização. {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -1. In the sidebar, click **{% octicon "sliders" aria-label="The sliders icon" %} Features**. ![Screenshot showing features menu item](/assets/images/help/projects-v2/features-org-menu.png) -1. Under "Insights", deselect **Enable Insights for the organization**. ![Screenshot showing Enable Insights for the organization checkbox](/assets/images/help/projects-v2/disable-insights-checkbox.png) +1. Na barra lateral, clique em **Funcionalidades de {% octicon "sliders" aria-label="The sliders icon" %}**. ![Captura de tela que mostra o item de menu das funcionalidades](/assets/images/help/projects-v2/features-org-menu.png) +1. Em "Insights", desmarque **HabilitarInsights para a organização**. ![Captura de tela que mostra Habilitar Insights para a caixa de seleção da organização](/assets/images/help/projects-v2/disable-insights-checkbox.png) 1. Clique em **Salvar**. ![Captura de tela que mostra o botão salvar](/assets/images/help/projects-v2/disable-insights-save.png) ## Leia mais - "[Sobre o {% data variables.product.prodname_projects_v2 %}](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)" -- "[About insights for {% data variables.projects.projects_v2 %}](/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/about-insights-for-projects)" +- "[Sobre insights para {% data variables.projects.projects_v2 %}](/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/about-insights-for-projects)" diff --git a/translations/pt-BR/content/organizations/managing-organization-settings/disabling-project-boards-in-your-organization.md b/translations/pt-BR/content/organizations/managing-organization-settings/disabling-project-boards-in-your-organization.md index 0daad087c7..72a673238b 100644 --- a/translations/pt-BR/content/organizations/managing-organization-settings/disabling-project-boards-in-your-organization.md +++ b/translations/pt-BR/content/organizations/managing-organization-settings/disabling-project-boards-in-your-organization.md @@ -1,6 +1,6 @@ --- -title: 'Disabling {% ifversion projects-v2 %}projects{% else %}project boards{% endif %} in your organization' -intro: 'Organization owners can turn off {% ifversion projects-v2 %}organization-wide {% data variables.projects.projects_v2 %}, organization-wide {% data variables.projects.projects_v1_boards %}, and repository-level {% data variables.projects.projects_v1_boards %}{% else %}organization-wide project boards and repository project boards{% endif %} in an organization.' +title: 'Desabilitando {% ifversion projects-v2 %}projetos{% else %}quadros de projetos{% endif %} na sua organização' +intro: 'Os proprietários da organização podem desativar {% ifversion projects-v2 %}em toda a organização {% data variables.projects.projects_v2 %}, em toda a organização {% data variables.projects.projects_v1_boards %}, e o nível de repositório {% data variables.projects.projects_v1_boards %}{% else %}quadros de projetos e quadros de projetos de repositórios em toda a organização{% endif %} em uma organização.' redirect_from: - /github/managing-your-work-on-github/managing-project-boards/disabling-project-boards-in-your-organization - /articles/disabling-project-boards-in-your-organization @@ -12,11 +12,11 @@ versions: ghec: '*' topics: - Pull requests -shortTitle: Disable projects +shortTitle: Desabilitar projetos allowTitleToDifferFromFilename: true --- -Após a desabilitação dos quadros de projeto em toda a organização, não é mais possível criar quadros de projeto no nível da organização nem acessar os quadros de projeto no nível de organização já existentes pelas URLs anteriores. Os quadros de projeto em repositórios não são afetados. {% ifversion projects-v2 %}These settings apply to {% data variables.projects.projects_v2 %} and {% data variables.projects.projects_v1_boards %}.{% endif %} +Após a desabilitação dos quadros de projeto em toda a organização, não é mais possível criar quadros de projeto no nível da organização nem acessar os quadros de projeto no nível de organização já existentes pelas URLs anteriores. Os quadros de projeto em repositórios não são afetados. {% ifversion projects-v2 %}Estas configurações aplicam-se a {% data variables.projects.projects_v2 %} e {% data variables.projects.projects_v1_boards %}.{% endif %} Após a desabilitação dos quadros de projeto de repositório em uma organização, não é mais possível criar quadros de projeto em repositórios da organização nem acessar os quadros de projeto já existentes em repositórios da organização pelas URLs anteriores. Os quadros de projeto no nível da organização não são afetados. @@ -38,8 +38,8 @@ Quando você desabilita quadros de projeto, deixa de ver informações relaciona ## Leia mais -{% ifversion projects-v2 %}- "[About {% data variables.product.prodname_projects_v2 %}](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)"{% endif %} +{% ifversion projects-v2 %}- "[Sobre {% data variables.product.prodname_projects_v2 %}](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)"{% endif %} - "[Sobre o {% data variables.product.prodname_projects_v1 %}](/articles/about-project-boards)" -- "[Closing a {% data variables.projects.projects_v1_board %}](/articles/closing-a-project-board)" -- "[Deleting a {% data variables.projects.projects_v1_board %}](/articles/deleting-a-project-board)" -- "[Disabling {% data variables.projects.projects_v1_boards %} in a repository](/articles/disabling-project-boards-in-a-repository)" +- "[Fechando um {% data variables.projects.projects_v1_board %}](/articles/closing-a-project-board)" +- "[Excluindo um {% data variables.projects.projects_v1_board %}](/articles/deleting-a-project-board)" +- "[Desabilitando {% data variables.projects.projects_v1_boards %} em um repositório](/articles/disabling-project-boards-in-a-repository)" diff --git a/translations/pt-BR/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md b/translations/pt-BR/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md index 902aa6d34b..cb8263d2da 100644 --- a/translations/pt-BR/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md +++ b/translations/pt-BR/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md @@ -1,6 +1,6 @@ --- title: Habilitando ou desabilitando as discussões no GitHub para uma organização -intro: 'Você pode usar o {% data variables.product.prodname_discussions %} em uma organização como um local para a sua organização ter conversas que não são específicas para um único repositório dentro da sua organização.' +intro: 'You can use {% data variables.product.prodname_discussions %} in an organization as a place for your organization to have conversations that aren''t specific to a single repository within your organization.' permissions: 'Organization owners can enable {% data variables.product.prodname_discussions %} for their organization.' versions: feature: discussions diff --git a/translations/pt-BR/content/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization.md b/translations/pt-BR/content/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization.md index c06c37a2a8..b4333ec865 100644 --- a/translations/pt-BR/content/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization.md +++ b/translations/pt-BR/content/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization.md @@ -1,25 +1,25 @@ --- title: Gerenciando a política de aprovação do commit para sua organização -intro: 'You can require users to automatically sign off all commits they make in {% data variables.product.product_name %}''s web interface to repositories owned by your organization.' +intro: 'Você pode exigir que os usuários assinem automaticamente todos os commits que criarem na interface web do {% data variables.product.product_name %} em repositórios pertencentes à sua organização.' versions: feature: commit-signoffs permissions: Organization owners can require all commits to repositories owned by the organization be signed off by the commit author. topics: - Organizations -shortTitle: Manage the commit signoff policy +shortTitle: Gerenciar a política de aprovação de commit --- -## About commit signoffs +## Sobre as autorizações de commit -To affirm that a commit complies with the rules and licensing governing a repository, many organizations require developers to sign off on every commit. If your organization requires commit signoffs, you can make signing off a seamless part of the commit process by enabling compulsory commit signoffs for users committing through {% data variables.product.product_name %}'s web interface. After you enable compulsory commit signoffs for an organization, every commit made to repositories in that organization through {% data variables.product.product_name %}'s web interface will automatically be signed off on by the commit author. +Para afirmar que um commit está de acordo com as regras e licenciamento de um repositório, muitas organizações exigem que os desenvolvedores assinem em todos os commits. Se sua organização requer assinaturas do commit, você pode tornar a assinatura de uma parte ininterrupta do processo de commit, permitindo a aprovação obrigatória de commits para os usuários que fizerem commit da interface web de {% data variables.product.product_name %}. Após habilitar as assinaturas de commit obrigatórias para uma organização, cada commit criado nos repositórios dessa organização por meio da interface web de {% data variables.product.product_name %} será automaticamente assinado pelo autor do commit. -People with admin access to a repository can also enable compulsory commit signoffs at the repository level. For more information, see "[Managing the commit signoff policy for your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository)." +Pessoas com acesso de administrador a um repositório também podem habilitar assinaturas de commit obrigatórias no nível de repositório. Para obter mais informações, consulte "[Gerenciando a política de assinatura de commit para o seu repositório](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository)". {% data reusables.repositories.commit-signoffs %} -## Managing compulsory commit signoffs for your organization +## Gerenciando as assinaturas de commit obrigatórias para sua organização {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.repository-defaults %} -1. Select or deselect **Require contributors to sign off on web-based commits**. ![Screenshot of Require contributors to sign off on web-based commits](/assets/images/help/organizations/require-signoffs.png) +1. Selecione ou desmarque **Exigir que os colaboradores assinem em commits baseados na web**. ![Captura de tela dos contribuidores obrigatórios para assinar commits baseados na web](/assets/images/help/organizations/require-signoffs.png) diff --git a/translations/pt-BR/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md b/translations/pt-BR/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md index ee1fff8a1f..00c39b7439 100644 --- a/translations/pt-BR/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md +++ b/translations/pt-BR/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md @@ -92,9 +92,10 @@ Você só pode escolher uma permissão adicional se já não estiver incluída n - **Definir limites de interação**: Restrinja temporariamente certos usuários de comentários, problemas de abertura ou criação de pull requests no seu repositório público para aplicar um período de atividade limitada. Para obter mais informações, consulte "[Restringir interações no seu repositório](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)". {%- endif %} - **Defina a visualização social**: Adicione uma imagem de identificação ao repositório que aparece nas plataformas de mídia social quando seu repositório é vinculado. Para obter mais informações, consulte "[Personalizar a exibição das redes sociais do repositório](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview)". -- **Faça push commits para branches protegidos**: Faça push para um branch que é marcado como um branch protegido. +- **Faça push commits para branches protegidos**: Faça push para um branch que é marcado como um branch protegido. As regras de protecção dos branches continuarão sendo aplicadas e poderão resultar na rejeição de um "push". - **Crie etiquetas protegidas**: Crie etiquetas que correspondam a uma regra de proteção de tags. Para obter mais informações, consulte "[Configurando regras de proteção de tagsde](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules)". -- **Excluir tags protegidas**: Excluir tags que correspondam a uma regra de proteção de tags. Para obter mais informações, consulte "[Configurando regras de proteção de tagsde](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules)". +- **Excluir tags protegidas**: Excluir tags que correspondam a uma regra de proteção de tags. Para obter mais informações, consulte "[Configurando regras de proteção de tags](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules)".{% ifversion bypass-branch-protections %} +- **Proteções de branch de bypass**: Enviar por push para um ramo protegido sem ter de cumprir as regras de proteção de branch.{% endif %} ### Segurança diff --git a/translations/pt-BR/content/packages/index.md b/translations/pt-BR/content/packages/index.md index d18a8e456e..44f13ee989 100644 --- a/translations/pt-BR/content/packages/index.md +++ b/translations/pt-BR/content/packages/index.md @@ -18,6 +18,7 @@ featuredLinks: guideCards: - '{% ifversion docker-ghcr-enterprise-migration %}/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry{% endif %}' - '{% ifversion fpt or ghec or ghes > 3.4 %}/packages/working-with-a-github-packages-registry/working-with-the-container-registry{% else %}/packages/working-with-a-github-packages-registry/working-with-the-docker-registry{% endif %}' + - '{% ifversion packages-npm-v2 %}/packages/working-with-a-github-packages-registry/working-with-the-npm-registry{% endif %}' - /packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry changelog: label: packages diff --git a/translations/pt-BR/content/packages/learn-github-packages/about-permissions-for-github-packages.md b/translations/pt-BR/content/packages/learn-github-packages/about-permissions-for-github-packages.md index dfdb7479e2..f999a3d477 100644 --- a/translations/pt-BR/content/packages/learn-github-packages/about-permissions-for-github-packages.md +++ b/translations/pt-BR/content/packages/learn-github-packages/about-permissions-for-github-packages.md @@ -18,20 +18,22 @@ As permissões para pacotes são do escopo do repositório ou do escopo de usuá Um pacote com escopo de repositório herda as permissões e visibilidade do repositório que possui o pacote. Você pode encontrar um escopo de pacote para um repositório, acessando a página principal do repositório e clicando no link **Pacotes** à direita da página. {% ifversion fpt or ghec %}Para obter mais informações, consulte "[Conectar um repositório a um pacote](/packages/learn-github-packages/connecting-a-repository-to-a-package)."{% endif %} -Os {% data variables.product.prodname_registry %} registros abaixo usam permissões com escopo do repositório: +Os registros de {% data variables.product.prodname_registry %} abaixo de **apenas** usam permissões com escopo do repositório: {% ifversion not fpt or ghec %}- Docker registry (`docker.pkg.github.com`){% endif %} - - Registro de npm + {% ifversion packages-npm-v2 %}{% else %}- npm registry{% endif %} - Registro do Rubygems - Registro do Apache Maven - Registro do NuGet +{% ifversion packages-npm-v2 %}Para {% data variables.product.prodname_ghcr_and_npm_registry %}, você pode optar por permitir que os pacotes tenham o escopo definido para um usuário, uma organização ou vinculados a um repositório.{% endif %} + {% ifversion fpt or ghec %} ## Permissões granulares para pacotes com escopo de usuário/organização Pacotes com permissões granulares são escopos para uma conta de usuário pessoal ou de organização. Você pode alterar o controle de acesso e a visibilidade do pacote separadamente de um repositório que está conectado (ou vinculado) a um pacote. -Atualmente, apenas o {% data variables.product.prodname_container_registry %} oferece permissões granulares para os seus pacotes de imagem de contêiner. +Atualmente, o {% data variables.product.prodname_ghcr_and_npm_registry %} oferece permissões granulares para seus pacotes de imagens de contêiner. ## Visibilidade e permissões de acesso para imagens de contêiner diff --git a/translations/pt-BR/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md b/translations/pt-BR/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md index 0050aa82d7..b8da0d51e5 100644 --- a/translations/pt-BR/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md +++ b/translations/pt-BR/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md @@ -16,7 +16,7 @@ shortTitle: Controle de acesso & visibilidade Pacotes com permissões granulares são escopos para uma conta de usuário pessoal ou de organização. Você pode alterar o controle de acesso e a visibilidade de um pacote separadamente do repositório ao qual ele está conectado (ou vinculado). -Atualmente, você só pode usar permissões granulares com o {% data variables.product.prodname_container_registry %}. Granular permissions are not supported in our other package registries, such as the npm registry.{% ifversion docker-ghcr-enterprise-migration %} For more information about migration to the {% data variables.product.prodname_container_registry %}, see "[Migrating to the {% data variables.product.prodname_container_registry %} from the Docker registry](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)."{% endif %} +Atualmente, você só pode usar permissões granulares com o {% data variables.product.prodname_ghcr_and_npm_registry %}. As oermissões granulares não são compatíveis com os nossos registros de pacotes, como o registro do RubyGems.{% ifversion docker-ghcr-enterprise-migration %} Para mais informações sobre a migração para o {% data variables.product.prodname_container_registry %}, consulte "[Migrando para o {% data variables.product.prodname_container_registry %} do registro Docker](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry).{% endif %} Para obter mais informações sobre permissões para pacotes com escopo de repositório, escopos relacionados aos pacotes para PATs, ou gerenciar permissões para seus fluxos de trabalho de ações, consulte "[Sobre permissões para os Pacotes GitHub](/packages/learn-github-packages/about-permissions-for-github-packages)". @@ -95,7 +95,7 @@ Para personalizar ainda mais o acesso à sua imagem de contêiner, consulte "[Co {% ifversion fpt or ghec %} ## Assegurando acesso de {% data variables.product.prodname_codespaces %} ao seu pacote -Por padrão, um codespace pode acessar perfeitamente certos pacotes no Registro Contêiner de{% data variables.product.prodname_dotcom %} como, por exemplo, aqueles publicados no mesmo repositório com a opção **herdar acesso** selecionada. Para obter mais informações sobre o qual o acesso é automaticamente configurado, consulte "[Acessando imagens armazenadas no registro de contêiner de {% data variables.product.prodname_dotcom %}](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-images-stored-in-github-container-registry)". +Por padrão, um codespac pode acessar perfeitamente certos pacotes em {% data variables.product.prodname_ghcr_and_npm_registry %}, como aqueles publicados no mesmo repositório com a opção **Herdar acesso** selecionada. Para obter mais informações sobre as quais o acesso é configurado automaticamente, consulte "[Permitindo que o seu codespace acesse um registro de imagens privadas](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-images-stored-in-container-registry-and-npm-registry)". Caso contrário, para garantir que um código tenha acesso ao seu pacote, você deverá conceder acesso ao repositório onde o codespace está sendo iniciado. diff --git a/translations/pt-BR/content/packages/learn-github-packages/deleting-and-restoring-a-package.md b/translations/pt-BR/content/packages/learn-github-packages/deleting-and-restoring-a-package.md index 80123fc3a0..02ae35eeec 100644 --- a/translations/pt-BR/content/packages/learn-github-packages/deleting-and-restoring-a-package.md +++ b/translations/pt-BR/content/packages/learn-github-packages/deleting-and-restoring-a-package.md @@ -23,12 +23,12 @@ Em {% data variables.product.prodname_dotcom %} se você tiver o acesso necessá - um pacote privado inteiro - um pacote público inteiro, se não houver mais de 5000 downloads de qualquer versão do pacote - uma versão específica de um pacote privado -- uma versão específica de um pacote público, se a versão do pacote não tiver mais de 5000 downloads +- uma versão específica de um pacote público, se a versão do pacote não tiver mais de 5,000 downloads {% note %} **Observação:** -- Você não pode excluir um pacote público se uma versão do pacote tiver mais de 5000 downloads. Neste caso, entre em contato com o [suporte do GitHub](https://support.github.com/contact?tags=docs-packages) para obter mais assistência. +- Você não pode excluir um pacote público se uma versão do pacote tiver mais de 5,000 downloads. Neste caso, entre em contato com o [suporte do GitHub](https://support.github.com/contact?tags=docs-packages) para obter mais assistência. - Ao excluir pacotes públicos, esteja ciente de que você pode quebrar projetos que dependem do seu pacote. {% endnote %} @@ -46,7 +46,7 @@ Você pode usar a API REST para gerenciar seus pacotes. Para obter mais informa {% endif %} -Para pacotes que herdam suas permissões e acesso dos repositórios, você pode usar o GraphQL para excluir uma versão específica de pacotes.{% ifversion fpt or ghec %} A API do GraphQL de {% data variables.product.prodname_registry %} não é compatível com contêineres ou imagens Docker que usam o namespace `https://ghcr. o/OWNER/PACKAGE-NAME`.{% endif %} Para obter mais informações sobre o suporte do GraphQL, consulte "[Excluindo uma versão de um pacote com escopo de repositório com o GraphQL](#deleting-a-version-of-a-repository-scoped-package-with-graphql)". +Para pacotes que herdam suas permissões e acesso dos repositórios, você pode usar o GraphQL para excluir uma versão específica de pacotes.{% data reusables.package_registry.no-graphql-to-delete-packages %} Para obter mais informações sobre o suporte do GraphQL, consulte "[Excluindo uma versão de um pacote com escopo de repositório com GraphQL](#deleting-a-version-of-a-repository-scoped-package-with-graphql)". {% endif %} @@ -54,17 +54,19 @@ Para pacotes que herdam suas permissões e acesso dos repositórios, você pode Para pacotes que herdam as permissões de acesso dos repositórios, é possível excluir um pacote se você tiver permissões de administrador para o repositório. -Os pacotes com escopo de repositório em {% data variables.product.prodname_registry %} incluem estes pacotes: -- npm -- RubyGems -- maven -- Gradle -- NuGet -{% ifversion not fpt or ghec %}- Imagens do Docker em `docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`{% endif %} +Os registros de {% data variables.product.prodname_registry %} abaixo de **apenas** usam permissões com escopo do repositório: + + {% ifversion not fpt or ghec %}- Imagens do Docker em `docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`{% endif %} + {% ifversion packages-npm-v2 %}{% else %}- npm{% endif %} + - Registro do Rubygems + - Registro do Apache Maven + - Registro do NuGet + +{% ifversion packages-npm-v2 %}Para {% data variables.product.prodname_ghcr_and_npm_registry %}, você pode optar por permitir que os pacotes tenham o escopo definido para um usuário, uma organização ou vinculados a um repositório.{% endif %} {% ifversion fpt or ghec %} -Para excluir um pacote que tem permissões granulares separadas de um repositório, como imagens de contêiner armazenadas em `https://ghcr.io/OWNER/PACKAGE-NAME`, você deverá ter acesso de administrador ao pacote. Para obter mais informações, consulte "[Sobre permissões para {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)". +Para excluir um pacote que tem permissões granulares separadas de um repositório, como imagens de contêiner armazenadas em `https://ghcr. o/OWNER/PACKAGE-NAME` ou `https://npm.pkg.github.com/OWNER/PACKAGE-NAME`, você deve ter acesso de administrador ao pacote. Para obter mais informações, consulte "[Sobre permissões para {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)". {% endif %} @@ -86,11 +88,9 @@ Para excluir uma versão de um pacote com escopo do repositório, você deve ter Para pacotes que herdam suas permissões e acesso dos repositórios, você pode usar o GraphQL para excluir uma versão específica de pacotes. -{% ifversion fpt or ghec %} -Para contêineres ou imagens do Docker em `ghcr.io`, o GraphQL não é compatível, mas você pode usar a API REST. Para obter mais informações, consulte o "[API de {% data variables.product.prodname_registry %}](/rest/reference/packages)". -{% endif %} +{% data reusables.package_registry.no-graphql-to-delete-packages %}{% ifversion fpt or ghec %} Você pode usar a API REST. Para obter mais informações, consulte a "[API de {% data variables.product.prodname_registry %}](/rest/reference/packages)."{% endif %} -Use a mutação `deletePackageVersion` na API do GraphQL. Você deve usar um token com os escopos `read:packages`, `delete:packages` e `repo`. For more information about tokens, see "[About {% data variables.product.prodname_registry %}](/packages/publishing-and-managing-packages/about-github-packages#about-tokens)." +Use a mutação `deletePackageVersion` na API do GraphQL. Você deve usar um token com os escopos `read:packages`, `delete:packages` e `repo`. Para obter mais informações sobre tokens, consulte "[Sobre {% data variables.product.prodname_registry %}](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)." O exemplo a seguir demonstra como excluir uma versão do pacote, usando um `packageVersionId` de `MDIyOlJlZ2lzdHJ5UGFja2FnZVZlcnNpb243MTExNg`. diff --git a/translations/pt-BR/content/packages/learn-github-packages/introduction-to-github-packages.md b/translations/pt-BR/content/packages/learn-github-packages/introduction-to-github-packages.md index fc5090006e..5450ffcff9 100644 --- a/translations/pt-BR/content/packages/learn-github-packages/introduction-to-github-packages.md +++ b/translations/pt-BR/content/packages/learn-github-packages/introduction-to-github-packages.md @@ -51,7 +51,7 @@ For more information about the configuration of {% data variables.product.prodna | | | |--------------------|--------------------| -| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_container_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

    For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | +| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_ghcr_and_npm_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

    For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | | Visibility | {% data reusables.package_registry.public-or-private-packages %} | For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." @@ -101,7 +101,9 @@ For more information about Docker and the {% data variables.product.prodname_con ## Managing packages {% ifversion fpt or ghec %} -You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." +You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." + +{% data reusables.package_registry.no-graphql-to-delete-packages %} {% endif %} {% ifversion ghes %} @@ -112,7 +114,9 @@ You can delete a private or public package in the {% data variables.product.prod You can delete a version of a package in the {% data variables.product.product_name %} user interface or using the GraphQL API. {% endif %} -When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and "[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." +When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. + +For more information, see {% ifversion ghes or ghae %}"[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and {% endif %}"[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "[`package` webhook event](/webhooks/event-payloads/#package)." diff --git a/translations/pt-BR/content/packages/learn-github-packages/viewing-packages.md b/translations/pt-BR/content/packages/learn-github-packages/viewing-packages.md index 845f2eb3f8..ef4a284eca 100644 --- a/translations/pt-BR/content/packages/learn-github-packages/viewing-packages.md +++ b/translations/pt-BR/content/packages/learn-github-packages/viewing-packages.md @@ -23,15 +23,15 @@ versions: A sua capacidade de visualizar um pacote depende de vários fatores. Por padrão, você pode visualizar todos os pacotes que você publicou. -Pacotes com escopo de repositórios herdam suas permissões e visibilidade do repositório que possui o pacote. Os registros abaixo usam este tipo de permissões:{% ifversion not fpt or ghec %} +Pacotes com escopo de repositórios herdam suas permissões e visibilidade do repositório que possui o pacote. Os registros abaixo **apenas** usam este tipo de permissões:{% ifversion not fpt or ghec %} - Registro Docker (`docker.pkg.github.com`){% endif %} -- Registro de npm +{% ifversion packages-npm-v2 %}{% else %}- npm registry{% endif %} - Registro do Rubygems - Registro do Apache Maven - Registro do NuGet {% ifversion fpt or ghec %} -O registro do contêiner oferece a opção de permissões e configurações de visibilidade granulares que podem ser personalizadas para cada pacote de propriedade de um usuário pessoal ou de uma conta de organização. Você pode optar por usar permissões granulares ou conectar o pacote a um repositório e herdar suas permissões. Para obter mais informações, consulte "[Conectar um repositório a um pacote](/packages/learn-github-packages/connecting-a-repository-to-a-package)". +O {% data variables.product.prodname_ghcr_and_npm_registry %} oferece a opção de permissões e configurações de visibilidade granulares que podem ser personalizadas para cada pacote de propriedade de uma conta pessoal ou da conta de uma organização. Você pode optar por usar permissões granulares ou conectar o pacote a um repositório e herdar suas permissões. Para obter mais informações, consulte "[Conectar um repositório a um pacote](/packages/learn-github-packages/connecting-a-repository-to-a-package)". {% endif %} Para obter mais informações consulte "[Sobre permissões para o GitHub Packages](/packages/learn-github-packages/about-permissions-for-github-packages){% ifversion fpt or ghec %}" e[Configurando controle de acesso e visibilidade de um pacote](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility){% endif %}." diff --git a/translations/pt-BR/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md b/translations/pt-BR/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md index f5ee768345..7f62a92fb0 100644 --- a/translations/pt-BR/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md +++ b/translations/pt-BR/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md @@ -24,9 +24,9 @@ shortTitle: Publicar & instalar com ações Você pode estender os recursos de CI e CD do seu repositório publicando ou instalando pacotes como parte do seu fluxo de trabalho. {% ifversion fpt or ghec %} -### Efetuar a autenticação no {% data variables.product.prodname_container_registry %} +### Efetuar a autenticação no {% data variables.product.prodname_ghcr_and_npm_registry %} -{% data reusables.package_registry.authenticate_with_pat_for_container_registry %} +{% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} {% endif %} @@ -40,7 +40,7 @@ Você pode fazer referência ao `GITHUB_TOKEN` no seu arquivo de fluxo de trabal {% note %} -**Observação:** Os pacotes que possuem repositórios incluem RubyGems, npm, Apache Maven, NuGet, {% ifversion fpt or ghec %}e Gradle. {% else %}Os pacotes do Gradle e Docker que usam o pacote namespace `docker.pkg.github.com`.{% endif %} +**Observação:** Alguns registros, como RubyGems, {% ifversion packages-npm-v2 %}{% else %}npm, {% endif %}Apache Maven, NuGet, {% ifversion fpt or ghec %}e Gradle{% else %}Gradle e pacotes Docker que usam o namespace `docker.pkg.github.com`{% endif %}, só permitem pacotes propriedade de repositório. Com {% data variables.product.prodname_ghcr_and_npm_registry_full %} você pode optar por permitir que os pacotes sejam propriedade de um usuário, organização ou vinculados a um repositório. {% endnote %} @@ -49,11 +49,11 @@ Quando você habilita o GitHub Actions, o GitHub instala um aplicativo GitHub no {% data variables.product.prodname_registry %} permite que você faça push e pull de pacotes por meio do `GITHUB_TOKEN` disponível para um fluxo de trabalho de {% data variables.product.prodname_actions %}. {% ifversion fpt or ghec %} -## Sobre permissões e acesso de pacote para {% data variables.product.prodname_container_registry %} +## Sobre permissões e acesso de pacote para {% data variables.product.prodname_ghcr_and_npm_registry %} -O {% data variables.product.prodname_container_registry %} (`ghcr.io`) permite aos usuários criar e administrar contêineres como recursos independentes no nível da organização. Os contêineres podem pertencer a uma conta pessoal ou organização e você pode personalizar o acesso a cada um dos seus contêineres separadamente das permissões de repositório. +O {% data variables.product.prodname_ghcr_and_npm_registry_full %} permite aos usuários criar e administrar pacotes como recursos independentes no nível da organização. Os pacotes podem pertencer a uma conta organizacional ou pessoal e você pode personalizar o acesso a cada um dos seus pacotes separadamente das permissões de repositório. -Todos os workflows que acessam o {% data variables.product.prodname_container_registry %} devem usar o `GITHUB_TOKEN` em vez de um token de acesso pessoal. Para obter mais informações sobre as melhores práticas de segurança, consulte "[Enrijecimento de segurança para o GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)". +Todos os workflows que acessam o {% data variables.product.prodname_ghcr_and_npm_registry %} devem usar o `GITHUB_TOKEN` em vez de um token de acesso pessoal. Para obter mais informações sobre as melhores práticas de segurança, consulte "[Enrijecimento de segurança para o GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)". ## Configurações padrão de permissões e acesso para contêineres modificados por meio de fluxos de trabalho @@ -484,9 +484,9 @@ A instalação de pacotes hospedados pelo {% data variables.product.prodname_reg {% data reusables.package_registry.actions-configuration %} {% ifversion fpt or ghec %} -## Atualizando um fluxo de trabalho que acessa `ghcr.io` +## Atualizando um fluxo de trabalho que acessa um registro usando um PAT -O {% data variables.product.prodname_container_registry %} é compatível com `GITHUB_TOKEN` para autenticação fácil e segura nos seus fluxos de trabalho. Se seu fluxo de trabalho estiver usando um token de acesso pessoal (PAT) para efetuar a autenticação com `ghcr.io`, é altamente recomendável atualizar o seu fluxo de trabalho para usar o `GITHUB_TOKEN`. +O {% data variables.product.prodname_ghcr_and_npm_registry %} é compatível com `GITHUB_TOKEN` para autenticação fácil e segura nos seus fluxos de trabalho. Se seu fluxo de trabalho estiver usando um token de acesso pessoal (PAT) para efetuar a autenticação no registro, é altamente recomendável atualizar o seu fluxo de trabalho para usar o `GITHUB_TOKEN`. Para obter mais informações sobre o `GITHUB_TOKEN`, consulte "[Autenticação em um fluxo de trabalho](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)". @@ -501,9 +501,9 @@ O uso do `GITHUB_TOKEN` em vez de um PAT, que inclui o escopo do `repositório` {% endnote %} 1. Opcionalmente, usando o menu suspenso "função", selecione o nível de acesso padrão que você gostaria que o repositório tivesse na imagem do seu contêiner. ![Níveis de acesso permitidos para repositórios](/assets/images/help/package-registry/repository-permission-options-for-package-access-through-actions.png) -1. Abra o arquivo do seu fluxo de trabalho. Na linha em que você efetua o login em `ghcr.io`, substitua seu PAT por {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. +1. Abra o arquivo do seu fluxo de trabalho. Na linha em que você fez login no registro, substitua o seu PAT por {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. -Por exemplo, este fluxo de trabalho publica um imagem do Docker usando {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} para efetuar a autenticação. +Por exemplo, este fluxo de trabalho publica uma imagem Docker para {% data variables.product.prodname_container_registry %} e usa {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} para efetuar a autenticação. ```yaml{:copy} name: Demo Push diff --git a/translations/pt-BR/content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md index 44177e2e46..e8cb93cd54 100644 --- a/translations/pt-BR/content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md +++ b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md @@ -1,6 +1,6 @@ --- title: Fazendo a migração para o Registro do Contêiner a partir do Registro Docker -intro: '{% ifversion docker-ghcr-enterprise-migration %}An enterprise owner can{% else %}{% data variables.product.company_short %} will{% endif %} migrate Docker images previously stored in the Docker registry on {% data variables.product.product_location %} to the {% data variables.product.prodname_container_registry %}.' +intro: '{% ifversion docker-ghcr-enterprise-migration %}O proprietário de uma empresa pode{% else %}{% data variables.product.company_short %} irá{% endif %} migrar imagens do Docker previamente armazenadas no registro do Docker em {% data variables.product.product_location %} para o {% data variables.product.prodname_container_registry %}.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /packages/getting-started-with-github-container-registry/migrating-to-github-container-registry-for-docker-images @@ -25,26 +25,26 @@ topics: ## Sobre a migração do registro do Docker -{% data reusables.package_registry.container-registry-replaces-docker-registry %} If you've stored Docker images in the Docker registry, {% ifversion docker-ghcr-enterprise-migration %}an enterprise owner{% else %}{% data variables.product.company_short %}{% endif %} will gradually migrate the images to the {% data variables.product.prodname_container_registry %}. No action is required on your part. +{% data reusables.package_registry.container-registry-replaces-docker-registry %} Se você armazenou imagens do Docker no registro do Docker, {% ifversion docker-ghcr-enterprise-migration %} o proprietário de uma empresa{% else %}{% data variables.product.company_short %}{% endif %} irá transferir gradualmente as imagens para o {% data variables.product.prodname_container_registry %}. Nenhuma ação é necessária de sua parte. {% ifversion docker-ghcr-enterprise-migration %} {% note %} -**Note**: {% data reusables.package_registry.container-registry-ghes-migration-availability %} For more information about finding the version of {% data variables.product.product_name %} that you use, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs#github-enterprise-server)." +**Observação**: {% data reusables.package_registry.container-registry-ghes-migration-availability %} Para mais informações sobre como encontrar a versão de {% data variables.product.product_name %} que você usa, consulte "[Sobre as versões de {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs#github-enterprise-server)". {% endnote %} {% endif %} -After a Docker image has been migrated to the {% data variables.product.prodname_container_registry %}, you'll see the following changes to the details for the package. +Depois que a imagem de um Docker foi transferida para {% data variables.product.prodname_container_registry %}, você verá as seguintes alterações nos detalhes do pacote. -- The icon will be the {% data variables.product.prodname_container_registry %} logo instead of the Docker logo. -- The domain in the pull URL will be {% data variables.product.prodname_container_registry_namespace %} instead of {% data variables.product.prodname_docker_registry_namespace %}. +- O ícone será o logotipo de {% data variables.product.prodname_container_registry %} ao invés do logo do Docker. +- O domínio na URL do pull será {% data variables.product.prodname_container_registry_namespace %} em vez de {% data variables.product.prodname_docker_registry_namespace %}. {% ifversion fpt or ghec %} -![Screenshot of a Docker image migrated to the {% data variables.product.prodname_container_registry %}](/assets/images/help/package-registry/container-registry-details-page.png) +![Captura de tela de uma imagem do Docker transferida para {% data variables.product.prodname_container_registry %}](/assets/images/help/package-registry/container-registry-details-page.png) {% endif %} @@ -52,11 +52,11 @@ After a Docker image has been migrated to the {% data variables.product.prodname {% ifversion fpt or ghec %} -After migration, you'll no longer be able to use the GraphQL API to query for packages with a `PackageType` of "DOCKER". Instead, you can use the REST API to query for packages with a `package_type` of "container". For more information, see "[Packages](/rest/reference/packages)" in the REST API documentation. +Após a migração, você não poderá mais usar o API do GraphQL para consultar pacotes com um `tipo de pacote` do "DOCKER". Em vez disso, você pode usar a API REST para consultar pacotes com um `package_type` de "contêiner". Para obter mais informações, consulte "[Pacotes](/rest/reference/packages)" na documentação da API REST. ## Sobre a cobrança do {% data variables.product.prodname_container_registry %} -For more information about billing for the {% data variables.product.prodname_container_registry %}, see "[About billing for {% data variables.product.prodname_registry %}](/billing/managing-billing-for-github-packages/about-billing-for-github-packages)." +Para obter mais informações sobre a cobrança para o {% data variables.product.prodname_container_registry %}, consulte "[Sobre a cobrança para {% data variables.product.prodname_registry %}](/billing/managing-billing-for-github-packages/about-billing-for-github-packages). {% endif %} @@ -64,6 +64,6 @@ For more information about billing for the {% data variables.product.prodname_co ## Leia mais -- "[Migrating your enterprise to the {% data variables.product.prodname_container_registry %} from the Docker registry](/admin/packages/migrating-your-enterprise-to-the-container-registry-from-the-docker-registry)" +- "[Fazendo a migração da sua empresa para {% data variables.product.prodname_container_registry %} do registro Docker](/admin/packages/migrating-your-enterprise-to-the-container-registry-from-the-docker-registry)" {% endif %} diff --git a/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md index 3e8c702bbd..d9cf56e750 100644 --- a/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md +++ b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md @@ -27,7 +27,7 @@ shortTitle: Container registry {% ifversion ghes > 3.4 %} -To use the {% data variables.product.prodname_container_registry %} on {% data variables.product.product_name %}, your site administrator must first configure {% data variables.product.prodname_registry %} for your instance **and** enable subdomain isolation. Para obter mais informações, consulte "[Primeiros passos com o GitHub Packages para sua empresa](/admin/packages/getting-started-with-github-packages-for-your-enterprise)" e "[Habilitando o isolamento do subdomínio](/admin/configuration/configuring-network-settings/enabling-subdomain-isolation)". +Para usar o {% data variables.product.prodname_container_registry %} em {% data variables.product.product_name %}, o administrador do site deve primeiro configurar {% data variables.product.prodname_registry %} para sua instância **e** habilitar o isolamento do subdomínio. Para obter mais informações, consulte "[Primeiros passos com o GitHub Packages para sua empresa](/admin/packages/getting-started-with-github-packages-for-your-enterprise)" e "[Habilitando o isolamento do subdomínio](/admin/configuration/configuring-network-settings/enabling-subdomain-isolation)". {% endif %} @@ -42,7 +42,9 @@ Ao instalar ou publicar uma imagem Docker, a {% data variables.product.prodname_ ## Efetuar a autenticação no {% data variables.product.prodname_container_registry %} -{% data reusables.package_registry.authenticate_with_pat_for_container_registry %} +{% ifversion fpt or ghec or ghes > 3.4 %} +Para efetuar a autenticação no {% data variables.product.prodname_container_registry %} (`ghcr.io`) dentro de um fluxo de trabalho de {% data variables.product.prodname_actions %}, use o `GITHUB_TOKEN` para uma melhor segurança e experiência. {% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} +{% endif %} {% ifversion ghes %}Certifique-se de substituir o `HOSTNAME` pelo nome do host {% data variables.product.product_location_enterprise %} ou endereço IP nos exemplos abaixo.{% endif %} diff --git a/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md index 6714384e4d..8007cd2b6f 100644 --- a/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md +++ b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -21,6 +21,8 @@ shortTitle: npm registry {% data reusables.package_registry.admins-can-configure-package-types %} +{% ifversion packages-npm-v2 %} +{% else %} ## Limits for published npm versions If you publish over 1,000 npm package versions to {% data variables.product.prodname_registry %}, you may see performance issues and timeouts occur during usage. @@ -28,12 +30,17 @@ If you publish over 1,000 npm package versions to {% data variables.product.prod In the future, to improve performance of the service, you won't be able to publish more than 1,000 versions of a package on {% data variables.product.prodname_dotcom %}. Any versions published before hitting this limit will still be readable. If you reach this limit, consider deleting package versions or contact Support for help. When this limit is enforced, our documentation will be updated with a way to work around this limit. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" or "[Contacting Support](/packages/learn-github-packages/about-github-packages#contacting-support)." +{% endif %} ## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} -{% data reusables.package_registry.authenticate-packages-github-token %} +{% ifversion packages-npm-v2 %} +{% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} + +You can also choose to give access permissions to packages independently for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_actions %}. For more information, see "[Ensuring Codespaces access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-codespaces-access-to-your-package) and [Ensuring workflow access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package)." +{% endif %} ### Authenticating with a personal access token @@ -94,12 +101,24 @@ $ npm login --scope=@OWNER --registry=https://HOSTNAME/_regist {% endnote %} -By default, {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the name field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. You can add a summary for the package listing page by including a *README.md* file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. +{% ifversion packages-npm-v2 %} +The {% data variables.product.prodname_registry %} registry stores npm packages within your organization or personal account, and allows you to associate a package with a repository. You can choose whether to inherit permissions from a repository, or set granular permissions independently of a repository. +{% endif %} + +By default, {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the name field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. If you're running [npm v8.5.3](https://github.com/npm/cli/releases/tag/v8.5.3) or later, you can add a summary for the package listing page by including a *README.md* file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. You can publish multiple packages to the same {% data variables.product.prodname_dotcom %} repository by including a `URL` field in the *package.json* file. For more information, see "[Publishing multiple packages to the same repository](#publishing-multiple-packages-to-the-same-repository)." +{% ifversion fpt or ghec %} +When a package is published, it isn't automatically linked to a repository. You can however choose to link your published package to a repository using the user interface or command line. For more information, see "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)." +{% endif %} + You can set up the scope mapping for your project using either a local *.npmrc* file in the project or using the `publishConfig` option in the *package.json*. {% data variables.product.prodname_registry %} only supports scoped npm packages. Scoped packages have names with the format of `@owner/name`. Scoped packages always begin with an `@` symbol. You may need to update the name in your *package.json* to use the scoped name. For example, `"name": "@codertocat/hello-world-npm"`. +{% ifversion packages-npm-v2 %} +When you first publish a package, the default visibility is private. When a package is linked to repository, the package visibility is dependent on the repository's visibility. To change the visibility or set access permissions, see "[Configuring a package's access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." +{% endif %} + {% data reusables.package_registry.viewing-packages %} ### Publishing a package using a local *.npmrc* file diff --git a/translations/pt-BR/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/translations/pt-BR/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index 60b42b34a3..74f7f172d5 100644 --- a/translations/pt-BR/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/translations/pt-BR/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -40,13 +40,13 @@ O comando `dig`, que pode ser usado para verificar a configuração correta dos ## Configurando um subdomínio -To set up a `www` or custom subdomain, such as `www.example.com` or `blog.example.com`, you must add your domain in the repository settings. Em seguida, configure um registro CNAME com seu provedor DNS. +Para configurar um `www` ou um subdomínio personalizado como, por exemplo, `www.example.com` ou `blog.example.com`, você deve adicionar seu domínio nas configurações do repositório. Em seguida, configure um registro CNAME com seu provedor DNS. {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -4. Em "Domínio personalizado,", digite o seu domínio personalizado e clique em **Salvar**. If you are publishing your site from a branch, this will create a commit that adds a `CNAME` file to the root of your source branch. If you are publishing your site with a custom {% data variables.product.prodname_actions %} workflow , no `CNAME` file is created. For more information about your publishing source, see "[Configuring a publishing source for your GitHub Pages site](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." ![Botão Salvar domínio personalizado](/assets/images/help/pages/save-custom-subdomain.png) -5. Navegue até o provedor DNS e crie um registro `CNAME` que aponte seu subdomínio para o domínio padrão do seu site. Por exemplo, se você quiser usar o subdomínio `www.example.com` para seu site de usuário, crie um registro `CNAME` que aponte `www.example.com` para `.github.io`. Se você desejar usar o subdomínio `www.anotherexample.com` no seu site da organização, crie um registro `CNAME` que aponte `www. notherexample.com` para `.github.io`. O registro `CNAME` sempre deve apontar para `.github.io` ou `.github.io`, excluindo o nome do repositório. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} +4. Em "Domínio personalizado,", digite o seu domínio personalizado e clique em **Salvar**. Se você estiver publicando seu site a partir de um branch, isso irá criar um commit que adiciona um arquivo `CNAME` à raiz do seu branch de origem. Se você publicar o seu site com um fluxo de trabalho de {% data variables.product.prodname_actions %} personalizado, não será criado nenhum arquivo `CNAME`. Para obter mais informações sobre a fonte de publicação, consulte "[Configurando uma fonte de publicação para o site do GitHub Pages](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)". ![Botão Salvar domínio personalizado](/assets/images/help/pages/save-custom-subdomain.png) +5. Navegue até o provedor DNS e crie um registro `CNAME` que aponte seu subdomínio para o domínio padrão do seu site. Por exemplo, se você quiser usar o subdomínio `www.example.com` para seu site de usuário, crie um registro `CNAME` que aponte `www.example.com` para `.github.io`. If you want to use the subdomain `another.example.com` for your organization site, create a `CNAME` record that points `another.example.com` to `.github.io`. O registro `CNAME` sempre deve apontar para `.github.io` ou `.github.io`, excluindo o nome do repositório. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} {% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %} {% data reusables.command_line.open_the_multi_os_terminal %} @@ -63,14 +63,14 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl ## Configurando um domínio apex -To set up an apex domain, such as `example.com`, you must configure a custom domain in your repository settings and at least one `ALIAS`, `ANAME`, or `A` record with your DNS provider. +Para configurar um domínio apex, como o `example.com`, você deve configurar um domínio personalizado nas configurações do repositório e pelo menos um `ALIAS`, `ANAME` ou registro `A` com o seu provedor DNS. {% data reusables.pages.www-and-apex-domain-recommendation %} Para obter mais informações, consulte "[Configurar um subdomínio](#configuring-a-subdomain)". {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -4. Em "Domínio personalizado,", digite o seu domínio personalizado e clique em **Salvar**. If you are publishing your site from a branch, this will create a commit that adds a `CNAME` file to the root of your source branch. If you are publishing your site with a custom {% data variables.product.prodname_actions %} workflow , no `CNAME` file is created. For more information about your publishing source, see "[Configuring a publishing source for your GitHub Pages site](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." ![Botão Salvar domínio personalizado](/assets/images/help/pages/save-custom-apex-domain.png) +4. Em "Domínio personalizado,", digite o seu domínio personalizado e clique em **Salvar**. Se você estiver publicando seu site a partir de um branch, isso irá criar um commit que adiciona um arquivo `CNAME` à raiz do seu branch de origem. Se você publicar o seu site com um fluxo de trabalho de {% data variables.product.prodname_actions %} personalizado, não será criado nenhum arquivo `CNAME`. Para obter mais informações sobre a fonte de publicação, consulte "[Configurando uma fonte de publicação para o site do GitHub Pages](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)". ![Botão Salvar domínio personalizado](/assets/images/help/pages/save-custom-apex-domain.png) 5. Navegue até o provedor DNS e crie um registro `ALIAS`, `ANAME` ou `A`. Você também pode criar registros de `AAAA` para suporte ao IPv6. {% data reusables.pages.contact-dns-provider %} - Para criar um registro `ALIAS` ou `ANAME`, aponte o domínio apex para o domínio padrão do seu site. {% data reusables.pages.default-domain-information %} - Para criar registros `A`, aponte seu domínio apex para os endereços IP para {% data variables.product.prodname_pages %}. diff --git a/translations/pt-BR/content/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages.md b/translations/pt-BR/content/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages.md index f0b17a4def..4e7dbc2af1 100644 --- a/translations/pt-BR/content/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages.md +++ b/translations/pt-BR/content/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages.md @@ -18,9 +18,9 @@ shortTitle: Solucione o problema de um domínio personalizado ## Erros _CNAME_ -{% ifversion pages-custom-workflow %}If you are publishing from a custom {% data variables.product.prodname_actions %} workflow, any _CNAME_ file is ignored and is not required.{% endif %} +{% ifversion pages-custom-workflow %}Se você publicando a partir de um fluxo de trabalho de {% data variables.product.prodname_actions %} personalizado, qualquer arquivo _CNAME_ será ignorado e não não será obrigatório.{% endif %} -If you are publishing from a branch, custom domains are stored in a _CNAME_ file in the root of your publishing source. que pode ser adicionado ou atualizado manualmente ou por meio das configurações do repositório. Para obter mais informações, consulte "[Gerenciar um domínio personalizado para seu site do {% data variables.product.prodname_pages %}](/articles/managing-a-custom-domain-for-your-github-pages-site)". +Se você estiver publicando a partir de um branch, os domínios personalizados serão armazenados em um arquivo _CNAME_ na raiz da fonte de publicação. que pode ser adicionado ou atualizado manualmente ou por meio das configurações do repositório. Para obter mais informações, consulte "[Gerenciar um domínio personalizado para seu site do {% data variables.product.prodname_pages %}](/articles/managing-a-custom-domain-for-your-github-pages-site)". Para que o site seja renderizado no domínio correto, verifique se o arquivo _CNAME_ ainda existe no repositório. Por exemplo, muitos geradores de site estáticos fazem push forçado para o repositório, o que pode substituir o arquivo _CNAME_ que foi adicionado ao repositório quando você configurou o domínio personalizado. Se você criar o site localmente e fizer push dos arquivos gerados para o {% data variables.product.product_name %}, primeiro insira o commit que adicionou o arquivo _CNAME_ ao repositório local, para que o arquivo seja incluído na criação. diff --git a/translations/pt-BR/content/pages/getting-started-with-github-pages/about-github-pages.md b/translations/pt-BR/content/pages/getting-started-with-github-pages/about-github-pages.md index 74e75dee5d..ec3d264fe7 100644 --- a/translations/pt-BR/content/pages/getting-started-with-github-pages/about-github-pages.md +++ b/translations/pt-BR/content/pages/getting-started-with-github-pages/about-github-pages.md @@ -1,6 +1,6 @@ --- title: Sobre o GitHub Pages -intro: 'Você pode usar {% data variables.product.prodname_pages %} para hospedar um site sobre você, sua organização, ou seu projeto diretamente a partir de um repositório em {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}.' +intro: 'Você pode usar {% data variables.product.prodname_pages %} para hospedar um site sobre você, sua organização, ou seu projeto diretamente a partir de um repositório no {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}.' redirect_from: - /articles/what-are-github-pages - /articles/what-is-github-pages @@ -75,7 +75,7 @@ Para obter mais informações, consulte "[Habilitar isolamento de subdomínio](/ {% data reusables.pages.pages-about-publishing-source %} -For more information, see "[Configuring a publishing source for your GitHub Pages site](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." +Para obter mais informações, consulte "[Configurando uma fonte de publicação para o site do GitHub Pages](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)". {% ifversion ghec %} ## Limitações para {% data variables.product.prodname_emus %} @@ -93,9 +93,9 @@ O {% data variables.product.prodname_pages %} publica qualquer arquivo estático {% ifversion pages-custom-workflow %} -If you use a custom build process or a static site generator other than Jekyll, you can write a {% data variables.product.prodname_actions %} to build and publish your site. {% data variables.product.product_name %} provides starter workflows for several static site generators. For more information, see "[Configuring a publishing source for your GitHub Pages site](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." +Se você usar um processo de compilação personalizado ou um gerador de site estático diferente do Jekyll, você poderá escrever um {% data variables.product.prodname_actions %} para criar e publicar seu site. O {% data variables.product.product_name %} fornece fluxos de trabalho iniciais para vários geradores de site estáticos. Para obter mais informações, consulte "[Configurando uma fonte de publicação para o site do GitHub Pages](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)". -If you publish your site from a source branch, {% data variables.product.prodname_pages %} will use Jekyll to build your site by default. If you want to use a static site generator other than Jekyll, we recommend that you write a {% data variables.product.prodname_actions %} to build and publish your site instead. Otherwise, disable the Jekyll build process by creating an empty file called `.nojekyll` in the root of your publishing source, then follow your static site generator's instructions to build your site locally. +Se você publicar seu site a partir de um branch fonte, o {% data variables.product.prodname_pages %} usará o Jekyll para criar seu site por padrão. Se quiser usar um gerador de site estático diferente do Jekyll, recomendamos que você escreva um {% data variables.product.prodname_actions %} para criar e publicar seu site. Caso contrário, desabilite o processo de compilação do Jekyll criando um arquivo vazio denominado `.nojekyll` na raiz da fonte de publicação e, em seguida, siga as instruções do gerador de site estático para criar seu site localmente. {% else %} @@ -125,8 +125,8 @@ Os sites do {% data variables.product.prodname_pages %} estão sujeitos ao segui - Os sites do {% data variables.product.prodname_pages %} publicados não podem ter mais de 1 GB. {% ifversion fpt or ghec %} - Sites de {% data variables.product.prodname_pages %} têm um limite de banda larga *flexível* de 100 GB por mês. - - {% data variables.product.prodname_pages %} sites have a *soft* limit of 10 builds per hour.{% ifversion pages-custom-workflow %} This limit does not apply if you build and publish your site with a custom {% data variables.product.prodname_actions %} workflow {% endif %} - - In order to provide consistent quality of service for all {% data variables.product.prodname_pages %} sites, rate limits may apply. These rate limits are not intended to interfere with legitimate uses of {% data variables.product.prodname_pages %}. If your request triggers rate limiting, you will receive an appropriate response with an HTTP status code of `429`, along with an informative HTML body. + - Os sites de {% data variables.product.prodname_pages %} têm um limite de *soft* de 10 compilações por hora.{% ifversion pages-custom-workflow %} Esse limite não se aplica se você criar e publicar seu site com um fluxo de trabalho personalizado de {% data variables.product.prodname_actions %} {% endif %} + - Para fornecer uma qualidade consistente de serviço para todos os sites de {% data variables.product.prodname_pages %}, é possível que se apliquem limites de taxa. Esses limites de taxa não são destinados a interferir nos usos legítimos de {% data variables.product.prodname_pages %}. Se o seu pedido acionar limites de taxa, você receberá uma resposta apropriada com um código de status HTTP de `429`, junto com um texto HTML informativo. Se o seu site exceder essas cotas de uso, talvez não possamos atender a ele ou você receba um e-mail formal do {% data variables.contact.contact_support %} sugerindo estratégias para reduzir o impacto do site em nossos servidores, como colocar uma rede de distribuição de conteúdo (CDN, Content Distribution Network) de terceiros na frente do site, usar outros recursos do {% data variables.product.prodname_dotcom %}, como versões, ou migrar para outro serviço de hospedagem que possa atender melhor às suas necessidades. diff --git a/translations/pt-BR/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md b/translations/pt-BR/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md deleted file mode 100644 index d2bc904d06..0000000000 --- a/translations/pt-BR/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Adicionar um tema ao site do GitHub Pages com o seletor de temas -intro: 'É possível adicionar um tema ao site do {% data variables.product.prodname_pages %} para personalizar a aparência dele.' -redirect_from: - - /articles/creating-a-github-pages-site-with-the-jekyll-theme-chooser - - /articles/adding-a-jekyll-theme-to-your-github-pages-site-with-the-jekyll-theme-chooser - - /articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser - - /github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser -product: '{% data reusables.gated-features.pages %}' -versions: - fpt: '*' - ghec: '*' -topics: - - Pages -shortTitle: Adicionar tema a um site de Páginas -permissions: 'People with admin permissions for a repository can use the theme chooser to add a theme to a {% data variables.product.prodname_pages %} site.' ---- - -## Sobre o seletor de temas - -{% ifversion pages-custom-workflow %} - -{% note %} - -**Note**: The Jekyll theme chooser is not supported for {% data variables.product.prodname_pages %} sites that are published with a custom {% data variables.product.prodname_actions %} workflow. If you build your site with Jekyll and publish your site with a custom {% data variables.product.prodname_actions %} workflow, you can add a theme by editing the `_config.yml` file. For more information, see "[Adding a theme to your GitHub Pages site using Jekyll](/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll)." - -{% endnote %} - -{% endif %} - -O seletor de temas adiciona um tema do Jekyll ao repositório. Para obter mais informações sobre o Jekyll, consulte "[Sobre o {% data variables.product.prodname_pages %} e o Jekyll](/articles/about-github-pages-and-jekyll)". - -O funcionamento do seletor de temas depende de o repositório ser público ou privado. - - Se o {% data variables.product.prodname_pages %} já estiver habilitado para o repositório, o seletor de temas adicionará o tema à fonte de publicação atual. - - Se o repositório for público e o {% data variables.product.prodname_pages %} estiver desabilitado para ele, o uso do seletor de temas habilitará o {% data variables.product.prodname_pages %} e definirá o branch-padrão como fonte de publicação. - - Se o repositório for privado e o {% data variables.product.prodname_pages %} estiver desabilitado para ele, será preciso habilitar o {% data variables.product.prodname_pages %} definindo uma fonte de publicação para poder usar o seletor de temas. - -Para obter mais informações sobre fontes de publicação, consulte "[Sobre o {% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)". - -Caso você tenha adicionado manualmente um tema do Jekyll ao repositório no passado, esses arquivos poderão ser aplicados mesmo depois que você usar o seletor de temas. Para evitar conflitos, remova todas as pastas e arquivos de temas adicionados manualmente antes de usar o seletor de temas. Para obter mais informações, consulte "[Adicionar um tema ao site do {% data variables.product.prodname_pages %} usando o Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)". - -## Adicionar um tema com o seletor de temas - -{% data reusables.pages.navigate-site-repo %} -{% data reusables.repositories.sidebar-settings %} -{% data reusables.pages.sidebar-pages %} -3. No "{% data variables.product.prodname_pages %}", clique em **Escolher um tema** ou **Alterar tema**. ![Botão Choose a theme (Escolher um tema)](/assets/images/help/pages/choose-a-theme.png) -4. No topo da página, clique no tema desejado e depois em **Selecionar tema**. ![Opções de tema e botão Select theme (Selecionar tema)](/assets/images/help/pages/select-theme.png) -5. Talvez seja necessário editar o arquivo *README.md* do site. - - Para editá-lo mais tarde, clique em **Cancelar**. ![Link Cancel (Cancelar) ao editar um arquivo](/assets/images/help/pages/cancel-edit.png) - - Para editar o arquivo agora, consulte "[Editando os arquivos](/repositories/working-with-files/managing-files/editing-files)". - -O tema escolhido será aplicado automaticamente aos arquivos markdown no repositório. Para aplicar o tema a arquivos HTML no repositório, é preciso adicionar a página inicial YAML que especifica um layout para cada arquivo. Para obter mais informações, consulte "[Página inicial](https://jekyllrb.com/docs/front-matter/)" no site do Jekyll. - -## Leia mais - -- [Temas](https://jekyllrb.com/docs/themes/) no site do Jekyll diff --git a/translations/pt-BR/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md b/translations/pt-BR/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md index 5543fb7bdd..47ad696404 100644 --- a/translations/pt-BR/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md +++ b/translations/pt-BR/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md @@ -1,6 +1,6 @@ --- title: Configurar uma fonte de publicação para o site do GitHub Pages -intro: '{% ifversion pages-custom-workflow %}You can configure your {% data variables.product.prodname_pages %} site to publish when changes are pushed to a specific branch, or you can write a {% data variables.product.prodname_actions %} workflow to publish your site.{% else%}If you use the default publishing source for your {% data variables.product.prodname_pages %} site, your site will publish automatically. You can also choose to publish your site from a different branch or folder.{% endif %}' +intro: '{% ifversion pages-custom-workflow %}Você pode configurar seu site de {% data variables.product.prodname_pages %} para publicar quando as alterações são enviadas para um branch específico ou você pode escrever um fluxo de trabalho de {% data variables.product.prodname_actions %} para publicar seu site.{% else%}Se você usar a fonte de publicação padrão do seu site de {% data variables.product.prodname_pages %}, seu site será publicado automaticamente. Você também pode optar por publicar o seu site a partir de um branch ou uma pasta diferente.{% endif %}' redirect_from: - /articles/configuring-a-publishing-source-for-github-pages - /articles/configuring-a-publishing-source-for-your-github-pages-site @@ -17,21 +17,21 @@ topics: shortTitle: Configurar fonte de publicação --- -## About publishing sources +## Sobre as fontes de publicação {% data reusables.pages.pages-about-publishing-source %} {% data reusables.pages.private_pages_are_public_warning %} -## Publishing from a branch +## Publicando a partir de um branch -1. Make sure the branch you want to use as your publishing source already exists in your repository. +1. Certifique-se de que o branch que você deseja usar como fonte de publicação já existe no repositório. {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} {% ifversion pages-custom-workflow %} -1. Under "Build and deployment", under "Source", select **Deploy from a branch**. -1. Under "Build and deployment", under "Branch", use the **None** or **Branch** drop-down menu and select a publishing source. +1. Em "Compilação e implantação", em "Fonte", selecione **Implantar a partir de um branch**. +1. Em "Compilação e implantação", em "Branch", use o menu suspenso **Nenhum** ou **Branch** e selecione uma fonte de publicação. ![Menu suspenso para selecionar uma fonte de publicação](/assets/images/help/pages/publishing-source-drop-down.png) {% else %} @@ -40,7 +40,7 @@ shortTitle: Configurar fonte de publicação 4. Opcionalmente, use o menu suspenso para selecionar uma pasta para sua fonte de publicação. ![Menu suspenso para selecionar uma pasta para a fonte de publicação](/assets/images/help/pages/publishing-source-folder-drop-down.png) 5. Clique em **Salvar**. ![Botão para salvar alterações nas configurações da fonte de publicação](/assets/images/help/pages/publishing-source-save.png) -### Troubleshooting publishing from a branch +### Solucionar problemas de publicação a partir de um branch {% data reusables.pages.admin-must-push %} @@ -56,42 +56,42 @@ Para encontrar possíveis erros com a compilação ou implantação, você pode {% ifversion pages-custom-workflow %} -## Publishing with a custom {% data variables.product.prodname_actions %} workflow +## Publicação com um fluxo de trabalho de {% data variables.product.prodname_actions %} personalizado {% data reusables.pages.pages-custom-workflow-beta %} -To configure your site to publish with {% data variables.product.prodname_actions %}: +Para configurar seu site para publicar com {% data variables.product.prodname_actions %}: {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -1. Under "Build and deployment", under "Source", select **GitHub Actions**. -1. {% data variables.product.product_name %} will suggest several starter workflows. If you already have a workflow to publish your site, you can skip this step. Otherwise, choose one of the options to create a {% data variables.product.prodname_actions %} workflow. For more information about creating your custom workflow, see "[Creating a custom {% data variables.product.prodname_actions %} workflow to publish your site](#creating-a-custom-github-actions-workflow-to-publish-your-site)." +1. Em "Compilação e implantação", em "Fonte", selecione **GitHub Actions**. +1. {% data variables.product.product_name %} irá sugerir vários fluxos de trabalho iniciais. Se você já tem um fluxo de trabalho para publicar o site, você pode pular esta etapa. Caso contrário, escolha uma das opções para criar um fluxo de trabalho de {% data variables.product.prodname_actions %}. Para obter mais informações sobre a criação de seu fluxo de trabalho personalizado, consulte "[Criando um fluxo de trabalho de {% data variables.product.prodname_actions %} personalizado para publicar seu site](#creating-a-custom-github-actions-workflow-to-publish-your-site)". - {% data variables.product.prodname_pages %} does not associate a specific workflow to the {% data variables.product.prodname_pages %} settings. However, the {% data variables.product.prodname_pages %} settings will link to the workflow run that most recently deployed your site. + {% data variables.product.prodname_pages %} não associa um fluxo de trabalho específico às configurações de {% data variables.product.prodname_pages %}. No entanto, as configurações do {% data variables.product.prodname_pages %} serão ligadas à execução do fluxo de trabalho que o seu site implantou mais recentemente. -### Creating a custom {% data variables.product.prodname_actions %} workflow to publish your site +### Criar um fluxo de trabalhode {% data variables.product.prodname_actions %} personalizado para publicar seu site -For more information about {% data variables.product.prodname_actions %}, see "[Actions](/actions)." +Para obter mais informações sobre {% data variables.product.prodname_actions %}, consulte "[Actions](/actions)." -When you configure your site to publish with {% data variables.product.prodname_actions %}, {% data variables.product.product_name %} will suggest starter workflows for common publishing scenarios. The general flow of a workflow is to: +Ao configurar seu site para publicar com {% data variables.product.prodname_actions %}, {% data variables.product.product_name %} irá sugerir fluxos de trabalho iniciantes para cenários de publicação comuns. O fluxo de trabalho geral é: -1. Trigger whenever there is a push to the default branch of the repository or whenever a pull request that targets the default branch is opened, reopened, or updated. -1. Use the [`actions/checkout`](https://github.com/actions/checkout) action to check out the repository contents. -1. If required by your site, build any static site files. -1. Use the [`actions/upload-pages-artifact`](https://github.com/actions/upload-pages-artifact) action to upload the static files as an artifact. -1. If the workflow was triggered by a push to the default branch, use the [`actions/deploy-pages`](https://github.com/actions/deploy-pages) action to deploy the artifact. This step is skipped if the workflow was triggered by a pull request. +1. Acionar sempre que houver um push para o branch padrão do repositório ou sempre que um pull request que apontar para o branch padrão for aberto, reaberto ou atualizado. +1. Use a ação [`ações/checkout`](https://github.com/actions/checkout) para conferir o conteúdo do repositório. +1. Se o seu site exigir, crie qualquer arquivo de site estático. +1. Use a ação [`actions/upload-pages-artifact`](https://github.com/actions/upload-pages-artifact) para fazer upload dos arquivos estáticos como um artefato. +1. Se o fluxo de trabalho foi acionado por um push para o branch padrão, use a ação [`actions/deploy-pages`](https://github.com/actions/deploy-pages) para implantar o artefato. Esta etapa é ignorada se o fluxo de trabalho foi acionado por um pull request. -The starter workflows use a deployment environment called `github-pages`. If your repository does not already include an environment called `github-pages`, the environment will be created automatically. We recommend that you add an environment protection rule so that only the default branch can deploy to this environment. Para obter mais informações, consulte "[Usando ambientes para implantação](/actions/deployment/targeting-different-environments/using-environments-for-deployment)". +Os fluxos de trabalho iniciais usam um ambiente de implantação denominado `github-pages`. Se seu repositório ainda não incluir um ambiente denominado `github-pages`, o ambiente será criado automaticamente. Recomendamos que você adicione uma regra de proteção de ambiente para que apenas o branch padrão possa fazer a implantação nesse ambiente. Para obter mais informações, consulte "[Usando ambientes para implantação](/actions/deployment/targeting-different-environments/using-environments-for-deployment)". {% note %} -**Note**: A `CNAME` file in your repository file does not automatically add or remove a custom domain. Instead, you must configure the custom domain through your repository settings or through the API. For more information, see "[Managing a custom domain for your GitHub Pages site](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain)" and the [Pages API reference documentation](/rest/pages#update-information-about-a-github-pages-site). +**Observação**: Um arquivo `CNAME` no seu arquivo de repositório não adiciona ou remove automaticamente um domínio personalizado. Em vez disso, você deve configurar o domínio personalizado por meio das configurações do repositório ou da API. Para obter mais informações, consulte "[Gerenciando um domínio personalizado para o seu site do GitHub Pages](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain) e [a documentação de referência da API do Pages](/rest/pages#update-information-about-a-github-pages-site). {% endnote %} -### Troubleshooting publishing with a custom {% data variables.product.prodname_actions %} workflow +### Solucionar problemas de publicação com um fluxo de trabalho personalizado de {% data variables.product.prodname_actions %} -For information about how to troubleshoot your {% data variables.product.prodname_actions %} workflow, see "[About monitoring and troubleshooting](/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting)." +Para obter informações sobre como solucionar seu fluxo de trabalho de {% data variables.product.prodname_actions %}, consulte "[Sobre o monitoramento e solução de problemas](/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting)." {% endif %} diff --git a/translations/pt-BR/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md b/translations/pt-BR/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md index 60a15642ae..53a77c58fb 100644 --- a/translations/pt-BR/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md +++ b/translations/pt-BR/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md @@ -41,11 +41,11 @@ shortTitle: Criar um site do GitHub Pages {% data reusables.pages.navigate-site-repo %} {% data reusables.pages.decide-publishing-source %} -1. Create the entry file for your site. {% data variables.product.prodname_pages %} will look for an `index.html`, `index.md`, or `README.md` file as the entry file for your site. +1. Criar o arquivo de entrada para o seu site. {% data variables.product.prodname_pages %} procurará um arquivo `index.html`, `index.md` ou `LEIAME.md` como arquivo de postagem do seu site. - {% ifversion pages-custom-workflow %}If your publishing source is a branch and folder, the entry file must be at the top level of the source folder on the source branch. For example, if your publishing source is the `/docs` folder on the `main` branch, your entry file must be located in the `/docs` folder on a branch called `main`. + {% ifversion pages-custom-workflow %}Se sua fonte de publicação for um branch e uma psata, o arquivo de entrada deverá estar no nível superior da pasta de origem no branch de origem. Por exemplo, se a fonte de publicação for a pasta `/docs` no branch principal`, o arquivo de postagem deverá estar localizado na pasta /docs` em um branch denominado `principal`. - If your publishing source is a {% data variables.product.prodname_actions %} workflow, the artifact that you deploy must include the entry file at the top level of the artifact. Instead of adding the entry file to your repository, you may choose to have your {% data variables.product.prodname_actions %} workflow generate your entry file when the workflow runs.{% else %} The entry file must be at the top level of your chosen publishing source. For example, if your publishing source is the `/docs` folder on the `main` branch, your entry file must be located in the `/docs` folder on a branch called `main`.{% endif %} + Se sua fonte de publicação for um fluxo de trabalho de {% data variables.product.prodname_actions %}, o artefato de que você implantar deverá incluir o arquivo de entrada no nível superior do artefato. Em vez de adicionar o arquivo de entrada ao seu repositório, você pode optar por fazer com que o seu fluxo de trabalho {% data variables.product.prodname_actions %} gere o arquivo de entrada quando o fluxo de trabalho é executado.{% else %} O arquivo de entrada deve estar no nível superior da fonte de publicação escolhida. Por exemplo, se a fonte de publicação for a pasta `/docs` no branch principal`, o arquivo de postagem deverá estar localizado na pasta /docs` em um branch denominado `principal`.{% endif %} {% data reusables.pages.configure-publishing-source %} {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} @@ -59,9 +59,9 @@ shortTitle: Criar um site do GitHub Pages Você pode adicionar mais páginas ao seu site criando novos arquivos. Cada arquivo ficará disponível no site na mesma estrutura de diretórios que a fonte de publicação. Por exemplo, se a fonte de publicação do site de projeto for o branch `gh-pages` e você criar um arquivo chamado `/about/contact-us.md` no branch `gh-pages`, o arquivo novo ficará disponível em {% ifversion fpt or ghec %}`https://.github.io//{% else %}`http(s):///pages///{% endif %}about/contact-us.html`. -Também é possível adicionar um tema para personalizar a aparência do site. Para obter mais informações, consulte {% ifversion fpt or ghec %}"[Adicionar um tema ao site do {% data variables.product.prodname_pages %} com o seletor de temas](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser){% else %}"[Adicionar um tema ao site do {% data variables.product.prodname_pages %} usando o Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll){% endif %}". +Também é possível adicionar um tema para personalizar a aparência do site. Para obter mais informações, consulte "[Adicionar um tema ao site do {% data variables.product.prodname_pages %} usando o Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)". -Para personalizar seu site ainda mais, você pode usar o Jekyll, um gerador de site estático com suporte integrado para o {% data variables.product.prodname_pages %}. Para obter mais informações, consulte "[Sobre o {% data variables.product.prodname_pages %} e o JJekyll](/articles/about-github-pages-and-jekyll)". +Para personalizar seu site ainda mais, você pode usar o Jekyll, um gerador de site estático com suporte integrado para o {% data variables.product.prodname_pages %}. Para obter mais informações, consulte "[Sobre {% data variables.product.prodname_pages %} e o Jekyll](/articles/about-github-pages-and-jekyll)". ## Leia mais diff --git a/translations/pt-BR/content/pages/getting-started-with-github-pages/index.md b/translations/pt-BR/content/pages/getting-started-with-github-pages/index.md index 896b85fba0..c69758ab94 100644 --- a/translations/pt-BR/content/pages/getting-started-with-github-pages/index.md +++ b/translations/pt-BR/content/pages/getting-started-with-github-pages/index.md @@ -17,7 +17,6 @@ topics: children: - /about-github-pages - /creating-a-github-pages-site - - /adding-a-theme-to-your-github-pages-site-with-the-theme-chooser - /configuring-a-publishing-source-for-your-github-pages-site - /changing-the-visibility-of-your-github-pages-site - /creating-a-custom-404-page-for-your-github-pages-site diff --git a/translations/pt-BR/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md b/translations/pt-BR/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md index 1c38e0b8bc..90e51b5c4b 100644 --- a/translations/pt-BR/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md +++ b/translations/pt-BR/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md @@ -22,13 +22,13 @@ shortTitle: Cancelar a publicação do site de páginas {% ifversion pages-custom-workflow %} -When you unpublish your site, the site will no longer be available. Any existing repository settings or content will not be affected. +Quando você cancelar a publicação de seu site, o site não estará mais disponível. Todas as configurações de repositório ou o conteúdo não serão afetados. {% data reusables.repositories.navigate-to-repo %} -1. Under **{% data variables.product.prodname_pages %}**, next to the **Your site is live at** message, click {% octicon "kebab-horizontal" aria-label="the horizontal kebab icon" %}. -1. In the menu that appears, select **Unpublish site**. +1. Em **{% data variables.product.prodname_pages %}**, ao lado da mensagem **seu site está ativo em**, clique em {% octicon "kebab-horizontal" aria-label="the horizontal kebab icon" %}. +1. No menu que será exibido, selecione **Cancelar a publicação do site**. - ![Drop down menu to unpublish site](/assets/images/help/pages/unpublish-site.png) + ![Menu suspenso para cancelar a publicação do site](/assets/images/help/pages/unpublish-site.png) {% else %} diff --git a/translations/pt-BR/content/pages/index.md b/translations/pt-BR/content/pages/index.md index 65f9aa86bc..72ab270913 100644 --- a/translations/pt-BR/content/pages/index.md +++ b/translations/pt-BR/content/pages/index.md @@ -12,7 +12,6 @@ featuredLinks: - '{% ifversion fpt or ghec %}/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site{% endif %}' - '{% ifversion ghes or ghae %}/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll{% endif %}' - '{% ifversion ghec %}/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site{% endif %}' - - '{% ifversion fpt %}/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser{% endif %}' - '{% ifversion ghes or ghae %}/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll{% endif %}' popular: - '{% ifversion fpt or ghec %}/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages{% endif %}' diff --git a/translations/pt-BR/content/pages/quickstart.md b/translations/pt-BR/content/pages/quickstart.md index 5c5330e1b3..c2c223e7e2 100644 --- a/translations/pt-BR/content/pages/quickstart.md +++ b/translations/pt-BR/content/pages/quickstart.md @@ -26,11 +26,12 @@ Este guia irá orientar você com relação à criação de um site em `username 1. Digite `username.github.io` como nome do repositório. Substitua `nome de usuário` pelo seu nome de usuário de {% data variables.product.prodname_dotcom %}. Por exemplo, se seu nome de usuário for `octocat`, o nome do repositório deverá ser `octocat.github.io`. ![Campo nome do repositório](/assets/images/help/pages/create-repository-name-pages.png) {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -1. Clique **Escolher um tema**. ![Botão Choose a theme (Escolher um tema)](/assets/images/help/pages/choose-theme.png) -2. O seletor de temas será aberto. Pesquise os temas disponíveis e, em seguida, clique em **Selecionar tema** para selecionar um tema. É fácil mudar seu tema mais tarde. Portanto, se você não tiver certeza, basta escolher um por enquanto. ![Opções de tema e botão Select theme (Selecionar tema)](/assets/images/help/pages/select-theme.png) -3. Depois de selecionar um tema, o arquivo `README.md` do repositório será aberto no editor do arquivo. O arquivo `README.md` é onde você escreverá o conteúdo do seu site. Você pode editar o arquivo ou manter o conteúdo padrão por enquanto. -4. Ao terminar de editar o arquivo, clique em **Aplicar as alterações**. -5. Acesse `username.github.io` para ver seu novo site. **Observação:** podem ser necessários até 20 minutos para que as alterações no site sejam publicadas após o push delas no {% data variables.product.product_name %}. +1. Em "Compilação e implantação", em "Fonte", selecione **Implantar a partir de um branch**. +1. Em "Compilação e implantação", em "Branch", use o menu suspenso **Nenhum** ou **Branch** e selecione uma fonte de publicação. + + ![Menu suspenso para selecionar uma fonte de publicação](/assets/images/help/pages/publishing-source-drop-down.png) +1. Opcionalmente, abra o arquivo `README.md` do seu repositório. O arquivo `README.md` é onde você escreverá o conteúdo do seu site. Você pode editar o arquivo ou manter o conteúdo padrão por enquanto. +1. Acesse `username.github.io` para ver seu novo site. **Observação:** podem ser necessários até 10 minutos para que as alterações no site sejam publicadas após o push delas no {% data variables.product.product_name %}. ## Alterando o título e a descrição diff --git a/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md b/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md index 940d459ec2..69d3c52e4c 100644 --- a/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md +++ b/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md @@ -75,9 +75,9 @@ Você pode adicionar `site.github` a uma publicação ou página para incluir me {% data reusables.pages.add-jekyll-theme %} Para obter mais informações, consulte "[Temas](https://jekyllrb.com/docs/themes/)" na documentação do Jekyll. {% ifversion fpt or ghec %} -É possível adicionar um tema compatível ao seu site no {% data variables.product.prodname_dotcom %}. Para obter mais informações, consulte "[Temas compatíveis](https://pages.github.com/themes/)" no site do {% data variables.product.prodname_pages %} e "[Adicionar um tema ao seu site do {% data variables.product.prodname_pages %} com o seletor de temas](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser)". +É possível adicionar um tema compatível ao seu site no {% data variables.product.prodname_dotcom %}. Para obter mais informações, consulte "[temas compatíveis](https://pages.github.com/themes/)" no site de {% data variables.product.prodname_pages %} e [Adicionando um tema ao seu site de {% data variables.product.prodname_pages %} usando o Jekyll"](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll). -Para usar qualquer tema de código aberto do Jekyll hospedado em {% data variables.product.prodname_dotcom %}, você pode adicionar o tema manualmente.{% else %} Você pode adicionar um tema ao seu site manualmente.{% endif %} Para obter mais informações, consulte {% ifversion fpt or ghec %} [temas hospedados em {% data variables.product.prodname_dotcom %}](https://github.com/topics/jekyll-theme) e{% else %} "[Temas compatíveisthemes](https://pages.github.com/themes/)" no site de {% data variables.product.prodname_pages %} e {% endif %} "[Adicionar um tema ao seu site do {% data variables.product.prodname_pages %} usando o Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)." +Para usar qualquer tema de código aberto do Jekyll hospedado em {% data variables.product.prodname_dotcom %}, você pode adicionar o tema manualmente.{% else %} Você pode adicionar um tema ao seu site manualmente.{% endif %} Para obter mais informações, consulte {% ifversion fpt or ghec %} [temas hospedados em {% data variables.product.prodname_dotcom %}](https://github.com/topics/jekyll-theme) e{% else %} "[Temas compatíveis](https://pages.github.com/themes/)" no site de {% data variables.product.prodname_pages %} e {% endif %} "[Adicionar um tema ao seu site do {% data variables.product.prodname_pages %} usando o Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)." Você pode substituir qualquer um dos padrões do seu tema editando os arquivos do tema. Para obter mais informações, consulte a documentação do seu tema e "[Substituir padrões do tema](https://jekyllrb.com/docs/themes/#overriding-theme-defaults)" na documentação do Jekyll. diff --git a/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md b/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md index 4773fd2e26..e3427823f8 100644 --- a/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md +++ b/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md @@ -19,14 +19,14 @@ shortTitle: Erros de criação do Jekyll para as páginas ## Sobre erros de criação do Jekyll -{% ifversion pages-custom-workflow %}If you are publishing from a branch, sometimes{% else %}Sometimes,{% endif %} {% data variables.product.prodname_pages %} will not attempt to build your site after you push changes to your site's publishing source.{% ifversion fpt or ghec %} +{% ifversion pages-custom-workflow %}Se você estiver publicando em uma branch, às vezes{% else %}às vezes,{% endif %} {% data variables.product.prodname_pages %} não tentará criar seu site depois que você fizer push das alterações na fonte de publicação do seu site.{% ifversion fpt or ghec %} - A pessoa que fez push das alterações não verificou o endereço de e-mail dela. Para obter mais informações, consulte "[Verificar o endereço de e-mail](/articles/verifying-your-email-address)".{% endif %} - Você está fazendo push com uma chave de implantação. Se desejar automatizar pushes para o repositório do seu site, você poderá configurar um usuário de máquina. Para obter mais informações, consulte "[Gerenciar chaves de implantação](/developers/overview/managing-deploy-keys#machine-users)". - Você está usando um serviço de CI que não está configurado para criar sua fonte de publicação. Por exemplo, Travis CI não criará o branch `gh-pages`, a menos que você adicione o branch a uma lista segura. Para obter mais informações, consulte "[Personalizar a criação](https://docs.travis-ci.com/user/customizing-the-build/#safelisting-or-blocklisting-branches)" em Travis CI ou na documentação do seu serviço de CI. {% note %} -**Observação:** podem ser necessários até 20 minutos para que as alterações no site sejam publicadas após o push delas no {% data variables.product.product_name %}. +**Observação:** podem ser necessários até 10 minutos para que as alterações no site sejam publicadas após o push delas no {% data variables.product.product_name %}. {% endnote %} @@ -58,15 +58,15 @@ Por padrão, seu site de {% data variables.product.prodname_pages %} foi criado ## Visualizando mensagens de erro de criação do Jekyll no seu pull request -{% ifversion pages-custom-workflow %}If you are publishing from a branch, when{% else %}When{% endif %} you create a pull request to update your publishing source on {% data variables.product.product_name %}, you can see build error messages on the **Checks** tab of the pull request. Para obter mais informações, consulte "[Sobre verificações de status](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)". +{% ifversion pages-custom-workflow %}Se você estiver publicando a partir de um branch, quando{% else %}Quando{% endif %} você cria um pull request para atualizar a sua fonte de pulicação em {% data variables.product.product_name %}, você pode ver as mensagens de erro de criação na aba **Verificações** do pull request. Para obter mais informações, consulte "[Sobre verificações de status](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)". -{% ifversion pages-custom-workflow %}If you are publishing with a custom {% data variables.product.prodname_actions %} workflow, in order to see build error messages in your pull request, you must configure your workflow to run on the `pull_request` trigger. When you do this, we recommend that you skip any deploy steps if the workflow was triggered by the `pull_request` event. This will allow you to see any build errors without deploying the changes from your pull request to your site. For more information, see "[Events that trigger workflows](/actions/using-workflows/events-that-trigger-workflows#pull_request)" and "[Expressions](/actions/learn-github-actions/expressions)."{% endif %} +{% ifversion pages-custom-workflow %}Se você estiver publicando com um fluxo de trabalho personalizado de {% data variables.product.prodname_actions %}, para ver as mensagens de erro de criação no seu pull request, você deve configurar seu fluxo de trabalho para executar o gatilho `pull_request`. Ao fazer isso, recomendamos que você ignore todas as etapas de implantação se o fluxo de trabalho foi acionado pelo evento `pull_request`. Isso permitirá que você veja todos os erros de criação sem implantar as alterações de seu pull request para seu site. Para obter mais informações, consulte "[Eventos que acionam fluxos de trabalho](/actions/using-workflows/events-that-trigger-workflows#pull_request)" e "[Expressões](/actions/learn-github-actions/expressions)".{% endif %} ## Visualizando os erros de criação do Jekyll por e-mail -{% ifversion pages-custom-workflow %}If you are publishing from a branch, when{% else %}When{% endif %} you push changes to your publishing source on {% data variables.product.product_name %}, {% data variables.product.prodname_pages %} will attempt to build your site. Se a criação falhar, você receberá um e-mail no seu endereço de e-mail principal. {% data reusables.pages.build-failure-email-server %} +{% ifversion pages-custom-workflow %}Se você estiver publicando a partir de um branch, quando{% else %}quando{% endif %} você fizer push de alterações na sua fonte de publicação em {% data variables.product.product_name %}, {% data variables.product.prodname_pages %} tentará criar seu site. Se a criação falhar, você receberá um e-mail no seu endereço de e-mail principal. {% data reusables.pages.build-failure-email-server %} -{% ifversion pages-custom-workflow %}If you are publishing with a custom {% data variables.product.prodname_actions %} workflow, in order to receive emails about build errors in your pull request, you must configure your workflow to run on the `pull_request` trigger. When you do this, we recommend that you skip any deploy steps if the workflow was triggered by the `pull_request` event. This will allow you to see any build errors without deploying the changes from your pull request to your site. For more information, see "[Events that trigger workflows](/actions/using-workflows/events-that-trigger-workflows#pull_request)" and "[Expressions](/actions/learn-github-actions/expressions)."{% endif %} +{% ifversion pages-custom-workflow %}Se você está publicando com um fluxo de trabalho personalizado de {% data variables.product.prodname_actions %}, para receber e-mails sobre erros de criação em sua pull request, você deve configurar seu fluxo de trabalho para executar o gatilho `pull_request`. Ao fazer isso, recomendamos que você ignore todas as etapas de implantação se o fluxo de trabalho foi acionado pelo evento `pull_request`. Isso permitirá que você veja todos os erros de criação sem implantar as alterações de seu pull request para seu site. Para obter mais informações, consulte "[Eventos que acionam fluxos de trabalho](/actions/using-workflows/events-that-trigger-workflows#pull_request)" e "[Expressões](/actions/learn-github-actions/expressions)".{% endif %} ## Visualizando as mensagens de erro do Jekyll no seu pull request com um serviço de CI de terceiros diff --git a/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md b/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md index 774066d6fe..d7c2f82d6a 100644 --- a/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md +++ b/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md @@ -6,6 +6,7 @@ redirect_from: - /articles/adding-a-jekyll-theme-to-your-github-pages-site - /articles/adding-a-theme-to-your-github-pages-site-using-jekyll - /github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-using-jekyll + - /pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser product: '{% data reusables.gated-features.pages %}' versions: fpt: '*' diff --git a/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md b/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md index d29a0d912a..38d5a0d9a9 100644 --- a/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md +++ b/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md @@ -43,12 +43,12 @@ Se o Jekyll encontrar um erro ao criar seu site do {% data variables.product.pro Se você recebeu uma mensagem de erro genérica, verifique os problemas comuns. - Você está usando plugins incompatíveis. Para obter mais informações, consulte "[Sobre o {% data variables.product.prodname_pages %} e o Jekyll](/articles/about-github-pages-and-jekyll#plugins)".{% ifversion fpt or ghec %} - Seu repositório excedeu os limites de tamanho. Para obter mais informações, consulte "[Qual é a minha quota de disco?](/articles/what-is-my-disk-quota)"{% endif %} -- Você alterou a configuração `source` no arquivo *_config.yml*. {% ifversion pages-custom-workflow %}If you publish your site from a branch, {% endif %}{% data variables.product.prodname_pages %} overrides this setting during the build process. -- A filename in your published files contains a colon (`:`) which is not supported. +- Você alterou a configuração `source` no arquivo *_config.yml*. {% ifversion pages-custom-workflow %}Se você publicar seu site a partir de um branch, {% endif %}{% data variables.product.prodname_pages %} irá substituir essa configuração durante o processo de criação. +- Um nome de arquivo em seus arquivos publicados contém dois pontos (`:`) o que não é compatível. Se você recebeu uma mensagem de erro específica, revise abaixo as informações de solução de problemas relativas à mensagem de erro. -{% ifversion pages-custom-workflow %}After you've fixed any errors, trigger another build by pushing the changes to your site's source branch (if you are publishing from a branch) or by triggering your custom {% data variables.product.prodname_actions %} workflow (if you are publishing with {% data variables.product.prodname_actions %}).{% else %}After you've fixed any errors, push the changes to your site's publishing source to trigger another build on {% data variables.product.product_name %}.{% endif %} +{% ifversion pages-custom-workflow %}Depois de corrigir todos os erros, acionar outra compilação, enviando as alterações por push para o branch de origem do seu site de (se você estiver publicando de uma filial) ou acionando o fluxo de trabalho personalizado do {% data variables.product.prodname_actions %} (se você estiver publicando com {% data variables.product.prodname_actions %}).{% else %}Depois de corrigir todos os erros, envie as alterações por push para a fonte de publicação do seu site para acionar outra compilação em {% data variables.product.product_name %}.{% endif %} ## Erro no arquivo de configuração @@ -74,7 +74,7 @@ Este erro significa que o código faz referência a um arquivo que não existe n ## O arquivo é um link simbólico -This error means that your code references a symlinked file that does not exist in the published files for your site. +Este erro significa que o código faz referência a um arquivo com link simbólico que não existe nos arquivos publicados para o seu site. {% data reusables.pages.search-for-includes %} Se algum dos arquivos a que você fez referência for com link simbólico, copie ou mova os arquivos para o diretório *_includes*. @@ -162,9 +162,9 @@ Para solucionar problemas, remova a linha `relative_permalinks` do arquivo *_con ## O link simbólico não existe no repositório do site -This error means that your site includes a symbolic link (symlink) that does not exist in the published files for your site. Para obter mais informações sobre links simbólicos, consulte "[Link simbólico](https://en.wikipedia.org/wiki/Symbolic_link)" na Wikipédia. +Este erro significa que seu site inclui um link simbólico (symlink) que não existe nos arquivos publicados em seu site. Para obter mais informações sobre links simbólicos, consulte "[Link simbólico](https://en.wikipedia.org/wiki/Symbolic_link)" na Wikipédia. -Para solucionar problemas, determine se o arquivo na mensagem de erro é usado para criar o site. Se ele não for ou se você não quiser que o arquivo seja um link simbólico, exclua o arquivo. If the symlinked file is necessary to build your site, make sure the file or directory the symlink references is in the published files for your site. Para incluir ativos externos, considere usar {% ifversion fpt or ghec %}`submódulo do Git` ou {% endif %}um gerenciador de pacotes terceirizado como o [Bower](https://bower.io/).{% ifversion fpt or ghec %} Para obter mais informações, consulte "[Usar submódulos com o {% data variables.product.prodname_pages %}](/articles/using-submodules-with-github-pages)".{% endif %} +Para solucionar problemas, determine se o arquivo na mensagem de erro é usado para criar o site. Se ele não for ou se você não quiser que o arquivo seja um link simbólico, exclua o arquivo. Se o arquivo com o link simbólico for necessário para criar seu site, certifique-se de que o arquivo ou diretório ao qual o link simbólico faz referência esteja nos arquivos publicados no seu site. Para incluir ativos externos, considere usar {% ifversion fpt or ghec %}`submódulo do Git` ou {% endif %}um gerenciador de pacotes terceirizado como o [Bower](https://bower.io/).{% ifversion fpt or ghec %} Para obter mais informações, consulte "[Usar submódulos com o {% data variables.product.prodname_pages %}](/articles/using-submodules-with-github-pages)".{% endif %} ## Erro de sintaxe no loop 'for' diff --git a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md index c758116988..fd13d8791f 100644 --- a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md +++ b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md @@ -16,18 +16,18 @@ topics: - Pull requests --- -## Merge your commits +## Fazer merge dos seus commits {% data reusables.pull_requests.default_merge_option %} -## Squash and merge your commits +## Fazer combinação por squash e merge dos seus commits {% data reusables.pull_requests.squash_and_merge_summary %} ### Mesclar mensagem para uma mesclagem por squash {% ifversion default-merge-squash-commit-message %} -Ao fazer combinação por squash e merge, {% data variables.product.prodname_dotcom %} gera uma mensagem de commit padrão, que você pode editar. Depending on how the repository is configured and the number of commits in the pull request, not including merge commits, this message may include the pull request title, pull request description, or information about the commits. +Ao fazer combinação por squash e merge, {% data variables.product.prodname_dotcom %} gera uma mensagem de commit padrão, que você pode editar. Dependendo de como o repositório é configurado e do número de commits no pull request, não sem incluir os commits do merge, esta mensagem poderá incluir o título do pull request, descrição do pull request ou informações sobre o commits. {% else %} Ao fazer combinação por squash e merge, {% data variables.product.prodname_dotcom %} gera uma mensagem de commit padrão, que você pode editar. A mensagem padrão depende do número de commits no pull request, que não inclui commits de merge. @@ -43,7 +43,7 @@ Ao fazer combinação por squash e merge, {% data variables.product.prodname_dot | Mais de um commit | Título da pull request, seguido do número da pull request | Uma lista das mensagens de commit para todos os commits combinados por squash, por ordem de data | {% ifversion default-merge-squash-commit-message %} -People with maintainer or admin access to a repository can configure their repository's default merge message for all squashed commits to use the pull request title, the pull request title and commit details, or the pull request title and description. For more information, see "[Configure commit squashing](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests)".{% endif %} +As pessoas com acesso de mantenedor ou administrador a um repositório podem configurar a mensagem de merge padrão de seu repositório para todos os commits combinados por squash para usar o título do pull request, os detalhes do título e do commit do pull request ou o título e a descrição do pull request. Para obter mais informações, consulte "[Configurar o commit combinado por squash](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests)".{% endif %} {% ifversion ghes = 3.6 %} As pessoas com acesso de administrador a um repositório podem configurar o repositório para usar o título do pull request como a mensagem de merge padrão para todos os commits combinados por squash. Para obter mais informações, consulte "[Configurar o commit combinado por squash](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests)". @@ -57,7 +57,7 @@ Quando você cria uma pull request, o {% data variables.product.prodname_dotcom Uma vez que esse commit está apenas no branch base e não no branch head, o ancestral comum dos dois branches permanece inalterado. Se você continuar a trabalhar no branch head e, em seguida, criar uma nova pull request entre os dois branches, a pull request incluirá todos os commits desde o ancestral comum, incluindo commits que você combinou por squash e fez merge na pull request anterior. Se não houver conflitos, você pode mesclar esses commits com segurança. No entanto, este fluxo de trabalho torna os conflitos de mesclagem mais prováveis. Se você continuar a combinar por squash e mesclar pull requests para um branch head de longo prazo, você terá que resolver os mesmos conflitos repetidamente. -## Rebase and merge your commits +## Faça rebase e merge dos seus commits {% data reusables.pull_requests.rebase_and_merge_summary %} diff --git a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md index e98cfec19f..574af385fb 100644 --- a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md +++ b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md @@ -24,7 +24,7 @@ Antes de usar o merge automático com um pull request, o merge automático deve Depois que você ativar o merge automático para uma pull request, se alguém que não tiver permissões de gravação no repositório fizer push de novas alterações no branch principal ou alterar o branch de base do pull request, o merge automático será desabilitado. Por exemplo, se um mantenedor permitir o merge automático para um pull request a partir de uma bifurcação, o merge automático será desabilitado depois que um colaborador fizer push de novas alterações no pull request. -You can provide feedback about auto-merge through a [{% data variables.product.prodname_github_community %} discussion](https://github.com/orgs/community/discussions/categories/pull-requests). +Você pode fornecer feedback sobre a o merge automático por meio de uma discussão [{% data variables.product.prodname_github_community %}](https://github.com/orgs/community/discussions/categories/pull-requests). ## Habilitar merge automático diff --git a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md index 207bf31c82..614bd89a64 100644 --- a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md +++ b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md @@ -27,7 +27,7 @@ redirect_from: 1. Na lista "Pull Requests", clique no pull request que você gostaria de adicionar a uma fila de merge. 1. Clique em **Fazer merge quando estiver pronto** para adicionar o pull request à fila de merge. Como alternativa, se você for um administrador, você pode: - - Faça o merge diretamente do pull request verificando **Merge sem aguardar que os requisitos sejam cumpridos (somente administradores)**, se permitido pelas configurações de proteção de branches e siga o fluxo padrão. ![Opções da fila de merge](/assets/images/help/pull_requests/merge-queue-options.png) + - Faça o merge direto do pull request marcando **Merge sem espera para atendimento dos requisitos ({% ifversion bypass-branch-protections %}ignorar proteções do branch{% else %}apenas administradores{% endif %})**, se permitido pelas configurações de proteção de branches e siga o fluxo padrão. ![Opções da fila de merge](/assets/images/help/pull_requests/merge-queue-options.png) {% tip %} diff --git a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md index 04908b3653..e4e2653ed6 100644 --- a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md +++ b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md @@ -27,7 +27,7 @@ Você pode fazer comentários na guia **Conversation** (Conversa) de uma pull re Também é possível comentar em seções específicas de um arquivo na guia **Files changed** (Arquivos alterados) de uma pull request na forma de comentários em linha individuais ou como parte de uma [revisão de pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews). Adicionar comentários em linha é uma excelente maneira de discutir questões sobre implementação ou fornecer feedback ao autor. -For more information on adding line comments to a pull request review, see "[Reviewing proposed changes in a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)." +Para obter mais informações sobre como adicionar comentários em linha a uma revisão de pull request, consulte "[Revisar alterações propostas em um pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)". {% note %} diff --git a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md index 72f51400c0..c8462071e8 100644 --- a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md +++ b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md @@ -25,11 +25,11 @@ permissions: People with write access for a forked repository can sync the fork {% ifversion syncing-fork-web-ui %} 1. Em {% data variables.product.product_name %}, acesse a página principal do repositório bifurcado que você deseja sincronizar com o repositório upstream. -2. Select the **Sync fork** dropdown. !["Sync fork" dropdown emphasized](/assets/images/help/repository/sync-fork-dropdown.png) -3. Review the details about the commits from the upstream repository, then click **Update branch**. ![Sync fork modal with "Update branch" button emphasized](/assets/images/help/repository/update-branch-button.png) +2. Selecione o menu suspenso **Sincronizar bifurcação**. ![Menu suspenso "Sincronizar bifurcação" destacado](/assets/images/help/repository/sync-fork-dropdown.png) +3. Revise os detalhes sobre os commits do repositório upstream e clique em **Atualizar branch**. ![Modo sincronizar bifurcação com o botão "Atualizar branch" destacado](/assets/images/help/repository/update-branch-button.png) {% else %} 1. Em {% data variables.product.product_name %}, acesse a página principal do repositório bifurcado que você deseja sincronizar com o repositório upstream. -2. Select the **Fetch upstream** dropdown. ![Menu suspenso "Buscar upstream"](/assets/images/help/repository/fetch-upstream-drop-down.png) +2. Selecione o menu suspenso **Buscar upstream**. ![Menu suspenso "Buscar upstream"](/assets/images/help/repository/fetch-upstream-drop-down.png) 3. Revise as informações sobre os commits do repositório upstream e, em seguida, clique em **Buscar e merge**. !["Fetch and merge" button](/assets/images/help/repository/fetch-and-merge-button.png){% endif %} Se as alterações do repositório a upstream gerarem conflitos, {% data variables.product.company_short %} solicitará a criação de um pull request para resolver os conflitos. diff --git a/translations/pt-BR/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md b/translations/pt-BR/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md index 00fe1c38b4..2e7a215e47 100644 --- a/translations/pt-BR/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md +++ b/translations/pt-BR/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md @@ -19,7 +19,7 @@ versions: {% data reusables.commits.about-commits %} {% ifversion commit-signoffs %} -If the repository you are committing to has compulsory commit signoffs enabled, and you are committing via the web interface, you will automatically sign off on the commit as part of the commit process. For more information, see "[Managing the commit signoff policy for your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository)." {% endif %} +Se o repositório com o qual você está se comprometendo tiver assinaturas de commit habilitadas e você estiver fazendo o commit por meio da interface web, você irá automaticamente assinar o commit como parte do processo de commit. Para obter mais informações, consulte "[Gerenciando a política de assinatura de commit para o seu repositório](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository)". {% endif %} Você pode adicionar um coautor em qualquer commit em que colaborar. Para obter mais informações, consulte "[Criar um commit com vários autores](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors)". diff --git a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md index ca2e7821d7..fe21fd3413 100644 --- a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md +++ b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md @@ -1,6 +1,6 @@ --- -title: Configuring commit merging for pull requests -intro: 'You can enforce, allow, or disable merging with a merge commit for all pull request merges on {% data variables.product.product_location %} in your repository.' +title: Configurar o merge do commit para pull requests +intro: 'É possível aplicar, permitir ou desabilitar o merge com um commit de merge para todos os merge de pull request em {% data variables.product.product_location %} no seu repositório.' versions: fpt: '*' ghes: '*' @@ -8,18 +8,18 @@ versions: ghec: '*' topics: - Repositories -shortTitle: Configure commit merging +shortTitle: Configurar o merge de commit --- {% data reusables.pull_requests.configure_pull_request_merges_intro %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -1. Under {% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-6069 %}"Pull Requests"{% else %}"Merge button"{% endif %}, select **Allow merge commits**. This allows contributors to merge a pull request with a full history of commits.{% ifversion default-merge-squash-commit-message %} ![Screenshot of Pull Request settings with allow merge commits checkbox emphasized](/assets/images/help/repository/allow-merge-commits.png){% endif %}{% ifversion ghes = 3.6 %} ![Screenshot of Pull Request settings with allow merge commits checkbox emphasized](/assets/images/help/repository/allow-merge-commits-no-dropdown.png){% endif %} +1. Em {% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-6069 %}"Pull Requests"{% else %}"Botão de merge"{% endif %}, selecione **Permitir commits de merge**. Isso permite que os contribuidores façam merge de um pull request com um histórico completo dos commits.{% ifversion default-merge-squash-commit-message %} ![Screenshot of Pull Request settings with allow merge commits checkbox emphasized](/assets/images/help/repository/allow-merge-commits.png){% endif %}{% ifversion ghes = 3.6 %} ![Screenshot of Pull Request settings with allow merge commits checkbox emphasized](/assets/images/help/repository/allow-merge-commits-no-dropdown.png){% endif %} {% ifversion ghes < 3.6 %} ![allow_standard_merge_commits](/assets/images/help/repository/pr-merge-full-commits.png){% endif %} {% ifversion default-merge-squash-commit-message %} -1. Optionally, under **Allow merge commits**, use the dropdown to choose the format of the commit message presented to contributors when merging. The default message includes the pull request number and title. For example, `Merge pull request #123 from patch-1`. You can also choose to use just the pull request title, or the pull request title and description. ![Screenshot of emphasized default commit message dropdown](/assets/images/help/repository/default-commit-message-dropdown.png) +1. Opcionalmente, em **Permitir commits de merge**, use o menu suspenso para escolher o formato da mensagem de commit apresentada aos contribuidores quando realizar o merge. A mensagem padrão inclui o número e título do pull request. Por exemplo, `Merge pull request #123 from patch-1`. Você também pode escolher usar apenas o título do pull request ou o título e a descrição do pull request. ![Captura de tela do menu suspenso da mensagem do commit de combinação por squash padrão](/assets/images/help/repository/default-commit-message-dropdown.png) {% endif %} Se você selecionar mais de um método de merge, os colaboradores poderão escolher qual o tipo de commit de merge usar ao fazer o merge de um pull request. {% data reusables.repositories.squash-and-rebase-linear-commit-history %} diff --git a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md index 33d1ef03b1..d093ff8b48 100644 --- a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md +++ b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md @@ -21,7 +21,7 @@ shortTitle: Configurar rebase de commit {% data reusables.repositories.sidebar-settings %} 3. Em {% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-6069 %}"Pull Requests"{% else %}"Botão de merge"{% endif %}, selecione **Permitir merge de rebase**. Isso permite que os contribuidores façam merge de uma pull request fazendo rebase dos respectivos commits individuais no branch base. {% ifversion default-merge-squash-commit-message %} - ![Screenshot of Pull Request settings with allow rebase merging checkbox emphasized](/assets/images/help/repository/allow-rebase-merging.png){% endif %}{% ifversion ghes = 3.6 %} ![Screenshot of Pull Request settings with allow rebase merging checkbox emphasized](/assets/images/help/repository/allow-rebase-merging-no-dropdown.png){% endif %} + ![Captura de tela das configurações de pull request com a caixa de seleção permitir merge de rebase destacada](/assets/images/help/repository/allow-rebase-merging.png){% endif %}{% ifversion ghes = 3.6 %} ![Screenshot of Pull Request settings with allow rebase merging checkbox emphasized](/assets/images/help/repository/allow-rebase-merging-no-dropdown.png){% endif %} {% ifversion ghes < 3.6 %} ![Commits com rebase da pull request](/assets/images/help/repository/pr-merge-rebase.png){% endif %} diff --git a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md index 56dbb27442..c6165a65ee 100644 --- a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md +++ b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md @@ -21,11 +21,11 @@ shortTitle: Configurar combinação por squash de commit {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -1. Em {% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-6069 %}"Pull Requests"{% else %}"Botão de merge"{% endif %}, selecione **Permitir merge de combinação por squash**. Isso permite que os contribuidores façam merge de uma pull request combinando por squash todos os commits em um único commit. The default commit message presented to contributors when merging is the commit title and message if the pull request contains only 1 commit, or the pull request title and list of commits if the pull request contains 2 or more commits. {% ifversion ghes = 3.6 %} To always use the title of the pull request regardless of the number of commits in the pull request select **Default to PR title for squash merge commits**.{% endif %}{% ifversion default-merge-squash-commit-message %} ![Pull request squashed commits](/assets/images/help/repository/allow-squash-merging.png){% endif %}{% ifversion ghes = 3.6 %} ![Screenshot of Pull Request settings with allow merge commits checkbox emphasized](/assets/images/help/repository/allow-squash-merging-no-dropdown.png){% endif %} +1. Em {% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-6069 %}"Pull Requests"{% else %}"Botão de merge"{% endif %}, selecione **Permitir merge de combinação por squash**. Isso permite que os contribuidores façam merge de uma pull request combinando por squash todos os commits em um único commit. A mensagem de commit padrão apresentada aos contribuidores ao fazer o merge é o título e a mensagem do commit se o pull request contiver apenas 1 commit, ou o título do pull request e lista de commits se o pull request contiver 2 ou mais commits. {% ifversion ghes = 3.6 %} Para usar sempre o título do pull request, independentemente do número de commits no pull request, selecione **Título padrão do PR para commits de merge de combinação por squash**.{% endif %}{% ifversion default-merge-squash-commit-message %} ![Pull request squashed commits](/assets/images/help/repository/allow-squash-merging.png){% endif %}{% ifversion ghes = 3.6 %} ![Screenshot of Pull Request settings with allow merge commits checkbox emphasized](/assets/images/help/repository/allow-squash-merging-no-dropdown.png){% endif %} {% ifversion ghes < 3.6 %} ![Commits de combinação por squash da pull request](/assets/images/enterprise/3.5/repository/pr-merge-squash.png){% endif %} {% ifversion default-merge-squash-commit-message %} -1. Optionally, under **Allow squash merging**, use the dropdown to choose the format of the default squash commit message presented to contributors when merging. The default message uses the commit title and message if the pull request contains only 1 commit, or the pull request title and list of commits if the pull request contains 2 or more commits. You can also choose to use just the pull request title, the pull request title and commit details, or the pull request title and description. ![Screenshot of emphasized default squash message dropdown](/assets/images/help/repository/default-squash-message-dropdown.png) +1. Opcionalmente, em **Permitir o merge de combinação por squash**, use o menu suspenso para escolher o formato da mensagem do commit da combinação por squash padrão apresentada para os contribuidores ao realizar o merge. A mensagem padrão usa o título e a mensagem de commit se o pull request contiver apenas 1 commit, ou o título do pull request e lista de commits se o pull request contiver 2 ou mais commits. Você também pode opter por usar apenas o título do pull request, o título e os detalhes de commit do pull request ou o título e descrição do pull request. ![Captura de tela do menu suspenso da mensagem de combinação por squash padrão](/assets/images/help/repository/default-squash-message-dropdown.png) {% endif %} Se você selecionar mais de um método de merge, os colaboradores poderão escolher qual o tipo de commit de merge usar ao fazer o merge de um pull request. {% data reusables.repositories.squash-and-rebase-linear-commit-history %} diff --git a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md index a13a9d7974..b9e4cbafbb 100644 --- a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md +++ b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md @@ -19,7 +19,7 @@ redirect_from: {% data reusables.pull_requests.merge-queue-overview %} -A fila de merge cria branches temporários com um prefixo especial para validar as alterações do pull request. The changes in the pull request are then grouped into a `merge_group` with the latest version of the `base_branch` as well as changes ahead of it in the queue. {% data variables.product.product_name %} fará merge de todas essas alterações em `base_branch` uma vez que as verificações exigidas pelas proteções do branch de `base_branch` sejam aprovadas. +A fila de merge cria branches temporários com um prefixo especial para validar as alterações do pull request. Em seguida, as alterações no pull request são agrupadas em um `merge_group` com a última versão do `base_branch` e também com as alterações antes dele na fila. {% data variables.product.product_name %} fará merge de todas essas alterações em `base_branch` uma vez que as verificações exigidas pelas proteções do branch de `base_branch` sejam aprovadas. Para obter informações sobre métodos de merge, consulte "[Sobre merges de pull requests](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)". @@ -34,11 +34,11 @@ Para obter informações sobre métodos de merge, consulte "[Sobre merges de pul {% data reusables.pull_requests.merge-queue-reject %} -### Triggering merge group checks with {% data variables.product.prodname_actions %} +### Acionando verificações de grupo de merge com {% data variables.product.prodname_actions %} -You can use the `merge_group` event to trigger your {% data variables.product.prodname_actions %} workflow when a pull request is added to a merge queue. Note that this is a different event from the `pull_request` and `push` events. +Você pode usar o evento `merge_group` para acionar o fluxo de trabalho {% data variables.product.prodname_actions %} quando um pull request é adicionado à fila de merge. Observe que este é um evento diferente dos eventos `pull_request` e `push`. -A workflow that reports a check which is required by the target branch's protections would look like this: +Um fluxo de trabalho que informa uma verificação necessária pelas proteções do branch de destino ficaria assim: ```yaml on: @@ -46,11 +46,11 @@ on: merge_group: ``` -For more information see "[Events that trigger workflows](/actions/using-workflows/events-that-trigger-workflows#merge-group)" +Para obter mais informações, consulte "[Eventos que acionam fluxos de trabalho](/actions/using-workflows/events-that-trigger-workflows#merge-group)" -### Triggering merge group checks with other CI providers +### Acionando verificações de grupo de merge com outros provedores de CI -With other CI providers, you may need to update your CI configuration to run when a branch that begins with the special prefix `gh-readonly-queue/{base_branch}` is created. +Com outros provedores de CI, é possível que você precise atualizar sua configuração de CI para ser executada quando uma branch que começa quando o prefixo especial `gh-readonly /{base_branch}` é criado. ## Gerenciando uma fila de merge diff --git a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md index eee713b1c3..5107588067 100644 --- a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md +++ b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md @@ -32,7 +32,10 @@ topics: Por padrão, cada regra de proteção de branch desabilita push forçado para os branches correspondentes e impede que os branches correspondentes sejam excluídos. Você pode, opcionalmente, desabilitar essas restrições e habilitar configurações adicionais de proteção de branches. -Por padrão, as restrições de uma regra de proteção de branch não se aplicam a pessoas com permissões de administrador para o repositório. Opcionalmente, você também pode escolher incluir administradores. +{% ifversion bypass-branch-protections %} +Por padrão, as restrições de uma regra de proteção de branch não se aplicam a pessoas com permissões de administrador para o repositório ou funções personalizadas com a permissão de "ignorar proteção de branch". Opcionalmente, você pode aplicar as restrições para administradores e funções com a permissão "ignorar proteção de branch". Para obter mais informações, consulte "[Gerenciando funções de repositórios personalizados para uma organização](/en/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". +{% else %} +Por padrão, as restrições de uma regra de proteção de branch não se aplicam a pessoas com permissões de administrador para o repositório. Opcionalmente, você também pode escolher incluir administradores.{% endif %} {% data reusables.repositories.branch-rules-example %} Para obter mais informações sobre os padrões de nomes do branch, consulte "[Gerenciar uma regra de proteção de branch](/github/administering-a-repository/managing-a-branch-protection-rule)". @@ -52,7 +55,7 @@ Para cada regra de proteção do branch, você pode escolher habilitar ou desabi {%- ifversion required-deployments %} - [Exige implantações para ter sucesso antes do merge](#require-deployments-to-succeed-before-merging) {%- endif %} -- [Incluir administradores](#include-administrators) +{% ifversion bypass-branch-protections %}- [Não permita que as configurações acima sejam ignoradas](#do-not-allow-bypassing-the-above-settings){% else %}- [Incluir administradores](#include-administrators){% endif %} - [Restringir quem pode fazer push para branches correspondentes](#restrict-who-can-push-to-matching-branches) - [Permitir push forçado](#allow-force-pushes) - [Permitir exclusões](#allow-deletions) @@ -124,7 +127,7 @@ Ao habilitar a assinatura de commit obrigatória em um branch, os contribuidores {% endnote %} -Você sempre pode fazer push de commits locais para o branch se os commits forem assinados e verificados. {% ifversion fpt or ghec %}Você também pode mesclar commits assinados e verificados no branch usando uma pull request no {% data variables.product.product_name %}. No entanto, você não pode combinar por squash e fazer o merge de uma pull request no branch em {% data variables.product.product_name %}, a menos que você seja o autor da pull request.{% else %} No entanto, você não pode mesclar as pull requests no branch no {% data variables.product.product_name %}.{% endif %} Você pode {% ifversion fpt or ghec %}combinar por squash e {% endif %}merge pull requests localmente. Para obter mais informações, consulte "[Fazer checkout de pull requests localmente](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally)". +Você sempre pode fazer push de commits locais para o branch se os commits forem assinados e verificados. {% ifversion fpt or ghec %}Você também pode fazer merge de commits assinados e verificados no branch usando um pull request em {% data variables.product.product_name %}. No entanto, você não pode realizar a combinação por squash e fazer o merge de um pull request no branch em {% data variables.product.product_name %} a menos que você seja o autor do pull request.{% else %}No entanto, você não pode fazer merge de pull requests no branch em {% data variables.product.product_name %}.{% endif %} Você pode {% ifversion fpt or ghec %}fazer combinação por squash e {% endif %} fazer merge de pull requests localmente. Para obter mais informações, consulte "[Fazer checkout de pull requests localmente](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally)". {% ifversion fpt or ghec %} Para obter mais informações sobre métodos de merge, consulte "[Sobre métodos de merge em {% data variables.product.prodname_dotcom %}](/github/administering-a-repository/about-merge-methods-on-github){% endif %} @@ -149,9 +152,15 @@ Antes de exigir um histórico de commit linear, seu repositório deve permitir m Você pode exigir que as alterações sejam implantadas em ambientes específicos antes de ua branch poder ser mesclado. Por exemplo, você pode usar essa regra para garantir que as alterações sejam implantadas com sucesso em um ambiente de teste antes das alterações sofrerem merge no seu branch padrão. -### Incluir administradores +{% ifversion bypass-branch-protections %}### Não permita que sejam ignoradas as configurações acima{% else %} +### Incluir administradores{% endif %} -Por padrão, as regras de branch protegidos não se aplicam a pessoas com permissões de administrador em um repositório. Você pode habilitar essa configuração para incluir administradores em suas regras de branch protegido. +{% ifversion bypass-branch-protections %} +Por padrão, as restrições de uma regra de proteção de branch não se aplicam a pessoas com permissões de administrador para o repositório ou funções personalizadas com a permissão de "ignorar proteção de branch" em um repositório. + +Você pode habilitar esta configuração para aplicar as restrições aos administradores e funções com a permissão "ignorar proteção de branch". Para obter mais informações, consulte "[Gerenciando funções de repositórios personalizados para uma organização](/en/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". +{% else %} +Por padrão, as regras de branch protegidos não se aplicam a pessoas com permissões de administrador em um repositório. Você pode habilitar essa configuração para incluir administradores em suas regras de proteção de branch.{% endif %} ### Restringir quem pode fazer push para branches correspondentes diff --git a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md index 0e676764c9..f040be4182 100644 --- a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md +++ b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md @@ -77,14 +77,14 @@ Ao criar uma regra de branch, o branch que você especificar ainda não existe n 1. Opcionalmente, para fazer merge de pull requests usando uma fila de merge, selecione **Exigir fila de merge**. {% data reusables.pull_requests.merge-queue-references %} ![Opção de exigir fila de merge](/assets/images/help/repository/require-merge-queue.png) {% tip %} - **Dica:** O recurso de merge da fila de pull request está atualmente em versão beta pública limitada e sujeito a alterações. Organizations owners can request early access to the beta by joining the [waitlist](https://github.com/features/merge-queue/signup). + **Dica:** O recurso de merge da fila de pull request está atualmente em versão beta pública limitada e sujeito a alterações. As organizações às quais os proprietários podem solicitar acesso antecipado ao beta entrando na [lista de espera](https://github.com/features/merge-queue/signup). {% endtip %} {%- endif %} {%- ifversion required-deployments %} 1. Opcionalmente, para escolher em quais ambientes as alterações devem ser implantadas com sucesso antes de fazer merge, selecione **Exigir implantações para ser bem-sucedidas antes do merge** e, em seguida, selecione os ambientes. ![Exigir uma opção de implantação bem-sucedida](/assets/images/help/repository/require-successful-deployment.png) {%- endif %} -1. Opcionalmente, selecione **Aplicar as regras acima aos administradores**. ![Aplicar as regras acima à caixa de seleção dos administradores](/assets/images/help/repository/include-admins-protected-branches.png) +1. Opcionalmente, selecione {% ifversion bypass-branch-protections %}**Não permita que sejam ignoradas as configurações acima**. ![Do not allow bypassing the above settings checkbox](/assets/images/help/repository/do-not-allow-bypassing-the-above-settings.png){% else %}**Aplicar as regras acima aos administradores**. ![Apply the rules above to administrators checkbox](/assets/images/help/repository/include-admins-protected-branches.png){% endif %} 1. Opcionalmente, {% ifversion fpt or ghec %} se o repositório pertencer a uma organização que usa {% data variables.product.prodname_team %} ou {% data variables.product.prodname_ghe_cloud %},{% endif %} habilitar as restrições de branches. - Selecione **Restringir quem pode fazer push para os branches correspondentes**. ![Branch restriction checkbox](/assets/images/help/repository/restrict-branch.png){% ifversion restrict-pushes-create-branch %} - Opcionalmente, para também restringir a criação de branches correspondentes, selecione **Restringir pushes que criam branches correspondentes**. ![Branch creation restriction checkbox](/assets/images/help/repository/restrict-branch-create.png){% endif %} diff --git a/translations/pt-BR/content/repositories/creating-and-managing-repositories/about-repositories.md b/translations/pt-BR/content/repositories/creating-and-managing-repositories/about-repositories.md index 7d4b78c205..bcbf580bb5 100644 --- a/translations/pt-BR/content/repositories/creating-and-managing-repositories/about-repositories.md +++ b/translations/pt-BR/content/repositories/creating-and-managing-repositories/about-repositories.md @@ -90,12 +90,12 @@ Todos os integrantes da empresa têm permissões de leitura no repositório inte {% data reusables.repositories.internal-repo-default %} -{% ifversion ghec %}Unless your enterprise uses {% data variables.product.prodname_emus %}, members{% else %}Members{% endif %} of the enterprise can fork any internal repository owned by an organization in the enterprise. O repositório bifurcado pertencerá à conta pessoal do integrante e a visibilidade da bifurcação será privada. Se um usuário for removido de todas as organizações pertencentes à empresa, essas bifurcações do usuário dos repositórios internos do usuário serão removidas automaticamente. +{% ifversion ghec %}A menos que sua empresa use {% data variables.product.prodname_emus %}, os integrantes{% else %}Integrantes{% endif %} da empresa poderão bifurcar qualquer repositório interno de propriedade de uma organização na empresa. O repositório bifurcado pertencerá à conta pessoal do integrante e a visibilidade da bifurcação será privada. Se um usuário for removido de todas as organizações pertencentes à empresa, essas bifurcações do usuário dos repositórios internos do usuário serão removidas automaticamente. {% ifversion ghec %} {% note %} -**Note:** {% data variables.product.prodname_managed_users_caps %} cannot fork internal repositories. For more information, see "[About {% data variables.product.prodname_emus %}](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#abilities-and-restrictions-of-managed-user-accounts)." +**Observação:** {% data variables.product.prodname_managed_users_caps %} não pode realizar a bifurcação a partir de repositórios internos. Para obter mais informações, consulte "[Sobre {% data variables.product.prodname_emus %}](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#abilities-and-restrictions-of-managed-user-accounts)." {% endnote %} {% endif %} @@ -109,9 +109,9 @@ A maioria dos limites abaixo afetam o {% data variables.product.product_name %} ### Limites de texto -Os arquivos de texto acima de **512 KB** são sempre exibidos como texto sem formatação. Code is not syntax highlighted, and prose files are not converted to HTML (such as Markdown, AsciiDoc, *etc.*). +Os arquivos de texto acima de **512 KB** são sempre exibidos como texto sem formatação. O código não destaca a sintaxe e arquivos em prosa não são convertidos em HTML (como markdown, AsciiDoc *etc.*). -Text files over **5 MB** are only available through their raw URLs, which are served through `{% data variables.product.raw_github_com %}`; for example, `https://{% data variables.product.raw_github_com %}/octocat/Spoon-Knife/master/index.html`. Click the **Raw** button to get the raw URL for a file. +Arquivos de texto acima de **5 MB** somente estão disponíveis por meio de suas URLs não processadas, que são servidas em `{% data variables.product.raw_github_com %}`; por exemplo, `https://{% data variables.product.raw_github_com %}/octocat/Spoon-Knife/master/index.html`. Clique no botão **Não processado** para obter a URL não processada de um arquivo. ### Limites de diff @@ -126,7 +126,7 @@ Algumas partes de um diff limitado podem ser exibidas, mas qualquer excedente de ### Limites de listas de commits -As páginas de visualização comparada e pull requests exibem uma lista de commits entre as revisões `base` e `head`. These lists are limited to **250** commits. Caso o limite seja excedido, uma observação indicará que commits adicionais estão presentes (mas não são mostrados). +As páginas de visualização comparada e pull requests exibem uma lista de commits entre as revisões `base` e `head`. Essas listas são limitadas a **250** commits. Caso o limite seja excedido, uma observação indicará que commits adicionais estão presentes (mas não são mostrados). ## Leia mais diff --git a/translations/pt-BR/content/repositories/creating-and-managing-repositories/transferring-a-repository.md b/translations/pt-BR/content/repositories/creating-and-managing-repositories/transferring-a-repository.md index 4093783174..140953a966 100644 --- a/translations/pt-BR/content/repositories/creating-and-managing-repositories/transferring-a-repository.md +++ b/translations/pt-BR/content/repositories/creating-and-managing-repositories/transferring-a-repository.md @@ -31,7 +31,7 @@ Pré-requisitos para transferências no repositório: - Ao transferir um repositório que possui para outra conta pessoal, o novo proprietário receberá um e-mail de confirmação.{% ifversion fpt or ghec %} O e-mail de confirmação inclui instruções para aceitar a transferência. Se o novo proprietário não aceitar a transferência em um dia, o convite vai expirar.{% endif %} - Para transferir um repositório que você possui para uma organização, é preciso ter permissão para criar um repositório na organização de destino. - A conta de destino não deve ter um repositório com o mesmo nome ou uma bifurcação na mesma rede. -- O proprietário original do repositório é adicionado como colaborador no repositório transferido. Other collaborators to the transferred repository remain intact.{% ifversion ghes < 3.7 %} +- O proprietário original do repositório é adicionado como colaborador no repositório transferido. Outros colaboradores no repositório transferido permanecem intactos.{% ifversion ghes < 3.7 %} - Os repositórios internos não podem ser transferidos.{% endif %} - Bifurcações privadas não podem ser transferidas. diff --git a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md index 5d34fb20d2..c1bd353596 100644 --- a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md +++ b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md @@ -48,7 +48,7 @@ Para reduzir o tamanho do seu arquivo CODEOWNERS, considere o uso de padrões cu ## Sintaxe de CODEOWNERS -Um arquivo CODEOWNERS usa um padrão que segue a maioria das mesmas regras usadas nos arquivos [gitignore](https://git-scm.com/docs/gitignore#_pattern_format), com [algumas exceções](#syntax-exceptions). O padrão é seguido por um ou mais nomes de usuário ou nomes de equipe do {% data variables.product.prodname_dotcom %} usando o formato padrão `@username` ou `@org/team-name`. Users and teams must have explicit `write` access to the repository, even if the team's members already have access. +Um arquivo CODEOWNERS usa um padrão que segue a maioria das mesmas regras usadas nos arquivos [gitignore](https://git-scm.com/docs/gitignore#_pattern_format), com [algumas exceções](#syntax-exceptions). O padrão é seguido por um ou mais nomes de usuário ou nomes de equipe do {% data variables.product.prodname_dotcom %} usando o formato padrão `@username` ou `@org/team-name`. Os usuários e as equipes devem ter acesso explícito de `gravação` para o repositório, mesmo que os integrantes da equipe já tenham acesso. {% ifversion fpt or ghec%}Na maioria dos casos você{% else %}Você{% endif %} também pode se referir a um usuário por um endereço de e-mail que foi adicionado a sua conta em {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, por exemplo, `user@example tom`. {% ifversion fpt or ghec %} Você não pode usar um endereço de e-mail para fazer referência a um {% data variables.product.prodname_managed_user %}. Para obter mais informações sobre {% data variables.product.prodname_managed_users %}, consulte "[Sobre {% data variables.product.prodname_emus %}](/enterprise-cloud@latest/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/about-enterprise-managed-users){% ifversion fpt %}" na documentação de {% data variables.product.prodname_ghe_cloud %}.{% else %}."{% endif %}{% endif %} diff --git a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md index c4678ef37d..64aa9bd18c 100644 --- a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md +++ b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md @@ -18,7 +18,7 @@ shortTitle: Exibir um botão de patrocinador Para configurar o botão de patrocinador, edite um arquivo _FUNDING.yml_ na pasta `.github` do repositório, no branch padrão. É possível configurar o botão para incluir desenvolvedores patrocinados no {% data variables.product.prodname_sponsors %}, em plataformas de financiamento externas ou em uma URL de financiamento personalizado. Para obter mais informações a respeito do {% data variables.product.prodname_sponsors %}, consulte "[Sobre o GitHub Sponsors](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)". -Você pode adicionar um nome de usuário, de pacote ou de projeto por plataforma de financiamento externa e até quatro URLs personalizadas. You can add one organization and up to four sponsored developers in {% data variables.product.prodname_sponsors %}. Adicione cada plataforma em uma nova linha, usando a seguinte sintaxe: +Você pode adicionar um nome de usuário, de pacote ou de projeto por plataforma de financiamento externa e até quatro URLs personalizadas. Você pode adicionar uma organização e até quatro desenvolvedores patrocinados em {% data variables.product.prodname_sponsors %}. Adicione cada plataforma em uma nova linha, usando a seguinte sintaxe: | Plataforma | Sintaxe | | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | diff --git a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository.md b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository.md index a333f2fae9..349867a03a 100644 --- a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository.md +++ b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository.md @@ -1,6 +1,6 @@ --- -title: 'Disabling {% data variables.projects.projects_v1_boards %} in a repository' -intro: 'Repository administrators can turn off {% data variables.projects.projects_v1_boards %} for a repository if you or your team manages work differently.' +title: 'Desabilitando {% data variables.projects.projects_v1_boards %} em um repositório' +intro: 'Os administradores do repositório podem desativar {% data variables.projects.projects_v1_boards %} para um repositório, se você ou sua equipe gerenciarem trabalhos de forma diferente.' redirect_from: - /github/managing-your-work-on-github/managing-project-boards/disabling-project-boards-in-a-repository - /articles/disabling-project-boards-in-a-repository @@ -13,14 +13,14 @@ versions: ghec: '*' topics: - Pull requests -shortTitle: 'Disable {% data variables.projects.projects_v1_boards %}' +shortTitle: 'Desabilite {% data variables.projects.projects_v1_boards %}' allowTitleToDifferFromFilename: true --- -When you disable {% data variables.projects.projects_v1_boards %}, you will no longer see {% data variables.projects.projects_v1_board %} information in timelines or [audit logs](/articles/reviewing-your-security-log/). +Ao desabilitar {% data variables.projects.projects_v1_boards %}, você não verá mais as informações de {% data variables.projects.projects_v1_board %} em linhas do tempo ou em [logs de auditoria](/articles/reviewing-your-security-log/). {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} 3. Em "Features" (Recursos), desmarque a caixa de seleção **Projects** (Projetos). ![Caixa de seleção Remove Projects (Remover projetos)](/assets/images/help/projects/disable-projects-checkbox.png) -After {% data variables.projects.projects_v1_boards %} are disabled, existing {% data variables.projects.projects_v1_boards %} are inaccessible at their previous URLs. {% data reusables.organizations.disable_project_board_results %} +Após {% data variables.projects.projects_v1_boards %} ser desabilitado, {% data variables.projects.projects_v1_boards %} existente poderá ser acessado nas suas URLs anteriores. {% data reusables.organizations.disable_project_board_results %} diff --git a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository.md b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository.md index 0e76db15bc..2ccb44ce8f 100644 --- a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository.md +++ b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository.md @@ -1,24 +1,24 @@ --- -title: Managing the commit signoff policy for your repository -intro: 'You can require users to automatically sign off on the commits they make to your repository using {% data variables.product.product_name %}''s web interface.' +title: Gerenciando a política de assinatura do commit para seu repositório +intro: 'Você pode exigir que os usuários assinem automaticamente os commits que criarem no seu repositório usando a interface web do {% data variables.product.product_name %}.' versions: feature: commit-signoffs permissions: Organization owners and repository administrators can require all commits to a repository to be signed off by the commit author. topics: - Repositories -shortTitle: Manage the commit signoff policy +shortTitle: Gerenciar a política de aprovação de commit --- -## About commit signoffs +## Sobre as autorizações de commit -Commit signoffs enable users to affirm that a commit complies with the rules and licensing governing a repository. You can enable compulsory commit signoffs on individual repositories for users committing through {% data variables.product.product_location %}'s web interface, making signing off on a commit a seemless part of the commit process. Once compulsory commit signoffs are enabled for a repository, every commit made to that repository through {% data variables.product.product_location %}'s web interface will automatically be signed off on by the commit author. +As assinaturas de commits permitem que os usuários afirmem que um commit cumpre as regras e licenciamento que regem um repositório. Você pode habilitar assinaturas de commit obrigatórias em repositórios individuais para os usuários que fazem commit através da interface web do {% data variables.product.product_location %}, tornando a assinatura de um commit uma parte integrante do processo de commit. Uma vez que as assinaturas obrigatórias de commit estiverem habilitadas para um repositório, cada commit criado para esse repositório por meio da interface web do {% data variables.product.product_location %} será automaticamente assinado pelo autor do commit. -Organization owners can also enable compulsory commit signoffs at the organization level. For more information, see "[Managing the commit signoff policy for your organization](/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization)." +Os proprietários da organização também podem habilitar assinaturas de commit obrigatórias no nível da organização. Para obter mais informações, consulte "[Gerenciando a política de assinatura de commit para a sua organização](/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization)". {% data reusables.repositories.commit-signoffs %} -## Enabling or disabling compulsory commit signoffs for your repository +## Habilitando ou desabilitando as assinaturas obrigatórias de commit para o seu repositório {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -1. Select **Require contributors to sign off on web-based commits**. ![Screenshot of Require contributors to sign off on web-based commits](/assets/images/help/repository/require-signoffs.png) +1. Selecione **Exigir que os contribuidores assinem os commits baseados na web**. ![Captura de tela dos contribuidores obrigatórios para assinar commits baseados na web](/assets/images/help/repository/require-signoffs.png) diff --git a/translations/pt-BR/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md b/translations/pt-BR/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md index e6f77eeb6a..78c55b1fed 100644 --- a/translations/pt-BR/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md +++ b/translations/pt-BR/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md @@ -1,6 +1,6 @@ --- title: Adicionar um arquivo a um repositório -intro: 'Você pode fazer o upload e o commit de um arquivo existente para um repositório no {% data variables.product.product_name %} ou usando a linha de comando.' +intro: 'Você pode fazer o upload e o commit de um arquivo existente para um repositório em {% data variables.product.product_name %} ou usando a linha de comando.' redirect_from: - /articles/adding-a-file-to-a-repository - /github/managing-files-in-a-repository/adding-a-file-to-a-repository @@ -22,7 +22,7 @@ shortTitle: Adicionar um arquivo ## Adicionando um arquivo a um repositório em {% data variables.product.product_name %} -Os arquivos que você adiciona a um repositório por meio do navegador são limitados a {% data variables.large_files.max_github_browser_size %} por arquivo. É possível adicionar arquivos maiores, de até {% data variables.large_files.max_github_size %} cada um, usando a linha de comando. Para obter mais informações, consulte "[Adicionar um arquivo a um repositório usando a linha de comando](#adding-a-file-to-a-repository-using-the-command-line)". To add files larger than {% data variables.large_files.max_github_size %}, you must use {% data variables.large_files.product_name_long %}. For more information, see "[About large files on {% data variables.product.product_name %}](/repositories/working-with-files/managing-large-files/about-large-files-on-github)." +Os arquivos que você adiciona a um repositório por meio do navegador são limitados a {% data variables.large_files.max_github_browser_size %} por arquivo. É possível adicionar arquivos maiores, de até {% data variables.large_files.max_github_size %} cada um, usando a linha de comando. Para obter mais informações, consulte "[Adicionar um arquivo a um repositório usando a linha de comando](#adding-a-file-to-a-repository-using-the-command-line)". Para adicionar arquivos maiores que {% data variables.large_files.max_github_size %}, você deve usar {% data variables.large_files.product_name_long %}. Para obter mais informações, consulte "[Sobre arquivos grandes em {% data variables.product.product_name %}](/repositories/working-with-files/managing-large-files/about-large-files-on-github)." {% tip %} diff --git a/translations/pt-BR/content/repositories/working-with-files/using-files/working-with-non-code-files.md b/translations/pt-BR/content/repositories/working-with-files/using-files/working-with-non-code-files.md index 70dc064c89..71226163b4 100644 --- a/translations/pt-BR/content/repositories/working-with-files/using-files/working-with-non-code-files.md +++ b/translations/pt-BR/content/repositories/working-with-files/using-files/working-with-non-code-files.md @@ -363,7 +363,7 @@ Ao visualizar o arquivo no repositório, ele é interpretado como um gráfico de Se o seu gráfico não faz nenhuma interpretação, verifique se ele contém uma sintaxe válida do Markdown do Mermaid, verificando sua carta com [editor ativo do Mermaid](https://mermaid.live/edit). -If the chart displays, but does not appear as you'd expect, you can create a new [{% data variables.product.prodname_github_community %} discussion](https://github.com/orgs/community/discussions/categories/general), and add the `Mermaid` label. +Se o gráfico for exibido, mas não aparecer como você esperara, você poderá uma nova [discussão de {% data variables.product.prodname_github_community %} discussão](https://github.com/orgs/community/discussions/categories/general) e adicionar a etiqueta `Mermaid`. #### Problemas conhecidos diff --git a/translations/pt-BR/content/rest/actions/cache.md b/translations/pt-BR/content/rest/actions/cache.md index 2c0dcb2956..67035b74c3 100644 --- a/translations/pt-BR/content/rest/actions/cache.md +++ b/translations/pt-BR/content/rest/actions/cache.md @@ -13,4 +13,4 @@ versions: ## About a API do cache -A API do cache do {% data variables.product.prodname_actions %} permite que você consulte e gerencie o cache {% data variables.product.prodname_actions %} para repositórios. {% ifversion actions-cache-management %}You can also install a {% data variables.product.prodname_cli %} extension to manage your caches from the command line. {% endif %}For more information, see "[Caching dependencies to speed up workflows](/actions/advanced-guides/caching-dependencies-to-speed-up-workflows#managing-caches)." +A API do cache do {% data variables.product.prodname_actions %} permite que você consulte e gerencie o cache {% data variables.product.prodname_actions %} para repositórios. {% ifversion actions-cache-management %}Você também pode instalar uma extensão de {% data variables.product.prodname_cli %} para gerenciar seus caches a partir da linha de comando. {% endif %}Para obter mais informações, consulte "[Dependências de cache para acelerar os fluxos de trabalho](/actions/advanced-guides/caching-dependencies-to-speed-up-workflows#managing-caches)". diff --git a/translations/pt-BR/content/rest/deployments/branch-policies.md b/translations/pt-BR/content/rest/deployments/branch-policies.md index 77279b9fe8..b6cb80a805 100644 --- a/translations/pt-BR/content/rest/deployments/branch-policies.md +++ b/translations/pt-BR/content/rest/deployments/branch-policies.md @@ -1,8 +1,8 @@ --- -title: Deployment branch policies +title: Políticas de branch de implantação allowTitleToDifferFromFilename: true -shortTitle: Deployment branch policies -intro: The Deployment branch policies API allows you to manage custom deployment branch policies. +shortTitle: Políticas de branch de implantação +intro: A API de políticas de branch de implantação permite que você gerencie políticas personalizadas de branch de implantação. versions: fpt: '*' ghes: '*' @@ -13,8 +13,8 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Deployment branch policies API +## Sobre a API das políticas de branch de implantação -The Deployment branch policies API allows you to specify custom name patterns that branches must match in order to deploy to an environment. The `deployment_branch_policy.custom_branch_policies` property for the environment must be set to `true` to use these endpoints. To update the `deployment_branch_policy` for an environment, see "[Create or update an environment](/rest/deployments/environments#create-or-update-an-environment)." +A API de políticas de branch de implantação permite que você especifique padrões de nome personalizados aos quais os branchs devem corresponder para fazer a implantação em um ambiente. A propriedade `deployment_branch_policy.custom_branch_policy` para o ambiente deve ser definida como `verdadeiro` para usar estas extremidades. Para atualizar o `deployment_branch_policy` para um ambiente, consulte "[Criando ou atualizando um ambiente](/rest/deployments/environments#create-or-update-an-environment)". -For more information about restricting environment deployments to certain branches, see "[Using environments for deployment](/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-branches)." +Para obter mais informações sobre como restringir implantações de ambiente em certos branches, consulte "[Usando ambientes para implantação](/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-branches). ". diff --git a/translations/pt-BR/content/rest/deployments/deployments.md b/translations/pt-BR/content/rest/deployments/deployments.md index 3b5dd1922a..1b3a87d635 100644 --- a/translations/pt-BR/content/rest/deployments/deployments.md +++ b/translations/pt-BR/content/rest/deployments/deployments.md @@ -19,7 +19,7 @@ Os status de implantação externos permitem marcar implantações com `error`, Os status de implantação também podem incluir uma `descrição` opcional e `log_url`, que são altamente recomendados porque tornam o status de implantação mais útil. O `log_url` é a URL completa para a saída de implantação e a `descrição` é um resumo de alto nível do que aconteceu com a implantação. -O GitHub envia os eventos de `implantação` e `deployment_status` quando novas implantações de status de implantação são criadas. Esses eventos permitem que as integrações de terceiros recebam resposta para solicitações de implantação e atualizem o status de implantação conforme o progresso é feito. +O GitHub envia os eventos de `implantação` e `deployment_status` quando novas implantações de status de implantação são criadas. Esses eventos permitem que as integrações de terceiros recebam e respondam às solicitações de implantação e atualizem o status de implantação conforme o progresso é feito. Abaixo está um diagrama de sequência sobre para como essas interações funcionariam. diff --git a/translations/pt-BR/content/rest/guides/getting-started-with-the-checks-api.md b/translations/pt-BR/content/rest/guides/getting-started-with-the-checks-api.md index 93eba6bfd7..7aedf51294 100644 --- a/translations/pt-BR/content/rest/guides/getting-started-with-the-checks-api.md +++ b/translations/pt-BR/content/rest/guides/getting-started-with-the-checks-api.md @@ -41,7 +41,7 @@ Uma execução de verificação é um teste individual que faz parte de um conju ![Fluxo de trabalho das execuções de verificação](/assets/images/check_runs.png) -Se uma execução de verificação estiver em um estado incompleto por mais de 14 dias, a execução de verificação `conclusão` irá tornar-se `obsoleta` e será exibida em {% data variables.product.prodname_dotcom %} como obsoleto com {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Somente {% data variables.product.prodname_dotcom %} pode marcar a execuções de verificação como `obsoleto`. Para obter mais informações sobre possíveis conclusões de uma execução de verificação, consulte o parâmetro [`conclusão`](/rest/reference/checks#create-a-check-run--parameters). +If a check run is in an incomplete state for more than 14 days, then the check run's `conclusion` becomes `stale` and appears on {% data variables.product.prodname_dotcom %} as stale with {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Somente {% data variables.product.prodname_dotcom %} pode marcar a execuções de verificação como `obsoleto`. Para obter mais informações sobre possíveis conclusões de uma execução de verificação, consulte o parâmetro [`conclusão`](/rest/reference/checks#create-a-check-run--parameters). Assim que você receber o webhook de [`check_suite`](/webhooks/event-payloads/#check_suite), você poderá criar a execução de verificação, mesmo que a verificação não esteja completa. Você pode atualizar o `status` da execução de verificação, pois ele é completado com os valores de `queued`, `in_progress` ou `completed`, e você poderá atualizar a saída de `` conforme mais informações forem disponibilizadas. Uma verificação de execução pode conter registros de hora, um link para obter mais informações sobre o seu site externo, anotações detalhadas para linhas específicas de código, e informações sobre a análise realizada. diff --git a/translations/pt-BR/content/rest/guides/getting-started-with-the-rest-api.md b/translations/pt-BR/content/rest/guides/getting-started-with-the-rest-api.md index 940cef7d5c..ac338ba59f 100644 --- a/translations/pt-BR/content/rest/guides/getting-started-with-the-rest-api.md +++ b/translations/pt-BR/content/rest/guides/getting-started-with-the-rest-api.md @@ -1,9 +1,6 @@ --- title: Primeiros passos com a API REST -intro: 'Aprenda os fundamentos para usar a API REST, começando com a autenticação e alguns exemplos de pontos de extremidade.' -redirect_from: - - /guides/getting-started - - /v3/guides/getting-started +intro: 'Aprenda a usar a API REST de {% data variables.product.prodname_dotcom %}.' versions: fpt: '*' ghes: '*' @@ -11,418 +8,754 @@ versions: ghec: '*' topics: - API -shortTitle: Primeiros passos - REST API +shortTitle: Usando a API +miniTocMaxHeadingLevel: 3 --- +## Sobre a API REST de {% data variables.product.prodname_dotcom %} -Vamos andar pelos conceitos básicos da API, à medida que abordamos alguns casos de uso diário. +Esse artigo descreve como usar a API REST de {% data variables.product.prodname_dotcom %}, usando {% data variables.product.prodname_cli %}, JavaScript ou cURL. Para um guia de início rápido, consulte " Quickstart[Início rápido para a API REST do GitHub](/rest/quickstart)." -{% data reusables.rest-api.dotcom-only-guide-note %} +Ao fazer uma solicitação para a API REST, você especifica um método HTTP e um caminho. Além disso, você também pode especificar cabeçalhos de solicitação e caminho, consulta ou parâmetros de texto. A API retornará o código de status de resposta, cabeçalhos de resposta e, potencialmente, um texto de resposta. -## Visão Geral +A documentação de referência da API REST descreve o método HTTP, o caminho e os parâmetros para cada operação. Els também exibe exemplos de solicitações e respostas para cada operação. Para obter mais informações, consulte a [Documentação de referência de REST](/rest). -A maioria dos aplicativos usará uma [biblioteca de segurança][wrappers] existente na linguagem da sua escolha, mas é importante familiarizar-se primeiro com os métodos HTTP e de API subjacentes. +## Fazendo uma solicitação -Não há uma maneira mais de fazê-lo do que através do [cURL][curl].{% ifversion fpt or ghec %} Se você estiver usando um cliente alternativo, observe que você será obrigado a enviar um [cabeçalho do agente de usuário](/rest/overview/resources-in-the-rest-api#user-agent-required) válido na sua solicitação.{% endif %} +Para fazer uma solicitação, primeiro encontre o método HTTP e o caminho para a operação que você deseja usar. Por exemplo, a operação "Obter Octocat" usa o método `GET` e o caminho `/octocat`. Para a documentação completa de referência para esta operação, consulte "[Obter Octocat](/rest/meta#get-octocat)". -### Hello World +{% cli %} -Vamos começar testando a nossa configuração. Abra uma instrução de comando e digite o comando a seguir: +{% note %} + +**Observação**: Você deve instalar {% data variables.product.prodname_cli %} para usar os comandos nos exemplos de {% data variables.product.prodname_cli %}. For installation instructions, see the [{% data variables.product.prodname_cli %} repository](https://github.com/cli/cli#installation). + +{% endnote %} + +Se você ainda não está efetuando a autenticação em {% data variables.product.prodname_cli %}, você deve usar o subcomando de autenticação `gh login` para efetuar a autenticação antes de fazer qualquer solicitação. Para obter mais informações, consulte "[Efetuando a autenticação](#authenticating)". + +Para fazer uma solicitação usando {% data variables.product.prodname_cli %}, use o subcomando `api` junto com o caminho. Use o sinalizador `--method` ou `-X` para especificar o método. ```shell -$ curl https://api.github.com/zen - -> Keep it logically awesome. +gh api /octocat --method GET ``` -A resposta será uma seleção aleatória das nossas filosofias de design. +{% endcli %} -Next, let's `GET` [Chris Wanstrath's][defunkt github] [GitHub profile][users api]: +{% javascript %} + +{% note %} + +**Observação**: Você deve instalar e importar o `octokit` para usar a biblioteca Octokit.js usada nos exemplos de JavaScript. For more information, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). + +{% endnote %} + +Para fazer uma solicitação usando o JavaScript, você pode usar o Octokit.js. For more information, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). + +Primeiro, crie uma instância de `Octokit`.{% ifversion ghes or ghae %} Defina a URL de base como `{% data variables.product.api_url_code %}`. Substitua `[hostname]` pelo nome de {% data variables.product.product_location %}.{% endif %} + +```javascript +const octokit = new Octokit({ {% ifversion ghes or ghae %} + baseUrl: "{% data variables.product.api_url_code %}", +{% endif %}}); +``` + +Em seguida, use o método `solicitação` para fazer solicitações. Passe o método HTTP e o caminho como o primeiro argumento. + +```javascript +await octokit.request("GET /octocat", {}); +``` + +{% endjavascript %} + +{% curl %} + +Prepend the base URL for the {% data variables.product.prodname_dotcom %} REST API, `{% data variables.product.api_url_code %}`, to the path to get the full URL: `{% data variables.product.api_url_code %}/octocat`.{% ifversion ghes or ghae %} Replace `[hostname]` with the name of {% data variables.product.product_location %}.{% endif %} + +Use o comando `curl` na sua linha de comando. Use o sinalizador `--request` ou `-X` seguido do método HTTP. Use o sinalizador `--url` seguido da URL completa. ```shell -# GET /users/defunkt -$ curl https://api.github.com/users/defunkt - -> { -> "login": "defunkt", -> "id": 2, -> "node_id": "MDQ6VXNlcjI=", -> "avatar_url": "https://avatars.githubusercontent.com/u/2?v=4", -> "gravatar_id": "", -> "url": "https://api.github.com/users/defunkt", -> "html_url": "https://github.com/defunkt", -> ... -> } +curl --request GET \ +--url "https://api.github.com/octocat" ``` -Mmmmm, tastes like [JSON][json]. Vamos adicionar o sinalizador `-i` para incluir cabeçalhos: +{% note %} + +**Observação**: Se você receber uma mensagem semelhante a command not found: curl", talvez você tenha de fazer o download e instalar o cURL. For more information, see [the cURL project download page](https://curl.se/download.html). + +{% endnote %} + +{% endcurl %} + +Continue lendo para aprender como efetuar a autenticação, enviar parâmetros e usar a resposta. + +## Autenticando + +Muitas operações exigem autenticação ou devolução de informações adicionais se você estiver autenticado. Além disso, você pode fazer mais solicitações quando estiver autenticado.{% cli %} Embora algumas operações da API REST possam ser acessadas sem autenticação, você deve efetuar a autenticação em {% data variables.product.prodname_cli %} para usar o subcomando `api` .{% endcli %} + +### Sobre tokens + +Você pode autenticar a sua solicitação adicionando um token. + +Se você deseja usar a API REST de {% data variables.product.company_short %} para uso pessoal, você pode criar um token de acesso pessoal (PAT). As operações da API REST usadas neste artigo exigem um escopo `repo` para tokens de acesso pessoal. Outras operações podem exigir diferentes escopos. Para obter mais informações sobre a criação de um token de acesso pessoal, consulte[Criando um token de acesso pessoal](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + +Se você quiser usar a API em nome de uma organização ou outro usuário, {% data variables.product.company_short %} recomenda que você use um {% data variables.product.prodname_github_app %}. Se uma operação estiver disponível para {% data variables.product.prodname_github_apps %}, a documentação de referência REST para essa operação dirá "Funciona com aplicativos GitHub". As operações da API REST usadas neste artigo exigem permissões de leitura e gravação de `problemas` para {% data variables.product.prodname_github_apps %}. Outras operações podem exigir diferentes permissões. Para obter mais informações, consulte "[Criando um aplicativo GitHub](/developers/apps/building-github-apps/creating-a-github-app)", "[Efetuando a autenticação com aplicativos GitHub](/developers/apps/building-github-apps/authenticating-with-github-apps) e "[Identificando e autorizando os usuários pelos aplicativos GitHub](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps)". + +Se você quiser usar a API em um fluxo de trabalho de {% data variables.product.prodname_actions %}, {% data variables.product.company_short %} recomenda que você efetue a autenticação com o `GITHUB_TOKEN` ao invés de criar um token. Você pode conceder permissões para o `GITHUB_TOKEN` com a tecla `permissões`. Para obter mais informações, consulte "[Autenticação automática de tokens](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token)". + +### Exemplo de autenticação + +{% cli %} + +Com {% data variables.product.prodname_cli %}, você não precisa criar um token de acesso antecipadamente. Use o subcomando `auth login` para efetuar a autenticação em {% data variables.product.prodname_cli %}: ```shell -$ curl -i https://api.github.com/users/defunkt - -> HTTP/2 200 -> server: GitHub.com -> date: Thu, 08 Jul 2021 07:04:08 GMT -> content-type: application/json; charset=utf-8 -> cache-control: public, max-age=60, s-maxage=60 -> vary: Accept, Accept-Encoding, Accept, X-Requested-With -> etag: W/"61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0" -> last-modified: Fri, 01 Nov 2019 21:56:00 GMT -> x-github-media-type: github.v3; format=json -> access-control-expose-headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, Deprecation, Sunset -> access-control-allow-origin: * -> strict-transport-security: max-age=31536000; includeSubdomains; preload -> x-frame-options: deny -> x-content-type-options: nosniff -> x-xss-protection: 0 -> referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin -> content-security-policy: default-src 'none' -> x-ratelimit-limit: 60 -> x-ratelimit-remaining: 53 -> x-ratelimit-reset: 1625731053 -> x-ratelimit-resource: core -> x-ratelimit-used: 7 -> accept-ranges: bytes -> content-length: 1305 -> x-github-request-id: 9F60:7019:ACC5CD5:B03C931:60E6A368 -> -> { -> "login": "defunkt", -> "id": 2, -> "node_id": "MDQ6VXNlcjI=", -> "avatar_url": "https://avatars.githubusercontent.com/u/2?v=4", -> "gravatar_id": "", -> "url": "https://api.github.com/users/defunkt", -> "html_url": "https://github.com/defunkt", -> -> ... -> } +gh auth login ``` -Há algumas partes interessantes nos cabeçalhos da resposta. Como esperado, o `Content-Type` é `application/json`. +Você pode usar o sinalizador `--escopes` para especificar quais escopos você quer. Se você deseja efetuar a autenticação com um token que você criou, você pode usar o sinalizador `--with-token`. For more information, see the [{% data variables.product.prodname_cli %} `auth login` documentation](https://cli.github.com/manual/gh_auth_login). -Qualquer cabeçalho que começar com `X -` é um cabeçalho personalizado e não está incluído nas especificações de HTTP. Por exemplo, anote os cabeçalhos `X-RateLimit-Limit` e `X-RateLimit-Remaining`. This pair of headers indicate [how many requests a client can make][rate-limiting] in a rolling time period (typically an hour) and how many of those requests the client has already spent. +{% endcli %} -## Autenticação - -Clientes sem autenticação podem fazer 60 solicitações por hora. Para obter mais solicitações por hora, precisaremos _efetuar a autenticação_. In fact, doing anything interesting with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API requires [authentication][authentication]. - -### Usar tokens de acesso pessoal - -A maneira melhor e mais fácil de efetuar a autenticação com a {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API é usando a Autenticação Básica [por meio dos tokens do OAuth](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens). OAuth tokens include [personal access tokens][personal token]. - -Use um sinalizador `-u` para definir o seu nome de usuário: - -```shell -$ curl -i -u your_username {% data variables.product.api_url_pre %}/users/octocat - -``` - -Quando solicitado, você poderá inserir o seu token OAuth, mas nós recomendamos que você configure uma variável para isso: - -Você pode usar `-u "your_username:$token"` e configurar uma variável para `token` para evitar deixar seu token no histórico do shell, o que deve ser evitado. - -```shell -$ curl -i -u your_username:$token {% data variables.product.api_url_pre %}/users/octocat - -``` - -Ao efetuar a autenticação, você deverá ver seu limite de taxa disparado para 5.000 slicitações por hora, conforme indicado no cabeçalho `X-RateLimit-Limit`. Além de fornecer mais chamadas por hora, a autenticação permite que você leia e escreva informações privadas usando a API. - -You can easily [create a **personal access token**][personal token] using your [Personal access tokens settings page][tokens settings]: +{% javascript %} {% warning %} -Para ajudar a manter suas informações seguras, é altamente recomendável definir um vencimento para seus tokens de acesso pessoal. +**Warning**: Treat your access token like a password. + +To keep your token secure, you can store your token as a secret and run your script through {% data variables.product.prodname_actions %}. Para obter mais informações, consulte "[Segredos criptografados](/actions/security-guides/encrypted-secrets)". + +{% ifversion ghec or fpt %}Você também pode armazenar seu token como um segredo de {% data variables.product.prodname_codespaces %} e executar seu script em {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} + +If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. {% endwarning %} -{% ifversion fpt or ghes or ghec %} -![Seleção de Token Pessoal](/assets/images/personal_token.png) +Para efetuar a autenticação com a biblioteca do Octokit.js, você pode passar seu token ao criar uma instância de `Octokit`. Substitua `YOUR-TOKEN` pelo seu token.{% ifversion ghes or ghae %} Substitua `[hostname]` pelo nome de {% data variables.product.product_location %}.{% endif %} + +```javascript +const octokit = new Octokit({ {% ifversion ghes or ghae %} + baseUrl: "{% data variables.product.api_url_code %}",{% endif %} + auth: 'YOUR-TOKEN', +}); +``` + +{% endjavascript %} + +{% curl %} + +{% warning %} + +**Warning**: Treat your access token like a password. + +Para ajudar a manter sua conta segura, você pode usar {% data variables.product.prodname_cli %} ao invés de cURL. {% data variables.product.prodname_cli %} will take care of authentication for you. For more information, see the {% data variables.product.prodname_cli %} version of this page. + +{% ifversion ghec or fpt %}Você também pode armazenar seu token como um segredo de {% data variables.product.prodname_codespaces %} e usar a linha de comando através de {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} + +If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. + +{% endwarning %} + +Com cURL, você enviará um cabeçalho `Autorização` com seu token. Substitua `YOUR-TOKEN` pelo seu token: + +```shell +curl --request GET \ +--url "https://api.github.com/octocat" \ +--header "Authorization: Bearer YOUR-TOKEN" +``` + +{% note %} + +**Note:** In most cases, you can use `Authorization: Bearer` or `Authorization: token`. Os tokens da web JSON (JWTs) só funcionarão com `Authorization: Bearer`. + +{% endnote %} + +{% endcurl %} + +### Exemplo de autenticação para {% data variables.product.prodname_actions %} + +{% cli %} + +Você também pode usar a palavra-chave `executar` para executar comandos de {% data variables.product.prodname_cli %} nos seus fluxos de trabalho {% data variables.product.prodname_actions %}. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." + +Em vez de usar o comando de autenticação `gh login`, passe seu token como uma variável de ambiente denominada `GH_TOKEN`. {% data variables.product.prodname_dotcom %} recomenda que você efetue a autenticação com o `GITHUB_TOKEN` integrado em vez de criar um token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." Para obter mais informações sobre segredos, consulte "[Segredos criptografados](/actions/security-guides/encrypted-secrets)". + +```yaml +jobs: + use_api: + runs-on: ubuntu-latest + permissions: {} + steps: + - env: + GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + gh api /octocat +``` + +{% endcli %} + +{% javascript %} + +Você também pode usar a palavra-chave `executar` para executar seus scripts do JavaScript nos seus fluxos de trabalho de {% data variables.product.prodname_actions %}. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." + +{% data variables.product.prodname_dotcom %} recomenda que você efetue a autenticação com o `GITHUB_TOKEN` integrado em vez de criar um token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." Para obter mais informações sobre segredos, consulte "[Segredos criptografados](/actions/security-guides/encrypted-secrets)". + +The following example workflow: + +1. Checks out the repository content +1. Sets up Node.js +1. Installs `octokit` +1. Stores the value of `GITHUB_TOKEN` as an environment variable called `TOKEN` and runs `.github/actions-scripts/use-the-api.mjs`, which can access that environment variable as `process.env.TOKEN` + +Example workflow: + +```yaml +on: + workflow_dispatch: +jobs: + use_api_via_script: + runs-on: ubuntu-latest + permissions: {} + steps: + - name: Check out repo content + uses: {% data reusables.actions.action-checkout %} + + - name: Setup Node + uses: {% data reusables.actions.action-setup-node %} + with: + node-version: '16.15.0' + cache: npm + + - name: Install dependencies + run: npm install octokit + + - name: Run script + env: + TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + node .github/actions-scripts/use-the-api.mjs +``` + +Example JavaScript script, with the file path `.github/actions-scripts/use-the-api.mjs`: + +```javascript +import { Octokit } from "octokit"; + +const octokit = new Octokit({ {% ifversion ghes or ghae %} + baseUrl: "{% data variables.product.api_url_code %}",{% endif %} + auth: process.env.TOKEN, +}); + +await octokit.request("GET /octocat", {}); +``` + +Em vez de armazenar seu script em um arquivo separado e executar o script do seu fluxo de trabalho, você pode usar a ação `actions/github-script` para executar um script. Para obter mais informações, consulte [actions/github-script README](https://github.com/actions/github-script). + +```yaml +jobs: + use_api_via_script: + runs-on: ubuntu-latest + permissions: {} + steps: + - uses: {% data reusables.actions.action-github-script %} + with: + github-token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + script: | + await github.request('GET /octocat', {}) +``` + +{% endjavascript %} + +{% curl %} + +Você também pode usar a palavra-chave `executar` para executar comandos do cURL nos fluxos de trabalho {% data variables.product.prodname_actions %}. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." + +{% data variables.product.prodname_dotcom %} recomenda que você efetue a autenticação com o `GITHUB_TOKEN` integrado em vez de criar um token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." Para obter mais informações sobre segredos, consulte "[Segredos criptografados](/actions/security-guides/encrypted-secrets)". + +```yaml +jobs: + use_api: + runs-on: ubuntu-latest + permissions: {} + steps: + - env: + GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + curl --request GET \ + --url "https://api.github.com/octocat" \ + --header "Authorization: Bearer $GH_TOKEN" +``` + +{% endcurl %} + +## Usando cabeçalhos + +A maioria das operações especifica que você deve passar um cabeçalho `Aceitar` com um valor de `application/vnd.github.v3+json`. Outras operações podem especificar que você deve enviar um cabeçalho `Aceitar` diferente ou cabeçalhos adicionais. + +{% cli %} + +Para enviar um cabeçalho com {% data variables.product.prodname_cli %}, utilize o sinalizador `--header` ou `-H` seguido pelo formato de cabeçalho em `key: value`. + +```shell +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /octocat +``` + +{% endcli %} + +{% javascript %} + +A biblioteca do Octokit.js passa automaticamente o cabeçalho <`Accept: application/vnd.github.v3+json`. Para passar cabeçalhos adicionais ou um outro cabeçalho `Aceitar`, adicione uma propriedade de `cabeçalhos` ao objeto que é passado como um segundo argumento ao mpetodo de `solicitação`. O valor da propriedade dos `cabeçalhos` propriedade é um objeto com os nomes de cabeçalho como chaves e valores de cabeçalho como valores. Por exemplo, para enviar um cabeçalho `content-type` com um valor de `text/plain`: + +```javascript +await octokit.request("GET /octocat", { + headers: { + "content-type": "text/plain", + }, +}); +``` + +{% endjavascript %} + +{% curl %} + +Para enviar um cabeçalho com cURL, use o sinalizador `--header` ou `-H` seguido pelo cabeçalho no formato `key: value`. + +```shell +curl --request GET \ +--url "https://api.github.com/octocat" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" +``` + +{% endcurl %} + +## Usando parâmetros de caminho + +Os parâmetros de caminho modificam o caminho da operação. Por exemplo, o caminho "Listar problemas de repositório" é `/repos/{owner}/{repo}/issues`. As chaves `{}` denotam parâmetros de caminhos que você precisa especificar. Neste caso, você deve especificar o proprietário e o nome do repositório. Para a documentação de referência para esta operação, consulte "[Listar problemas com o repositório](/rest/issues/issues#list-repository-issues)". + +{% cli %} + +{% ifversion ghes or ghae %} +{% note %} + +**Observação:** Para que este comando funcione para {% data variables.product.product_location %}, substitua `octocat/Spoon-Knife` por um repositório pertencente ao {% data variables.product.product_location %}. Caso contrário, execute novamente o comando `gh login` para efetuar a autenticação em {% data variables.product.prodname_dotcom_the_website %} em vez de {% data variables.product.product_location %}. + +{% endnote %} {% endif %} -{% ifversion ghae %} -![Seleção de Token Pessoal](/assets/images/help/personal_token_ghae.png) +Para obter problemas do repositório `octocat/Spoon-Knife`, substitua `{owner}` por `octocat` e `{repo}` por `Spoon-Knife`. + +```shell +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues +``` + +{% endcli %} + +{% javascript %} + +{% ifversion ghes or ghae %} +{% note %} + +**Observação:** Para que este exemplo funcione para {% data variables.product.product_location %}, substitua `octocat/Spoon-Knife` por um repositório pertencente ao {% data variables.product.product_location %}. Caso contrário, crie uma nova instância `Octokit` e não especifique `baseURL`. + +{% endnote %} {% endif %} -As solicitações da API que usam um token de acesso pessoal vencido retornará a data de validade do token por meio do cabeçalho `GitHub-Authentication-Token-Expiration`. Você pode usar o cabeçalho nos seus scripts para fornecer uma mensagem de aviso quando o token estiver próximo da data de vencimento. +Ao fazer uma solicitação com Octokit.js, todos os parâmetros, incluindo os parâmetros de caminho, são passados em um objeto como o segundo argumento para o método `solicitação`. Para obter problemas do repositório `octocat/Spoon-Knife`, especifique `proprietário` como `octocat` e `repo` como `Spoon-Knife`. -### Obtenha seu próprio perfil de usuário - -Quando autenticado corretamente, você pode aproveitar as permissões associadas à sua conta em {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. Por exemplo, tente obter - -```shell -$ curl -i -u your_username:your_token {% data variables.product.api_url_pre %}/user - -> { -> ... -> "plan": { -> "space": 2516582, -> "collaborators": 10, -> "private_repos": 20, -> "name": "medium" -> } -> ... -> } +```javascript +await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife" +}); ``` -This time, in addition to the same set of public information we retrieved for [@defunkt][defunkt github] earlier, you should also see the non-public information for your user profile. Por exemplo, você verá um objeto `plano` na resposta, que fornece detalhes sobre o plano de {% data variables.product.product_name %} para a conta. +{% endjavascript %} -### Usar tokens do OAuth para aplicativos +{% curl %} -Os aplicativos que precisam ler ou escrever informações privadas usando a API em nome de outro usuário devem usar o [OAuth][oauth]. +Para obter problemas do repositório `octocat/Spoon-Knife`, substitua `{owner}` por `octocat` e `{repo}` por `Spoon-Knife`. Para criar o caminho completo, preencha a URL de base para a API REST de {% data variables.product.prodname_dotcom %}, `https://api.github.com`: `https://api.github.com/repos/octocat/Spoon-Knife/issues`. -O OAuth usa _tokens_. Os tokens fornecem dois grandes recursos: +{% ifversion ghes or ghae %} +{% note %} -* **Acesso revogável**: os usuários podem revogar a autorização a aplicativos de terceiros a qualquer momento -* **Acesso limitado**: os usuários podem revisar o acesso específico que um token fornecerá antes de autorizar um aplicativo de terceiros +**Observação:** Se você quiser usar {% data variables.product.product_location %} em vez de {% data variables.product.prodname_dotcom_the_website %}, use `{% data variables.product.api_url_code %}` em vez de `https://api.github.com` e substitua `[hostname]` pelo nome de {% data variables.product.product_location %}. Substitua `octocat/Spoon-Knife` por um repositório pertencente a {% data variables.product.product_location %}. -Os tokens devem ser criados por meio de um [fluxo web][webflow]. Um aplicativo envia os usuários para {% data variables.product.product_name %} para efetuar o login. {% data variables.product.product_name %} apresenta uma caixa de diálogo, que indica o nome do aplicativo, bem como o nível de acesso que o aplicativo tem uma após ser autorizado pelo usuário. Depois que um usuário autoriza o acesso, {% data variables.product.product_name %} redireciona o usuário de volta para o aplicativo: - -![Diálogo do GitHub's OAuth](/assets/images/oauth_prompt.png) - -**Trate os tokens de OAuth como senhas!** Não compartilhe-os com outros usuários ou armazene-os em lugares inseguros. Os tokens nestes exemplos são falsos e os nomes foram alterados para proteger os inocentes. - -Now that we've got the hang of making authenticated calls, let's move along to the [Repositories API][repos-api]. - -## Repositórios - -Quase qualquer uso significativo da {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API envolverá algum nível de informação do repositório. We can [`GET` repository details][get repo] in the same way we fetched user details earlier: +{% endnote %} +{% endif %} ```shell -$ curl -i {% data variables.product.api_url_pre %}/repos/twbs/bootstrap +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" ``` -In the same way, we can [view repositories for the authenticated user][user repos api]: +{% endcurl %} + +A operação retorna uma lista de problemas e dados sobre cada problema. Para obter mais informações sobre como usar a resposta, consulte a seção "[Usando a resposta](#using-the-response). + +## Usando parâmetros de consulta + +Os parâmetros de consulta permitem que você controle quais dados são retornados para uma solicitação. Por exemplo, um parâmetro de consulta pode permitir que você especifique quantos itens são retornados quando a resposta é paginada. + +Por padrão, a operação "Listar problemas do repositório" retorna trinta problemas, ordenados em ordem decrescente pela data em que eles foram criados. Você pode usar o parâmetro `per_page` para retornar dois problemas em vez de 30. Você pode usar o parâmetro `ordenar` para classificar os problemas pela data em que foram atualizados pela última vez de ordenar pela data em que foram criados. Você pode usar o parâmetro `direção` para classificar os resultados em ordem ascendente em vez de descemdente. + +{% cli %} + +Para {% data variables.product.prodname_cli %}, use o sinalizador `-F` para passar um parâmetro que é um número, booleano ou nulo. Use `-f` para passar parâmetros de string + +{% note %} + +**Observação**: {% data variables.product.prodname_cli %} no momento não aceita parâmetros que são matrizes. Para obter mais informações, consulte [este problema](https://github.com/cli/cli/issues/1484). + +{% endnote %} ```shell -$ curl -i -H "Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a" \ - {% data variables.product.api_url_pre %}/user/repos +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 -f sort=updated -f direction=asc ``` -Or, we can [list repositories for another user][other user repos api]: +{% endcli %} + +{% javascript %} + +Ao fazer uma solicitação com Octokit.js, todos os parâmetros, incluindo os parâmetros de consulta, são passados em um objeto como o segundo argumento para o método `solicitação`. + +```javascript +await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + per_page: 2, + sort: "updated", + direction: "asc", +}); +``` + +{% endjavascript %} + +{% curl %} + +Para o cURL, adicione um `?` ao final do caminho e, em seguida, anexe o nome e o valor do parâmetro de consulta na forma `parameter_name=value`. Separe os parâmetros múltiplos de consulta com `&`. ```shell -$ curl -i {% data variables.product.api_url_pre %}/users/octocat/repos +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2&sort=updated&direction=asc" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" ``` -Or, we can [list repositories for an organization][org repos api]: +{% endcurl %} + +A operação retorna uma lista de problemas e dados sobre cada problema. Para obter mais informações sobre como usar a resposta, consulte a seção "[Usando a resposta](#using-the-response). + +## Usando parâmetros do texto + +Os parâmetros do texto permitem que você passe dados adicionais para a API. Por exemplo, a operação "Criar um problema" exige que você especifique um título para o novo problema. Ela também permite especificar outras informações, como texto para colocar no texto do problema. Para a documentação completa de referência para esta operação, consulte "[Criar um problema](/rest/issues/issues#create-an-issue)". + +A operação "Criar um problema" usa o mesmo caminho da operação "Listar problemas de repositório" nos exemplos acima, mas usa um método `POST` em vez de um método `GET`. + +{% cli %} + +Para {% data variables.product.prodname_cli %}, use o sinalizador `-F` para passar um parâmetro que é um número, booleano ou nulo. Use `-f` para passar parâmetros de string + +{% note %} + +**Observação**: {% data variables.product.prodname_cli %} no momento não aceita parâmetros que são matrizes. Para obter mais informações, consulte [este problema](https://github.com/cli/cli/issues/1484). + +{% endnote %} ```shell -$ curl -i {% data variables.product.api_url_pre %}/orgs/octo-org/repos +gh api --header 'Accept: application/vnd.github.v3+json' --method POST /repos/octocat/Spoon-Knife/issues -f title="Created with the REST API" -f body="This is a test issue created by the REST API" ``` -As informações retornadas dessas chamadas dependerão de quais escopos o nosso token terá quando efetuarmos a autenticação: +{% endcli %} -{%- ifversion fpt or ghec or ghes %} -* A token with `public_repo` [scope][scopes] returns a response that includes all public repositories we have access to see on {% data variables.product.product_location %}. -{%- endif %} -* A token with `repo` [scope][scopes] returns a response that includes all {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories we have access to see on {% data variables.product.product_location %}. +{% javascript %} -As the [docs][repos-api] indicate, these methods take a `type` parameter that can filter the repositories returned based on what type of access the user has for the repository. Desta forma, podemos buscar apenas repositórios de propriedade direta, repositórios da organização ou repositórios nos quais o usuário colabora por meio de uma equipe. +Ao fazer uma solicitação com Octokit.js, todos os parâmetros, incluindo os parâmetros de texto, são passados em um objeto como o segundo argumento para o método `solicitação`. + +```javascript +await octokit.request("POST /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + title: "Created with the REST API", + body: "This is a test issue created by the REST API", +}); +``` + +{% endjavascript %} + +{% curl %} + +Para o cURL, use o sinalizador `--data` para passar os parâmetros de texto em um objeto do JSON. ```shell -$ curl -i "{% data variables.product.api_url_pre %}/users/octocat/repos?type=owner" +curl --request POST \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" \ +--data '{ + "title": "Created with the REST API", + "body": "This is a test issue created by the REST API" +}' ``` -Neste exemplo, pegamos apenas os repositórios que o octocat possui, não os nos quais ela colabora. Observe a URL entre aspas acima. Dependendo de sua configuração do shell, a cURL às vezes exigirá uma URL entre aspas ou irá ignorar a string de consulta. +{% endcurl %} -### Criar um repositório +A operação cria um problema e retorna dados sobre o novo problema. Na resposta, encontre o `html_url` do seu problema e acesse o seu problema no navegador. Para obter mais informações sobre como usar a resposta, consulte a seção "[Usando a resposta](#using-the-response). -Buscar informações para repositórios existentes é um caso de uso comum, mas a -{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} A API é compatível com a criação de novos repositórios também. To [create a repository][create repo], -precisamos `POST` alguns JSON que contém informações e opções de configuração. +## Usando a resposta + +### Sobre o código de resposta e cabeçalhos + +Cada solicitação retornará um código de status HTTP que indica o sucesso da resposta. Para obter mais informações sobre códigos de resposta, consulte [a documentação de código de status de resposta de HTTP MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status). + +Além disso, a resposta incluirá cabeçalhos que fornecem mais detalhes sobre a resposta. Os cabeçalhos que começam com `X-` ou `x-` são personalizados para {% data variables.product.company_short %}. Por exemplo, os cabeçalhos `x-ratelimit-remaining` e `x-ratelimit-reset` mostram quantas solicitações você pode fazer em um período de tempo. + +{% cli %} + +Para ver o código de status e os cabeçalhos, use o sinalizador `--include` ou `--i` ao enviar sua solicitação. + +Por exemplo, essa solicitação: ```shell -$ curl -i -H "Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a" \ - -d '{ - "name": "blog", - "auto_init": true, - "private": true, - "gitignore_template": "nanoc" - }' \ - {% data variables.product.api_url_pre %}/user/repos +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 --include ``` -In this minimal example, we create a new private repository for our blog (to be served on [GitHub Pages][pages], perhaps). Embora o blogue {% ifversion not ghae %}seja público{% else %}, ele pode ser acessado por todos os integrantes da empresa{% endif %}, tornamos o repositório privado. In this single step, we'll also initialize it with a README and a [nanoc][nanoc]-flavored [.gitignore template][gitignore templates]. - -O repositório resultante será encontrado em `https://github.com//blog`. Para criar um repositório sob uma organização da qual você é proprietário, altere apenas o método API de `/user/repos` para `/orgs//repos`. - -Em seguida, vamos buscar nosso repositório recém-criado: +retorna o código de resposta e cabeçalhos como: ```shell -$ curl -i {% data variables.product.api_url_pre %}/repos/pengwynn/blog - -> HTTP/2 404 - -> { -> "message": "Not Found" -> } +HTTP/2.0 200 OK +Access-Control-Allow-Origin: * +Access-Control-Expose-Headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset +Cache-Control: private, max-age=60, s-maxage=60 +Content-Security-Policy: default-src 'none' +Content-Type: application/json; charset=utf-8 +Date: Thu, 04 Aug 2022 19:56:41 GMT +Etag: W/"a63dfbcfdb73621e9d2e89551edcf9856731ced534bd7f1e114a5da1f5f73418" +Link: ; rel="next", ; rel="last" +Referrer-Policy: origin-when-cross-origin, strict-origin-when-cross-origin +Server: GitHub.com +Strict-Transport-Security: max-age=31536000; includeSubdomains; preload +Vary: Accept, Authorization, Cookie, X-GitHub-OTP, Accept-Encoding, Accept, X-Requested-With +X-Accepted-Oauth-Scopes: repo +X-Content-Type-Options: nosniff +X-Frame-Options: deny +X-Github-Api-Version-Selected: 2022-08-09 +X-Github-Media-Type: github.v3; format=json +X-Github-Request-Id: 1C73:26D4:E2E500:1EF78F4:62EC2479 +X-Oauth-Client-Id: 178c6fc778ccc68e1d6a +X-Oauth-Scopes: gist, read:org, repo, workflow +X-Ratelimit-Limit: 15000 +X-Ratelimit-Remaining: 14996 +X-Ratelimit-Reset: 1659645499 +X-Ratelimit-Resource: core +X-Ratelimit-Used: 4 +X-Xss-Protection: 0 ``` -Ah não! Onde ele foi parar? Uma vez que criamos o repositório como _privado_, precisamos autenticá-lo para poder vê-lo. Se você é um usuário de HTTP, você pode esperar um `403`. Como não queremos vazar informações sobre repositórios privados, a API {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} retorna `404` neste caso, como se dissesse "não podemos nem confirmar nem negar a existência deste repositório". +Neste exemplo, o código de resposta é `200`, o que indica uma solicitação bem-sucedida. -## Problemas +{% endcli %} -A interface de usuário para problemas no {% data variables.product.product_name %} visa a fornecer fluxo de trabalho "apenas suficiente" enquanto permanece fora de seu caminho. With the {% data variables.product.product_name %} [Issues API][issues-api], you can pull data out or create issues from other tools to create a workflow that works for your team. +{% javascript %} -Assim como o github.com, a API fornece alguns métodos para exibir problemas para o usuário autenticado. To [see all your issues][get issues api], call `GET /issues`: +Ao fazer uma solicitação com o Octokit.js, o método `solicitação` retorna uma promessa. If the request was successful, the promise resolves to an object that includes the HTTP status code of the response (`status`) and the response headers (`headers`). If an error occurs, the promise resolves to an object that includes the HTTP status code of the response (`status`) and the response headers (`response.headers`). + +Você pode usar um bloco `try/catch` para capturar um erro, caso ocorra. Por exemplo, se o pedido no script seguinte for bem-sucedido, o script registrará o código de status e o valor do cabeçalho `x-ratelimit-restante`. If the request was not successful, the script will log the status code, the value of the `x-ratelimit-remaining` header, and the error message. + +```javascript +try { + const result = await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + per_page: 2, + }); + + console.log(`Success! Status: ${result.status}. Rate limit remaining: ${result.headers["x-ratelimit-remaining"]}`) + +} catch (error) { + console.log(`Error! Status: ${error.status}. Rate limit remaining: ${error.headers["x-ratelimit-remaining"]}. Message: ${error.response.data.message}`) +} +``` + +{% endjavascript %} + +{% curl %} + +Para ver o código de status e os cabeçalhos, use o sinalizador `--include` ou `--i` ao enviar sua solicitação. + +Por exemplo, essa solicitação: ```shell -$ curl -i -H "Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a" \ - {% data variables.product.api_url_pre %}/issues +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" \ +--include ``` -To get only the [issues under one of your {% data variables.product.product_name %} organizations][get issues api], call `GET -/orgs//issues`: +retorna o código de resposta e cabeçalhos como: ```shell -$ curl -i -H "Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a" \ - {% data variables.product.api_url_pre %}/orgs/rails/issues +HTTP/2 200 +server: GitHub.com +date: Thu, 04 Aug 2022 20:07:51 GMT +content-type: application/json; charset=utf-8 +cache-control: public, max-age=60, s-maxage=60 +vary: Accept, Accept-Encoding, Accept, X-Requested-With +etag: W/"7fceb7e8c958d3ec4d02524b042578dcc7b282192e6c939070f4a70390962e18" +x-github-media-type: github.v3; format=json +link: ; rel="next", ; rel="last" +access-control-expose-headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset +access-control-allow-origin: * +strict-transport-security: max-age=31536000; includeSubdomains; preload +x-frame-options: deny +x-content-type-options: nosniff +x-xss-protection: 0 +referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin +content-security-policy: default-src 'none' +x-ratelimit-limit: 15000 +x-ratelimit-remaining: 14996 +x-ratelimit-reset: 1659645535 +x-ratelimit-resource: core +x-ratelimit-used: 4 +accept-ranges: bytes +content-length: 4936 +x-github-request-id: 14E0:4BC6:F1B8BA:208E317:62EC2715 ``` -We can also get [all the issues under a single repository][repo issues api]: +Neste exemplo, o código de resposta é `200`, o que indica uma solicitação bem-sucedida. + +{% endcurl %} + +### Sobre o texto de resposta + +Muitas operações retornarão um texto de resposta. A menos que seja especificado, o texto da resposta está em formato JSON. Por exemplo, esta solicitação retorna uma lista de problemas com dados sobre cada problema: + +{% cli %} ```shell -$ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 ``` -### Paginação +{% endcli %} -Um projeto do tamanho de Rails tem milhares de problemas. We'll need to [paginate][pagination], making multiple API calls to get the data. Vamos repetir essa última chamada, anotando os cabeçalhos de resposta: +{% javascript %} + +```javascript +await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + per_page: 2, +}); +``` + +{% endjavascript %} + +{% curl %} ```shell -$ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues - -> HTTP/2 200 - -> ... -> Link: <{% data variables.product.api_url_pre %}/repositories/8514/issues?page=2>; rel="next", <{% data variables.product.api_url_pre %}/repositories/8514/issues?page=30>; rel="last" -> ... +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" ``` -The [`Link` header][link-header] provides a way for a response to link to external resources, in this case additional pages of data. Como nossa chamada encontrou mais de trinta problemas (o tamanho da página padrão), a API nos informa onde podemos encontrar a próxima página e a última página de resultados. +{% endcurl %} -### Criar um problema +Unlike the GraphQL API where you specify what information you want, the REST API typically returns more information than you need. If desired, you can parse the response to pull out specific pieces of information. -Now that we've seen how to paginate lists of issues, let's [create an issue][create issue] from the API. +{% cli %} -Para criar um problema, precisamos estar autenticados. Portanto, passaremos um token do OAuth no cabeçalho. Além disso, passaremos o título, texto, e as etiquetas no texto do JSON para o caminho `/issues` abaixo do repositório em que queremos criar o problema: +For example, you can use `>` to redirect the response to a file: ```shell -$ curl -i -H 'Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a' \ -$ -d '{ \ -$ "title": "New logo", \ -$ "body": "We should have one", \ -$ "labels": ["design"] \ -$ }' \ -$ {% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/issues - -> HTTP/2 201 -> Location: {% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/issues/17 -> X-RateLimit-Limit: 5000 - -> { -> "pull_request": { -> "patch_url": null, -> "html_url": null, -> "diff_url": null -> }, -> "created_at": "2012-11-14T15:25:33Z", -> "comments": 0, -> "milestone": null, -> "title": "New logo", -> "body": "We should have one", -> "user": { -> "login": "pengwynn", -> "gravatar_id": "7e19cd5486b5d6dc1ef90e671ba52ae0", -> "avatar_url": "https://secure.gravatar.com/avatar/7e19cd5486b5d6dc1ef90e671ba52ae0?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", -> "id": 865, -> "url": "{% data variables.product.api_url_pre %}/users/pengwynn" -> }, -> "closed_at": null, -> "updated_at": "2012-11-14T15:25:33Z", -> "number": 17, -> "closed_by": null, -> "html_url": "https://github.com/pengwynn/api-sandbox/issues/17", -> "labels": [ -> { -> "color": "ededed", -> "name": "design", -> "url": "{% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/labels/design" -> } -> ], -> "id": 8356941, -> "assignee": null, -> "state": "open", -> "url": "{% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/issues/17" -> } +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 > data.json ``` -A resposta nos dá algumas indicações sobre a questão recém-criada, tanto no cabeçalho de resposta da `Localização` quanto no campo `url` da resposta do JSON. - -## Solicitações condicionais - -Uma grande parte de ser um bom cidadão da API é respeitar os limites de taxa por meio de armazenamento de informações que não mudaram. The API supports [conditional requests][conditional-requests] and helps you do the right thing. Considere a primeira chamada de que fizemos para obter o perfil de defunkt: +Em seguida, você pode usar jq para obter o título e o ID do autor de cada problema: ```shell -$ curl -i {% data variables.product.api_url_pre %}/users/defunkt - -> HTTP/2 200 -> etag: W/"61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0" +jq '.[] | {title: .title, authorID: .user.id}' data.json ``` -Além do texto do JSON, anote o código de status de HTTP de `200` e o cabeçalho `ETag`. The [ETag][etag] is a fingerprint of the response. Se passarmos isso em chamadas subsequentes, podemos dizer à API para nos dar o recurso novamente, somente se tiver mudado: +Os dois comandos anteriores retornam algo parecido a: + +``` +{ + "title": "Update index.html", + "authorID": 10701255 +} +{ + "title": "Edit index file", + "authorID": 53709285 +} +``` + +Para obter mais informações sobre jq, consulte [a documentação do jq](https://stedolan.github.io/jq/) e [jq play](https://jqplay.org/). + +{% endcli %} + +{% javascript %} + +Por exemplo, você pode obter o ID do autor e título de cada problema: + +```javascript +try { + const result = await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + per_page: 2, + }); + + const titleAndAuthor = result.data.map(issue => {title: issue.title, authorID: issue.user.id}) + + console.log(titleAndAuthor) + +} catch (error) { + console.log(`Error! Status: ${error.status}. Message: ${error.response.data.message}`) +} +``` + +{% endjavascript %} + +{% curl %} + +For example, you can use `>` to redirect the response to a file: ```shell -$ curl -i -H 'If-None-Match: "61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0"' \ -$ {% data variables.product.api_url_pre %}/users/defunkt - -> HTTP/2 304 +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" > data.json ``` -O status `304` indica que o recurso não mudou desde a última vez que pedimos e a resposta não conterá texto. As a bonus, `304` responses don't count against your [rate limit][rate-limiting]. +Em seguida, você pode usar jq para obter o título e o ID do autor de cada problema: -Agora você sabe o básico da API {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %}! +```shell +jq '.[] | {title: .title, authorID: .user.id}' data.json +``` -* Autenticação básica do & OAuth -* Buscar e criar de repositórios e problemas -* Solicitações condicionais +Os dois comandos anteriores retornam algo parecido a: -Keep learning with the next API guide [Basics of Authentication][auth guide]! +``` +{ + "title": "Update index.html", + "authorID": 10701255 +} +{ + "title": "Edit index file", + "authorID": 53709285 +} +``` -[wrappers]: /libraries/ -[curl]: http://curl.haxx.se/ -[oauth]: /apps/building-integrations/setting-up-and-registering-oauth-apps/ -[webflow]: /apps/building-oauth-apps/authorizing-oauth-apps/ -[scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ -[repos-api]: /rest/reference/repos -[repos-api]: /rest/reference/repos -[pages]: http://pages.github.com -[nanoc]: http://nanoc.ws/ -[gitignore templates]: https://github.com/github/gitignore -[issues-api]: /rest/reference/issues -[link-header]: https://www.w3.org/wiki/LinkHeader -[conditional-requests]: /rest#conditional-requests -[rate-limiting]: /rest/overview/resources-in-the-rest-api#rate-limit-http-headers -[rate-limiting]: /rest/overview/resources-in-the-rest-api#rate-limit-http-headers -[users api]: /rest/reference/users#get-a-user -[defunkt github]: https://github.com/defunkt -[defunkt github]: https://github.com/defunkt -[json]: http://en.wikipedia.org/wiki/JSON -[authentication]: /rest#authentication -[personal token]: /articles/creating-an-access-token-for-command-line-use -[personal token]: /articles/creating-an-access-token-for-command-line-use -[tokens settings]: https://github.com/settings/tokens -[pagination]: /rest#pagination -[get repo]: /rest/reference/repos#get-a-repository -[create repo]: /rest/reference/repos#create-a-repository-for-the-authenticated-user -[create issue]: /rest/reference/issues#create-an-issue -[auth guide]: /guides/basics-of-authentication -[user repos api]: /rest/reference/repos#list-repositories-for-the-authenticated-user -[other user repos api]: /rest/reference/repos#list-repositories-for-a-user -[org repos api]: /rest/reference/repos#list-organization-repositories -[get issues api]: /rest/reference/issues#list-issues-assigned-to-the-authenticated-user -[get issues api]: /rest/reference/issues#list-issues-assigned-to-the-authenticated-user -[repo issues api]: /rest/reference/issues#list-repository-issues -[etag]: http://en.wikipedia.org/wiki/HTTP_ETag +Para obter mais informações sobre jq, consulte [a documentação do jq](https://stedolan.github.io/jq/) e [jq play](https://jqplay.org/). + +{% endcurl %} + +## Próximas etapas + +Este artigo demonstrou como listar e criar problemas em um repositório. Para mais adquirir prática, tente comentar sobre um problema, editar o título de um problema ou fechar um problema. Para obter mais informações sobre essas operações, consulte "[Criar um comentário de problema](/rest/issues#create-an-issue-comment)" e "[Atualizar um problema](/rest/issues/issues#update-an-issue)". + +Para obter mais informações sobre as operações que você pode usar, consulte a [documentação de referência de REST](/rest). diff --git a/translations/pt-BR/content/rest/index.md b/translations/pt-BR/content/rest/index.md index e71c82453c..9242b32bba 100644 --- a/translations/pt-BR/content/rest/index.md +++ b/translations/pt-BR/content/rest/index.md @@ -3,7 +3,8 @@ title: API de REST do GitHub shortTitle: API REST intro: 'Para criar integrações, recuperar dados e automatizar seus fluxos de trabalho, crie com a API REST de {% data variables.product.prodname_dotcom %}.' introLinks: - quickstart: /rest/guides/getting-started-with-the-rest-api + quickstart: /rest/quickstart + overview: /rest/guides/getting-started-with-the-rest-api featuredLinks: guides: - /rest/guides/getting-started-with-the-rest-api @@ -31,6 +32,7 @@ versions: ghae: '*' ghec: '*' children: + - /quickstart - /overview - /guides - /actions diff --git a/translations/pt-BR/content/rest/orgs/security-managers.md b/translations/pt-BR/content/rest/orgs/security-managers.md index 9385167d76..09febe3b35 100644 --- a/translations/pt-BR/content/rest/orgs/security-managers.md +++ b/translations/pt-BR/content/rest/orgs/security-managers.md @@ -1,10 +1,10 @@ --- -title: Security Managers +title: Gerentes de segurança intro: '' versions: fpt: '*' ghes: '>=3.7' - ghae: 'issue-7691' + ghae: issue-7691 ghec: '*' topics: - API diff --git a/translations/pt-BR/content/rest/projects/cards.md b/translations/pt-BR/content/rest/projects/cards.md index 893d6413c5..76af8dae46 100644 --- a/translations/pt-BR/content/rest/projects/cards.md +++ b/translations/pt-BR/content/rest/projects/cards.md @@ -1,8 +1,8 @@ --- -title: '{% data variables.product.prodname_project_v1_caps %} cards' +title: 'Cartões de {% data variables.product.prodname_project_v1_caps %}' shortTitle: Cartões allowTitleToDifferFromFilename: true -intro: 'The {% data variables.product.prodname_project_v1 %} cards API lets you create and manage cards on a {% data variables.projects.projects_v1_board %}.' +intro: 'A API de cartões de {% data variables.product.prodname_project_v1 %} permite que você crie e gerencie cartões em um {% data variables.projects.projects_v1_board %}.' versions: fpt: '*' ghes: '*' diff --git a/translations/pt-BR/content/rest/projects/collaborators.md b/translations/pt-BR/content/rest/projects/collaborators.md index 1f9ddf287a..c8673b69a2 100644 --- a/translations/pt-BR/content/rest/projects/collaborators.md +++ b/translations/pt-BR/content/rest/projects/collaborators.md @@ -1,8 +1,8 @@ --- -title: '{% data variables.product.prodname_project_v1_caps %} collaborators' +title: 'colaboradores de {% data variables.product.prodname_project_v1_caps %}' shortTitle: Colaboradores allowTitleToDifferFromFilename: true -intro: 'The {% data variables.product.prodname_project_v1 %} collaborators API lets you manage collaborators on a {% data variables.projects.projects_v1_board %}.' +intro: 'A API de colaboradores de {% data variables.product.prodname_project_v1 %} permite que você gerencie os colaboradores em um {% data variables.projects.projects_v1_board %}.' versions: fpt: '*' ghes: '*' diff --git a/translations/pt-BR/content/rest/projects/columns.md b/translations/pt-BR/content/rest/projects/columns.md index fabf2f3daf..390e1daaff 100644 --- a/translations/pt-BR/content/rest/projects/columns.md +++ b/translations/pt-BR/content/rest/projects/columns.md @@ -1,8 +1,8 @@ --- -title: '{% data variables.product.prodname_project_v1_caps %} columns' +title: 'colunas de {% data variables.product.prodname_project_v1_caps %}' shortTitle: Colunas allowTitleToDifferFromFilename: true -intro: 'The {% data variables.product.prodname_project_v1 %} columns API lets you create and manage columns on a {% data variables.projects.projects_v1_board %}.' +intro: 'A API de colunas {% data variables.product.prodname_project_v1 %} permite que você crie e gerencie as colunas em um {% data variables.projects.projects_v1_board %}.' versions: fpt: '*' ghes: '*' diff --git a/translations/pt-BR/content/rest/projects/index.md b/translations/pt-BR/content/rest/projects/index.md index 7064fbb384..376f470c15 100644 --- a/translations/pt-BR/content/rest/projects/index.md +++ b/translations/pt-BR/content/rest/projects/index.md @@ -1,6 +1,6 @@ --- title: '{% data variables.product.prodname_projects_v1_caps %}' -intro: 'The {% data variables.product.prodname_projects_v1 %} API lets you create, list, update, delete and customize {% data variables.projects.projects_v1_boards %}.' +intro: 'A API de {% data variables.product.prodname_projects_v1 %} permite que você crie, liste, atualize, esxclua e personalize {% data variables.projects.projects_v1_boards %}.' redirect_from: - /v3/projects - /rest/reference/projects diff --git a/translations/pt-BR/content/rest/projects/projects.md b/translations/pt-BR/content/rest/projects/projects.md index 64cddc91ad..e4fa7aa4d4 100644 --- a/translations/pt-BR/content/rest/projects/projects.md +++ b/translations/pt-BR/content/rest/projects/projects.md @@ -2,7 +2,7 @@ title: '{% data variables.product.prodname_projects_v1_caps %}' shortTitle: Quadros allowTitleToDifferFromFilename: true -intro: 'The {% data variables.product.prodname_projects_v1 %} API lets you create and manage {% data variables.projects.projects_v1_boards %} in a repository.' +intro: 'A API de {% data variables.product.prodname_projects_v1 %} permite criar e gerenciar {% data variables.projects.projects_v1_boards %} em um repositório.' versions: fpt: '*' ghes: '*' diff --git a/translations/pt-BR/content/rest/quickstart.md b/translations/pt-BR/content/rest/quickstart.md new file mode 100644 index 0000000000..70914d0a04 --- /dev/null +++ b/translations/pt-BR/content/rest/quickstart.md @@ -0,0 +1,351 @@ +--- +title: Início rápido para a API REST do GitHub +intro: 'Saiba como começar com a API REST de {% data variables.product.prodname_dotcom %}.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +shortTitle: QuickStart +topics: + - API +redirect_from: + - /guides/getting-started + - /v3/guides/getting-started +miniTocMaxHeadingLevel: 3 +--- + +Esse artigo descreve como começar rapidamente com a API REST de {% data variables.product.prodname_dotcom %} usando {% data variables.product.prodname_cli %}, JavaScript ou cURL. Para um guia mais detalhado, consulte "[Primeiros passos com a API REST](/rest/guides/getting-started-with-the-rest-api)." + +{% cli %} + +## Primeiros passos para usar o {% data variables.product.prodname_cli %} + +### Usando {% data variables.product.prodname_cli %} na linha de comando + +{% data variables.product.prodname_cli %} is the easiest way to use the {% data variables.product.prodname_dotcom %} REST API from the command line. + +1. Install {% data variables.product.prodname_cli %} if you haven't installed it yet. For installation instructions, see the [{% data variables.product.prodname_cli %} repository](https://github.com/cli/cli#installation). +1. Use the `auth login` subcommand to authenticate to {% data variables.product.prodname_cli %}. For more information, see the [{% data variables.product.prodname_cli %} `auth login` documentation](https://cli.github.com/manual/gh_auth_login). + + ```shell + gh auth login + ``` + +1. Use the `api` subcommand to make your API request. For more information, see the [{% data variables.product.prodname_cli %} `api` documentation](https://cli.github.com/manual/gh_api). + + ```shell + gh api repos/octocat/Spoon-Knife/issues + ``` + +### Using {% data variables.product.prodname_cli %} in {% data variables.product.prodname_actions %} + +You can also use {% data variables.product.prodname_cli %} in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Using GitHub CLI in workflows](/actions/using-workflows/using-github-cli-in-workflows)." + +Instead of using the `gh auth login` command, pass an access token as an environment variable called `GH_TOKEN`. {% data variables.product.prodname_dotcom %} recommends that you use the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." Para obter mais informações sobre segredos, consulte "[Segredos criptografados](/actions/security-guides/encrypted-secrets)". + +```yaml +on: + workflow_dispatch: +jobs: + use_api: + runs-on: ubuntu-latest + permissions: + issues: read + steps: + - env: + GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + gh api repos/octocat/Spoon-Knife/issues +``` + +If you are authenticating with a {% data variables.product.prodname_github_app %}, you can create an installation access token within your workflow: + +1. Store your {% data variables.product.prodname_github_app %}'s ID as a secret. In the following example, replace `APP_ID` with the name of the secret. Você pode encontrar o ID do seu aplicativo na página de configurações do seu aplicativo ou por meio da API do aplicativo. Para obter mais informações, consulte "[Aplicativos](/rest/apps/apps#get-an-app)". Para obter mais informações sobre segredos, consulte "[Segredos criptografados](/actions/security-guides/encrypted-secrets)". +1. Gerar uma chave privada para o seu aplicativo. Store the contents of the resulting file as a secret. (Armazene todo o conteúdo do arquivo, incluindo `-----BEGIN RSA PRIVATE KEY-----` e `-----END RSA PRIVATE KEY-----`.) In the following example, replace `APP_PEM` with the name of the secret. Para obter mais informações, consulte "[Efetuando a autenticação com o {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)". +1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. Por exemplo: + +```yaml +{% data reusables.actions.actions-not-certified-by-github-comment %} + +on: + workflow_dispatch: +jobs: + track_pr: + runs-on: ubuntu-latest + steps: + - name: Generate token + id: generate_token + uses: tibdex/github-app-token@36464acb844fc53b9b8b2401da68844f6b05ebb0 + with: + app_id: {% raw %}${{ secrets.APP_ID }}{% endraw %} + private_key: {% raw %}${{ secrets.APP_PEM }}{% endraw %} + + - name: Use API + env: + GH_TOKEN: {% raw %}${{ steps.generate_token.outputs.token }}{% endraw %} + run: | + gh api repos/octocat/Spoon-Knife/issues +``` + +{% endcli %} + +{% javascript %} + +## Getting started using JavaScript + +You can use Octokit.js to interact with the {% data variables.product.prodname_dotcom %} REST API in your JavaScript scripts. For more information, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). + +### Using Octokit.js + +1. Create an access token. For example, create a personal access token (PAT) or a {% data variables.product.prodname_github_app %} user-to-server access token. For more information, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)" or "[Identifying and authorizing users for GitHub Apps](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps)." + + {% warning %} + + **Warning**: Treat your access token like a password. + + To keep your token secure, you can store your token as a secret and run your script through {% data variables.product.prodname_actions %}. For more information, see the "[Using Octokit.js in {% data variables.product.prodname_actions %}](#using-octokitjs-in-github-actions)" section. + + {%- ifversion fpt or ghec %} + + You can also store your token as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} + + If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. + + {% endwarning %} + +1. Install `octokit`. For example, `npm install octokit`. For other ways to install or load `octokit`, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). +1. Import `octokit` in your script. For example, `import { Octokit } from "octokit";`. For other ways to import `octokit`, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). +1. Create an instance of `Octokit` with your token. Replace `YOUR-TOKEN` with your token. + + ```javascript + const octokit = new Octokit({ + auth: 'YOUR-TOKEN' + }); + ``` + +1. Use `octokit.request` to execute your request. Send the HTTP method and path as the first argument. Specify any path, query, and body parameters in an object as the second argument. For example, in the following request the HTTP method is `GET`, the path is `/repos/{owner}/{repo}/issues`, and the parameters are `owner: "octocat"` and `repo: "Spoon-Knife"`. + + ```javascript + await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + }); + ``` + +### Using Octokit.js in {% data variables.product.prodname_actions %} + +You can also execute your JavaScript scripts in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." + +{% data variables.product.prodname_dotcom %} recommends that you use the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." Para obter mais informações sobre segredos, consulte "[Segredos criptografados](/actions/security-guides/encrypted-secrets)". + +The following example workflow: + +1. Checks out the repository content +1. Sets up Node.js +1. Installs `octokit` +1. Stores the value of `GITHUB_TOKEN` as an environment variable called `TOKEN` and runs `.github/actions-scripts/use-the-api.mjs`, which can access that environment variable as `process.env.TOKEN` + +Example workflow: + +```yaml +on: + workflow_dispatch: +jobs: + use_api_via_script: + runs-on: ubuntu-latest + permissions: + issues: read + steps: + - name: Check out repo content + uses: {% data reusables.actions.action-checkout %} + + - name: Setup Node + uses: {% data reusables.actions.action-setup-node %} + with: + node-version: '16.15.0' + cache: npm + + - name: Install dependencies + run: npm install octokit + + - name: Run script + run: | + node .github/actions-scripts/use-the-api.mjs + env: + TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} +``` + +Example JavaScript script, with the file path `.github/actions-scripts/use-the-api.mjs`: + +```javascript +import { Octokit } from "octokit" + +const octokit = new Octokit({ + auth: process.env.TOKEN +}); + +try { + const result = await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + }); + + const titleAndAuthor = result.data.map(issue => {title: issue.title, authorID: issue.user.id}) + + console.log(titleAndAuthor) + +} catch (error) { + console.log(`Error! Status: ${error.status}. Message: ${error.response.data.message}`) +} +``` + +If you are authenticating with a {% data variables.product.prodname_github_app %}, you can create an installation access token within your workflow: + +1. Store your {% data variables.product.prodname_github_app %}'s ID as a secret. In the following example, replace `APP_ID` with the name of the secret. Você pode encontrar o ID do seu aplicativo na página de configurações do seu aplicativo ou por meio da API do aplicativo. Para obter mais informações, consulte "[Aplicativos](/rest/apps/apps#get-an-app)". Para obter mais informações sobre segredos, consulte "[Segredos criptografados](/actions/security-guides/encrypted-secrets)". +1. Gerar uma chave privada para o seu aplicativo. Store the contents of the resulting file as a secret. (Armazene todo o conteúdo do arquivo, incluindo `-----BEGIN RSA PRIVATE KEY-----` e `-----END RSA PRIVATE KEY-----`.) In the following example, replace `APP_PEM` with the name of the secret. Para obter mais informações, consulte "[Efetuando a autenticação com o {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)". +1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. Por exemplo: + +```yaml +{% data reusables.actions.actions-not-certified-by-github-comment %} + +on: + workflow_dispatch: +jobs: + use_api_via_script: + runs-on: ubuntu-latest + steps: + - name: Check out repo content + uses: {% data reusables.actions.action-checkout %} + + - name: Setup Node + uses: {% data reusables.actions.action-setup-node %} + with: + node-version: '16.15.0' + cache: npm + + - name: Install dependencies + run: npm install octokit + + - name: Generate token + id: generate_token + uses: tibdex/github-app-token@36464acb844fc53b9b8b2401da68844f6b05ebb0 + with: + app_id: {% raw %}${{ secrets.APP_ID }}{% endraw %} + private_key: {% raw %}${{ secrets.APP_PEM }}{% endraw %} + + - name: Run script + run: | + node .github/actions-scripts/use-the-api.mjs + env: + TOKEN: {% raw %}${{ steps.generate_token.outputs.token }}{% endraw %} +``` + +{% endjavascript %} + +{% curl %} + +## Getting started using cURL + +### Using cURL in the command line + +{% note %} + +**Note:** If you want to make API requests from the command line, {% data variables.product.prodname_dotcom %} recommends that you use {% data variables.product.prodname_cli %}, which simplifies authentication and requests. For more information about getting started with the REST API using {% data variables.product.prodname_cli %}, see the {% data variables.product.prodname_cli %} version of this article. + +{% endnote %} + +1. Install cURL if cURL isn't already installed on your machine. To check if cURL is installed, execute `curl --version` in the command line. If the output is information about the cURL version, cURL is installed. If you get a message similar to `command not found: curl`, you need to download and install cURL. For more information, see [the cURL project download page](https://curl.se/download.html). +1. Create an access token. For example, create a personal access token (PAT) or a {% data variables.product.prodname_github_app %} user-to-server access token. For more information, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)" or "[Identifying and authorizing users for GitHub Apps](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps)." + + {% warning %} + + **Warning**: Treat your access token like a password. + + {%- ifversion fpt or ghec %} + + To keep your token secure, you can store your token as a {% data variables.product.prodname_codespaces %} secret and use the command line through {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} + + You can also use {% data variables.product.prodname_cli %} instead of cURL. {% data variables.product.prodname_cli %} will take care of authentication for you. For more information, see the {% data variables.product.prodname_cli %} version of this page. + + If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. + + {% endwarning %} + +1. Use the `cURL` command to make your request. Pass your token in an `Authorization` header. Replace `YOUR-TOKEN` with your token. + + ```shell + curl --request GET \ + --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ + --header "Accept: application/vnd.github.v3+json" \ + --header "Authorization: Bearer YOUR-TOKEN" + ``` + + {% note %} + + **Note:** In most cases, you can use `Authorization: Bearer` or `Authorization: token`. JSON web tokens (JWTs) only work with `Authorization: Bearer`. + + {% endnote %} + +### Using cURL in {% data variables.product.prodname_actions %} + +You can also use cURL in your {% data variables.product.prodname_actions %} workflows. + +{% data variables.product.prodname_dotcom %} recommends that you use the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." Para obter mais informações sobre segredos, consulte "[Segredos criptografados](/actions/security-guides/encrypted-secrets)". + +```yaml +on: + workflow_dispatch: +jobs: + use_api: + runs-on: ubuntu-latest + permissions: + issues: read + steps: + - env: + GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + curl --request GET \ + --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ + --header "Accept: application/vnd.github.v3+json" \ + --header "Authorization: Bearer $GH_TOKEN" +``` + +If you are authenticating with a {% data variables.product.prodname_github_app %}, you can create an installation access token within your workflow: + +1. Store your {% data variables.product.prodname_github_app %}'s ID as a secret. In the following example, replace `APP_ID` with the name of the secret. Você pode encontrar o ID do seu aplicativo na página de configurações do seu aplicativo ou por meio da API do aplicativo. Para obter mais informações, consulte "[Aplicativos](/rest/apps/apps#get-an-app)". Para obter mais informações sobre segredos, consulte "[Segredos criptografados](/actions/security-guides/encrypted-secrets)". +1. Gerar uma chave privada para o seu aplicativo. Store the contents of the resulting file as a secret. (Armazene todo o conteúdo do arquivo, incluindo `-----BEGIN RSA PRIVATE KEY-----` e `-----END RSA PRIVATE KEY-----`.) In the following example, replace `APP_PEM` with the name of the secret. Para obter mais informações, consulte "[Efetuando a autenticação com o {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)". +1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. Por exemplo: + +```yaml +{% data reusables.actions.actions-not-certified-by-github-comment %} + +on: + workflow_dispatch: +jobs: + use_api: + runs-on: ubuntu-latest + steps: + - name: Generate token + id: generate_token + uses: tibdex/github-app-token@36464acb844fc53b9b8b2401da68844f6b05ebb0 + with: + app_id: {% raw %}${{ secrets.APP_ID }}{% endraw %} + private_key: {% raw %}${{ secrets.APP_PEM }}{% endraw %} + + - name: Use API + env: + GH_TOKEN: {% raw %}${{ steps.generate_token.outputs.token }}{% endraw %} + run: | + curl --request GET \ + --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ + --header "Accept: application/vnd.github.v3+json" \ + --header "Authorization: Bearer $GH_TOKEN" +``` + +{% endcurl %} + +## Próximas etapas + +Para um guia mais detalhado, consulte "[Primeiros passos com a API REST](/rest/guides/getting-started-with-the-rest-api)." diff --git a/translations/pt-BR/content/rest/teams/external-groups.md b/translations/pt-BR/content/rest/teams/external-groups.md index 03ed927246..1ada12fe56 100644 --- a/translations/pt-BR/content/rest/teams/external-groups.md +++ b/translations/pt-BR/content/rest/teams/external-groups.md @@ -19,7 +19,7 @@ Para usar esta API, o usuário autenticado deve ser um mantenedor de equipe ou u **Notas:** -- A API de grupos externos está disponível apenas para organizações que fazem parte de uma empresa que usa {% data variables.product.prodname_emus %}. Para obter mais informações, consulte[Sobre usuários gerenciados pela empresa](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)". +- The external groups API is only available for organizations that are part of an enterprise using {% data variables.product.prodname_emus %}. Para obter mais informações, consulte[Sobre usuários gerenciados pela empresa](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)". - Se sua organização usar a sincronização de equipe, você poderá usar a API de sincronização de equipe. Para obter mais informações, consulte "[API de sincronização de equipe](#team-synchronization)". {% endnote %} diff --git a/translations/pt-BR/content/rest/webhooks/index.md b/translations/pt-BR/content/rest/webhooks/index.md index 12d70969a4..97fb7ce394 100644 --- a/translations/pt-BR/content/rest/webhooks/index.md +++ b/translations/pt-BR/content/rest/webhooks/index.md @@ -70,9 +70,9 @@ Solicitações do PubSubHubbub podem ser enviadas várias vezes. Se o hook já e #### Parâmetros -| Nome | Tipo | Descrição | -| -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `hub.mode` | `string` | **Obrigatório**. `Assine` ou `cancele a assinatura`. | -| `hub.topic` | `string` | **Obrigatório**. A URI do repositório do GitHub a ser assinada. O caminho deve estar no formato `/{owner}/{repo}/events/{event}`. | -| `hub.callback` | `string` | A URI para receber as atualizações do tópico. | -| `hub.secret` | `string` | Uma chave de segredo compartilhado que gera uma assinatura de hash do conteúdo de saída do texto. You can verify a push came from GitHub by comparing the raw request body with the contents of the {% ifversion fpt or ghes or ghec %}`X-Hub-Signature` or `X-Hub-Signature-256` headers{% elsif ghae %}`X-Hub-Signature-256` header{% endif %}. Você pode ver [a documentação do PubSubHubbub](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify) para obter mais informações. | +| Nome | Tipo | Descrição | +| -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `hub.mode` | `string` | **Obrigatório**. `Assine` ou `cancele a assinatura`. | +| `hub.topic` | `string` | **Obrigatório**. A URI do repositório do GitHub a ser assinada. O caminho deve estar no formato `/{owner}/{repo}/events/{event}`. | +| `hub.callback` | `string` | A URI para receber as atualizações do tópico. | +| `hub.secret` | `string` | Uma chave de segredo compartilhado que gera uma assinatura de hash do conteúdo de saída do texto. Você pode verificar se um push veio do GitHub comparando o texto da solicitação não processada com o conteúdo dos cabeçalhos {% ifversion fpt or ghes or ghec %}`X-Hub-Signature` ou `X-Hub-Signature-256` {% elsif ghae %}`X-Hub-Signature-256` cabeçalho{% endif %}. Você pode ver [a documentação do PubSubHubbub](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify) para obter mais informações. | diff --git a/translations/pt-BR/content/search-github/searching-on-github/finding-files-on-github.md b/translations/pt-BR/content/search-github/searching-on-github/finding-files-on-github.md index db96c2f487..fe598716c1 100644 --- a/translations/pt-BR/content/search-github/searching-on-github/finding-files-on-github.md +++ b/translations/pt-BR/content/search-github/searching-on-github/finding-files-on-github.md @@ -18,12 +18,12 @@ topics: **Dicas:** -- By default, file finder results exclude some directories like `build`, `log`, `tmp`, and `vendor`. To search for files in these directories, use the [`filename` code search qualifier](/search-github/searching-on-github/searching-code#search-by-filename).{% ifversion file-finder-exclusion-controls %} Alternatively, you can customize which directories are excluded by default [using a `.gitattributes` file](#customizing-excluded-files).{% endif %} +- Por padrão, os resultados da busca de arquivos excluem alguns diretórios como `criar`, `log`, `tmp` e `fornecedor`. To search for files in these directories, use the [`filename` code search qualifier](/search-github/searching-on-github/searching-code#search-by-filename).{% ifversion file-finder-exclusion-controls %} Alternatively, you can customize which directories are excluded by default [using a `.gitattributes` file](#customizing-excluded-files).{% endif %} - É possível também abrir o file finder (localizador de arquivos) digitando `t` no teclado. Para obter mais informações, consulte "[Atalhos de teclado](/articles/keyboard-shortcuts)". {% endtip %} -## Using the file finder +## Usando o buscador de arquivos {% data reusables.repositories.navigate-to-repo %} 2. Acima da lista de arquivos, clique em **Ir para o arquivo**. ![Botão Find file (Localizar arquivo)](/assets/images/help/search/find-file-button.png) @@ -32,9 +32,9 @@ topics: {% ifversion file-finder-exclusion-controls %} -## Customizing excluded files +## Personalizando arquivos excluídos -By default, file finder results do not include files in the following directories if they exist at your repository root: +Por padrão, os resultados do buscador de arquivos não incluem arquivos nos seguintes diretórios se eles existem na raiz do repositório: - `.git` - `.hg` @@ -46,22 +46,22 @@ By default, file finder results do not include files in the following directorie - `tmp` - `vendor` -You can override these default exclusions using a `.gitattributes` file. +Você pode substituir estas exclusões padrão usando um arquivo `.gitattributes`. -To do this, create or update a file called `.gitattributes` in your repository root, setting the [`linguist-generated`](https://github.com/github/linguist/blob/master/docs/overrides.md) attribute to `false` for each directory that should be included in file finder results. +Para fazer isso, crie ou atualize um arquivo denominado `.gitattributes` na raiz do seu repositório, definindo o atrivuto [`linguist-generated`](https://github.com/github/linguist/blob/master/docs/overrides.md) como `falso` para cada diretório que deve ser incluído nos resultados do busca de arquivos. -For example, the following `.gitattributes` file would cause files in the `build/` directory to be available to the file finder: +Por exemplo, o seguinte arquivo `.gitattributes` faria com que os arquivos no diretório `build/` estivessem disponíveis no gerenciador de arquivos: ``` build/** linguist-generated=false ``` -Note that this override requires the use of the recursive glob pattern (`**`). For more information, see "[pattern format](https://git-scm.com/docs/gitignore#_pattern_format)" in the Git documentation. More complex overrides of subdirectories within excluded-by-default directories are not supported. +Observe que esta substituição exige o uso do padrão glob recursivo (`**`). Para obter mais informações, consulte "[formato padrão](https://git-scm.com/docs/gitignore#_pattern_format)" na documentação do Git. As substituições mais complexas de subdiretórios dentro de diretórios excluídos por padrão não são compatíveis. {% endif %} ## Leia mais -- "[About searching on GitHub](/search-github/getting-started-with-searching-on-github/about-searching-on-github)"{% ifversion file-finder-exclusion-controls %} -- "[Customizing how changed files appear on GitHub](/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github)" -- [`.gitattributes`](https://git-scm.com/docs/gitattributes) in the Git documentation{% endif %} +- "[Sobre a pesquisa no GitHub](/search-github/getting-started-with-searching-on-github/about-searching-on-github)"{% ifversion file-finder-exclusion-controls %} +- "[Personalizando como arquivos alterados aparecem no GitHub](/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github)" +- [`.gitattributes`](https://git-scm.com/docs/gitattributes) na documentação do Git{% endif %} diff --git a/translations/pt-BR/content/site-policy/github-terms/github-community-code-of-conduct.md b/translations/pt-BR/content/site-policy/github-terms/github-community-code-of-conduct.md index 67b7c23fa5..92a231b993 100644 --- a/translations/pt-BR/content/site-policy/github-terms/github-community-code-of-conduct.md +++ b/translations/pt-BR/content/site-policy/github-terms/github-community-code-of-conduct.md @@ -1,5 +1,5 @@ --- -title: GitHub Community Code of Conduct +title: Código de Conduta da Comunidade GitHub redirect_from: - /articles/github-community-forum-code-of-conduct - /github/site-policy/github-community-forum-code-of-conduct @@ -16,7 +16,7 @@ topics: Milhões de desenvolvedores em todo o mundo hospedam milhões de projetos, tanto de código aberto como de código fechado, no GitHub. Nós temos sorte de poder participar da colaboração em toda a comunidade de desenvolvedores todos os dias que é uma responsabilidade que não aceitamos de de forma leviana. Juntos, todos nós temos a oportunidade interessante de fazer desta uma comunidade de que nos podemos orgulhar. -GitHub Community, powered by GitHub Discussions, is intended to be a place for further collaboration, support, and brainstorming. Este é um lugar civilizado para se conectar com outros usuários, aprender novas habilidades, compartilhar feedbacks e ideias e encontrar todo o suporte necessário para seus projetos do GitHub. By participating in GitHub Community, you are agreeing to the same [Terms of Service](/github/site-policy/github-terms-of-service/) and [GitHub Acceptable Use Policies](/github/site-policy/github-acceptable-use-policies) that apply to GitHub.com, as well as this GitHub Community-specific Code of Conduct. +A comunidade do GitHub, com base em Discussões do GitHub, destina-se a ser um lugar para mais colaboração, suporte e levantamento de ideias. Este é um lugar civilizado para se conectar com outros usuários, aprender novas habilidades, compartilhar feedbacks e ideias e encontrar todo o suporte necessário para seus projetos do GitHub. By participating in GitHub Community, you are agreeing to the same [Terms of Service](/github/site-policy/github-terms-of-service/) and [GitHub Acceptable Use Policies](/github/site-policy/github-acceptable-use-policies) that apply to GitHub.com, as well as this GitHub Community-specific Code of Conduct. With this Code of Conduct, we hope to help you understand how best to collaborate in GitHub Community, what you can expect from moderators, and what type of actions or content may result in temporary or permanent suspension from community participation. We will investigate any abuse reports and may moderate public content within GitHub Community that we determine to be in violation of either the GitHub Terms of Service or this Code of Conduct. diff --git a/translations/pt-BR/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md b/translations/pt-BR/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md index 94d34f2600..328e5c22c2 100644 --- a/translations/pt-BR/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md +++ b/translations/pt-BR/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md @@ -174,7 +174,7 @@ c/o Corporation Service Company 2710 Gateway Oaks Drive, Suite 150N Sacramento, CA 95833-3505 ``` -Courtesy copies may be emailed to legal-support@github.com +Cópias de cortesia podem ser enviadas para legal-support@github.com Por favor, faça suas solicitações da forma mais específica e breve quanto for possível, incluindo as seguintes informações: diff --git a/translations/pt-BR/content/site-policy/privacy-policies/github-privacy-statement.md b/translations/pt-BR/content/site-policy/privacy-policies/github-privacy-statement.md index 97b0499ba3..d0573033e7 100644 --- a/translations/pt-BR/content/site-policy/privacy-policies/github-privacy-statement.md +++ b/translations/pt-BR/content/site-policy/privacy-policies/github-privacy-statement.md @@ -289,22 +289,22 @@ Embora a tabela abaixo contenha informações sobre as categorias de informaçõ | Dados de geolocalização (como qualquer informação coletada após dar aos usuários a oportunidade de optar por serviços baseados na localização, que dependem dos serviços de localização precisos de um dispositivo. ) | Informação que o consumidor fornece automaticamente através da interação com os nossos Serviços | | Informações de áudio, eletrônicas, visuais ou similares, como conteúdo e arquivos enviados para o Serviço. | Informações que o consumidor pode optar por fornecer diretamente | | Informações profissionais ou de emprego | Informações que o consumidor pode optar por fornecer diretamente | -| Inferences drawn from any of the information identified in this table to create a profile about a consumer reflecting the consumer’s preferences | Informação que o consumidor fornece direta ou automaticamente através da interação com os nossos Serviços | +| Inferências extraídas de qualquer informação identificada nesta tabela para criar um perfil sobre um consumidor que reflete as preferências do consumidor | Informação que o consumidor fornece direta ou automaticamente através da interação com os nossos Serviços | -We use the categories of personal information described above for the purposes listed in the [“How GitHub uses your information”](/github/site-policy/github-privacy-statement#how-github-uses-your-information) section of our Privacy Statement. We also disclose the categories of personal information listed above for business purposes. Please see the [“How we share the information we collect”](/github/site-policy/github-privacy-statement#how-we-share-the-information-we-collect) section of our Privacy Statement for additional details. +Usamos as categorias de informações pessoais descritas acima para os fins listados na seção ["Como o GitHub usa suas informações"](/github/site-policy/github-privacy-statement#how-github-uses-your-information) da nossa Declaração de Privacidade. Também divulgamos as categorias de informações pessoais listadas acima para fins comerciais. Consulte a seção ["Como compartilhamos as informações que coletamos"](/github/site-policy/github-privacy-statement#how-we-share-the-information-we-collect) da nossa Declaração de Privacidade para obter detalhes adicionais. ### Não vendemos suas informações pessoais -De acordo com a CCPA, um negócio que consiste na venda de informações pessoais de residentes da Califórnia para outros: 1) deve avisar os residentes da Califórnia antes de vender suas informações pessoais para outros; e 2) deve fornecer o direito de opt-out (autoexclusão) pela venda de suas informações pessoais. GitHub does not sell personal information, including personal information of anyone under 16 years old. +De acordo com a CCPA, um negócio que consiste na venda de informações pessoais de residentes da Califórnia para outros: 1) deve avisar os residentes da Califórnia antes de vender suas informações pessoais para outros; e 2) deve fornecer o direito de opt-out (autoexclusão) pela venda de suas informações pessoais. O Github não vende informações pessoais, incluindo informações pessoais de menores de 16 anos. ### Seus direitos sob a CCPA A CCPA fornece aos residentes da Califórnia certos direitos relacionados às suas informações pessoais. Para enviar uma solicitação com base nesses direitos, entre em contato conosco por meio do nosso [formulário de contato](https://support.github.com/contact?tags=docs-policy). -Ao receber uma solicitação, verificaremos se o indivíduo que fez a solicitação é o residente a quem pertencem as informações pessoais sujeitas à solicitação. California residents may exercise their rights themselves or may use an authorized agent, designated in writing or through a power of attorney, to make requests on their behalf. If you use an authorized agent to submit a request, we may require that you provide us additional information demonstrating that the agent is acting on your behalf, and we may need you to verify your identity directly with us. With respect to your personal information, California residents may exercise the rights described below. -#### Right to Know. -You have a right to request that we disclose to you the personal information we have collected about you. Você também tem o direito de solicitar informações adicionais sobre nossa coleta, uso, divulgação ou venda dessas informações pessoais. Observe que fornecemos muitas dessas informações nesta declaração de privacidade. Você pode usar a API de Migração do Usuário GitHub para acessar e fazer o download dos seus dados. Saiba mais aqui. Você também pode fazer esse "pedido de conhecimento" entrando em contato conosco aqui. +Ao receber uma solicitação, verificaremos se o indivíduo que fez a solicitação é o residente a quem pertencem as informações pessoais sujeitas à solicitação. Os residentes da Califórnia podem exercer seus direitos eles mesmos ou utilizar um agente autorizado, designado por escrito ou por meio de um advogado, para fazer pedidos em seu nome. Se você usar um agente autorizado para enviar uma solicitação podemos exigir que você nos forneça informações adicionais que demonstrem que o agente está agindo em seu nome, e talvez seja necessário que você verifique sua identidade diretamente conosco. Com relação às suas informações pessoais, os residentes da Califórnia podem exercer os direitos descritos abaixo. +#### Direito de saber. +Você tem o direito de solicitar que divulgamos para você as informações pessoais que coletamos sobre você. Você também tem o direito de solicitar informações adicionais sobre nossa coleta, uso, divulgação ou venda dessas informações pessoais. Observe que fornecemos muitas dessas informações nesta declaração de privacidade. Você pode usar a API de Migração do Usuário GitHub para acessar e fazer o download dos seus dados. Saiba mais aqui. Você também pode fazer esse "pedido de conhecimento" entrando em contato conosco aqui. #### Direito de solicitar a exclusão. Você também tem o direito de solicitar que excluamos informações pessoais em certas circunstâncias, sujeitas a várias exceções. Para fazer um pedido de exclusão, você pode usar a API de migração de usuário do GitHub para acessar e fazer o download dos seus dados. Saiba mais aqui. Você também pode fazer esse "pedido de exclusão" entrando em contato conosco aqui. @@ -314,8 +314,8 @@ Você tem o direito de não participar de “vendas” futuras de informações #### Direito à não discriminação. Você tem o direito de não ser discriminado por exercer os seus direitos do CCPA. Não discriminaremos você pelo exercício dos seus direitos no âmbito do CCPA. -Você pode designar, por escrito ou por meio de advogado, um agente autorizado a fazer pedidos em seu nome para exercer seus direitos nos termos do CCPA. Antes de aceitar tal solicitação de um agente, exigimos que o agente forneça a prova que o autorizou a agir em seu nome, e talvez seja necessário que você verifique sua identidade diretamente conosco. Além disso, para fornecer ou excluir informações pessoais específicas, precisaremos verificar sua identidade de acordo com o grau de certeza exigido pela lei. Verificaremos a sua solicitação pedindo que você envie a solicitação do endereço de e-mail associado à sua conta ou exigindo que você forneça as informações necessárias para verificar sua conta. [Please note that you may use two-factor authentication with your GitHub account](/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication). -Finally, you have a right to receive notice of our practices at or before collection of personal information. +Você pode designar, por escrito ou por meio de advogado, um agente autorizado a fazer pedidos em seu nome para exercer seus direitos nos termos do CCPA. Antes de aceitar tal solicitação de um agente, exigimos que o agente forneça a prova que o autorizou a agir em seu nome, e talvez seja necessário que você verifique sua identidade diretamente conosco. Além disso, para fornecer ou excluir informações pessoais específicas, precisaremos verificar sua identidade de acordo com o grau de certeza exigido pela lei. Verificaremos a sua solicitação pedindo que você envie a solicitação do endereço de e-mail associado à sua conta ou exigindo que você forneça as informações necessárias para verificar sua conta. [Observeque você pode usar a autenticação de dois fatores com sua conta do GitHub.](/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication) +Por fim, você tem o direito de receber o aviso de nossas práticas durante ou antes da coleta de informações pessoais. Additionally, under California Civil Code section 1798.83, also known as the “Shine the Light” law, California residents who have provided personal information to a business with which the individual has established a business relationship for personal, family, or household purposes (“California Customers”) may request information about whether the business has disclosed personal information to any third parties for the third parties’ direct marketing purposes. Tenha em mente que não divulgamos informações pessoais a terceiros para fins de marketing direto, conforme definido nesta lei. California Customers may request further information about our compliance with this law by emailing **(privacy [at] github [dot] com)**. Observe que as empresas são obrigadas a responder a uma solicitação por cliente da Califórnia todos os anos e que talvez não seja necessário responder às solicitações por outros meios, além do endereço de e-mail designado. diff --git a/translations/pt-BR/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md b/translations/pt-BR/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md index 515fd465ff..a9a7e718c7 100644 --- a/translations/pt-BR/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md +++ b/translations/pt-BR/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md @@ -18,7 +18,7 @@ Data de entrada em vigor: **2 de abril de 2021** {% note %} -**Note:** Changes to the list of cookies on this page are currently pending. +**Observação:** As alterações para a lista de cookies nesta página estão pendentes. {% endnote %} @@ -26,7 +26,7 @@ O GitHub fornece um grande acordo de transparência em relação à forma como u ## Subprocessadores GitHub -Quando compartilhamos suas informações com terceiros subprocessadores, tais como nossos fornecedores e provedores de serviços, permanecemos responsáveis por elas. Trabalhamos muito duro para manter sua confiança quando trazemos novos fornecedores, e exigimos que todos os fornecedores se submetam a contratos de proteção de dados conosco que restringem seu processamento de Informações Pessoais dos Usuários (conforme definido na [Declaração de Privacidade](/articles/github-privacy-statement/)). You can sign up to receive subprocessor list updates [here](https://www.github.com/privacy/subprocessors). +Quando compartilhamos suas informações com terceiros subprocessadores, tais como nossos fornecedores e provedores de serviços, permanecemos responsáveis por elas. Trabalhamos muito duro para manter sua confiança quando trazemos novos fornecedores, e exigimos que todos os fornecedores se submetam a contratos de proteção de dados conosco que restringem seu processamento de Informações Pessoais dos Usuários (conforme definido na [Declaração de Privacidade](/articles/github-privacy-statement/)). Você pode se inscrever para receber atualizações da lista de subprocessadores [aqui](https://www.github.com/privacy/subprocessors). | Nome do subprocessador | Descrição do processamento | Local do Processamento | Localização corporativa | |:------------------------ |:--------------------------------------------------------------------------- |:---------------------- |:----------------------- | diff --git a/translations/pt-BR/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md b/translations/pt-BR/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md index 1a3b7b283e..a197a5a9ac 100644 --- a/translations/pt-BR/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md +++ b/translations/pt-BR/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md @@ -25,7 +25,7 @@ shortTitle: Patrocinar um contribuidor Você pode patrocinar uma conta em nome de sua conta de pessoal para investir em projetos dos quais você se beneficia pessoalmente. Você pode patrocinar uma conta em nome de sua organização por muitas razões. - Sustentar bibliotecas específicas das quais o trabalho da sua organização depende -- Investir no ecossistema com o qual você conta como uma organização (como a blockchain) +- Investing in the ecosystem you rely on as an organization (such as blockchain) - Desenvolver a conscientização da marca como uma organização que valoriza o código aberto - Agradecer aos desenvolvedores de código aberto para a criação de bibliotecas que complementam os produtos que a sua organização oferece diff --git a/translations/pt-BR/data/features/actions-oidc-hardening-config.yml b/translations/pt-BR/data/features/actions-oidc-hardening-config.yml new file mode 100644 index 0000000000..f3048bac8b --- /dev/null +++ b/translations/pt-BR/data/features/actions-oidc-hardening-config.yml @@ -0,0 +1,6 @@ +#Reference: #7336 +#General versioning for oidc hardening options +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' diff --git a/translations/pt-BR/data/features/actions-reusable-workflow-matrix.yml b/translations/pt-BR/data/features/actions-reusable-workflow-matrix.yml new file mode 100644 index 0000000000..6ab9b12b6b --- /dev/null +++ b/translations/pt-BR/data/features/actions-reusable-workflow-matrix.yml @@ -0,0 +1,7 @@ +#Reference: #7094 +#Documentation for allowing matrix jobs to call reusable workflows. +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7094' diff --git a/translations/pt-BR/data/features/bypass-branch-protections.yml b/translations/pt-BR/data/features/bypass-branch-protections.yml new file mode 100644 index 0000000000..d955962e56 --- /dev/null +++ b/translations/pt-BR/data/features/bypass-branch-protections.yml @@ -0,0 +1,7 @@ +#Issue: 6667 +#Description: Allow merging pull requests without complying with branch protection rules. +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-6667' diff --git a/translations/pt-BR/data/features/dependabot-alerts-dismissal-comment.yml b/translations/pt-BR/data/features/dependabot-alerts-dismissal-comment.yml new file mode 100644 index 0000000000..e2c2294cea --- /dev/null +++ b/translations/pt-BR/data/features/dependabot-alerts-dismissal-comment.yml @@ -0,0 +1,6 @@ +#Reference: Issue #7673 - Dependabot alerts: optional comment with dismissal - [GA] +versions: + fpt: '*' + ghec: '*' + ghes: '>3.6' + ghae: 'issue-7673' diff --git a/translations/pt-BR/data/features/dependabot-alerts-vulnerable-calls.yml b/translations/pt-BR/data/features/dependabot-alerts-vulnerable-calls.yml index 84825c368b..a7f772a7c5 100644 --- a/translations/pt-BR/data/features/dependabot-alerts-vulnerable-calls.yml +++ b/translations/pt-BR/data/features/dependabot-alerts-vulnerable-calls.yml @@ -3,5 +3,4 @@ versions: fpt: '*' ghec: '*' - ghes: '>3.5' ghae: 'issue-6076' diff --git a/translations/pt-BR/data/features/enterprise-namespace-repo-setting.yml b/translations/pt-BR/data/features/enterprise-namespace-repo-setting.yml new file mode 100644 index 0000000000..e20549f3ea --- /dev/null +++ b/translations/pt-BR/data/features/enterprise-namespace-repo-setting.yml @@ -0,0 +1,6 @@ +#Reference: #7757 +#Setting to disable personal namespace repo creation for EMUs, GHES 3.7+ and GHAE 3.7+ users +versions: + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7757' diff --git a/translations/pt-BR/data/features/ip-allow-list-address-check.yml b/translations/pt-BR/data/features/ip-allow-list-address-check.yml new file mode 100644 index 0000000000..c4dda87a70 --- /dev/null +++ b/translations/pt-BR/data/features/ip-allow-list-address-check.yml @@ -0,0 +1,3 @@ +versions: + ghec: '*' + ghae: 'issue-7818' diff --git a/translations/pt-BR/data/features/multiple-accounts-one-workstation.yml b/translations/pt-BR/data/features/multiple-accounts-one-workstation.yml new file mode 100644 index 0000000000..9fce93b34e --- /dev/null +++ b/translations/pt-BR/data/features/multiple-accounts-one-workstation.yml @@ -0,0 +1,5 @@ +#Issue #7330 +#Documentation for managing multiple GitHub accounts on one workstation +versions: + fpt: '*' + ghec: '*' diff --git a/translations/pt-BR/data/features/nested-reusable-workflow.yml b/translations/pt-BR/data/features/nested-reusable-workflow.yml new file mode 100644 index 0000000000..95d7cb5a56 --- /dev/null +++ b/translations/pt-BR/data/features/nested-reusable-workflow.yml @@ -0,0 +1,7 @@ +#Issues 7093 +#Reusable workflows can call other reusable workflows +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7093' diff --git a/translations/pt-BR/data/features/packages-npm-v2.yml b/translations/pt-BR/data/features/packages-npm-v2.yml new file mode 100644 index 0000000000..572e412e4a --- /dev/null +++ b/translations/pt-BR/data/features/packages-npm-v2.yml @@ -0,0 +1,5 @@ +#Issue 7039 +#npm Package Registry Improvements (v2) GA +versions: + fpt: '*' + ghec: '*' diff --git a/translations/pt-BR/data/features/push-protection-custom-link-orgs-beta.yml b/translations/pt-BR/data/features/push-protection-custom-link-orgs-beta.yml new file mode 100644 index 0000000000..509caa9fb4 --- /dev/null +++ b/translations/pt-BR/data/features/push-protection-custom-link-orgs-beta.yml @@ -0,0 +1,8 @@ +#Issue 7299 +#Push protection custom links beta flags +#See "push-protection-custom-link-orgs" for the feature +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7299' diff --git a/translations/pt-BR/data/features/push-protection-custom-link-orgs.yml b/translations/pt-BR/data/features/push-protection-custom-link-orgs.yml new file mode 100644 index 0000000000..fce23efa96 --- /dev/null +++ b/translations/pt-BR/data/features/push-protection-custom-link-orgs.yml @@ -0,0 +1,8 @@ +#Issue 7299 +#Push protection custom links +#See "push-protection-custom-link-orgs-beta" for the beta flags +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7299' diff --git a/translations/pt-BR/data/features/ssh-commit-verification.yml b/translations/pt-BR/data/features/ssh-commit-verification.yml new file mode 100644 index 0000000000..7851b1c8b7 --- /dev/null +++ b/translations/pt-BR/data/features/ssh-commit-verification.yml @@ -0,0 +1,8 @@ +#Reference: github/docs-content#6709 +#Initial docs for showing SSH signed commits as verified and +#uploading SSH signing keys +versions: + fpt: '*' + ghec: '*' + ghes: '>= 3.7' + ghae: '*' diff --git a/translations/pt-BR/data/features/streaming-datadog.yml b/translations/pt-BR/data/features/streaming-datadog.yml new file mode 100644 index 0000000000..ab90546c8d --- /dev/null +++ b/translations/pt-BR/data/features/streaming-datadog.yml @@ -0,0 +1,4 @@ +#Reference #7495 +#Documentation for audit log streaming to a Datadog endpoint +versions: + ghec: '*' diff --git a/translations/pt-BR/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml b/translations/pt-BR/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml index 816dab8647..ee5726c6de 100644 --- a/translations/pt-BR/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml +++ b/translations/pt-BR/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml @@ -154,13 +154,6 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: breaking owner: lukewar - - - location: ProjectNextFieldType.TASKS - description: '`TASKS` will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.' - reason: A API `ProjectNext` está obsoleta para favorecer a API `ProjectV2` que tem mais capacidade. - date: '2022-10-01T00:00:00+00:00' - criticality: breaking - owner: lukewar - location: ProjectNextFieldType.TEXT description: 'O `TEXT` será removido. Siga o guia ProjectV2 em https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ para encontrar um substituto adequado.' @@ -175,6 +168,13 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: breaking owner: lukewar + - + location: ProjectNextFieldType.TRACKS + description: 'O `TRACKS` será removido. Siga o guia ProjectV2 em https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ para encontrar um substituto adequado.' + reason: A API `ProjectNext` está obsoleta para favorecer a API `ProjectV2` que tem mais capacidade. + date: '2022-10-01T00:00:00+00:00' + criticality: breaking + owner: lukewar - location: RemovePullRequestFromMergeQueueInput.branch description: '`branch` será removido.' diff --git a/translations/pt-BR/data/graphql/ghec/graphql_upcoming_changes.public.yml b/translations/pt-BR/data/graphql/ghec/graphql_upcoming_changes.public.yml index 0c5216b822..f025d7e4e5 100644 --- a/translations/pt-BR/data/graphql/ghec/graphql_upcoming_changes.public.yml +++ b/translations/pt-BR/data/graphql/ghec/graphql_upcoming_changes.public.yml @@ -574,13 +574,6 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: breaking owner: lukewar - - - location: ProjectNextFieldType.TASKS - description: '`TASKS` will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.' - reason: A API `ProjectNext` está obsoleta para favorecer a API `ProjectV2` que tem mais capacidade. - date: '2022-10-01T00:00:00+00:00' - criticality: breaking - owner: lukewar - location: ProjectNextFieldType.TEXT description: 'O `TEXT` será removido. Siga o guia ProjectV2 em https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ para encontrar um substituto adequado.' @@ -595,6 +588,13 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: breaking owner: lukewar + - + location: ProjectNextFieldType.TRACKS + description: 'O `TRACKS` será removido. Siga o guia ProjectV2 em https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ para encontrar um substituto adequado.' + reason: A API `ProjectNext` está obsoleta para favorecer a API `ProjectV2` que tem mais capacidade. + date: '2022-10-01T00:00:00+00:00' + criticality: breaking + owner: lukewar - location: ProjectNextItem.content description: 'O `content` será removido. Siga o guia ProjectV2 em https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ para encontrar um substituto adequado.' @@ -994,6 +994,13 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: breaking owner: lukewar + - + location: ProjectView.groupedItems + description: 'O `groupedItems` será removido. Siga o guia ProjectV2 em https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ para encontrar um substituto adequado.' + reason: A API `ProjectNext` está obsoleta para favorecer a API `ProjectV2` que tem mais capacidade. + date: '2022-10-01T00:00:00+00:00' + criticality: breaking + owner: lukewar - location: ProjectView.items description: 'O `items` será removido. Siga o guia ProjectV2 em https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ para encontrar um substituto adequado.' diff --git a/translations/pt-BR/data/graphql/graphql_upcoming_changes.public.yml b/translations/pt-BR/data/graphql/graphql_upcoming_changes.public.yml index 0c5216b822..f025d7e4e5 100644 --- a/translations/pt-BR/data/graphql/graphql_upcoming_changes.public.yml +++ b/translations/pt-BR/data/graphql/graphql_upcoming_changes.public.yml @@ -574,13 +574,6 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: breaking owner: lukewar - - - location: ProjectNextFieldType.TASKS - description: '`TASKS` will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.' - reason: A API `ProjectNext` está obsoleta para favorecer a API `ProjectV2` que tem mais capacidade. - date: '2022-10-01T00:00:00+00:00' - criticality: breaking - owner: lukewar - location: ProjectNextFieldType.TEXT description: 'O `TEXT` será removido. Siga o guia ProjectV2 em https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ para encontrar um substituto adequado.' @@ -595,6 +588,13 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: breaking owner: lukewar + - + location: ProjectNextFieldType.TRACKS + description: 'O `TRACKS` será removido. Siga o guia ProjectV2 em https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ para encontrar um substituto adequado.' + reason: A API `ProjectNext` está obsoleta para favorecer a API `ProjectV2` que tem mais capacidade. + date: '2022-10-01T00:00:00+00:00' + criticality: breaking + owner: lukewar - location: ProjectNextItem.content description: 'O `content` será removido. Siga o guia ProjectV2 em https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ para encontrar um substituto adequado.' @@ -994,6 +994,13 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: breaking owner: lukewar + - + location: ProjectView.groupedItems + description: 'O `groupedItems` será removido. Siga o guia ProjectV2 em https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ para encontrar um substituto adequado.' + reason: A API `ProjectNext` está obsoleta para favorecer a API `ProjectV2` que tem mais capacidade. + date: '2022-10-01T00:00:00+00:00' + criticality: breaking + owner: lukewar - location: ProjectView.items description: 'O `items` será removido. Siga o guia ProjectV2 em https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ para encontrar um substituto adequado.' diff --git a/translations/pt-BR/data/learning-tracks/code-security.yml b/translations/pt-BR/data/learning-tracks/code-security.yml index 22db7b40dc..bac6b7fbfb 100644 --- a/translations/pt-BR/data/learning-tracks/code-security.yml +++ b/translations/pt-BR/data/learning-tracks/code-security.yml @@ -15,8 +15,8 @@ security_advisories: - /code-security/repository-security-advisories/removing-a-collaborator-from-a-repository-security-advisory #Feature available on dotcom and GHES 3.3+, so articles available on GHAE and earlier GHES hidden to hide the learning track dependabot_alerts: - title: 'Get notifications for insecure dependencies' - description: 'Set up Dependabot to alert you to new vulnerabilities{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %} in your dependencies.' + title: 'Receber notificações para dependências inseguras' + description: 'Configure o dependente para alertar você sobre novas vulnerabilidades{% ifversion GH-advisory-db-supports-malware %} ou malware{% endif %} em suas dependências.' guides: - /code-security/dependabot/dependabot-alerts/about-dependabot-alerts - '{% ifversion fpt or ghec or ghes > 3.2 %}/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository{% endif %}' diff --git a/translations/pt-BR/data/release-notes/enterprise-server/3-2/17.yml b/translations/pt-BR/data/release-notes/enterprise-server/3-2/17.yml index 4d76e62101..198fb8ef6a 100644 --- a/translations/pt-BR/data/release-notes/enterprise-server/3-2/17.yml +++ b/translations/pt-BR/data/release-notes/enterprise-server/3-2/17.yml @@ -7,3 +7,12 @@ sections: **HIGH**: Previously installed apps on user accounts were automatically granted permission to access an organization on scoped access tokens after the user account was transformed into an organization account. This vulnerability was reported via the [GitHub Bug Bounty program](https://bounty.github.com). bugs: - When a custom dormancy threshold was set for the instance, suspending all dormant users did not reliably respect the threshold. For more information about dormancy, see "[Managing dormant users](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)." + known_issues: + - Em uma instância de {% data variables.product.prodname_ghe_server %} recém-configurada sem usuários, um invasor pode criar o primeiro usuário administrador. + - As regras de firewall personalizadas são removidas durante o processo de atualização. + - Arquivos LFS do Git [enviados através da interface web](https://github.com/blog/2105-upload-files-to-your-repositories) são adicionados diretamente ao repositório e de forma incorreta. + - Os problemas não podem ser fechados se contiverem um permalink para um blob no mesmo repositório, onde o caminho do arquivo blob's é maior que 255 caracteres. + - Quando "Usuários podem pesquisar pelo GitHub.com" está habilitado com {% data variables.product.prodname_github_connect %}, os problemas nos repositórios privados e internos não são incluídos nos resultados de pesquisa de {% data variables.product.prodname_dotcom_the_website %}. + - O registro npm de {% data variables.product.prodname_registry %} não retorna mais o valor de tempo em respostas de metadados. Isso foi feito para permitir melhorias substanciais de desempenho. Continuamos a ter todos os dados necessários para devolver um valor de tempo como parte da resposta aos metadados e retomaremos o retorno desse valor no futuro, assim que tivermos resolvido os problemas de desempenho existentes. + - Os limites de recursos que são específicos para processamento de hooks pre-receive podem causar falha em alguns hooks pre-receive. + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/pt-BR/data/release-notes/enterprise-server/3-3/12.yml b/translations/pt-BR/data/release-notes/enterprise-server/3-3/12.yml index bdd7c88536..459f444aa0 100644 --- a/translations/pt-BR/data/release-notes/enterprise-server/3-3/12.yml +++ b/translations/pt-BR/data/release-notes/enterprise-server/3-3/12.yml @@ -9,3 +9,14 @@ sections: - When a custom dormancy threshold was set for the instance, suspending all dormant users did not reliably respect the threshold. For more information about dormancy, see "[Managing dormant users](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)." changes: - 'The enterprise audit log now includes more user-generated events, such as `project.create`. The REST API also returns additional user-generated events, such as `repo.create`. For more information, see "[Accessing the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)" and "[Using the audit log API for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)."' + known_issues: + - Após a atualização para {% data variables.product.prodname_ghe_server %} 3.3, {% data variables.product.prodname_actions %} pode não ser iniciado automaticamente. Para resolver esse problema, conecte-se ao dispositivo via SSH e execute o comando `ghe-actions-start`. + - Em uma instância de {% data variables.product.prodname_ghe_server %} recém-configurada sem usuários, um invasor pode criar o primeiro usuário administrador. + - As regras de firewall personalizadas são removidas durante o processo de atualização. + - Arquivos LFS do Git [enviados através da interface web](https://github.com/blog/2105-upload-files-to-your-repositories) são adicionados diretamente ao repositório e de forma incorreta. + - Os problemas não podem ser fechados se contiverem um permalink para um blob no mesmo repositório, onde o caminho do arquivo blob's é maior que 255 caracteres. + - Quando "Usuários podem pesquisar pelo GitHub.com" está habilitado com {% data variables.product.prodname_github_connect %}, os problemas nos repositórios privados e internos não são incluídos nos resultados de pesquisa de {% data variables.product.prodname_dotcom_the_website %}. + - O registro npm de {% data variables.product.prodname_registry %} não retorna mais o valor de tempo em respostas de metadados. Isso foi feito para permitir melhorias substanciais de desempenho. Continuamos a ter todos os dados necessários para devolver um valor de tempo como parte da resposta aos metadados e retomaremos o retorno desse valor no futuro, assim que tivermos resolvido os problemas de desempenho existentes. + - Os limites de recursos que são específicos para processamento de hooks pre-receive podem causar falha em alguns hooks pre-receive. + - 'As configurações de armazenamento de {% data variables.product.prodname_actions %} não podem ser validadas e salvas no {% data variables.enterprise.management_console %} quando "Forçar estilo de caminho" for selecionado e deverão ser definidas com a ferramenta de linha de comando `ghe-actions-precheck`.' + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/pt-BR/data/release-notes/enterprise-server/3-4/7.yml b/translations/pt-BR/data/release-notes/enterprise-server/3-4/7.yml index 4ac13d11b8..4829505056 100644 --- a/translations/pt-BR/data/release-notes/enterprise-server/3-4/7.yml +++ b/translations/pt-BR/data/release-notes/enterprise-server/3-4/7.yml @@ -12,3 +12,15 @@ sections: changes: - '`pre_receive_hook.rejected_push` events were not displayed in the enterprise audit log.' - Both migration archives for repositories and archive exports for user accounts include release reactions. + known_issues: + - Em uma instância de {% data variables.product.prodname_ghe_server %} recém-configurada sem usuários, um invasor pode criar o primeiro usuário administrador. + - As regras de firewall personalizadas são removidas durante o processo de atualização. + - Arquivos LFS do Git [enviados através da interface web](https://github.com/blog/2105-upload-files-to-your-repositories) são adicionados diretamente ao repositório e de forma incorreta. + - Os problemas não podem ser fechados se contiverem um permalink para um blob no mesmo repositório, onde o caminho do arquivo blob's é maior que 255 caracteres. + - Quando "Usuários podem pesquisar pelo GitHub.com" está habilitado com {% data variables.product.prodname_github_connect %}, os problemas nos repositórios privados e internos não são incluídos nos resultados de pesquisa de {% data variables.product.prodname_dotcom_the_website %}. + - O registro npm de {% data variables.product.prodname_registry %} não retorna mais o valor de tempo em respostas de metadados. Isso foi feito para permitir melhorias substanciais de desempenho. Continuamos a ter todos os dados necessários para devolver um valor de tempo como parte da resposta aos metadados e retomaremos o retorno desse valor no futuro, assim que tivermos resolvido os problemas de desempenho existentes. + - Os limites de recursos que são específicos para processamento de hooks pre-receive podem causar falha em alguns hooks pre-receive. + - | + Depois de registrar um executor auto-hospedado com o parâmetro `--ephemeral` em mais de um nível (por exemplo, tanto na empresa quanto na organização), o executor pode ficar preso em um estado ocioso e exigir o recadastro. [Atualizado: 2022-06-17] + - Depois de atualizar para {% data variables.product.prodname_ghe_server %} 3.4, as versões podem parecer ausentes nos repositórios. Isso pode ocorrer quando as migrações necessárias do índice Elasticsearch não tiverem sido concluídas com sucesso. + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/pt-BR/data/release-notes/enterprise-server/3-5/4.yml b/translations/pt-BR/data/release-notes/enterprise-server/3-5/4.yml index 2d66fe18bf..f27d5c371f 100644 --- a/translations/pt-BR/data/release-notes/enterprise-server/3-5/4.yml +++ b/translations/pt-BR/data/release-notes/enterprise-server/3-5/4.yml @@ -18,3 +18,13 @@ sections: - The light high contrast theme was unavailable in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3, but is now available in 3.5.4. For more information, see "[Managing your theme settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings)." changes: - '`pre_receive_hook.rejected_push` events were not displayed in the enterprise audit log.' + known_issues: + - Em uma instância de {% data variables.product.prodname_ghe_server %} recém-configurada sem usuários, um invasor pode criar o primeiro usuário administrador. + - As regras de firewall personalizadas são removidas durante o processo de atualização. + - Arquivos LFS do Git [enviados através da interface web](https://github.com/blog/2105-upload-files-to-your-repositories) são adicionados diretamente ao repositório e de forma incorreta. + - Os problemas não podem ser fechados se contiverem um permalink para um blob no mesmo repositório, onde o caminho do arquivo blob's é maior que 255 caracteres. + - Quando "Usuários podem pesquisar pelo GitHub.com" está habilitado com o GitHub Connect, os problemas em repositórios privados e internos não estão incluídos nos resultados de pesquisa do GitHub.com. + - O registro npm de {% data variables.product.prodname_registry %} não retorna mais o valor de tempo em respostas de metadados. Isso foi feito para permitir melhorias substanciais de desempenho. Continuamos a ter todos os dados necessários para devolver um valor de tempo como parte da resposta aos metadados e retomaremos o retorno desse valor no futuro, assim que tivermos resolvido os problemas de desempenho existentes. + - Os limites de recursos que são específicos para processamento de hooks pre-receive podem causar falha em alguns hooks pre-receive. + - Os serviços de ações precisam ser reiniciados após a restauração de um dispositivo de um backup em um host diferente. + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/pt-BR/data/release-notes/enterprise-server/3-6/0-rc1.yml b/translations/pt-BR/data/release-notes/enterprise-server/3-6/0-rc1.yml index 0e43202c58..28ecbcd03c 100644 --- a/translations/pt-BR/data/release-notes/enterprise-server/3-6/0-rc1.yml +++ b/translations/pt-BR/data/release-notes/enterprise-server/3-6/0-rc1.yml @@ -80,8 +80,6 @@ sections: notes: - | Enterprise owners on instances with a GitHub Advanced Security license can see an overview of Dependabot alerts for the entire instance, including a repository-centric view of application security risks, and an alert-centric view of all secret scanning and Dependabot alerts. The views are in beta and subject to change, and alert-centric views for code scanning are planned for a future release of GitHub Enterprise Server. For more information, see "[Viewing the security overview](/code-security/security-overview/viewing-the-security-overview#viewing-the-security-overview-for-an-enterprise)." - - | - Dependabot alerts show users if repository code calls vulnerable functions. Individual alerts display a "vulnerable call" label and code snippet, and users can filter search by `has:vulnerable-calls`. Vulnerable functions are curated during publication to the [GitHub Advisory Database](https://github.com/advisories). New incoming Python advisories will be supported, and GitHub is backfilling known vulnerable functions for historical Python advisories. After beta testing with Python, GitHub will add support for other ecosystems. For more information, see "[Viewing and updating Dependabot alerts](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts)." - | Users can select multiple Dependabot alerts, then dismiss or reopen or dismiss the alerts. For example, from the **Closed alerts** tab, you can select multiple alerts that have been previously dismissed, and then reopen them all at once. For more information, see "[About Dependabot alerts](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies)." - | diff --git a/translations/pt-BR/data/release-notes/enterprise-server/3-6/0.yml b/translations/pt-BR/data/release-notes/enterprise-server/3-6/0.yml index 052d93a50d..36076e85d1 100644 --- a/translations/pt-BR/data/release-notes/enterprise-server/3-6/0.yml +++ b/translations/pt-BR/data/release-notes/enterprise-server/3-6/0.yml @@ -79,8 +79,6 @@ sections: notes: - | Enterprise owners on instances with a GitHub Advanced Security license can see an overview of Dependabot alerts for the entire instance, including a repository-centric view of application security risks, and an alert-centric view of all secret scanning and Dependabot alerts. The views are in beta and subject to change, and alert-centric views for code scanning are planned for a future release of GitHub Enterprise Server. For more information, see "[Viewing the security overview](/code-security/security-overview/viewing-the-security-overview#viewing-the-security-overview-for-an-enterprise)." - - | - Dependabot alerts show users if repository code calls vulnerable functions. Individual alerts display a "vulnerable call" label and code snippet, and users can filter search by `has:vulnerable-calls`. Vulnerable functions are curated during publication to the [GitHub Advisory Database](https://github.com/advisories). New incoming Python advisories will be supported, and GitHub is backfilling known vulnerable functions for historical Python advisories. After beta testing with Python, GitHub will add support for other ecosystems. For more information, see "[Viewing and updating Dependabot alerts](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts)." - | Users can select multiple Dependabot alerts, then dismiss or reopen or dismiss the alerts. For example, from the **Closed alerts** tab, you can select multiple alerts that have been previously dismissed, and then reopen them all at once. For more information, see "[About Dependabot alerts](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies)." - | @@ -213,3 +211,4 @@ sections: - In a repository's settings, enabling the option to allow users with read access to create discussions does not enable this functionality. - In some cases, users cannot convert existing issues to discussions. - Custom patterns for secret scanning have `.*` as an end delimiter, specifically in the "After secret" field. This delimiter causes inconsistencies in scans for secrets across repositories, and you may notice gaps in a repository's history where no scans completed. Incremental scans may also be impacted. To prevent issues with scans, modify the end of the pattern to remove the `.*` delimiter. + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/pt-BR/data/reusables/accounts/create-personal-access-tokens.md b/translations/pt-BR/data/reusables/accounts/create-personal-access-tokens.md new file mode 100644 index 0000000000..c7b8790ed4 --- /dev/null +++ b/translations/pt-BR/data/reusables/accounts/create-personal-access-tokens.md @@ -0,0 +1 @@ +1. For each of your accounts, create a dedicated PAT with `repo` scope. Para obter mais informações, consulte "[Criando um token de acesso pessoal](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/actions/contacting-support.md b/translations/pt-BR/data/reusables/actions/contacting-support.md index 54009b10c5..931198eaba 100644 --- a/translations/pt-BR/data/reusables/actions/contacting-support.md +++ b/translations/pt-BR/data/reusables/actions/contacting-support.md @@ -5,5 +5,5 @@ Se você tiver comentários ou solicitações de recursos para {% data variables Contatar {% data variables.contact.contact_support %} para qualquer uma das seguintes opções, se o uso ou uso pretendido se enquadra nas categorias limite: * Se você acredita que sua conta foi restrita incorretamente -* Se você encontrar um erro inesperado ao executar uma de suas Ações, por exemplo: um ID exclusivo +* If you encounter an unexpected error when executing one of your actions * Se você encontrar uma situação onde o comportamento existente contradiz o esperado, mas nem sempre documentado, comportamento diff --git a/translations/pt-BR/data/reusables/actions/github_sha_description.md b/translations/pt-BR/data/reusables/actions/github_sha_description.md new file mode 100644 index 0000000000..6921c219c2 --- /dev/null +++ b/translations/pt-BR/data/reusables/actions/github_sha_description.md @@ -0,0 +1 @@ +Commit SHA que acionou o fluxo de trabalho. O valor do commit deste SHA depende do evento que acionou o fluxo de trabalho. Para obter mais informações, consulte "[Eventos que acionam fluxos de trabalho](/actions/using-workflows/events-that-trigger-workflows)". Por exemplo, `ffac537e6cbbf934b08745a378932722df287a53`. \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/actions/use-request-body-api.md b/translations/pt-BR/data/reusables/actions/use-request-body-api.md new file mode 100644 index 0000000000..1d37d0c4f0 --- /dev/null +++ b/translations/pt-BR/data/reusables/actions/use-request-body-api.md @@ -0,0 +1 @@ +To apply this configuration, submit a request to the API endpoint and include the required configuration in the request body. For more information, see "[Set the customization template for an OIDC subject claim for an organization](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization)". \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/advanced-security/custom-link-beta.md b/translations/pt-BR/data/reusables/advanced-security/custom-link-beta.md new file mode 100644 index 0000000000..a79fc22417 --- /dev/null +++ b/translations/pt-BR/data/reusables/advanced-security/custom-link-beta.md @@ -0,0 +1,5 @@ +{% note %} + +**Note:** The ability to add resource links to blocked push messages is currently in public beta and subject to change. + +{% endnote %} \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/advanced-security/secret-scanning-push-protection-org.md b/translations/pt-BR/data/reusables/advanced-security/secret-scanning-push-protection-org.md index 2b3424114a..51da1e8420 100644 --- a/translations/pt-BR/data/reusables/advanced-security/secret-scanning-push-protection-org.md +++ b/translations/pt-BR/data/reusables/advanced-security/secret-scanning-push-protection-org.md @@ -1,2 +1,6 @@ 1. Em "{% data variables.product.prodname_secret_scanning_caps %}", em "Proteção push", clique em **Habilitar todos**. ![Captura de tela que mostra como habilitar a proteção push para {% data variables.product.prodname_secret_scanning %} para uma organização](/assets/images/help/organizations/secret-scanning-enable-push-protection.png) -1. Opcionalmente, clique em "Habilitar automaticamente em repositórios privados adicionados ao {% data variables.product.prodname_secret_scanning %}." +1. Optionally, click "Automatically enable for private repositories added to {% data variables.product.prodname_secret_scanning %}."{% ifversion push-protection-custom-link-orgs %} +1. Optionally, to include a custom link in the message that members will see when they attempt to push a secret, select **Add a resource link in the CLI and web UI when a commit is blocked**, then type a URL, and click **Save link**. + {% ifversion push-protection-custom-link-orgs-beta %}{% indented_data_reference reusables.advanced-security.custom-link-beta spaces=3 %}{% endif %} + + ![Screenshot showing checkbox and text field for enabling a custom link](/assets/images/help/organizations/secret-scanning-custom-link.png){% endif %} \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/code-scanning/licensing-note.md b/translations/pt-BR/data/reusables/code-scanning/licensing-note.md index 475e59a7d4..8c1dc4e2af 100644 --- a/translations/pt-BR/data/reusables/code-scanning/licensing-note.md +++ b/translations/pt-BR/data/reusables/code-scanning/licensing-note.md @@ -1,8 +1,12 @@ {% note %} -**Note:** {% ifversion fpt %} -The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories. The {% data variables.product.prodname_codeql_cli %} is also available in private repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}. Para obter informações, consulte "[{% data variables.product.product_name %} Termos e Condições](https://securitylab.github.com/tools/codeql/license) de do CLI de {% data variables.product.prodname_codeql %} " e "[{% data variables.product.prodname_codeql %}](https://codeql.github.com/docs/codeql-cli/)". -{%- elsif ghec %} The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories that are maintained on {% data variables.product.prodname_dotcom_the_website %}, and available to use on private repositories that are owned by customers with an {% data variables.product.prodname_advanced_security %} license. Para obter informações, consulte "[{% data variables.product.product_name %} Termos e Condições](https://securitylab.github.com/tools/codeql/license) de do CLI de {% data variables.product.prodname_codeql %} " e "[{% data variables.product.prodname_codeql %}](https://codeql.github.com/docs/codeql-cli/)". -{%- elsif ghes or ghae %}O {% data variables.product.prodname_codeql_cli %} está disponível para clientes com uma licença de {% data variables.product.prodname_advanced_security %}. +**Notes:** {% ifversion fpt %} +- The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories. The {% data variables.product.prodname_codeql_cli %} is also available in private repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}. Para obter informações, consulte "[{% data variables.product.product_name %} Termos e Condições](https://securitylab.github.com/tools/codeql/license) de do CLI de {% data variables.product.prodname_codeql %} " e "[{% data variables.product.prodname_codeql %}](https://codeql.github.com/docs/codeql-cli/)". +{%- elsif ghec %} +- The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories that are maintained on {% data variables.product.prodname_dotcom_the_website %}, and available to use on private repositories that are owned by customers with an {% data variables.product.prodname_advanced_security %} license. Para obter informações, consulte "[{% data variables.product.product_name %} Termos e Condições](https://securitylab.github.com/tools/codeql/license) de do CLI de {% data variables.product.prodname_codeql %} " e "[{% data variables.product.prodname_codeql %}](https://codeql.github.com/docs/codeql-cli/)". +{%- elsif ghes or ghae %} +- O {% data variables.product.prodname_codeql_cli %} está disponível para os clientes com uma licença de {% data variables.product.prodname_advanced_security %}. {% endif %} +- {% data reusables.code-scanning.non-glibc-linux-support %} + {% endnote %} diff --git a/translations/pt-BR/data/reusables/code-scanning/non-glibc-linux-support.md b/translations/pt-BR/data/reusables/code-scanning/non-glibc-linux-support.md new file mode 100644 index 0000000000..2a1c2a8e53 --- /dev/null +++ b/translations/pt-BR/data/reusables/code-scanning/non-glibc-linux-support.md @@ -0,0 +1 @@ +The {% data variables.product.prodname_codeql_cli %} is currently not compatible with non-glibc Linux distributions such as (musl-based) Alpine Linux. \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/codespaces/availability.md b/translations/pt-BR/data/reusables/codespaces/availability.md deleted file mode 100644 index df1d8f27be..0000000000 --- a/translations/pt-BR/data/reusables/codespaces/availability.md +++ /dev/null @@ -1 +0,0 @@ -Codespaces are available for repositories owned by organizations using {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %}. diff --git a/translations/pt-BR/data/reusables/codespaces/click-remote-explorer-icon-vscode.md b/translations/pt-BR/data/reusables/codespaces/click-remote-explorer-icon-vscode.md index 2eacc3e212..e286675cee 100644 --- a/translations/pt-BR/data/reusables/codespaces/click-remote-explorer-icon-vscode.md +++ b/translations/pt-BR/data/reusables/codespaces/click-remote-explorer-icon-vscode.md @@ -1 +1,5 @@ -1. Em {% data variables.product.prodname_vscode_shortname %}, na barra lateral esquerda, clique no ícone Remote Explorer. ![O ícone do Remote Explorer em {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png) +1. Em {% data variables.product.prodname_vscode_shortname %}, na barra lateral esquerda, clique no ícone Remote Explorer. + + ![O ícone do Remote Explorer em {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png) + +{% indented_data_reference reusables.codespaces.remote-explorer spaces=3 %} \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/codespaces/codespaces-disabling-org-billing.md b/translations/pt-BR/data/reusables/codespaces/codespaces-disabling-org-billing.md new file mode 100644 index 0000000000..a3d7ca0c7a --- /dev/null +++ b/translations/pt-BR/data/reusables/codespaces/codespaces-disabling-org-billing.md @@ -0,0 +1,5 @@ +{% note %} + +**Note**: If you disable billable codespaces use for your organization, anyone who can create codespaces as an individual user, and can clone a repository in your organization, will still be able to create a codespace for that repository. However, this will not incur any charge for your organization. For information about restricting access to a repository, see "[Managing teams and people with access to your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." + +{% endnote %} \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/codespaces/codespaces-org-policies-note.md b/translations/pt-BR/data/reusables/codespaces/codespaces-org-policies-note.md new file mode 100644 index 0000000000..69e6530791 --- /dev/null +++ b/translations/pt-BR/data/reusables/codespaces/codespaces-org-policies-note.md @@ -0,0 +1,5 @@ +{% note %} + +**Note**: Organization policies you define for {% data variables.product.prodname_codespaces %} only apply to codespaces for which your organization will be billed. If an individual user creates a codespace for a repository in your organization, and the organization is not billed, then the codespace will not be bound by these policies. For information on how to choose who can create codespaces that are billed to your organization, see "[Enabling {% data variables.product.prodname_github_codespaces %} for your organization](https://docs-internal-29134-ad7bd8.preview.ghdocs.com/en/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization#choose-who-can-create-codespaces-that-are-billed-to-your-organization)." + +{% endnote %} \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/codespaces/codespaces-spending-limit-requirement.md b/translations/pt-BR/data/reusables/codespaces/codespaces-spending-limit-requirement.md index 61e7031435..69820f0878 100644 --- a/translations/pt-BR/data/reusables/codespaces/codespaces-spending-limit-requirement.md +++ b/translations/pt-BR/data/reusables/codespaces/codespaces-spending-limit-requirement.md @@ -1,9 +1,9 @@ {% note %} -**Note:** You must set a spending limit before you can use {% data variables.product.prodname_codespaces %}. +**Note:** You must set a non-zero spending limit before you can use {% data variables.product.prodname_codespaces %}. {% endnote %} -By default, your organization or enterprise will have a {% data variables.product.prodname_github_codespaces %} spending limit of $0, which prevents new codespaces from being created or existing codespaces from being opened. To allow your users to create codespaces in your organization, set the limit to a value higher than $0. +By default, your organization or enterprise will have a {% data variables.product.prodname_github_codespaces %} spending limit of $0. This prevents new codespaces from being created, or existing codespaces from being opened, if this would incur a billable cost to your organization or enterprise. To allow your users to create codespaces in your organization, set the limit to a value higher than $0. {% data reusables.billing.overages-billed-monthly %} diff --git a/translations/pt-BR/data/reusables/codespaces/concurrent-codespace-limit.md b/translations/pt-BR/data/reusables/codespaces/concurrent-codespace-limit.md index 53b5154270..2af690d606 100644 --- a/translations/pt-BR/data/reusables/codespaces/concurrent-codespace-limit.md +++ b/translations/pt-BR/data/reusables/codespaces/concurrent-codespace-limit.md @@ -1 +1 @@ -Você pode criar mais de um código de espaço por repositório ou até mesmo por branch. No entanto, cada conta pessoal tem um limite de 10 codespaces. Se você atingiu o limite e deseja criar um novo espaço de código, você deve primeiro excluir um código. +Você pode criar mais de um código de espaço por repositório ou até mesmo por branch. diff --git a/translations/pt-BR/data/reusables/codespaces/remote-explorer.md b/translations/pt-BR/data/reusables/codespaces/remote-explorer.md new file mode 100644 index 0000000000..c46ed9b539 --- /dev/null +++ b/translations/pt-BR/data/reusables/codespaces/remote-explorer.md @@ -0,0 +1,9 @@ +{% note %} + +**Note**: If the Remote Explorer is not displayed in the Activity Bar: + +1. Access the command palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux). +1. Type: `codespaces`. +1. Click **Codespaces: Details**. + +{% endnote %} diff --git a/translations/pt-BR/data/reusables/dependabot/dependabot-alerts-filters.md b/translations/pt-BR/data/reusables/dependabot/dependabot-alerts-filters.md new file mode 100644 index 0000000000..bb66dd9639 --- /dev/null +++ b/translations/pt-BR/data/reusables/dependabot/dependabot-alerts-filters.md @@ -0,0 +1,17 @@ +You can sort and filter {% data variables.product.prodname_dependabot_alerts %} by typing filters as `key:value` pairs into the search bar. + +| Opção | Descrição | Exemplo | +|:------------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `ecossistema` | Displays alerts for the selected ecosystem | Use `ecosystem:npm` to show {% data variables.product.prodname_dependabot_alerts %} for npm |{% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-7891 %} +| `has` | Displays alerts meeting the selected filter criteria | Use `has:patch` to show alerts related to advisories that have a patch{% ifversion dependabot-alerts-vulnerable-calls %}
    Use `has:vulnerable-calls` to show alerts relating to calls to vulnerable functions{% endif %} +{% endif %} +| `is` | Displays alerts based on their state | Use `is:open` to show open alerts | +| `manifest` | Displays alerts for the selected manifest | Use `manifest:webwolf/pom.xml` to show alerts on the pom.xml file of the webwolf application | +| `pacote` | Displays alerts for the selected package | Use `package:django` to show alerts for django | +| `resolução` | Displays alerts of the selected resolution status | Use `resolution:no-bandwidth` to show alerts previously parked due to lack of resources or time to fix them | +| `repo` | Displays alerts based on the repository they relate to
    Note that this filter is only available on the security overview. For more information, see "[About the security overview](/code-security/security-overview/about-the-security-overview)" | Use `repo:octocat-repo` to show alerts in the repository called `octocat-repo` |{%- ifversion dependabot-alerts-development-label %} +| `escopo` | Displays alerts based on the scope of the dependency they relate to | Use `scope:development` to show alerts for dependencies that are only used during development +{% endif %} +| `gravidade` | Displays alerts based on their level of severity | Use `severity:high` to show alerts with a severity of High |{%- ifversion dependabot-most-important-sort-option %} +| `ordenar` | Displays alerts according to the selected sort order | The default sorting option for alerts is `sort:most-important`, which ranks alerts by importance
    Use `sort:newest` to show the latest alerts reported by {% data variables.product.prodname_dependabot %} +{% endif %} diff --git a/translations/pt-BR/data/reusables/discussions/starting-a-poll.md b/translations/pt-BR/data/reusables/discussions/starting-a-poll.md index 81494b8734..f6ac5f2479 100644 --- a/translations/pt-BR/data/reusables/discussions/starting-a-poll.md +++ b/translations/pt-BR/data/reusables/discussions/starting-a-poll.md @@ -5,5 +5,5 @@ 1. Type a title and optional body for your poll. ![Screenshot showing text fields for title and body](/assets/images/help/discussions/new-poll-title-and-body-fields.png) 1. Type a question for your poll. ![Screenshot showing text fields for the poll's question](/assets/images/help/discussions/new-poll-question.png) 1. Type at least two options for your poll. ![Screenshot showing text fields for the poll's options](/assets/images/help/discussions/new-poll-options.png) -1. Optionally, to add a extra poll options, click **Add an option**. ![Screenshot showing "Add an option" button](/assets/images/help/discussions/new-poll-add-option.png) +1. Optionally, to add an extra poll option, click **Add an option**. ![Screenshot showing "Add an option" button](/assets/images/help/discussions/new-poll-add-option.png) 1. Click **Start poll**. ![Screenshot showing the "Start poll" button](/assets/images/help/discussions/new-poll-start-poll-button.png) diff --git a/translations/pt-BR/data/reusables/enterprise-accounts/repo-creation-policy.md b/translations/pt-BR/data/reusables/enterprise-accounts/repo-creation-policy.md index 3dc85d7c17..f010f96ca7 100644 --- a/translations/pt-BR/data/reusables/enterprise-accounts/repo-creation-policy.md +++ b/translations/pt-BR/data/reusables/enterprise-accounts/repo-creation-policy.md @@ -1 +1,6 @@ -1. Em "Repository creation" (Criação de repositório), selecione uma política. ![Menu suspenso com opções de políticas de criação de repositórios](/assets/images/help/business-accounts/repository-creation-policy-drop-down.png) +1. Em "Repository creation" (Criação de repositório), selecione uma política. + {% ifversion enterprise-namespace-repo-setting %} + ![Menu suspenso com opções de políticas de criação de repositórios](/assets/images/help/business-accounts/restrict-personal-namespace-setting.png) + {% else %} + ![Menu suspenso com opções de políticas de criação de repositórios](/assets/images/help/business-accounts/repository-creation-policy-drop-down.png) + {% endif %} diff --git a/translations/pt-BR/data/reusables/enterprise-accounts/repository-visibility-policy.md b/translations/pt-BR/data/reusables/enterprise-accounts/repository-visibility-policy.md deleted file mode 100644 index 525aa116b2..0000000000 --- a/translations/pt-BR/data/reusables/enterprise-accounts/repository-visibility-policy.md +++ /dev/null @@ -1 +0,0 @@ -1. Em "Repository visibility change" (Mudança de visibilidade do repositório), use o menu suspenso e escolha uma política. ![Menu suspenso com opções de política de visibilidade do repositório](/assets/images/help/business-accounts/repository-visibility-policy-drop-down.png) diff --git a/translations/pt-BR/data/reusables/enterprise-accounts/security-tab.md b/translations/pt-BR/data/reusables/enterprise-accounts/security-tab.md index 5d74f91ca1..b71d9a50b8 100644 --- a/translations/pt-BR/data/reusables/enterprise-accounts/security-tab.md +++ b/translations/pt-BR/data/reusables/enterprise-accounts/security-tab.md @@ -1,2 +1,7 @@ +{%- ifversion ghec or ghes > 3.4 or ghae-issue-7875 %} +1. In the left sidebar, click **Authentication security**. + {% ifversion ghae %}![Security tab in the enterprise account settings sidebar](/assets/images/enterprise/github-ae/enterprise-account-settings-authentication-security-tab.png){% else %}![Security tab in the enterprise account settings sidebar](/assets/images/help/business-accounts/enterprise-account-settings-authentication-security-tab.png){% endif %} +{%- else %} 1. Na barra lateral esquerda, clique em **Security** (Segurança). {% ifversion ghae %}![Security tab in the enterprise account settings sidebar](/assets/images/enterprise/github-ae/enterprise-account-settings-security-tab.png){% else %}![Security tab in the enterprise account settings sidebar](/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png){% endif %} +{%- endif %} \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md b/translations/pt-BR/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md index c5d6100063..d9e308eee9 100644 --- a/translations/pt-BR/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md +++ b/translations/pt-BR/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md @@ -1,4 +1,4 @@ -1. Define the key as a environment variable for {% data variables.product.product_name %}, replacing `` with the GPG key ID. +1. Define the key as an environment variable for {% data variables.product.product_name %}, replacing `` with the GPG key ID. ```bash{:copy} ghe-config "secrets.gpgverify.web-signing-key" "$(gpg --export-secret-keys -a | awk '{printf "%s\\n", $0}')" diff --git a/translations/pt-BR/data/reusables/git/cache-on-repository-path.md b/translations/pt-BR/data/reusables/git/cache-on-repository-path.md new file mode 100644 index 0000000000..ced81ebbd9 --- /dev/null +++ b/translations/pt-BR/data/reusables/git/cache-on-repository-path.md @@ -0,0 +1,5 @@ +1. To configure Git to cache credentials for each local directory where you clone a repository, enter the following command. + + ```shell{:copy} + git config --global credential.useHttpPath true + ``` diff --git a/translations/pt-BR/data/reusables/git/clear-stored-gcm-credentials.md b/translations/pt-BR/data/reusables/git/clear-stored-gcm-credentials.md new file mode 100644 index 0000000000..04e3de748e --- /dev/null +++ b/translations/pt-BR/data/reusables/git/clear-stored-gcm-credentials.md @@ -0,0 +1,5 @@ +- If the output is `manager-core`, you're using Git Credential Manager. To clear the credentials, run the following command. + + ```shell{:copy} + git credential-manager reject https://github.com + ``` diff --git a/translations/pt-BR/data/reusables/git/clear-the-stored-credentials.md b/translations/pt-BR/data/reusables/git/clear-the-stored-credentials.md new file mode 100644 index 0000000000..f723d7ab97 --- /dev/null +++ b/translations/pt-BR/data/reusables/git/clear-the-stored-credentials.md @@ -0,0 +1 @@ +1. If the output confirms that you're using a credential manager, clear the stored credentials for the credential manager. diff --git a/translations/pt-BR/data/reusables/git/confirm-credential-manager.md b/translations/pt-BR/data/reusables/git/confirm-credential-manager.md new file mode 100644 index 0000000000..68c6e99397 --- /dev/null +++ b/translations/pt-BR/data/reusables/git/confirm-credential-manager.md @@ -0,0 +1,5 @@ +1. To confirm your use of a credential manager, enter the following command and note the output. + + ```shell{:copy} + git config --get credential.helper + ``` diff --git a/translations/pt-BR/data/reusables/git/no-credential-manager.md b/translations/pt-BR/data/reusables/git/no-credential-manager.md new file mode 100644 index 0000000000..fe79c2ff04 --- /dev/null +++ b/translations/pt-BR/data/reusables/git/no-credential-manager.md @@ -0,0 +1 @@ +- If the output doesn't include the name of a credential manager, there is no credential manager configured, and you can proceed to the next step. \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/git/open-terminal.md b/translations/pt-BR/data/reusables/git/open-terminal.md new file mode 100644 index 0000000000..7eeb8de93f --- /dev/null +++ b/translations/pt-BR/data/reusables/git/open-terminal.md @@ -0,0 +1 @@ +1. Abra o terminal. diff --git a/translations/pt-BR/data/reusables/git/provide-credentials.md b/translations/pt-BR/data/reusables/git/provide-credentials.md new file mode 100644 index 0000000000..351a1e87d1 --- /dev/null +++ b/translations/pt-BR/data/reusables/git/provide-credentials.md @@ -0,0 +1,3 @@ +1. The first time that you use Git to clone a repository or access data in a repository that you've already cloned, Git will request credentials. Provide the PAT for the account with access to the repository. + + Git will cache the PAT for the directory you're in, and you'll be able to access and write repository data on {% data variables.product.product_location %} using the correct account. diff --git a/translations/pt-BR/data/reusables/gpg/configure-ssh-signing.md b/translations/pt-BR/data/reusables/gpg/configure-ssh-signing.md new file mode 100644 index 0000000000..f0f489a73a --- /dev/null +++ b/translations/pt-BR/data/reusables/gpg/configure-ssh-signing.md @@ -0,0 +1,4 @@ +1. Configure Git to use SSH to sign commits and tags: + ```bash + $ git config --global gpg.format ssh + ``` \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/gpg/copy-gpg-key-id.md b/translations/pt-BR/data/reusables/gpg/copy-gpg-key-id.md index 7527dd811a..99a4a4c3d9 100644 --- a/translations/pt-BR/data/reusables/gpg/copy-gpg-key-id.md +++ b/translations/pt-BR/data/reusables/gpg/copy-gpg-key-id.md @@ -1,9 +1,9 @@ 1. Da lista de chaves GPG, copie a forma longa do ID da chave GPG que você gostaria de usar. Neste exemplo, o ID da chave GPG é `3AA5C34371567BD2`: - ```shell + ```shell{:copy} $ gpg --list-secret-keys --keyid-format=long /Users/hubot/.gnupg/secring.gpg ------------------------------------ sec 4096R/3AA5C34371567BD2 2016-03-10 [expires: 2017-03-10] uid Hubot ssb 4096R/42B317FD4BA89E7A 2016-03-10 - ``` + ``` diff --git a/translations/pt-BR/data/reusables/gpg/copy-ssh-public-key.md b/translations/pt-BR/data/reusables/gpg/copy-ssh-public-key.md new file mode 100644 index 0000000000..ccfe59c1e1 --- /dev/null +++ b/translations/pt-BR/data/reusables/gpg/copy-ssh-public-key.md @@ -0,0 +1,43 @@ +1. Copie a chave pública SSH para a sua área de transferência. + + Se o seu arquivo de chave pública SSH tiver um nome diferente do código de exemplo, modifique o nome do arquivo para corresponder à sua configuração atual. Ao copiar sua chave, não adicione novas linhas nem espaços em branco. +{% mac %} + + ```shell + $ pbcopy < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub + # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard + ``` + + {% tip %} + + **Dica:** se `pbcopy` não estiver funcionando, você poderá localizar a pasta `.ssh` oculta, abrir o arquivo no seu editor de texto de preferência e copiá-lo na área de transferência. + + {% endtip %} +{% endmac %} +{% windows %} + + ```shell + $ clip < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub + # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard + ``` + + {% tip %} + + **Dica:** se `clip` não estiver funcionando, você poderá localizar a pasta `.ssh` oculta, abrir o arquivo no seu editor de texto de preferência e copiá-lo na área de transferência. + + {% endtip %} +{% endwindows %} +{% linux %} + + ```shell + $ cat ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub + # Then select and copy the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file + # displayed in the terminal to your clipboard + ``` + + {% tip %} + + **Dica:** Como alternativa, você pode localizar a pasta oculta de `.ssh`, abrir o arquivo no seu editor de texto favorito e copiá-lo na sua área de transferência. + + {% endtip %} +{% endlinux %} diff --git a/translations/pt-BR/data/reusables/gpg/list-keys-with-note.md b/translations/pt-BR/data/reusables/gpg/list-keys-with-note.md index de75bf4ce3..a3650500a0 100644 --- a/translations/pt-BR/data/reusables/gpg/list-keys-with-note.md +++ b/translations/pt-BR/data/reusables/gpg/list-keys-with-note.md @@ -1,10 +1,11 @@ - 1. Use o comando `gpg --list-secret-keys --keyid-format=long` para listar a forma longa das chaves GPG para as quais você tem uma chave pública e privada. Uma chave privada é necessária para assinar commits ou tags. - ```shell - $ gpg --list-secret-keys --keyid-format=long -``` - {% note %} - **Nota:** Algumas instalações GPG no Linux podem exigir que você use `gpg2 --list-keys --keyid-format LONG` para visualizar uma lista de suas chaves existentes. Neste caso você também precisará configurar o Git para usar `gpg2` executando `git config --global gpg.program gpg2`. + ```shell{:copy} + $ gpg --list-secret-keys --keyid-format=long + ``` - {% endnote %} + {% note %} + + **Nota:** Algumas instalações GPG no Linux podem exigir que você use `gpg2 --list-keys --keyid-format LONG` para visualizar uma lista de suas chaves existentes. Neste caso você também precisará configurar o Git para usar `gpg2` executando `git config --global gpg.program gpg2`. + + {% endnote %} diff --git a/translations/pt-BR/data/reusables/gpg/paste-ssh-public-key.md b/translations/pt-BR/data/reusables/gpg/paste-ssh-public-key.md new file mode 100644 index 0000000000..1274a0acb5 --- /dev/null +++ b/translations/pt-BR/data/reusables/gpg/paste-ssh-public-key.md @@ -0,0 +1,4 @@ +1. To set your SSH signing key in Git, paste the text below, substituting the contents of your clipboard for the key you'd like to use. Since the key contains spaces, you must wrap it in quotes: + ```bash + $ git config --global user.signingkey 'ssh-ed25519 AAAAC3(...) user@example.com' + ``` \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/gpg/ssh-git-version.md b/translations/pt-BR/data/reusables/gpg/ssh-git-version.md new file mode 100644 index 0000000000..b7b745ca4f --- /dev/null +++ b/translations/pt-BR/data/reusables/gpg/ssh-git-version.md @@ -0,0 +1,6 @@ + +{% note %} + +**Note:** SSH signature verification is available in Git 2.34 or later. Para atualizar sua versão do Git, consulte o site [Git](https://git-scm.com/downloads). + +{% endnote %} diff --git a/translations/pt-BR/data/reusables/gpg/x-509-key.md b/translations/pt-BR/data/reusables/gpg/x-509-key.md index d01c81454b..956f178d79 100644 --- a/translations/pt-BR/data/reusables/gpg/x-509-key.md +++ b/translations/pt-BR/data/reusables/gpg/x-509-key.md @@ -1,5 +1,5 @@ -### Contando ao Git sobre sua chave X.509 +## Contando ao Git sobre sua chave X.509 Você pode usar [smimesign](https://github.com/github/smimesign) para assinar commits e tags usando S/MIME em vez de GPG. diff --git a/translations/pt-BR/data/reusables/identity-and-permissions/about-adding-ip-allow-list-entries.md b/translations/pt-BR/data/reusables/identity-and-permissions/about-adding-ip-allow-list-entries.md new file mode 100644 index 0000000000..772581f87a --- /dev/null +++ b/translations/pt-BR/data/reusables/identity-and-permissions/about-adding-ip-allow-list-entries.md @@ -0,0 +1,3 @@ +You can create an IP allow list by adding entries that each contain an IP address or address range.{% ifversion ip-allow-list-address-check %} After you finish adding entries, you can check whether a particular IP address would be allowed by any of the enabled entries in your list.{% endif %} + +Before the list restricts access to {% ifversion ghae %}your enterprise{% else %}private assets owned by organizations in your enterprise{% endif %}, you must also enable allowed IP addresses. \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/identity-and-permissions/about-checking-ip-address.md b/translations/pt-BR/data/reusables/identity-and-permissions/about-checking-ip-address.md new file mode 100644 index 0000000000..dfdc758f91 --- /dev/null +++ b/translations/pt-BR/data/reusables/identity-and-permissions/about-checking-ip-address.md @@ -0,0 +1 @@ +You can check whether a particular IP address would be allowed by any of the enabled entries in your IP allow list, even if the list is not currently enabled. \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md b/translations/pt-BR/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md new file mode 100644 index 0000000000..d646e02ec5 --- /dev/null +++ b/translations/pt-BR/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md @@ -0,0 +1,5 @@ +You can edit an entry in your IP allow list. If you edit an enabled entry, changes are enforced immediately. + +{% ifversion ip-allow-list-address-check %} +After you finish editing entries, you can check whether a particular IP address would be allowed by any of the enabled entries in your list. +{% endif %} \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md b/translations/pt-BR/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md new file mode 100644 index 0000000000..f886df0690 --- /dev/null +++ b/translations/pt-BR/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md @@ -0,0 +1,5 @@ +After you create an IP allow list, you can enable allowed IP addresses. When you enable allowed IP addresses, {% data variables.product.company_short %} immediately enforces any enabled entries in your IP allow list. + +{% ifversion ip-allow-list-address-check %} +Before you enable allowed IP addresses, you can check whether a particular IP address would be allowed by any of the enabled entries in your list. For more information, see "[Checking if an IP address is permitted](#checking-if-an-ip-address-is-permitted)." +{% endif %} \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/identity-and-permissions/check-ip-address-step.md b/translations/pt-BR/data/reusables/identity-and-permissions/check-ip-address-step.md new file mode 100644 index 0000000000..5e73fdddcd --- /dev/null +++ b/translations/pt-BR/data/reusables/identity-and-permissions/check-ip-address-step.md @@ -0,0 +1 @@ +1. Under "Check your IP address", enter an IP address. ![Screenshot of the "Check IP address" text field](/assets/images/help/security/check-ip-address.png) \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/identity-and-permissions/check-ip-address.md b/translations/pt-BR/data/reusables/identity-and-permissions/check-ip-address.md new file mode 100644 index 0000000000..9a187752d6 --- /dev/null +++ b/translations/pt-BR/data/reusables/identity-and-permissions/check-ip-address.md @@ -0,0 +1,3 @@ +{%- ifversion ip-allow-list-address-check %} +1. Optionally, check if a particular IP address would be allowed by any of the enabled entries in your list. For more information, see "[Checking if an IP address is permitted](#checking-if-an-ip-address-is-permitted)." +{%- endif %} \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/identity-and-permissions/ip-allow-lists-enable.md b/translations/pt-BR/data/reusables/identity-and-permissions/ip-allow-lists-enable.md index 3bee02a42c..c7be5a3a0d 100644 --- a/translations/pt-BR/data/reusables/identity-and-permissions/ip-allow-lists-enable.md +++ b/translations/pt-BR/data/reusables/identity-and-permissions/ip-allow-lists-enable.md @@ -1 +1,3 @@ -Para fazer cumprir a lista de permissões de IP, você deve primeiro adicionar endereços IP à lista, e então habilitar a lista de permissões de IP. É preciso adicionar o endereço IP atual ou um intervalo correspondente antes de habilitar a lista de permissões de IP. +To enforce the IP allow list, you must first add IP addresses to the list, then enable the IP allow list.{% ifversion ip-allow-list-address-check %} After you complete your list, you can check whether a particular IP address would be allowed by any of the enabled entries in the list.{% endif %} + +É preciso adicionar o endereço IP atual ou um intervalo correspondente antes de habilitar a lista de permissões de IP. diff --git a/translations/pt-BR/data/reusables/identity-and-permissions/ipv6-allow-lists.md b/translations/pt-BR/data/reusables/identity-and-permissions/ipv6-allow-lists.md new file mode 100644 index 0000000000..3c26491fe2 --- /dev/null +++ b/translations/pt-BR/data/reusables/identity-and-permissions/ipv6-allow-lists.md @@ -0,0 +1,7 @@ +{% ifversion fpt or ghec %} +{% note %} + +**Note:** {% data variables.product.company_short %} is gradually rolling out support for IPv6. As {% data variables.product.prodname_dotcom %} services continue to add IPv6 support, we will start recognizing IPv6 addresses of {% data variables.product.prodname_dotcom %} users. To prevent possible access interruptions, please ensure you have added any necessary IPv6 addresses to your IP allow list. + +{% endnote %} +{% endif %} \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/organizations/about-following-organizations.md b/translations/pt-BR/data/reusables/organizations/about-following-organizations.md new file mode 100644 index 0000000000..52e52467fb --- /dev/null +++ b/translations/pt-BR/data/reusables/organizations/about-following-organizations.md @@ -0,0 +1 @@ +When you follow organizations on {% data variables.product.product_name %}, you'll see their {% ifversion fpt or ghec %}public{% endif %} activity on your personal dashboard. This activity includes new discussions, sponsorships, and repositories. \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/organizations/follow-organizations-beta.md b/translations/pt-BR/data/reusables/organizations/follow-organizations-beta.md new file mode 100644 index 0000000000..c43d9b7ad9 --- /dev/null +++ b/translations/pt-BR/data/reusables/organizations/follow-organizations-beta.md @@ -0,0 +1,5 @@ +{% note %} + +**Observação:** A capacidade de seguir organizações está atualmente em versão beta pública e sujeita a alterações. + +{% endnote %} \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/package_registry/authenticate-packages.md b/translations/pt-BR/data/reusables/package_registry/authenticate-packages.md index a766f6e96d..5ca4e91584 100644 --- a/translations/pt-BR/data/reusables/package_registry/authenticate-packages.md +++ b/translations/pt-BR/data/reusables/package_registry/authenticate-packages.md @@ -4,4 +4,4 @@ You can use a personal access token (PAT) to authenticate to {% data variables.p To authenticate to a {% data variables.product.prodname_registry %} registry within a {% data variables.product.prodname_actions %} workflow, you can use: - `GITHUB_TOKEN` to publish packages associated with the workflow repository. -- a PAT to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). +- a PAT with at least `packages:read` scope to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). diff --git a/translations/pt-BR/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md b/translations/pt-BR/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md deleted file mode 100644 index 7fa54b22c1..0000000000 --- a/translations/pt-BR/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md +++ /dev/null @@ -1,11 +0,0 @@ -{% ifversion fpt or ghec or ghes > 3.4 %} - -Para efetuar a autenticação em {% data variables.product.prodname_container_registry %} dentro de um fluxo de trabalho {% data variables.product.prodname_actions %}, use o `GITHUB_TOKEN` para obter a melhor segurança e experiência. If your workflow is using a personal access token (PAT) to authenticate to `{% data reusables.package_registry.container-registry-hostname %}`, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. - -{% ifversion fpt or ghec %}For guidance on updating your workflows that authenticate to `{% data reusables.package_registry.container-registry-hostname %}` with a personal access token, see "[Upgrading a workflow that accesses `ghcr.io`](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#upgrading-a-workflow-that-accesses-ghcrio)."{% endif %} - -Para obter mais informações sobre o `GITHUB_TOKEN`, consulte "[Autenticação em um fluxo de trabalho](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)". - -Se você estiver usando {% data variables.product.prodname_container_registry %} em ações, siga nossas práticas recomendadas em matéria de segurança na[Enrijecimento de segurança para o GitHub Actions](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)". - -{% endif %} diff --git a/translations/pt-BR/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md b/translations/pt-BR/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md new file mode 100644 index 0000000000..718710d5ce --- /dev/null +++ b/translations/pt-BR/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md @@ -0,0 +1,7 @@ +If your workflow is using a personal access token (PAT) to authenticate to a registry, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. + +{% ifversion fpt or ghec %}For guidance on updating your workflows that authenticate to a registry with a personal access token, see "[Upgrading a workflow that accesses a registry using a PAT](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#upgrading-a-workflow-that-accesses-a-registry-using-a-pat)."{% endif %} + +Para obter mais informações sobre o `GITHUB_TOKEN`, consulte "[Autenticação em um fluxo de trabalho](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)". + +For more information about the best practises when using a registry in actions, see "[Security hardening for GitHub Actions](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)." diff --git a/translations/pt-BR/data/reusables/package_registry/no-graphql-to-delete-packages.md b/translations/pt-BR/data/reusables/package_registry/no-graphql-to-delete-packages.md new file mode 100644 index 0000000000..cbab609f2b --- /dev/null +++ b/translations/pt-BR/data/reusables/package_registry/no-graphql-to-delete-packages.md @@ -0,0 +1 @@ +{% ifversion fpt or ghec %} The {% data variables.product.prodname_registry %} GraphQL API does not support containers or Docker images that use the package namespace `https://ghcr.io/OWNER/PACKAGE-NAME`, or npm images that use the package namespace `https://npm.pkg.github.com/OWNER/PACKAGE-NAME`.{% endif %} \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/pages/navigate-publishing-source.md b/translations/pt-BR/data/reusables/pages/navigate-publishing-source.md index 023fcbd392..f959dcee5e 100644 --- a/translations/pt-BR/data/reusables/pages/navigate-publishing-source.md +++ b/translations/pt-BR/data/reusables/pages/navigate-publishing-source.md @@ -1 +1 @@ -1. Navegue até a fonte de publicação do seu site. For more information, see "[Configuring a publishing source for your GitHub Pages site](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." +1. Navegue até a fonte de publicação do seu site. Para obter mais informações, consulte "[Configurando uma fonte de publicação para o site do GitHub Pages](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)". diff --git a/translations/pt-BR/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md b/translations/pt-BR/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md index 51048b2b8f..fce59af7f3 100644 --- a/translations/pt-BR/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md +++ b/translations/pt-BR/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md @@ -1,16 +1,16 @@ -{% ifversion ghes > 3.1 or ghes < 3.5 %} +{% ifversion ghes < 3.5 %} -In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server 3.5 or later may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 when you upgrade from an earlier release to 3.5 or later. A fix for 3.5 and later will be available in an upcoming patch release. +In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server 3.5 or later may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 when you upgrade from an earlier release to 3.5 or later. A fix will be available in upcoming patch releases. -To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). [Updated: 2022-08-16] +To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). [Updated: 2022-08-26] -{% elsif ghes > 3.4 or ghes < 3.7 %} +{% elsif ghes = 3.5 or ghes = 3.6 %} -In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server {{ currentVersion }} may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 as you upgrade to the latest release. To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). +In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server {{ allVersions[currentVersion].currentRelease }} may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 as you upgrade to the latest release. To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). - To display the missing alerts for all repositories owned by an organization, organization owners can navigate to the organization's **Code security and analysis** settings, then click **Enable all** for secret scanning. Para obter mais informações, consulte "[Gerenciar configurações de segurança e análise para sua organização](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories)". - To display the missing alerts for an individual repository, people with admin access to the repository can disable then enable secret scanning for the repository. Para obter mais informações, consulte "[Gerenciar configurações de segurança e análise do seu repositório](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)". -A fix will be available in an upcoming patch release. [Updated: 2022-08-16] +A fix will be available in an upcoming patch release. [Updated: 2022-08-26] {% endif %} diff --git a/translations/pt-BR/data/reusables/secret-scanning/push-protection-web-ui-choice.md b/translations/pt-BR/data/reusables/secret-scanning/push-protection-web-ui-choice.md index bc75f9431c..23e71bf6bf 100644 --- a/translations/pt-BR/data/reusables/secret-scanning/push-protection-web-ui-choice.md +++ b/translations/pt-BR/data/reusables/secret-scanning/push-protection-web-ui-choice.md @@ -2,5 +2,12 @@ Ao usar a interface de usuário web para tentar confirmar um segredo suportado p Você verá um banner no topo da página com informações sobre a localização do segredo, e o segredo também será sublinhado no arquivo para que você possa encontrá-lo facilmente. +{% ifversion push-protection-custom-link-orgs %} + + ![Captura de tela que mostra o commit na interface de usuário da web bloqueado devido à proteção de push da digitalização de segredo](/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-blocked-banner-with-link.png) + +{% else %} + ![Captura de tela que mostra o commit na interface de usuário da web bloqueado devido à proteção de push da digitalização de segredo](/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-blocked-banner.png) - \ No newline at end of file + +{% endif %} \ No newline at end of file diff --git a/translations/pt-BR/data/ui.yml b/translations/pt-BR/data/ui.yml index 4a96584bb0..bfbbc2b449 100644 --- a/translations/pt-BR/data/ui.yml +++ b/translations/pt-BR/data/ui.yml @@ -32,6 +32,9 @@ search: search_error: An error occurred trying to perform the search. description: Enter a search term to find it in the GitHub Documentation. label: Search GitHub Docs + results_found: Found {n} results in {s}ms + results_page: This is page {page} of {pages}. + nothing_found: Nothing found 😿 homepage: explore_by_product: Explorar por produto version_picker: Versão diff --git a/translations/pt-BR/data/variables/product.yml b/translations/pt-BR/data/variables/product.yml index ddecd920aa..4168fb80db 100644 --- a/translations/pt-BR/data/variables/product.yml +++ b/translations/pt-BR/data/variables/product.yml @@ -112,6 +112,10 @@ prodname_registry: 'GitHub Package Registry' prodname_container_registry: 'Container registry' prodname_docker_registry_namespace: '{% ifversion fpt or ghec %}`docker.pkg.github.com`{% elsif ghes or ghae %}docker.HOSTNAME{% endif %}' prodname_container_registry_namespace: '{% ifversion fpt or ghec %}`ghcr.io`{% elsif ghes or ghae %}containers.HOSTNAME{% endif %}' +prodname_npm_registry: 'Registro de npm' +prodname_ghcr_and_npm_registry: '{% data variables.product.prodname_container_registry %}{% ifversion packages-npm-v2 %} and {% data variables.product.prodname_npm_registry %}{% endif %}' +prodname_ghcr_or_npm_registry: '{% data variables.product.prodname_container_registry %}{% ifversion packages-npm-v2 %} or {% data variables.product.prodname_npm_registry %}{% endif %}' +prodname_ghcr_and_npm_registry_full: '{% data variables.product.prodname_container_registry %} (`ghcr.io`){% ifversion packages-npm-v2 %} and {% data variables.product.prodname_npm_registry %} (`npm.pkg.github.com`){% endif %}' #GitHub Insights prodname_insights: 'GitHub Insights' #GitHub Sponsors diff --git a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md index 92dd7fdc0a..e06edb7705 100644 --- a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md +++ b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md @@ -1,6 +1,6 @@ --- title: 在 GitHub 上设置和管理您的个人帐户 -intro: '您可以在 {% data variables.product.prodname_dotcom %} 上管理个人帐户的设置，包括电子邮件首选项、个人仓库的协作者访问权限和组织成员身份。' +intro: 'You can manage settings for your personal account on {% ifversion fpt or ghec or ghes %}{% data variables.product.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %}, including email preferences, access to personal repositories, and organization memberships. You can also manage the account itself.' shortTitle: 个人帐户 redirect_from: - /categories/setting-up-and-managing-your-github-user-account @@ -15,6 +15,7 @@ topics: - Accounts children: - /managing-personal-account-settings + - /managing-your-personal-account - /managing-email-preferences - /managing-access-to-your-personal-repositories - /managing-your-membership-in-organizations diff --git a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md index 44e94058a5..8db444c488 100644 --- a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md +++ b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md @@ -1,6 +1,6 @@ --- title: 管理用户帐户设置 -intro: 您可以更改个人帐户的多项设置，包括更改用户名和删除帐户。 +intro: 'You can manage settings for your personal account, including your theme, username, default branch, accessibility, and security settings.' redirect_from: - /categories/29/articles - /categories/user-accounts @@ -19,9 +19,6 @@ children: - /managing-your-theme-settings - /managing-your-tab-size-rendering-preference - /changing-your-github-username - - /merging-multiple-personal-accounts - - /converting-a-user-into-an-organization - - /deleting-your-personal-account - /permission-levels-for-a-personal-account-repository - /permission-levels-for-a-project-board-owned-by-a-personal-account - /managing-accessibility-settings @@ -29,7 +26,6 @@ children: - /managing-security-and-analysis-settings-for-your-personal-account - /managing-access-to-your-personal-accounts-project-boards - /integrating-jira-with-your-personal-projects - - /best-practices-for-leaving-your-company - /what-does-the-available-for-hire-checkbox-do shortTitle: 个人帐户设置 --- diff --git a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company.md b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md similarity index 95% rename from translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company.md rename to translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md index 0f84794666..155379d05f 100644 --- a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company.md +++ b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md @@ -6,6 +6,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/best-practices-for-leaving-your-company - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/best-practices-for-leaving-your-company - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/best-practices-for-leaving-your-company + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/best-practices-for-leaving-your-company versions: fpt: '*' ghec: '*' diff --git a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization.md b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md similarity index 97% rename from translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization.md rename to translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md index 2a1aa4bcb9..4d510d7ca2 100644 --- a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization.md +++ b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md @@ -7,6 +7,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/converting-a-user-into-an-organization - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization intro: 您可以将个人帐户转换为组织。 这样可以对属于组织的仓库设置更细化的权限。 versions: fpt: '*' diff --git a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account.md b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md similarity index 55% rename from translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account.md rename to translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md index 19bbcfc8a4..c1de520062 100644 --- a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account.md +++ b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md @@ -1,39 +1,53 @@ --- title: 删除个人帐户 -intro: '您可以随时在 {% data variables.product.product_name %} 上删除您的个人帐户。' +intro: '您可以随时在 {% data variables.product.product_location %} 上删除您的个人帐户。' redirect_from: - /articles/deleting-a-user-account - /articles/deleting-your-user-account - /github/setting-up-and-managing-your-github-user-account/deleting-your-user-account - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account versions: fpt: '*' ghes: '*' ghec: '*' topics: - Accounts -shortTitle: 删除个人帐户 +shortTitle: Delete your account --- -删除个人帐户会移除帐户所拥有的所有仓库、私有仓库分支、wiki、议题、拉取请求和页面。 {% ifversion fpt or ghec %} 在其他用户拥有的仓库中创建的议题和拉取请求以及所做的评论将不会被删除，而是与我们的[Ghost 用户](https://github.com/ghost)关联。{% else %}在其他用户拥有的仓库中创建的议题和拉取请求以及所做的评论将不会被删除。{% endif %} +## About deletion of your personal account -{% ifversion fpt or ghec %} 当您删除帐户时，我们会停止对您计费。 与该帐户关联的电子邮件地址可用于 {% data variables.product.product_location %} 上不同的帐户。 90 天后，该帐户名称也可供其他任何人用于新帐户。 {% endif %} +删除个人帐户会移除帐户所拥有的所有仓库、私有仓库分支、wiki、议题、拉取请求和页面。 {% ifversion fpt or ghec %}Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted. Your resources and comments will become associated with the [ghost user](https://github.com/ghost).{% else %}Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted.{% endif %} -如果您是组织的唯一所有者，则必须先将所有权转让给其他人或删除该组织，然后才能删除您的个人帐户。 如果组织中有其他所有者，则必须先从组织中删除自己，然后才能删除个人帐户。 +{% ifversion ghec %} + +{% note %} + +**Note**: If your enterprise manages your account and you sign into {% data variables.product.product_location %} through your company's identity provider (IdP), you cannot delete your account. 更多信息请参阅“[关于 {% data variables.product.prodname_emus %}](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)”。 + +{% endnote %} + +{% endif %} + +{% ifversion fpt or ghec %}When you delete your account we stop billing you. 与该帐户关联的电子邮件地址可用于 {% data variables.product.product_location %} 上不同的帐户。 90 天后，该帐户名称也可供其他任何人用于新帐户。 {% endif %} + +If you're the only owner of an organization, you must transfer ownership to another person or delete the organization before you can delete your personal account. 如果组织中有其他所有者，则必须先从组织中删除自己，然后才能删除个人帐户。 + +更多信息请参阅以下文章。 -更多信息请参阅： - “[转让组织所有权](/articles/transferring-organization-ownership)” - “[删除组织帐户](/articles/deleting-an-organization-account)” - “[从组织中删除自己](/articles/removing-yourself-from-an-organization/)” ## 备份帐户数据 -在删除个人帐户之前，请复制帐户拥有的所有仓库、私有分支、wiki、议题和拉取请求。 +在删除个人帐户之前，请复制帐户拥有的所有仓库、私有分支、wiki、议题和拉取请求。 For more information, see "[Backing up a repository](/repositories/archiving-a-github-repository/backing-up-a-repository)." {% warning %} -**警告：**删除个人帐户后，GitHub 无法恢复您的内容。 +**Warning:** Once your personal account has been deleted, {% ifversion fpt or ghec %}{% data variables.product.company_short %}{% elsif ghes or ghae %}an enterprise owner{% endif %} cannot restore your content. {% endwarning %} diff --git a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md new file mode 100644 index 0000000000..ab1c7a9394 --- /dev/null +++ b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md @@ -0,0 +1,19 @@ +--- +title: Managing your personal account +intro: 'You can manage your personal account on {% ifversion fpt or ghec or ghes %}{% data variables.product.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %}. For example, you can {% ifversion fpt or ghec %}manage multiple accounts, {% endif %}convert an account to an organization{% ifversion fpt or ghec or ghes %}, or delete an account{% endif %}.' +shortTitle: Manage personal account +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - Accounts +children: + - /managing-multiple-accounts + - /merging-multiple-personal-accounts + - /converting-a-user-into-an-organization + - /best-practices-for-leaving-your-company + - /deleting-your-personal-account +--- + diff --git a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md new file mode 100644 index 0000000000..1c926dde82 --- /dev/null +++ b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md @@ -0,0 +1,105 @@ +--- +title: Managing multiple accounts +intro: 'If you use one workstation to contribute to projects for more than one account on {% data variables.product.product_location %}, you can modify your Git configuration to simplify the contribution process.' +versions: + feature: multiple-accounts-one-workstation +topics: + - Accounts + - Git + - GitHub +shortTitle: Manage multiple accounts +--- + +## About management of multiple accounts + +In some cases, you may need to use multiple accounts on {% data variables.product.product_location %}. For example, you may have a personal account for open source contributions, and your employer may also create and manage a user account for you within an enterprise. + +You cannot use your {% data variables.product.prodname_managed_user %} to contribute to public projects on {% data variables.product.product_location %}, so you must contribute to those resources using your personal account. For more information, see "[About {% data variables.product.prodname_emus %}]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#abilities-and-restrictions-of-managed-user-accounts){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% elsif ghec %}."{% endif %} + +If you want to use one workstation to contribute from both accounts, you can simplify contribution with Git by using a mixture of protocols to access repository data, or by using credentials on a per-repository basis. + +{% warning %} + +**Warning**: Be mindful when you use one workstation to contribute to two separate accounts. Management of two or more accounts can increase the chance of mistakenly leaking internal code to the public. + +{% endwarning %} + +If you aren't required to use a {% data variables.product.prodname_managed_user %}, {% data variables.product.company_short %} recommends that you use one personal account for all your work on {% data variables.product.product_location %}. With a single personal account, you can contribute to a combination of personal, open source, or professional projects using one identity. Other people can invite the account to contribute to both individual repositories and repositories owned by an organization, and the account can be a member of multiple organizations or enterprises. + +## Contributing to two accounts using HTTPS and SSH + +If you contribute with two accounts from one workstation, you can access repositories by using a different protocol and credentials for each account. + +Git can use either the HTTPS or SSH protocol to access and update data in repositories on {% data variables.product.product_location %}. The protocol you use to clone a repository determines which credentials your workstation will use to authenticate when you access the repository. With this approach to account management, you store the credentials for one account to use for HTTPS connections and upload an SSH key to the other account to use for SSH connections. + +You can find both the HTTPS or an SSH URLs for cloning a repository on {% data variables.product.product_name %}. 更多信息请参阅“[克隆仓库](/repositories/creating-and-managing-repositories/cloning-a-repository)”。 + +For more information about the use of SSH to access repositories on {% data variables.product.product_name %}, see "[Connecting to {% data variables.product.prodname_dotcom %} with SSH](/authentication/connecting-to-github-with-ssh)." + +## Contributing to multiple accounts using HTTPS and PATs + +Alternatively, if you want to use the HTTPS protocol for both accounts, you can use different personal access tokens (PAT) for each account by configuring Git to store different credentials for each repository. + +{% mac %} + +{% data reusables.git.open-terminal %} +{% data reusables.git.confirm-credential-manager %} +{% data reusables.git.clear-the-stored-credentials %} + {% data reusables.git.no-credential-manager %} + - If the output is `osxkeychain`, you're using the macOS keychain. To clear the credentials, enter the following command. + + ```shell{:copy} + git credential-osxkeychain erase https://github.com + ``` + {% data reusables.git.clear-stored-gcm-credentials %} +{% data reusables.git.cache-on-repository-path %} +{% data reusables.accounts.create-personal-access-tokens %} +{% data reusables.git.provide-credentials %} + +{% endmac %} + +{% windows %} + +1. 打开 Git Bash。 +{% data reusables.git.confirm-credential-manager %} +{% data reusables.git.clear-the-stored-credentials %} + {% data reusables.git.no-credential-manager %} + {% data reusables.git.clear-stored-gcm-credentials %} + - If the output is `wincred`, you're using the Windows Credential Manager. To clear the credentials, enter the following command. + + ```shell{:copy} + cmdkey /delete:LegacyGeneric:target=git:https://github.com + ``` +{% data reusables.git.cache-on-repository-path %} +{% data reusables.accounts.create-personal-access-tokens %} +{% data reusables.git.provide-credentials %} + +{% endwindows %} + +{% linux %} + +{% data reusables.git.open-terminal %} +{% data reusables.git.confirm-credential-manager %} +{% data reusables.git.clear-the-stored-credentials %} + {% data reusables.git.no-credential-manager %} + {% data reusables.git.clear-stored-gcm-credentials %} +{% data reusables.git.cache-on-repository-path %} +{% data reusables.accounts.create-personal-access-tokens %} +{% data reusables.git.provide-credentials %} + +{% endlinux %} + +## Contributing to multiple accounts using SSH and `GIT_SSH_COMMAND` + +If you want to use the SSH protocol for both accounts, you can use different SSH keys for each account. For more information about using SSH, see "[Connecting to {% data variables.product.prodname_dotcom %} with SSH](/authentication/connecting-to-github-with-ssh)." + +To use a different SSH key for different repositories that you clone to your workstation, you must write a shell wrapper function for Git operations. The function should perform the following steps. +1. Determine the repository's full name with owner, using a command such as `git config --get remote.origin.url`. +2. Choose the correct SSH key for authentication. +3. Modify `GIT_SSH_COMMAND` accordingly. For more information about `GIT_SSH_COMMAND`, see [Environment Variables](https://git-scm.com/docs/git#Documentation/git.txt-codeGITSSHCOMMANDcode) in the Git documentation. + +For example, the following command sets the `GIT_SSH_COMMAND` environment variable to specify an SSH command that uses the private key file at **_PATH/TO/KEY/FILE_** for authentication to clone the repository named **_OWNER_**/**_REPOSITORY_** on {% data variables.product.product_location %}. + +
    +GIT_SSH_COMMAND='ssh -i PATH/TO/KEY/FILE -o IdentitiesOnly=yes' git clone git@github.com:OWNER/REPOSITORY
+
    diff --git a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts.md b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md similarity index 93% rename from translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts.md rename to translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md index 5ff88a3f41..5946b02367 100644 --- a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts.md +++ b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md @@ -8,12 +8,13 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/merging-multiple-user-accounts - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts versions: fpt: '*' ghec: '*' topics: - Accounts -shortTitle: 合并多个个人帐户 +shortTitle: Merge multiple accounts --- {% tip %} diff --git a/translations/zh-CN/content/actions/creating-actions/metadata-syntax-for-github-actions.md b/translations/zh-CN/content/actions/creating-actions/metadata-syntax-for-github-actions.md index 47ed9ff43f..b311baf195 100644 --- a/translations/zh-CN/content/actions/creating-actions/metadata-syntax-for-github-actions.md +++ b/translations/zh-CN/content/actions/creating-actions/metadata-syntax-for-github-actions.md @@ -354,7 +354,7 @@ runs: #### `runs.steps[*].with` -**可选** 输入参数的 `map` 由操作定义。 每个输入参数都是一个键/值对。 输入参数被设置为环境变量。 该变量的前缀为 INPUT_，并转换为大写。 +**可选** 输入参数的 `map` 由操作定义。 每个输入参数都是一个键/值对。 For more information, see [Example: Specifying inputs](#example-specifying-inputs). ```yaml runs: diff --git a/translations/zh-CN/content/actions/creating-actions/publishing-actions-in-github-marketplace.md b/translations/zh-CN/content/actions/creating-actions/publishing-actions-in-github-marketplace.md index a2f0a8f8f6..97f81a5e48 100644 --- a/translations/zh-CN/content/actions/creating-actions/publishing-actions-in-github-marketplace.md +++ b/translations/zh-CN/content/actions/creating-actions/publishing-actions-in-github-marketplace.md @@ -38,8 +38,10 @@ shortTitle: 在 GitHub Marketplace 中发布 要草拟新发行版并将操作发布到 {% data variables.product.prodname_marketplace %}，请遵循以下说明： {% data reusables.repositories.navigate-to-repo %} -1. 当仓库包含操作元数据文件（`action.yml` 或 `action.yaml`），您会看到一个用于将操作发布到 {% data variables.product.prodname_marketplace %} 的横幅。 单击 **Draft a release（草拟发行版）**。 ![将此操作发布到 Markeplace 按钮](/assets/images/help/repository/publish-github-action-to-markeplace-button.png) -1. 选择**将此操作发布到 {% data variables.product.prodname_marketplace %}**。 如果无法选择**将此操作发布到 {% data variables.product.prodname_marketplace %}** 复选框，则需要先阅读并接受 {% data variables.product.prodname_marketplace %} 协议。 ![选择发布到 Marketplace](/assets/images/help/repository/marketplace_actions_publish.png) +1. Navigate to the action metadata file in your repository (`action.yml` or `action.yaml`), and you'll see a banner to publish the action to {% data variables.product.prodname_marketplace %}. 单击 **Draft a release（草拟发行版）**。 + + ![Publish this action to marketplace button](/assets/images/help/repository/publish-github-action-to-marketplace-button.png) +1. Under "Release Action", select the checkbox to publish the action to the {% data variables.product.prodname_marketplace %}. If you can't select the checkbox, you must first click the link to read and accept the {% data variables.product.prodname_marketplace %} Developer Agreement. ![选择发布到 Marketplace](/assets/images/help/repository/marketplace_actions_publish.png) 1. 如果元数据文件中的标签包含任何问题，您将看到一条错误消息。 ![查看通知](/assets/images/help/repository/marketplace_actions_fixerrors.png) 1. 如果您看到任何屏幕上的建议，请通过更新元数据文件来解决这些问题。 完成后，您将看到一条“Everything looks good!（一切看起来都不错！）”的消息。 ![修复错误](/assets/images/help/repository/marketplace_actions_looksgood.png) 1. 选择“Primary Category（主要类别）”，然后按需要选择“Another Category（另一个类别）”，这将有助于人们找到您的 {% data variables.product.prodname_marketplace %} 中的操作。 ![选择类别](/assets/images/help/repository/marketplace_actions_categories.png) diff --git a/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md b/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md index bf592c0b96..4774b64695 100644 --- a/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md +++ b/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md @@ -73,6 +73,7 @@ topics: "repository": "octo-org/octo-repo", "repository_owner": "octo-org", "actor_id": "12", + "repo_visibility": private, "repository_id": "74", "repository_owner_id": "65", "run_id": "example-run-id", @@ -130,6 +131,7 @@ OIDC 令牌还包括其他标准声明： | `job_workflow_ref` | 这是此作业使用的可重用工作流程的引用路径。 更多信息请参阅“[使用 OpenID 连接和可重用工作流程](/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows)”。 | | `ref` | _（引用）_ 触发工作流程运行的 git 引用。 | | `ref_type` | `ref` 的类型，例如："branch"。 | +| `repo_visibility` | The visibility of the repository where the workflow is running. Accepts the following values: `internal`, `private`, or `public`. | | `仓库` | 运行工作流程的存储库。 | | `repository_id` | 运行工作流程的存储库的 ID。 | | `repository_owner` | 存储 `repository` 的组织的名称。 | @@ -145,11 +147,11 @@ OIDC 令牌还包括其他标准声明： 在云角色/资源上设置条件以限定其对 GitHub 工作流程的访问范围时，受众和主题声明通常结合使用。 - **受众**：默认情况下，此值使用组织或存储库所有者的 URL。 这可用于设置只有特定组织中的工作流程才能访问云角色的条件。 -- **主题**：具有预定义的格式，并且是有关工作流程的某些关键元数据的串联，如 {% data variables.product.prodname_dotcom %} 组织、存储库、分支或关联的[`作业`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idenvironment)环境。 请参阅“[示例主题声明](#example-subject-claims)”，了解如何从串联的元数据汇编主题声明。 +- **Subject**: By default, has a predefined format and is a concatenation of some of the key metadata about the workflow, such as the {% data variables.product.prodname_dotcom %} organization, repository, branch, or associated [`job`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idenvironment) environment. 请参阅“[示例主题声明](#example-subject-claims)”，了解如何从串联的元数据汇编主题声明。 -OIDC 令牌中还支持许多其他声明，这些声明也可用于设置这些条件。 +If you need more granular trust conditions, you can customize the issuer (`iss`) and subject (`sub`) claims that are included with the JWT. For more information, see "[Customizing the token claims](#customizing-the-token-claims)". -此外，云提供商可以允许你为访问令牌分配角色，从而允许你指定更精细的权限。 +There are also many additional claims supported in the OIDC token that can be used for setting these conditions. 此外，云提供商可以允许你为访问令牌分配角色，从而允许你指定更精细的权限。 {% note %} @@ -240,6 +242,197 @@ curl -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" "$ACTIONS_ID_TOK {% data reusables.actions.oidc-permissions-token %} +{% ifversion actions-oidc-hardening-config %} +## Customizing the token claims + +You can security harden your OIDC configuration by customizing the claims that are included with the JWT. These customisations allow you to define more granular trust conditions on your cloud roles when allowing your workflows to access resources hosted in the cloud: + +{% ifversion ghec %} - For an additional layer of security, you can append the `issuer` url with your enterprise slug. This lets you set conditions on the issuer (`iss`) claim, configuring it to only accept JWT tokens from a unique `issuer` URL that must include your enterprise slug.{% endif %} +- You can standardize your OIDC configuration by setting conditions on the subject (`sub`) claim that require JWT tokens to originate from a specific repository, reusable workflow, or other source. +- You can define granular OIDC policies by using additional OIDC token claims, such as `repository_id` and `repo_visibility`. For more information, see "[Understanding the OIDC token](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#understanding-the-oidc-token)". + +To customize these claim formats, organization and repository admins can use the REST API endpoints described in the following sections. + +{% ifversion ghec %} + +### Switching to a unique token URL + +By default, the JWT is issued by {% data variables.product.prodname_dotcom %}'s OIDC provider at `https://token.actions.githubusercontent.com`. This path is presented to your cloud provider using the `iss` value in the JWT. + +Enterprise admins can security harden their OIDC configuration by configuring their enterprise to receive tokens from a unique URL at `https://api.github.com/enterprises//actions/oidc/customization/issuer`. Replace `` with the slug value of your enterprise. + +This configuration means that your enterprise will receive the OIDC token from a unique URL, and you can then configure your cloud provider to only accept tokens from that URL. This helps ensure that only the enterprise's repositories can access your cloud resources using OIDC. + +To activate this setting for your enterprise, an enterprise admin must use the `/enterprises/{enterprise}/actions/oidc/customization/issuer` endpoint and specify `"include_enterprise_slug": true` in the request body. For more information, see "[Set the {% data variables.product.prodname_actions %} OIDC custom issuer policy for an enterprise](/rest/actions/oidc#set-the-github-actions-oidc-custom-issuer-policy-for-an-enterprise)." + +After this setting is applied, the JWT will contain the updated `iss` value. In the following example, the `iss` key uses `octocat-inc` as its `enterpriseSlug` value: + +```json +{ + "jti": "6f4762ed-0758-4ccb-808d-ee3af5d723a8" + "sub": "repo:octocat-inc/private-server:ref:refs/heads/main" + "aud": "http://octocat-inc.example/octocat-inc" + "enterprise": "octocat-inc" + "iss": "https://api.github.com/enterprises/octocat-inc/actions/oidc/customization/issuer", + "bf": 1755350653, + "exp": 1755351553, + "iat": 1755351253 +} +``` + +{% endif %} + +### Customizing the subject claims for an organization + +To configure organization-wide security, compliance, and standardization, you can customize the standard claims to suit your required access conditions. If your cloud provider supports conditions on subject claims, you can create a condition that checks whether the `sub` value matches the path of the reusable workflow, such as `"job_workflow_ref: "octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main""`. The exact format will vary depending on your cloud provider's OIDC configuration. To configure the matching condition on {% data variables.product.prodname_dotcom %}, you can can use the REST API to require that the `sub` claim must always include a specific custom claim, such as `job_workflow_ref`. For more information, see "[Set the customization template for an OIDC subject claim for an organization](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization)." + +Customizing the claims results in a new format for the entire `sub` claim, which replaces the default predefined `sub` format in the token described in "[Example subject claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims)." + +The following example templates demonstrate various ways to customize the subject claim. To configure these settings on {% data variables.product.prodname_dotcom %}, organization admins use the REST API to specify a list of claims that must be included in the subject (`sub`) claim. {% data reusables.actions.use-request-body-api %} + +To customize your subject claims, you should first create a matching condition in your cloud provider's OIDC configuration, before customizing the configuration using the REST API. Once the configuration is completed, each time a new job runs, the OIDC token generated during that job will follow the new customization template. If the matching condition doesn't exist in the cloud provider's OIDC configuration before the job runs, the generated token might not be accepted by the cloud provider, since the cloud conditions may not be synchronized. + +{% note %} + +**Note**: When the organization template is applied, it will not affect any existing repositories that already use OIDC. For existing repositories, as well as any new repositories that are created after the template has been applied, the repository owner will need to opt-in to receive this configuration. For more information, see "[Set the opt-in flag of an OIDC subject claim customization for a repository](/rest/actions/oidc#set-the-opt-in-flag-of-an-oidc-subject-claim-customization-for-a-repository)." + +{% endnote %} + +#### Example: Allowing repository based on visibility and owner + +This example template allows the `sub` claim to have a new format, using `repository_owner` and `repository_visibility`: + +```json +{ + "include_claim_keys": [ + "repository_owner", + "repository_visibility" + ] +} +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repository_owner` and `repository_visibility`. For example: `"repository_owner: "monalisa":repository_visibility:private"`. The approach lets you restrict cloud role access to only private repositories within an organization or enterprise. + +#### Example: Allowing access to all repositories with a specific owner + +This example template enables the `sub` claim to have a new format with only the value of `repository_owner`. {% data reusables.actions.use-request-body-api %} + +```json +{ + "include_claim_keys": [ + "repository_owner" + ] +} + +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include a specific value for `repository_owner`. For example: `"repository_owner: "monalisa""` + +#### Example: Requiring a reusable workflow + +This example template allows the `sub` claim to have a new format that contains the value of the `job_workflow_ref` claim. This enables an enterprise to use [reusable workflows](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims) to enforce consistent deployments across its organizations and repositories. + +{% data reusables.actions.use-request-body-api %} + +```json + { + "include_claim_keys": [ + "job_workflow_ref" + ] + } +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include a specific value for `job_workflow_ref`. For example: `"job_workflow_ref: "octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main""`. + +#### Example: Requiring a reusable workflow and other claims + +The following example template combines the requirement of a specific reusable workflow with additional claims. {% data reusables.actions.use-request-body-api %} + +This example also demonstrates how to use `"context"` to define your conditions. This is the part that follows the repository in the [default `sub` format](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims). For example, when the job references an environment, the context contains: `environment:`. + +```json +{ + "include_claim_keys": [ + "repo", + "context", + "job_workflow_ref" + ] +} +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repo`, `context`, and `job_workflow_ref`. + +This customization template requires that the `sub` uses the following format: `repo::environment::job_workflow_ref:`. For example: `"sub": "repo:octo-org/octo-repo:environment:prod:job_workflow_ref:octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main"` + +#### Example: Granting access to a specific repository + +This example template lets you grant cloud access to all the workflows in a specific repository, across all branches/tags and environments. To help improve security, combine this template with the custom issuer URL described in "[Customizing the token URL for an enterprise](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-url-for-an-enterprise)." + +{% data reusables.actions.use-request-body-api %} + +```json +{ + "include_claim_keys": [ + "repo" + ] +} +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require a `repo` claim that matches the required value. + +#### Example: Using system-generated GUIDs + +This example template enables predictable OIDC claims with system-generated GUIDs that do not change between renames of entities (such as renaming a repository). {% data reusables.actions.use-request-body-api %} + +```json + { + "include_claim_keys": [ + "repository_id" + ] + } +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require a `repository_id` claim that matches the required value. + +或: + +```json +{ + "include_claim_keys": [ + "repository_owner_id" + ] +} +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require a `repository_owner_id` claim that matches the required value. + +#### Resetting your customizations + +This example template resets the subject claims to the default format. {% data reusables.actions.use-request-body-api %} This template effectively opts out of any organization-level customization policy. + +```json +{ + "include_claim_keys": [ + "repo", + "context" + ] +} +``` + +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repo` and `context`. + +#### Using the default subject claims + +For repositories that can receive a subject claim policy from their organization, the repository owner can later choose to opt-out and instead use the default `sub` claim format. To configure this, the repository admin must use the REST API endpoint at "[Set the opt-out flag of an OIDC subject claim customization for a repository](/rest/actions/oidc#set-the-opt-out-flag-of-an-oidc-subject-claim-customization-for-a-repository)" with the following request body: + +```json +{ + "use_default": true +} +``` + +{% endif %} + ## 更新 OIDC 的工作流程 现在，您可以更新 YAML 工作流程，以使用 OIDC 访问令牌而不是机密。 常用的云提供商已发布其官方登录操作，使您可以轻松开始使用 OIDC。 有关更新工作流程的详细信息，请参阅下面“[为云提供商启用 OpenID Connect ](#enabling-openid-connect-for-your-cloud-provider)”中列出的云特定指南。 diff --git a/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md b/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md index a3d8a64281..28fd1ba7e0 100644 --- a/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md +++ b/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md @@ -32,10 +32,52 @@ OpenID Connect (OIDC) 允许您的 {% data variables.product.prodname_actions %} 要将 OIDC 与 HashiCorp Vault 配合使用，您需要为 {% data variables.product.prodname_dotcom %} OIDC 提供商添加信任配置。 更多信息请参阅 HashiCorp Vault [文档](https://www.vaultproject.io/docs/auth/jwt)。 -配置 Vault 接受 JSON Web 令牌 (JWT) 进行身份验证： -- 对于 `oidc_discovery_url`，请使用 {% ifversion ghes %}`https://HOSTNAME/_services/token`{% else %}`https://token.actions.githubusercontent.com`{% endif %} -- 对于 `bound_issuer`，请使用 {% ifversion ghes %}`https://HOSTNAME/_services/token`{% else %}`https://token.actions.githubusercontent.com`{% endif %} -- 确保针对您的安全要求正确定义了 `bound_subject`。 更多信息请参阅[“使用云配置 OIDC 信任”](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#configuring-the-oidc-trust-with-the-cloud)和 [`hashicorp/vault-action`](https://github.com/hashicorp/vault-action)。 +To configure your Vault server to accept JSON Web Tokens (JWT) for authentication: + +1. Enable the JWT `auth` method, and use `write` to apply the configuration to your Vault. For `oidc_discovery_url` and `bound_issuer` parameters, use {% ifversion ghes %}`https://HOSTNAME/_services/token`{% else %}`https://token.actions.githubusercontent.com`{% endif %}. These parameters allow the Vault server to verify the received JSON Web Tokens (JWT) during the authentication process. + + ```sh{:copy} + vault auth enable jwt + ``` + + ```sh{:copy} + vault write auth/jwt/config \ + bound_issuer="{% ifversion ghes %}https://HOSTNAME/_services/token{% else %}https://token.actions.githubusercontent.com{% endif %}" \ + oidc_discovery_url="{% ifversion ghes %}https://HOSTNAME/_services/token{% else %}https://token.actions.githubusercontent.com{% endif %}" + ``` +2. Configure a policy that only grants access to the specific paths your workflows will use to retrieve secrets. For more advanced policies, see the HashiCorp Vault [Policies documentation](https://www.vaultproject.io/docs/concepts/policies). + + ```sh{:copy} + vault policy write myproject-production - <`：将此值替换为您的 HashiCorp Vault 的URL。 +- ``: Replace this with the Namespace you've set in HashiCorp Vault. For example: `admin`. - ``：将此值替换为您在 HashiCorp Vault 信任关系中设置的角色。 -- ``：将此值替换为您在 HashiCorp Vault 信任关系中定义的受众。 -- ``：将此值替换为您从 HashiCorp Vault 检索的机密的路径。 例如：`secret/data/ci npmToken`。 +- ``：将此值替换为您从 HashiCorp Vault 检索的机密的路径。 For example: `secret/data/production/ci npmToken`. ```yaml{:copy} jobs: - retrieve-secret: - steps: - - name: Retrieve secret from Vault - uses: hashicorp/vault-action@v2.4.0 - with: - url: - role: - method: jwt - jwtGithubAudience: - secrets: + retrieve-secret: + runs-on: ubuntu-latest + permissions: + id-token: write + contents: read + steps: + - name: Retrieve secret from Vault + uses: hashicorp/vault-action@v2.4.0 + with: + method: jwt + url: + namespace: + role: + secrets: - - name: Use secret from Vault - run: | - # This step has access to the secret retrieved above; see hashicorp/vault-action for more details. + - name: Use secret from Vault + run: | + # This step has access to the secret retrieved above; see hashicorp/vault-action for more details. +``` + +{% note %} + +**注**： + +- If your Vault server is not accessible from the public network, consider using a self-hosted runner with other available Vault [auth methods](https://www.vaultproject.io/docs/auth). 更多信息请参阅“[关于自托管运行器](/actions/hosting-your-own-runners/about-self-hosted-runners)”。 +- `` must be set for a Vault Enterprise (including HCP Vault) deployment. For more information, see [Vault namespace](https://www.vaultproject.io/docs/enterprise/namespaces). + +{% endnote %} + +### Revoking the access token + +By default, the Vault server will automatically revoke access tokens when their TTL is expired, so you don't have to manually revoke the access tokens. However, if you do want to revoke access tokens immediately after your job has completed or failed, you can manually revoke the issued token using the [Vault API](https://www.vaultproject.io/api/auth/token#revoke-a-token-self). + +1. Set the `exportToken` option to `true` (default: `false`). This exports the issued Vault access token as an environment variable: `VAULT_TOKEN`. +2. Add a step to call the [Revoke a Token (Self)](https://www.vaultproject.io/api/auth/token#revoke-a-token-self) Vault API to revoke the access token. + +```yaml{:copy} +jobs: + retrieve-secret: + runs-on: ubuntu-latest + permissions: + id-token: write + contents: read + steps: + - name: Retrieve secret from Vault + uses: hashicorp/vault-action@v2.4.0 + with: + exportToken: true + method: jwt + url: + role: + secrets: + + - name: Use secret from Vault + run: | + # This step has access to the secret retrieved above; see hashicorp/vault-action for more details. + + - name: Revoke token + # This step always runs at the end regardless of the previous steps result + if: always() + run: | + curl -X POST -sv -H "X-Vault-Token: {% raw %}${{ env.VAULT_TOKEN }}{% endraw %}" \ + /v1/auth/token/revoke-self ``` diff --git a/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md b/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md index 3d3d21dcfd..af140033c8 100644 --- a/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md +++ b/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md @@ -23,11 +23,18 @@ topics: 您可以创建一个可重用的工作流程来执行部署步骤，而不是将部署作业从一个工作流程复制并粘贴到另一个工作流程。 如果可重用工作流程满足“[重用工作流](/actions/learn-github-actions/reusing-workflows#access-to-reusable-workflows)”中所述的访问要求之一，则可以由另一个工作流程使用。 -与 OpenID Connect (OIDC) 结合使用时，可重用工作流程可让您在存储库、组织或企业中实施一致的部署。 为此，可以基于可重用工作流程在云角色上定义信任条件。 +You should be familiar with the concepts described in "\[Reusing workflows\](/actions/learn-github-actions/reusing-workflows" and "[About security hardening with OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)." -为了创建基于可重用工作流程的信任条件，云提供商必须支持 `job_workflow_ref` 的自定义声明。 这允许您的云提供商确定作业最初来自哪个存储库。 如果您的云提供商仅支持标准声明（_受众_和_主题_），则无法确定作业是否源自可重用工作流程存储库。 支持 `job_workflow_ref` 的云提供商包括 Google Cloud Platform 和 HashiCorp Vault。 +## Defining the trust conditions -在继续之前，您应该熟悉[可重用工作流程](/actions/learn-github-actions/reusing-workflows) 和 [OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect) 的概念。 +与 OpenID Connect (OIDC) 结合使用时，可重用工作流程可让您在存储库、组织或企业中实施一致的部署。 为此，可以基于可重用工作流程在云角色上定义信任条件。 The available options will vary depending on your cloud provider: + +- **Using `job_workflow_ref`**: + - To create trust conditions based on reusable workflows, your cloud provider must support custom claims for `job_workflow_ref`. 这允许您的云提供商确定作业最初来自哪个存储库。 + - For clouds that only support the standard claims (audience (`aud`) and subject (`sub`)), you can use the API to customize the `sub` claim to include `job_workflow_ref`. For more information, see "[Customizing the token claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". Support for custom claims is currently available for Google Cloud Platform and HashiCorp Vault. + +- **Customizing the token claims**: + - You can configure more granular trust conditions by customizing the issuer (`iss`) and subject (`sub`) claims included with the JWT. For more information, see "[Customizing the token claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". ## 令牌如何与可重用工作流程配合使用 diff --git a/translations/zh-CN/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md b/translations/zh-CN/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md index 14e01a6ba9..d95f60b37a 100644 --- a/translations/zh-CN/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md +++ b/translations/zh-CN/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md @@ -18,15 +18,23 @@ shortTitle: 启动时运行运行器应用程序 {% capture service_first_step %}1. 如果自托管的运行器应用程序正在运行，请停止它。{% endcapture %} {% capture service_non_windows_intro_shell %}在运行器机器上，在安装了自托管运行器应用程序的目录中打开 shell。 使用以下命令安装和管理自托管的运行器服务。{% endcapture %} -{% capture service_nonwindows_intro %}将自托管的运行器应用程序配置为服务之前，您必须添加运行器到 {% data variables.product.product_name %}。 更多信息请参阅“[添加自托管的运行器](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)”。{% endcapture %} -{% capture service_win_name %}actions.runner.*{% endcapture %} +{% capture service_nonwindows_intro %} + +{% note %} + +**Note:** You must add a runner to {% data variables.product.product_name %} before you can configure the self-hosted runner application as a service. 更多信息请参阅“[添加自托管的运行器](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)”。 + +{% endnote %} +{% endcapture %} + +{% capture service_win_name %}actions.runner.*{% endcapture %} {% linux %} {{ service_nonwindows_intro }} -对于使用 `systemd` 的 Linux 系统，您可以使用随自托管运行器应用程序分发的 `svc.h` 脚本来安装和管理应用程序即服务。 +For Linux systems that use `systemd`, you can use the `svc.sh` script that is created after successfully adding the runner to install and manage using the application as a service. {{ service_non_windows_intro_shell }} diff --git a/translations/zh-CN/content/actions/learn-github-actions/contexts.md b/translations/zh-CN/content/actions/learn-github-actions/contexts.md index 5a9f912ee0..b4a1356f70 100644 --- a/translations/zh-CN/content/actions/learn-github-actions/contexts.md +++ b/translations/zh-CN/content/actions/learn-github-actions/contexts.md @@ -33,17 +33,13 @@ miniTocMaxHeadingLevel: 3 {% data reusables.actions.context-injection-warning %} -| 上下文名称 | 类型 | 描述 | -| ---------- | ---- | ----------------------------------------------------------------- | -| `github` | `对象` | 工作流程运行的相关信息。 更多信息请参阅 [`github` 上下文](#github-context)。 | -| `env` | `对象` | 包含工作流程、作业或步骤中设置的环境变量。 更多信息请参阅 [`env` 上下文](#env-context)。 | -| `job` | `对象` | 有关当前运行的作业的信息。 更多信息请参阅 [`job` 上下文](#job-context)。 | -| `steps` | `对象` | 有关当前作业中已运行的步骤的信息。 更多信息请参阅 [`steps` 上下文](#steps-context)。 | -| `runner` | `对象` | 运行当前作业的运行程序相关信息。 更多信息请参阅 [`runner` 上下文](#runner-context)。 | -| `secrets` | `对象` | 包含可用于工作流程运行的机密的名称和值。 更多信息请参阅 [`secrets` 上下文](#secrets-context)。 | -| `strategy` | `对象` | 有关当前作业的矩阵执行策略的信息。 更多信息请参阅 [`strategy` 上下文](#strategy-context)。 | -| `matrix` | `对象` | 包含在工作流程中定义的应用于当前作业的矩阵属性。 更多信息请参阅 [`matrix` 上下文](#matrix-context)。 | -| `needs` | `对象` | 包含定义为当前作业依赖项的所有作业的输出。 更多信息请参阅 [`needs` 上下文](#needs-context)。 | +| 上下文名称 | 类型 | 描述 | +| -------- | ---- | -------------------------------------------------------- | +| `github` | `对象` | 工作流程运行的相关信息。 更多信息请参阅 [`github` 上下文](#github-context)。 | +| `env` | `对象` | 包含工作流程、作业或步骤中设置的环境变量。 更多信息请参阅 [`env` 上下文](#env-context)。 | +| `job` | `对象` | 有关当前运行的作业的信息。 更多信息请参阅 [`job` 上下文](#job-context)。 | +{%- ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} +| `jobs` | `object` | For reusable workflows only, contains outputs of jobs from the reusable workflow. For more information, see [`jobs` context](#jobs-context). |{% endif %} | `steps` | `object` | Information about the steps that have been run in the current job. 更多信息请参阅 [`steps` 上下文](#steps-context)。 | | `runner` | `object` | Information about the runner that is running the current job. 更多信息请参阅 [`runner` 上下文](#runner-context)。 | | `secrets` | `object` | Contains the names and values of secrets that are available to a workflow run. 更多信息请参阅 [`secrets` 上下文](#secrets-context)。 | | `strategy` | `object` | Information about the matrix execution strategy for the current job. 更多信息请参阅 [`strategy` 上下文](#strategy-context)。 | | `matrix` | `object` | Contains the matrix properties defined in the workflow that apply to the current job. 更多信息请参阅 [`matrix` 上下文](#matrix-context)。 | | `needs` | `object` | Contains the outputs of all jobs that are defined as a dependency of the current job. 更多信息请参阅 [`needs` 上下文](#needs-context)。 | {%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4757 %} | `inputs` | `object` | 包含可重用 {% ifversion actions-unified-inputs %}或手动触发 {% endif %}工作流程的输入。 更多信息请参阅 [`inputs` 上下文](#inputs-context)。 |{% endif %} @@ -84,7 +80,7 @@ miniTocMaxHeadingLevel: 3 | jobs.<job_id>.name | github, needs, strategy, matrix, inputs | | | jobs.<job_id>.outputs.<output_id> | github, needs, strategy, matrix, job, runner, env, secrets, steps, inputs | | | jobs.<job_id>.runs-on | github, needs, strategy, matrix, inputs | | -| jobs.<job_id>.secrets.<secrets_id> | github, needs, secrets{% ifversion actions-unified-inputs %}, inputs{% endif %} | | +| jobs.<job_id>.secrets.<secrets_id> | github, needs,{% ifversion actions-reusable-workflow-matrix %} strategy, matrix,{% endif %} secrets{% ifversion actions-unified-inputs %}, inputs{% endif %} | | | jobs.<job_id>.services | github, needs, strategy, matrix, inputs | | | jobs.<job_id>.services.<service_id>.credentials | github, needs, strategy, matrix, env, secrets, inputs | | | jobs.<job_id>.services.<service_id>.env.<env_id> | github, needs, strategy, matrix, job, runner, env, secrets, inputs | | @@ -98,7 +94,7 @@ miniTocMaxHeadingLevel: 3 | jobs.<job_id>.steps.working-directory | github, needs, strategy, matrix, job, runner, env, secrets, steps, inputs | hashFiles | | jobs.<job_id>.strategy | github, needs, inputs | | | jobs.<job_id>.timeout-minutes | github, needs, strategy, matrix, inputs | | -| jobs.<job_id>.with.<with_id> | github, needs{% ifversion actions-unified-inputs %}, inputs{% endif %} | | +| jobs.<job_id>.with.<with_id> | github, needs{% ifversion actions-reusable-workflow-matrix %}, strategy, matrix{% endif %}{% ifversion actions-unified-inputs %}, inputs{% endif %} | | | on.workflow_call.inputs.<inputs_id>.default | github{% ifversion actions-unified-inputs %}, inputs{% endif %} | | | on.workflow_call.outputs.<output_id>.value | github, jobs, inputs | | {% else %} @@ -200,7 +196,7 @@ jobs: {%- ifversion fpt or ghec or ghes > 3.5 or ghae-issue-4722 %} | `github.run_attempt` | `string` | 在存储库中运行的特定工作流程的每次尝试的唯一编号。 对于工作流程运行的第一次尝试，此数字从 1 开始，并随着每次重新运行而递增。 | {%- endif %} -| `github.server_url` | `string` | GitHub 服务器的 URL。 例如：`https://github.com`。 | | `github.sha` | `string` | 触发工作流运行的提交 SHA。 | | `github.token` | `string` | 用于代表存储库上安装的 GitHub 应用进行身份验证的令牌。 这在功能上等同于 `GITHUB_TOKEN` 密码。 更多信息请参阅“[自动令牌身份验证](/actions/security-guides/automatic-token-authentication)”。
    注意：此上下文属性由 Actions 运行器设置，并且仅在作业的执行 `steps` 中可用。 否则，此属性的值将为 `null`。 |{% ifversion actions-stable-actor-ids %} | `github.triggering_actor` | `string` | The username of the user that initiated the workflow run. If the workflow run is a re-run, this value may differ from `github.actor`. Any workflow re-runs will use the privileges of `github.actor`, even if the actor initiating the re-run (`github.triggering_actor`) has different privileges. |{% endif %} | `github.workflow` | `string` | The name of the workflow. 如果工作流程文件未指定 `name`，此属性的值将是仓库中工作流程文件的完整路径。 | | `github.workspace` | `string` | 运行器上步骤的默认工作目录，以及使用[`检出`](https://github.com/actions/checkout)操作时存储库的默认位置。 | +| `github.server_url` | `string` | GitHub 服务器的 URL。 例如：`https://github.com`。 | | `github.sha` | `string` | {% data reusables.actions.github_sha_description %} | | `github.token` | `string` | A token to authenticate on behalf of the GitHub App installed on your repository. 这在功能上等同于 `GITHUB_TOKEN` 密码。 更多信息请参阅“[自动令牌身份验证](/actions/security-guides/automatic-token-authentication)”。
    注意：此上下文属性由 Actions 运行器设置，并且仅在作业的执行 `steps` 中可用。 否则，此属性的值将为 `null`。 |{% ifversion actions-stable-actor-ids %} | `github.triggering_actor` | `string` | The username of the user that initiated the workflow run. If the workflow run is a re-run, this value may differ from `github.actor`. Any workflow re-runs will use the privileges of `github.actor`, even if the actor initiating the re-run (`github.triggering_actor`) has different privileges. |{% endif %} | `github.workflow` | `string` | The name of the workflow. 如果工作流程文件未指定 `name`，此属性的值将是仓库中工作流程文件的完整路径。 | | `github.workspace` | `string` | 运行器上步骤的默认工作目录，以及使用[`检出`](https://github.com/actions/checkout)操作时存储库的默认位置。 | ### `github` 上下文的示例内容 @@ -390,6 +386,72 @@ jobs: - run: ./run-tests ``` +{% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} + +## `jobs` context + +The `jobs` context is only available in reusable workflows, and can only be used to set outputs for a reusable workflow. 更多信息请参阅“[重用工作流程](/actions/using-workflows/reusing-workflows#using-outputs-from-a-reusable-workflow)”。 + +| 属性名称 | 类型 | 描述 | +| ------------------------------------------------- | ----- | -------------------------------------------------------------------------------------------------------------------------- | +| `jobs` | `对象` | This is only available in reusable workflows, and can only be used to set outputs for a reusable workflow. 此对象包含下面列出的所有属性。 | +| `jobs..result` | `字符串` | The result of a job in the reusable workflow. 可能的值包括 `success`、`failure`、`cancelled` 或 `skipped`。 | +| `jobs..outputs` | `对象` | The set of outputs of a job in a reusable workflow. | +| `jobs..outputs.` | `字符串` | The value of a specific output for a job in a reusable workflow. | + +### Example contents of the `jobs` context + +This example `jobs` context contains the result and outputs of a job from a reusable workflow run. + +```json +{ + example_job: { + result: success, + outputs: { + output1: hello, + output2: world + } + } +} +``` + +### Example usage of the `jobs` context + +This example reusable workflow uses the `jobs` context to set outputs for the reusable workflow. Note how the outputs flow up from the steps, to the job, then to the `workflow_call` trigger. 更多信息请参阅“[重用工作流程](/actions/using-workflows/reusing-workflows#using-outputs-from-a-reusable-workflow)”。 + +{% raw %} +```yaml{:copy} +name: Reusable workflow + +on: + workflow_call: + # Map the workflow outputs to job outputs + outputs: + firstword: + description: "The first output string" + value: ${{ jobs.example_job.outputs.output1 }} + secondword: + description: "The second output string" + value: ${{ jobs.example_job.outputs.output2 }} + +jobs: + example_job: + name: Generate output + runs-on: ubuntu-latest + # Map the job outputs to step outputs + outputs: + output1: ${{ steps.step1.outputs.firstword }} + output2: ${{ steps.step2.outputs.secondword }} + steps: + - id: step1 + run: echo "::set-output name=firstword::hello" + - id: step2 + run: echo "::set-output name=secondword::world" +``` +{% endraw %} + +{% endif %} + ## `steps` 上下文 `steps` 上下文包含有关当前作业中指定了 [`id`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsid) 且已运行的步骤的信息。 diff --git a/translations/zh-CN/content/actions/learn-github-actions/environment-variables.md b/translations/zh-CN/content/actions/learn-github-actions/environment-variables.md index a290bcda48..d8f2e403a4 100644 --- a/translations/zh-CN/content/actions/learn-github-actions/environment-variables.md +++ b/translations/zh-CN/content/actions/learn-github-actions/environment-variables.md @@ -147,7 +147,7 @@ jobs: {%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5338 %} | `GITHUB_REF_NAME` | {% data reusables.actions.ref_name-description %} For example, `feature-branch-1`.| | `GITHUB_REF_PROTECTED` | {% data reusables.actions.ref_protected-description %} | | `GITHUB_REF_TYPE` | {% data reusables.actions.ref_type-description %} {%- endif %} -| `GITHUB_REPOSITORY` |所有者和存储库名称。 例如 `octocat/Hello-World`。 | | `GITHUB_REPOSITORY_OWNER` |存储库所有者的姓名。 例如 `octocat`。 | | `GITHUB_RETENTION_DAYS` |工作流程运行日志和构件的保留天数。 例如 `90`。 | | `GITHUB_RUN_ATTEMPT` | 在存储库中运行的特定工作流程的每次尝试的唯一编号。 对于工作流程运行的第一次尝试，此数字从 1 开始，并随着每次重新运行而递增。 例如 `3`。 | | `GITHUB_RUN_ID` | {% data reusables.actions.run_id_description %} 例如 `1658821493`。 | | `GITHUB_RUN_NUMBER` | {% data reusables.actions.run_number_description %} 例如 `3`。 | | `GITHUB_SERVER_URL`| {% data variables.product.product_name %} 服务器的 URL。 例如：`https://{% data variables.product.product_url %}`。 | `GITHUB_SHA` | 触发工作流程的提交 SHA。 此提交 SHA 的值取决于触发工作流程的事件。 更多信息请参阅“[触发工作流程的事件](/actions/using-workflows/events-that-trigger-workflows)”。 例如 `ffac537e6cbbf934b08745a378932722df287a53`。 | +| `GITHUB_REPOSITORY` |所有者和存储库名称。 例如 `octocat/Hello-World`。 | | `GITHUB_REPOSITORY_OWNER` |存储库所有者的姓名。 例如 `octocat`。 | | `GITHUB_RETENTION_DAYS` |工作流程运行日志和构件的保留天数。 例如 `90`。 | | `GITHUB_RUN_ATTEMPT` | 在存储库中运行的特定工作流程的每次尝试的唯一编号。 对于工作流程运行的第一次尝试，此数字从 1 开始，并随着每次重新运行而递增。 例如 `3`。 | | `GITHUB_RUN_ID` | {% data reusables.actions.run_id_description %} 例如 `1658821493`。 | | `GITHUB_RUN_NUMBER` | {% data reusables.actions.run_number_description %} 例如 `3`。 | | `GITHUB_SERVER_URL`| {% data variables.product.product_name %} 服务器的 URL。 例如：`https://{% data variables.product.product_url %}`。 | `GITHUB_SHA` | {% data reusables.actions.github_sha_description %} {%- ifversion actions-job-summaries %} | `GITHUB_STEP_SUMMARY` | 包含工作流程命令中作业摘要的文件在运行器上的路径。 此文件对于当前步骤是唯一的，并且会针对作业中的每个步骤进行更改。 例如，`/home/rob/runner/_layout/_work/_temp/_runner_file_commands/step_summary_1cb22d7f-5663-41a8-9ffc-13472605c76c`。 更多信息请参阅“[{% data variables.product.prodname_actions %} 的工作流程命令](/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary)”。 | {%- endif %} diff --git a/translations/zh-CN/content/actions/learn-github-actions/understanding-github-actions.md b/translations/zh-CN/content/actions/learn-github-actions/understanding-github-actions.md index adc7f99fe1..b2945079e8 100644 --- a/translations/zh-CN/content/actions/learn-github-actions/understanding-github-actions.md +++ b/translations/zh-CN/content/actions/learn-github-actions/understanding-github-actions.md @@ -93,7 +93,7 @@ _操作_是 {% data variables.product.prodname_actions %} 平台的自定义应 - 要继续了解 {% data variables.product.prodname_actions %}，请参阅“[查找和自定义操作](/actions/learn-github-actions/finding-and-customizing-actions)”。 {% ifversion fpt or ghec or ghes %} -- 要了解 {% data variables.product.prodname_actions %} 的计费方式，请参阅“[关于 {% data variables.product.prodname_actions %} 的计费](/actions/reference/usage-limits-billing-and-administration#about-billing-for-github-actions)”。 +- To understand how billing works for {% data variables.product.prodname_actions %}, see "[About billing for {% data variables.product.prodname_actions %}](/actions/reference/usage-limits-billing-and-administration#about-billing-for-github-actions)." {% endif %} ## 联系支持 diff --git a/translations/zh-CN/content/actions/publishing-packages/publishing-nodejs-packages.md b/translations/zh-CN/content/actions/publishing-packages/publishing-nodejs-packages.md index b05078b9e3..aa8257e381 100644 --- a/translations/zh-CN/content/actions/publishing-packages/publishing-nodejs-packages.md +++ b/translations/zh-CN/content/actions/publishing-packages/publishing-nodejs-packages.md @@ -98,9 +98,9 @@ always-auth=true ### 配置目标仓库 -如果您没有在 *package.json* 文件中提供 `repository` 键，则 {% data variables.product.prodname_registry %} 将包发布到您在 *package.json* 文件的 `name` 字段中指定的 {% data variables.product.prodname_dotcom %} 仓库。 例如，名为 `@my-org/test` 的包将被发布到 `my-org/test` {% data variables.product.prodname_dotcom %} 仓库。 +Linking your package to {% data variables.product.prodname_registry %} using the `repository` key is optional. If you choose not to provide the `repository` key in your *package.json* file, then {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the `name` field of the *package.json* file. 例如，名为 `@my-org/test` 的包将被发布到 `my-org/test` {% data variables.product.prodname_dotcom %} 仓库。 If the `url` specified in the `repository` key is invalid, your package may still be published however it won't be linked to the repository source as intended. -但是，如果您提供了 `repository` 键，则该键中的仓库将被用作 {% data variables.product.prodname_registry %} 的目标 npm 注册表。 例如，发布以下 *package.json* 将导致名为 `my-amazing-package` 的包被发布到 `octocat/my-other-repo` {% data variables.product.prodname_dotcom %} 仓库。 +If you do provide the `repository` key in your *package.json* file, then the repository in that key is used as the destination npm registry for {% data variables.product.prodname_registry %}. 例如，发布以下 *package.json* 将导致名为 `my-amazing-package` 的包被发布到 `octocat/my-other-repo` {% data variables.product.prodname_dotcom %} 仓库。 Once published, only the repository source is updated, and the package doesn't inherit any permissions from the destination repository. ```json { diff --git a/translations/zh-CN/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md b/translations/zh-CN/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md index 16c47f1261..e26a9bb8ce 100644 --- a/translations/zh-CN/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md +++ b/translations/zh-CN/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md @@ -51,7 +51,7 @@ miniTocMaxHeadingLevel: 3 工作流程可以访问和还原当前分支、基础分支（包括复刻的仓库的基本分支）或默认分支（通常是 `main`）中创建的缓存 例如，在默认分支上创建的缓存可从任何拉取请求访问。 另外，如果分支 `feature-b` 具有基础分支 `feature-a`，则触发于 `feature-b` 的工作流程可以访问默认分支 (`main`)、`feature-a` 和 `feature-b` 中创建的缓存。 -访问限制通过在不同分支之间创建逻辑边界来提供缓存隔离和安全。 例如， 为分支 `feature-a`（具有基础分支 `main`）创建的缓存将无法访问分支 `feature-c`（具有基础分支 `main`）的拉取请求。 +Access restrictions provide cache isolation and security by creating a logical boundary between different branches or tags. 例如， 为分支 `feature-a`（具有基础分支 `main`）创建的缓存将无法访问分支 `feature-c`（具有基础分支 `main`）的拉取请求。 On similar lines, a cache created for the tag `release-a` (from the base `main`) would not be accessible to a workflow triggered for the tag `release-b` (with the base `main`). 仓库中的多个工作流程共享缓存条目。 可以从同一仓库和分支的另一个工作流程访问和恢复为工作流程中的分支创建的缓存。 diff --git a/translations/zh-CN/content/actions/using-workflows/events-that-trigger-workflows.md b/translations/zh-CN/content/actions/using-workflows/events-that-trigger-workflows.md index 4ab6eaa0c2..11772563b6 100644 --- a/translations/zh-CN/content/actions/using-workflows/events-that-trigger-workflows.md +++ b/translations/zh-CN/content/actions/using-workflows/events-that-trigger-workflows.md @@ -812,6 +812,8 @@ on: 此事件在拉取请求基础的上下文中运行，而不是像 `pull_request` 事件一样在合并提交的上下文中运行。 这样可以防止从拉取请求的头部执行不安全的代码，以免更改您的仓库或窃取您在工作流程中使用的任何机密。 此事件允许您的工作流程对来自复刻的拉取请求执行标记或评论等操作。 如果需要从拉取请求构建或运行代码，请避免使用此事件。 +To ensure repository security, branches with names that match certain patterns (such as those which look similar to SHAs) may not trigger workflows with the `pull_request_target` event. + {% warning %} **警告：** 对于由 `pull_request_target` 事件触发的工作流程，除非指定了 `permissions` 密钥并且工作流程可以访问机密，否则将向 `GITHUB_TOKEN` 授予读/写存储库权限， 即使它是从复刻触发的。 虽然工作流程在拉取请求的基础上下文中运行，但您应该确保不在此事件中检出、生成或运行来自拉取请求的不受信任代码。 此外，任何缓存都与基本分支共享相同的作用域。 为帮助防止缓存中毒，如果缓存内容可能已更改，则不应保存缓存。 更多信息请参阅 GitHub 安全实验室网站上的“[保持 GitHub Actions 和工作流程安全：阻止 pwn 请求](https://securitylab.github.com/research/github-actions-preventing-pwn-requests)”。 diff --git a/translations/zh-CN/content/actions/using-workflows/reusing-workflows.md b/translations/zh-CN/content/actions/using-workflows/reusing-workflows.md index 54c07393ae..bbdf28e7fe 100644 --- a/translations/zh-CN/content/actions/using-workflows/reusing-workflows.md +++ b/translations/zh-CN/content/actions/using-workflows/reusing-workflows.md @@ -39,7 +39,7 @@ You can view the reused workflows referenced in your {% data variables.product.p ### Reusable workflows and starter workflows -Starter workflows allow everyone in your organization who has permission to create workflows to do so more quickly and easily. When people create a new workflow, they can choose a starter workflow and some or all of the work of writing the workflow will be done for them. Within a starter workflow, you can also reference reusable workflows to make it easy for people to benefit from reusing centrally managed workflow code. If you use a tag or branch name when referencing the reusable workflow, you can ensure that everyone who reuses that workflow will always be using the same YAML code. However, if you reference a reusable workflow by a tag or branch, be sure that you can trust that version of the workflow. For more information, see "[Security hardening for {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions#reusing-third-party-workflows)." +Starter workflows allow everyone in your organization who has permission to create workflows to do so more quickly and easily. When people create a new workflow, they can choose a starter workflow and some or all of the work of writing the workflow will be done for them. Within a starter workflow, you can also reference reusable workflows to make it easy for people to benefit from reusing centrally managed workflow code. If you use a commit SHA when referencing the reusable workflow, you can ensure that everyone who reuses that workflow will always be using the same YAML code. However, if you reference a reusable workflow by a tag or branch, be sure that you can trust that version of the workflow. For more information, see "[Security hardening for {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions#reusing-third-party-workflows)." For more information, see "[Creating starter workflows for your organization](/actions/learn-github-actions/creating-starter-workflows-for-your-organization)." @@ -69,10 +69,14 @@ Called workflows that are owned by the same user or organization{% ifversion ghe ## Limitations +{% ifversion nested-reusable-workflow %} +* You can connect up to four levels of workflows. For more information, see "[Calling a nested reusable workflow](#calling-a-nested-reusable-workflow)." +{% else %} * Reusable workflows can't call other reusable workflows. +{% endif %} * Reusable workflows stored within a private repository can only be used by workflows within the same repository. -* Any environment variables set in an `env` context defined at the workflow level in the caller workflow are not propagated to the called workflow. For more information about the `env` context, see "[Context and expression syntax for GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions#env-context)." -* The `strategy` property is not supported in any job that calls a reusable workflow. +* Any environment variables set in an `env` context defined at the workflow level in the caller workflow are not propagated to the called workflow. For more information about the `env` context, see "[Context and expression syntax for GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions#env-context)."{% ifversion actions-reusable-workflow-matrix %}{% else %} +* The `strategy` property is not supported in any job that calls a reusable workflow.{% endif %} ## Creating a reusable workflow @@ -105,7 +109,13 @@ You can define inputs and secrets, which can be passed from the caller workflow {% endraw %} For details of the syntax for defining inputs and secrets, see [`on.workflow_call.inputs`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callinputs) and [`on.workflow_call.secrets`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callsecrets). {% ifversion actions-inherit-secrets-reusable-workflows %} -1. In the reusable workflow, reference the input or secret that you defined in the `on` key in the previous step. If the secrets are inherited using `secrets: inherit`, you can reference them even if they are not defined in the `on` key. +1. In the reusable workflow, reference the input or secret that you defined in the `on` key in the previous step. + + {% note %} + + **Note**: If the secrets are inherited by using `secrets: inherit` in the calling workflow, you can reference them even if they are not explicitly defined in the `on` key. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit)." + + {% endnote %} {%- else %} 1. In the reusable workflow, reference the input or secret that you defined in the `on` key in the previous step. {%- endif %} @@ -164,7 +174,36 @@ jobs: token: ${{ secrets.token }} ``` {% endraw %} +{% ifversion actions-reusable-workflow-matrix %} +## Using a matrix strategy with a reusable workflow +Jobs using the matrix strategy can call a reusable workflow. + +A matrix strategy lets you use variables in a single job definition to automatically create multiple job runs that are based on the combinations of the variables. For example, you can use a matrix strategy to pass different inputs to a reusable workflow. For more information about matrices, see "[Using a matrix for your jobs](/actions/using-jobs/using-a-matrix-for-your-jobs)." + +### Example matrix strategy with a reusable workflow + +This workflow file references the matrix context by defining the variable `target` with the values `[dev, stage, prod]`. The workflow will run three jobs, one for each value in the variable. The workflow file also calls a reusable workflow by using the `uses` keyword. + +{% raw %} +```yaml{:copy} +name: Reusable workflow with matrix strategy + +on: + push: + +jobs: + ReuseableMatrixJobForDeployment: + strategy: + matrix: + target: [dev, stage, prod] + uses: octocat/octo-repo/.github/workflows/deployment.yml@main + with: + target: ${{ matrix.target }} +``` +{% endraw %} + +{% endif %} ## Calling a reusable workflow You call a reusable workflow by using the `uses` keyword. Unlike when you are using actions within a workflow, you call reusable workflows directly within a job, and not from within job steps. @@ -234,9 +273,62 @@ jobs: ``` {% endraw %} +{% ifversion nested-reusable-workflow %} +## Nesting reusable workflows + +You can connect a maximum of four levels of workflows - that is, the top-level caller workflow and up to three levels of reusable workflows. For example: _caller-workflow.yml_ → _called-workflow-1.yml_ → _called-workflow-2.yml_ → _called-workflow-3.yml_. Loops in the workflow tree are not permitted. + +From within a reusable workflow you can call another reusable workflow. + +{% raw %} +```yaml{:copy} +name: Reusable workflow + +on: + workflow_call: + +jobs: + call-another-reusable: + uses: octo-org/example-repo/.github/workflows/another-reusable.yml@v1 +``` +{% endraw %} + +### Passing secrets to nested workflows + +You can use `jobs..secrets` in a calling workflow to pass named secrets to a directly called workflow. Alternatively, you can use `jobs..secrets.inherit` to pass all of the calling workflow's secrets to a directly called workflow. For more information, see the section "[Passing inputs and secrets to a reusable workflow](/actions/using-workflows/reusing-workflows#passing-inputs-and-secrets-to-a-reusable-workflow)" above, and the reference article "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit)." Secrets are only passed to directly called workflow, so in the workflow chain A > B > C, workflow C will only receive secrets from A if they have been passed from A to B, and then from B to C. + +In the following example, workflow A passes all of its secrets to workflow B, by using the `inherit` keyword, but workflow B only passes one secret to workflow C. Any of the other secrets passed to workflow B are not available to workflow C. + +{% raw %} +```yaml +jobs: + workflowA-calls-workflowB: + uses: octo-org/example-repo/.github/workflows/B.yml@main + secrets: inherit # pass all secrets +``` + +```yaml +jobs: + workflowB-calls-workflowC: + uses: different-org/example-repo/.github/workflows/C.yml@main + secrets: + envPAT: ${{ secrets.envPAT }} # pass just this secret +``` +{% endraw %} + +### Access and permissions + +A workflow that contains nested reusable workflows will fail if any of the nested workflows is inaccessible to the initial caller workflow. For more information, see "[Access to reusable workflows](/actions/using-workflows/reusing-workflows#access-to-reusable-workflows)." + +`GITHUB_TOKEN` permissions can only be the same or more restrictive in nested workflows. For example, in the workflow chain A > B > C, if workflow A has `package: read` token permission, then B and C cannot have `package: write` permission. For more information, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." +{% endif %} + ## Using outputs from a reusable workflow -A reusable workflow may generate data that you want to use in the caller workflow. To use these outputs, you must specify them as the outputs of the reusable workflow. +A reusable workflow may generate data that you want to use in the caller workflow. To use these outputs, you must specify them as the outputs of the reusable workflow.{% ifversion actions-reusable-workflow-matrix %} + +If a reusable workflow that sets an output is executed with a matrix strategy, the output will be the output set by the last successful completing reusable workflow of the matrix which actually sets a value. +That means if the last successful completing reusable workflow sets an empty string for its output, and the second last successful completing reusable workflow sets an actual value for its output, the output will contain the value of the second last completing reusable workflow.{% endif %} The following reusable workflow has a single job containing two steps. In each of these steps we set a single word as the output: "hello" and "world." In the `outputs` section of the job, we map these step outputs to job outputs called: `output1` and `output2`. In the `on.workflow_call.outputs` section we then define two outputs for the workflow itself, one called `firstword` which we map to `output1`, and one called `secondword` which we map to `output2`. diff --git a/translations/zh-CN/content/actions/using-workflows/workflow-syntax-for-github-actions.md b/translations/zh-CN/content/actions/using-workflows/workflow-syntax-for-github-actions.md index 48c8c4b44c..31cd1b3de4 100644 --- a/translations/zh-CN/content/actions/using-workflows/workflow-syntax-for-github-actions.md +++ b/translations/zh-CN/content/actions/using-workflows/workflow-syntax-for-github-actions.md @@ -365,9 +365,9 @@ jobs: 选择要作为作业中步骤的一部分运行的操作。 操作是一种可重复使用的代码单位。 您可以使用工作流程所在仓库中、公共仓库中或[发布 Docker 容器映像](https://hub.docker.com/)中定义的操作。 -强烈建议指定 Git ref、SHA 或 Docker 标记编号来包含所用操作的版本。 如果不指定版本，在操作所有者发布更新时可能会中断您的工作流程或造成非预期的行为。 +We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag. 如果不指定版本，在操作所有者发布更新时可能会中断您的工作流程或造成非预期的行为。 - 使用已发行操作版本的 SHA 对于稳定性和安全性是最安全的。 -- 使用特定主要操作版本可在保持兼容性的同时接收关键修复和安全补丁。 还可确保您的工作流程继续工作。 +- If the action publishes major version tags, you should expect to receive critical fixes and security patches while still retaining compatibility. Note that this behavior is at the discretion of the action's author. - 使用操作的默认分支可能很方便，但如果有人新发布具有突破性更改的主要版本，您的工作流程可能会中断。 有些操作要求必须通过 [`with`](#jobsjob_idstepswith) 关键词设置输入。 请查阅操作的自述文件，确定所需的输入。 @@ -1037,15 +1037,23 @@ jobs: - `[]` 匹配列在括号中或包含在范围内的一个字符。 范围只能包含 `a-z`、`A-Z` 和 `0-9`。 例如，范围 `[0-9a-z]` 匹配任何数字或小写字母。 例如，`[CB]at` 匹配 `Cat` 或 `Bat`，`[1-2]00` 匹配 `100` 和 `200`。 - `!`：在模式开始时，它将否定以前的正模式。 如果不是第一个字符，它就没有特殊的意义。 -字符 `*`、`[` 和 `!` 是 YAML 中的特殊字符。 如果模式以 `*`、`[` 或 `!` 开头，必须用引号括住模式。 +字符 `*`、`[` 和 `!` 是 YAML 中的特殊字符。 如果模式以 `*`、`[` 或 `!` 开头，必须用引号括住模式。 Also, if you use a [flow sequence](https://yaml.org/spec/1.2.2/#flow-sequences) with a pattern containing `[` and/or `]`, the pattern must be enclosed in quotes. ```yaml # Valid -- '**/README.md' +branches: + - '**/README.md' # Invalid - creates a parse error that # prevents your workflow from running. -- **/README.md +branches: + - **/README.md + +# Valid +branches: [ main, 'release/v[0-9].[0-9]' ] + +# Invalid - creates a parse error +branches: [ main, release/v[0-9].[0-9] ] ``` 有关分支、标记和路径筛选器语法的更多信息，请参阅“[`on..`](#onpushbranchestagsbranches-ignoretags-ignore)”、“[`on..`](#onpull_requestpull_request_targetbranchesbranches-ignore)”和“[`on..paths`](#onpushpull_requestpull_request_targetpathspaths-ignore)”。 diff --git a/translations/zh-CN/content/admin/configuration/configuring-github-connect/about-github-connect.md b/translations/zh-CN/content/admin/configuration/configuring-github-connect/about-github-connect.md index 801d3c5066..4b900f7f44 100644 --- a/translations/zh-CN/content/admin/configuration/configuring-github-connect/about-github-connect.md +++ b/translations/zh-CN/content/admin/configuration/configuring-github-connect/about-github-connect.md @@ -8,6 +8,7 @@ type: overview topics: - Enterprise - GitHub Connect +miniTocMaxHeadingLevel: 3 --- ## About {% data variables.product.prodname_github_connect %} @@ -37,6 +38,16 @@ Unified contributions | Allow users to include anonymized contribution counts fo ## Data transmission for {% data variables.product.prodname_github_connect %} +When {% data variables.product.prodname_github_connect %} is enabled, a record on {% data variables.product.prodname_ghe_cloud %} stores information about the connection. If you enable individual features of {% data variables.product.prodname_github_connect %}, additional data is transmitted. + +{% note %} + +**Note:** No repositories, issues, or pull requests are ever transmitted from {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} by {% data variables.product.prodname_github_connect %}. + +{% endnote %} + +### Data transmitted when {% data variables.product.prodname_github_connect %} is enabled + When you enable {% data variables.product.prodname_github_connect %} or specific {% data variables.product.prodname_github_connect %} features, a record on {% data variables.product.prodname_ghe_cloud %} stores the following information about the connection. {% ifversion ghes %} - The public key portion of your {% data variables.product.prodname_ghe_server %} license @@ -54,11 +65,7 @@ When you enable {% data variables.product.prodname_github_connect %} or specific {% data variables.product.prodname_github_connect %} syncs the above connection data between {% data variables.product.product_location %} and {% data variables.product.prodname_ghe_cloud %} weekly, from the day and approximate time that {% data variables.product.prodname_github_connect %} was enabled. -{% note %} - -**Note:** No repositories, issues, or pull requests are ever transmitted from {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} by {% data variables.product.prodname_github_connect %}. - -{% endnote %} +### Data transmitted by individual features of {% data variables.product.prodname_github_connect %} Additional data is transmitted if you enable individual features of {% data variables.product.prodname_github_connect %}. @@ -68,7 +75,7 @@ Automatic user license sync | Each {% data variables.product.product_name %} use {% data variables.product.prodname_dependabot_alerts %} | Vulnerability alerts | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %} | {% data variables.product.product_name %} |{% endif %}{% ifversion dependabot-updates-github-connect %} {% data variables.product.prodname_dependabot_updates %} | Dependencies and the metadata for each dependency's repository

    If a dependency is stored in a private repository on {% data variables.product.prodname_dotcom_the_website %}, data will only be transmitted if {% data variables.product.prodname_dependabot %} is configured and authorized to access that repository. | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %} | {% data variables.product.product_name %} {% endif %} {% data variables.product.prodname_dotcom_the_website %} actions | Name of action, action (YAML file from {% data variables.product.prodname_marketplace %}) | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %}

    From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %}{% ifversion server-statistics %} -{% data variables.product.prodname_server_statistics %} | Aggregate {% data variables.product.prodname_ghe_server %} usage metrics
    For the list of aggregate metrics collected, see "[{% data variables.product.prodname_server_statistics %} data collected](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)." | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %}{% endif %} +{% data variables.product.prodname_server_statistics %} | Aggregate metrics about your usage of {% data variables.product.prodname_ghe_server %}. For the complete list of metrics, see "[About {% data variables.product.prodname_server_statistics %}](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)." | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %}{% endif %} Unified search | Search terms, search results | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %}

    From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %} | Unified contributions | Contribution counts | From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.prodname_dotcom_the_website %} | diff --git a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md index 1652755f7b..5fa9384fb2 100644 --- a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md +++ b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md @@ -672,7 +672,7 @@ You can add the optional `--prune` argument to remove unreachable Git objects th {% warning %} -**Warning**: Before using the `--prune` argument to remove unreachable Git objects, put {% data variables.product.product_location %} into maintenance mode, or ensure the repository is offline. For more information, see "[Enabling and scheduling maintenance mode](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." +**Warning**: Before using the `--prune` argument to remove unreachable Git objects, put {% data variables.product.product_location %} into maintenance mode, or ensure all repositories within the same repository network are locked. For more information, see "[Enabling and scheduling maintenance mode](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." {% endwarning %} diff --git a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md index 09da7fa90d..b6ffe64d1e 100644 --- a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md +++ b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md @@ -31,12 +31,15 @@ redirect_from: ## 添加允许的 IP 地址 +{% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} {% data reusables.identity-and-permissions.ip-allow-lists-add-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-add-description %} {% data reusables.identity-and-permissions.ip-allow-lists-add-entry %} +{% data reusables.identity-and-permissions.check-ip-address %} ## 允许 {% data variables.product.prodname_github_apps %} 访问 @@ -44,6 +47,8 @@ redirect_from: ## 启用允许的 IP 地址 +{% data reusables.identity-and-permissions.about-enabling-allowed-ip-addresses %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} @@ -52,6 +57,8 @@ redirect_from: ## 编辑允许的 IP 地址 +{% data reusables.identity-and-permissions.about-editing-ip-allow-list-entries %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} @@ -59,6 +66,18 @@ redirect_from: {% data reusables.identity-and-permissions.ip-allow-lists-edit-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-description %} 8. 单击 **Update（更新）**。 +{% data reusables.identity-and-permissions.check-ip-address %} + +{% ifversion ip-allow-list-address-check %} +## Checking if an IP address is permitted + +{% data reusables.identity-and-permissions.about-checking-ip-address %} + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.security-tab %} +{% data reusables.identity-and-permissions.check-ip-address-step %} +{% endif %} ## 删除允许的 IP 地址 diff --git a/translations/zh-CN/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md b/translations/zh-CN/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md index 2967175c90..2f4c308294 100644 --- a/translations/zh-CN/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md +++ b/translations/zh-CN/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md @@ -20,7 +20,7 @@ shortTitle: 创建 HA 副本 ## 创建高可用性副本 1. 在所需平台上设置新的 {% data variables.product.prodname_ghe_server %} 设备。 副本设备应镜像主设备的 CPU、RAM 和存储设置。 建议您在独立环境中安装副本设备。 底层硬件、软件和网络组件应与主设备的相应部分隔离。 如果要使用云提供商，请使用单独的区域或分区。 更多信息请参阅“[设置 {% data variables.product.prodname_ghe_server %} 实例](/enterprise/admin/guides/installation/setting-up-a-github-enterprise-server-instance)”。 -1. 确保主设备和新的副本设备可以通过端口 122/TCP 和 1194/UDP 相互通信。 更多信息请参阅“[网络端口](/admin/configuration/configuring-network-settings/network-ports#administrative-ports)”。 +1. Ensure that the new appliance can communicate with all other appliances in this high availability environment over ports 122/TCP and 1194/UDP. 更多信息请参阅“[网络端口](/admin/configuration/configuring-network-settings/network-ports#administrative-ports)”。 1. 在浏览器中，导航到新副本设备的 IP 地址并上传您的 {% data variables.product.prodname_enterprise %} 许可。 {% data reusables.enterprise_installation.replica-steps %} 1. 使用 SSH 连接到副本设备的 IP 地址。 diff --git a/translations/zh-CN/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md b/translations/zh-CN/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md index a7b4759223..0ad52e007b 100644 --- a/translations/zh-CN/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md +++ b/translations/zh-CN/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md @@ -82,7 +82,11 @@ These restrictions are unacceptable for some enterprises. To determine whether { ### Do your developers rely on collaboration outside of your enterprise? -{% data variables.product.prodname_managed_users_caps %} can only contribute to repositories within your enterprise. If your developers need to collaborate in repositories outside your enterprise, even private repositories, to complete their work, {% data variables.product.prodname_emus %} may not be right for your enterprise, and SAML SSO may be a better solution. +{% data variables.product.prodname_managed_users_caps %} can only contribute to repositories within your enterprise. If your developers must contribute to both repositories within and outside of your enterprise, including private repositories, {% data variables.product.prodname_emus %} may not be right for your enterprise. SAML SSO may be a better solution. + +Some companies maintain repositories within an existing enterprise using SAML SSO on {% data variables.product.product_location %}, and also create an {% data variables.product.prodname_emu_enterprise %}. Developers who contribute to repositories owned by both enterprises from a single workstation must switch between the accounts on {% data variables.product.product_location %} within a single browser, or use a different browser for each account. The developer may also need to customize the workstation's Git configuration to accommodate the two accounts. The complexity of this workflow can increase the risk of mistakenly leaking internal code to the public. + +If you decide to create an {% data variables.product.prodname_emu_enterprise %} but require that developers contribute to resources outside of the enterprise from a single workstation, you can provide support for switching between the accounts in a developer's local Git configuration. For more information, see "[About {% data variables.product.prodname_emus %}](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#supporting-developers-with-multiple-user-accounts-on-githubcom)." ### Does your enterprise rely on outside collaborators? diff --git a/translations/zh-CN/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md b/translations/zh-CN/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md index 86fa66eae0..b6a8459792 100644 --- a/translations/zh-CN/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md +++ b/translations/zh-CN/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md @@ -36,8 +36,6 @@ You can grant {% data variables.product.prodname_managed_users %} access to and The usernames of your enterprise's {% data variables.product.prodname_managed_users %} and their profile information, such as display names and email addresses, are set by through your IdP and cannot be changed by the users themselves. For more information, see "[Usernames and profile information](#usernames-and-profile-information)." -{% data reusables.enterprise-accounts.emu-forks %} - Enterprise owners can audit all of the {% data variables.product.prodname_managed_users %}' actions on {% data variables.product.prodname_dotcom %}. For more information, see "[Audit log events for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise#about-audit-log-events-for-your-enterprise)." To use {% data variables.product.prodname_emus %}, you need a separate type of enterprise account with {% data variables.product.prodname_emus %} enabled. For more information about creating this account, see "[About enterprises with managed users](#about-enterprises-with-managed-users)." @@ -75,7 +73,8 @@ To use {% data variables.product.prodname_emus %}, you need a separate type of e * {% data variables.product.prodname_managed_users_caps %} cannot create gists or comment on gists. * {% data variables.product.prodname_managed_users_caps %} cannot install {% data variables.product.prodname_github_apps %} on their user accounts. * Other {% data variables.product.prodname_dotcom %} users cannot see, mention, or invite a {% data variables.product.prodname_managed_user %} to collaborate. -* {% data variables.product.prodname_managed_users_caps %} can only own private repositories and {% data variables.product.prodname_managed_users %} can only invite other enterprise members to collaborate on their owned repositories. +* You can choose whether {% data variables.product.prodname_managed_users %} are able to create repositories owned by their user accounts. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-repository-creation)." +* If you allow {% data variables.product.prodname_managed_users %} to create repositories owned by their user accounts, they can only own private repositories and can only invite other enterprise members to collaborate on their user-owned repositories. * {% data reusables.enterprise-accounts.emu-forks %} * Only private and internal repositories can be created in organizations owned by an {% data variables.product.prodname_emu_enterprise %}, depending on organization and enterprise repository visibility settings. * {% data variables.product.prodname_managed_users_caps %} are limited in their use of {% data variables.product.prodname_pages %}. For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages#limitations-for-enterprise-managed-users)." @@ -113,6 +112,8 @@ Before your developers can use {% data variables.product.prodname_ghe_cloud %} w 5. Once authentication and provisioning are configured, you can start provisioning members and managing teams. For more information, see "[Managing team memberships with identity provider groups](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups)." +If members of your enterprise must use one workstation to contribute to repositories on {% data variables.product.product_location %} from both a {% data variables.product.prodname_managed_user %} and a personal account, you can provide support. For more information, see "[Supporting developers with multiple user accounts on {% data variables.product.prodname_dotcom_the_website %}](#supporting-developers-with-multiple-user-accounts-on-githubcom)." + ## Authenticating as a {% data variables.product.prodname_managed_user %} {% data variables.product.prodname_managed_users_caps %} must authenticate through their identity provider. To authenticate, a {% data variables.product.prodname_managed_user %} can visit their IdP application portal or use the login page on {% data variables.product.prodname_dotcom_the_website %}. @@ -135,3 +136,9 @@ Before your developers can use {% data variables.product.prodname_ghe_cloud %} w A conflict may occur when provisioning users if the unique parts of the identifier provided by your IdP are removed during normalization. If you're unable to provision a user due to a username conflict, you should modify the username provided by your IdP. For more information, see "[Resolving username conflicts](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication#resolving-username-conflicts)." The profile name and email address of a {% data variables.product.prodname_managed_user %} is also provided by the IdP. {% data variables.product.prodname_managed_users_caps %} cannot change their profile name or email address on {% data variables.product.prodname_dotcom %}, and the IdP can only provide a single email address. + +## Supporting developers with multiple user accounts on {% data variables.product.product_location %} + +People on your team may need to contribute to resources on {% data variables.product.product_location %} that are outside of your {% data variables.product.prodname_emu_enterprise %}. For example, you may wish to maintain a separate enterprise for your company's open source projects. Because a {% data variables.product.prodname_managed_user %} cannot contribute to public resources, users will need to maintain a separate, personal account for this work. + +People who must contribute from two user accounts on {% data variables.product.product_location %} using one workstation can configure Git to simplify the process. For more information, see "[Managing multiple accounts](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts)." diff --git a/translations/zh-CN/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md b/translations/zh-CN/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md index ef85ae0631..b1f16a8b7b 100644 --- a/translations/zh-CN/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md +++ b/translations/zh-CN/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md @@ -22,9 +22,11 @@ topics: 有关将 OIDC 与 {% data variables.product.prodname_emus %} 配合使用的更多信息，请参阅“[为企业托管用户配置 OIDC](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-oidc-for-enterprise-managed-users)”和“[从 SAML 迁移到 OIDC](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc)”。 -## 关于将 CAP 与 IP 允许列表一起使用 +{% note %} -我们建议您禁用企业帐户的 IP 允许列表，并依靠 IdP 的 CAP。 如果您为企业启用 IP 允许列表，并且还利用 IdP 的 CAP，则将强制执行 IP 允许列表和 CAP。 如果限制或拒绝用户的 IP 地址，则请求将失败。 有关 IP 允许列表的更多信息，请参阅“[在企业中实施安全设置策略](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)”。 +**Note:** If you use Conditional Access (CA) network location policies in your Azure AD tenant, do not use the IP allow list feature on {% data variables.product.prodname_dotcom_the_website %}, with your enterprise account or with any of the organizations owned by the enterprise. Using both is unsupported and can result in the wrong policy applying. For more information about IP allow lists, see "[Enforcing security settings in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)" and "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization)." + +{% endnote %} ## 集成和自动化的注意事项 diff --git a/translations/zh-CN/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md b/translations/zh-CN/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md index f31513ef68..f6e7cb1071 100644 --- a/translations/zh-CN/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md +++ b/translations/zh-CN/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md @@ -31,6 +31,7 @@ If you're new to {% data variables.product.prodname_emus %} and haven't yet conf {% endnote %} 1. Before you begin the migration, sign in to Azure and disable provisioning in the existing {% data variables.product.prodname_emu_idp_application %} application. +1. If you use [Conditional Access (CA) network location policies](https://docs.microsoft.com/en-us/azure/active-directory/conditional-access/location-condition) in Azure AD, and you're currently using an IP allow list with your enterprise account or any of the organizations owned by the enterprise account on {% data variables.product.prodname_dotcom_the_website %}, disable the IP allow lists. For more information, see "[Enforcing security settings in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)" and "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization)." 1. Sign into {% data variables.product.prodname_dotcom_the_website %} as the setup user for your enterprise with the username **@SHORT-CODE_admin**. 1. When prompted to continue to your identity provider, click **Use a recovery code** and sign in using one of your enterprise's recovery codes. {% data reusables.enterprise-accounts.access-enterprise %} diff --git a/translations/zh-CN/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md b/translations/zh-CN/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md index 50f779b7b8..6a414eaa11 100644 --- a/translations/zh-CN/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md +++ b/translations/zh-CN/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md @@ -75,10 +75,12 @@ topics: 以下 SAML 属性可用于 {% data variables.product.product_name %}。{% ifversion ghes %} 您可以在管理控制台中更改属性名称，但 `administrator` 属性除外。 更多信息请参阅“[访问管理控制台](/admin/configuration/configuring-your-enterprise/accessing-the-management-console)”。{% endif %} -| 名称 | 必填？ | 描述 | -|:--------------------- |:--- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `NameID` | 是 | 持久用户标识符。 可以使用任意持久名称标识符格式。 {% ifversion ghec %}如果将企业与 {% data variables.product.prodname_emus %} 一起使用， {% endif %}{% data variables.product.product_name %} 将规范化 `NameID` 元素以用作用户名，除非提供了替代断言之一。 更多信息请参阅“[外部身份验证的用户名注意事项](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication)”。 | -| `SessionNotOnOrAfter` | 否 | {% data variables.product.product_name %} 使关联的会话失效的日期。 失效后，此人必须再次进行身份验证才能访问 {% ifversion ghec or ghae %}企业的资源{% elsif ghes %}{% data variables.product.product_location %}{% endif %}。 更多信息请参阅“[会话持续时间和超时](#session-duration-and-timeout)”。 | +| 名称 | 必填？ | 描述 | +|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |:--- |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `NameID` | 是 | 持久用户标识符。 可以使用任意持久名称标识符格式。 | +| {% ifversion ghec %}如果将企业与 {% data variables.product.prodname_emus %} 一起使用， {% endif %}{% data variables.product.product_name %} 将规范化 `NameID` 元素以用作用户名，除非提供了替代断言之一。 For more information, see "[Username considerations for external authentication](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication)."

    {% note %}**Note:** It's important to use a human-readable, persistent identifier. Using a transient identifier format like `urn:oasis:names:tc:SAML:2.0:nameid-format:transient` will result in re-linking of accounts on every sign-in, which can be detrimental to authorization management.{% endnote %} | | | +| | | | +| `SessionNotOnOrAfter` | 否 | {% data variables.product.product_name %} 使关联的会话失效的日期。 失效后，此人必须再次进行身份验证才能访问 {% ifversion ghec or ghae %}企业的资源{% elsif ghes %}{% data variables.product.product_location %}{% endif %}。 更多信息请参阅“[会话持续时间和超时](#session-duration-and-timeout)”。 | {%- ifversion ghes or ghae %} | `administrator` | 无|当值为 `true` 时，{% data variables.product.product_name %} 会自动将用户提升为 {% ifversion ghes %}站点管理员{% elsif ghae %}企业所有者{% endif %}。 将此属性设置为除 `true` 以外的任何值都将导致降级，只要该值不为空。 省略此属性或将值留空不会更改用户的角色。 | | `username` | 无 | {% data variables.product.product_location %} 的用户名。 | {%- endif %} diff --git a/translations/zh-CN/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md b/translations/zh-CN/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md index 851db4fda6..e9ee55ce39 100644 --- a/translations/zh-CN/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md +++ b/translations/zh-CN/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md @@ -44,7 +44,8 @@ Enterprise owners can set up{% ifversion pause-audit-log-stream %}, pause,{% end - [Amazon S3](#setting-up-streaming-to-amazon-s3) - [Azure Blob Storage](#setting-up-streaming-to-azure-blob-storage) -- [Azure Event Hubs](#setting-up-streaming-to-azure-event-hubs) +- [Azure Event Hubs](#setting-up-streaming-to-azure-event-hubs){% ifversion streaming-datadog %} +- [Datadog](#setting-up-streaming-to-datadog){% endif %} - [Google Cloud Storage](#setting-up-streaming-to-google-cloud-storage) - [Splunk](#setting-up-streaming-to-splunk) @@ -231,6 +232,32 @@ Then, set up streaming with access keys until the vulnerability is resolved. For {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +{% ifversion streaming-datadog %} +### Setting up streaming to Datadog + +To set up streaming to Datadog, you must create a client token or an API key in Datadog, then configure audit log streaming in {% data variables.product.product_name %} using the token for authentication. You do not need to create a bucket or other storage container in Datadog. + +After you set up streaming to Datadog, you can see your audit log data by filtering by "github.audit.streaming." For more information, see [Log Management](https://docs.datadoghq.com/logs/). + +1. If you don't already have a Datadog account, create one. +1. In Datadog, generate a client token or an API key, then click **Copy key**. For more information, see [API and Application Keys](https://docs.datadoghq.com/account_management/api-app-keys/) in Datadog Docs. +{% data reusables.enterprise.navigate-to-log-streaming-tab %} +1. Select the **Configure stream** dropdown menu and click **Datadog**. + + ![Screenshot of the "Configure stream" dropdown menu with "Datadog" highlighted](/assets/images/help/enterprises/audit-stream-choice-datadog.png) +1. Under "Token", paste the token you copied earlier. + + ![Screenshot of the "Token" field](/assets/images/help/enterprises/audit-stream-datadog-token.png) +1. Select the "Site" dropdown menu and click your Datadog site. To determine your Datadog site, compare your Datadog URL to the table in [Datadog sites](https://docs.datadoghq.com/getting_started/site/) in Datadog Docs. + + ![Screenshot of the "Site" dropdown menu](/assets/images/help/enterprises/audit-stream-datadog-site.png) +1. To verify that {% data variables.product.prodname_dotcom %} can connect and write to the Datadog endpoint, click **Check endpoint**. + + ![检查端点](/assets/images/help/enterprises/audit-stream-check.png) +{% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +1. After a few minutes, confirm that audit log data is appearing on the **Logs** tab in Datadog. If audit log data is not appearing, confirm that your token and site are correct in {% data variables.product.prodname_dotcom %}. +{% endif %} + ### 设置流式传输到 Google Cloud Storage 要设置流式传输到 Google Cloud Storage，您必须在 Google Cloud 中使用适当的凭据和权限创建一个服务帐户，然后使用服务帐户的凭据在 {% data variables.product.product_name %} 中配置审核日志流以进行身份验证。 @@ -291,6 +318,10 @@ Then, set up streaming with access keys until the vulnerability is resolved. For 暂停流允许您对接收应用程序执行维护，而不会丢失审核数据。 审核日志在 {% data variables.product.product_location %} 上最多存储七天，然后在取消暂停流时导出。 +{% ifversion streaming-datadog %} +Datadog only accepts logs from up to 18 hours in the past. If you pause a stream to a Datadog endpoint for more than 18 hours, you risk losing logs that Datadog won't accept after you resume streaming. +{% endif %} + {% data reusables.enterprise.navigate-to-log-streaming-tab %} 1. 单击 **Pause stream（暂停流）**。 diff --git a/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md b/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md index e7c5637f97..49a87dbefd 100644 --- a/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md +++ b/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md @@ -77,12 +77,17 @@ shortTitle: 安全设置策略 ### 添加允许的 IP 地址 +{% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} + +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} {% data reusables.identity-and-permissions.ip-allow-lists-add-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-add-description %} {% data reusables.identity-and-permissions.ip-allow-lists-add-entry %} +{% data reusables.identity-and-permissions.check-ip-address %} ### 允许 {% data variables.product.prodname_github_apps %} 访问 @@ -90,6 +95,8 @@ shortTitle: 安全设置策略 ### 启用允许的 IP 地址 +{% data reusables.identity-and-permissions.about-enabling-allowed-ip-addresses %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} @@ -98,6 +105,8 @@ shortTitle: 安全设置策略 ### 编辑允许的 IP 地址 +{% data reusables.identity-and-permissions.about-editing-ip-allow-list-entries %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} @@ -105,6 +114,18 @@ shortTitle: 安全设置策略 {% data reusables.identity-and-permissions.ip-allow-lists-edit-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-description %} 8. 单击 **Update（更新）**。 +{% data reusables.identity-and-permissions.check-ip-address %} + +{% ifversion ip-allow-list-address-check %} +### Checking if an IP address is permitted + +{% data reusables.identity-and-permissions.about-checking-ip-address %} + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.security-tab %} +{% data reusables.identity-and-permissions.check-ip-address-step %} +{% endif %} ### 删除允许的 IP 地址 diff --git a/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md b/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md index 21ad8a9642..6b1166f4a3 100644 --- a/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md +++ b/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md @@ -71,24 +71,28 @@ shortTitle: 仓库管理策略 {% endif %} -## 执行 {% ifversion ghec or ghes or ghae %}基础{% else %}默认{% endif %} 仓库权限的策略 +## Enforcing a policy for base repository permissions -在企业帐户拥有的所有组织中，您可以为组织成员设置{% ifversion ghec or ghes or ghae %}基础{% else %}默认{% endif %}仓库权限级别（无、读取、写入或管理），或允许所有者在组织级别管理设置。 +Across all organizations owned by your enterprise, you can set a base repository permission level (none, read, write, or admin) for organization members, or allow owners to administer the setting on the organization level. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} -4. 在“{% ifversion ghec or ghes or ghae %}基础{% else %}默认{% endif %} 权限”下，查看有关更改设置的信息。 {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -5. 在“{% ifversion ghec or ghes or ghae %}基础{% else %}默认{% endif %} 权限”下，使用下拉菜单并选择策略。 - {% ifversion ghec or ghes or ghae %} - ![带有仓库权限策略选项的下拉菜单](/assets/images/help/business-accounts/repository-permissions-policy-drop-down.png) - {% else %} - ![带有仓库权限策略选项的下拉菜单](/assets/images/enterprise/business-accounts/repository-permissions-policy-drop-down.png) - {% endif %} +4. Under "Base permissions", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +5. 在“Base permissions（基本权限）”下，使用下拉菜单并选择策略。 ![带有仓库权限策略选项的下拉菜单](/assets/images/help/business-accounts/repository-permissions-policy-drop-down.png) + ## 执行仓库创建策略 -在企业拥有的所有组织中，您可以允许成员创建仓库、将仓库创建限于组织所有者或允许所有者在组织级别管理设置。 如果允许成员创建仓库，您可以选择成员能否创建公共、私有和内部仓库的任意组合。 {% data reusables.repositories.internal-repo-default %} 有关内部仓库的更多信息，请参阅“[创建内部仓库](/articles/creating-an-internal-repository)”。 +在企业拥有的所有组织中，您可以允许成员创建仓库、将仓库创建限于组织所有者或允许所有者在组织级别管理设置。 + +If you allow members to create repositories in your organizations, you can choose which types of repositories (public, private, and internal) that members can create. + +{% ifversion enterprise-namespace-repo-setting %} +{% ifversion ghec %}If your enterprise uses {% data variables.product.prodname_emus %}, you{% else %}You{% endif %} can also prevent users from creating repositories owned by their user accounts. +{% endif %} + +{% data reusables.repositories.internal-repo-default %} 有关内部仓库的更多信息，请参阅“[创建内部仓库](/articles/creating-an-internal-repository)”。 {% data reusables.organizations.repo-creation-constants %} @@ -96,33 +100,32 @@ shortTitle: 仓库管理策略 {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} 5. 在“Repository creation”下，检查有关更改设置的信息。 {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -{% ifversion ghes or ghae or ghec %} {% data reusables.enterprise-accounts.repo-creation-policy %} -{% data reusables.enterprise-accounts.repo-creation-types %} -{% else %} -6. 在“Repository creation（仓库创建）”下，使用下拉菜单并选择策略。 - - ![包含仓库创建策略的下拉菜单](/assets/images/enterprise/site-admin-settings/repository-creation-drop-down.png) -{% endif %} +{% data reusables.enterprise-accounts.repo-creation-types %}{% ifversion enterprise-namespace-repo-setting %} +1. Optionally, {% ifversion ghec %}if your enterprise uses {% data variables.product.prodname_emus %} and you want {% endif %}to prevent enterprise members from creating repositories owned by their user accounts, select **Block the creation of user namespace repositories**. ![Screenshot showing the list of disabled options from forking policy](/assets/images/help/business-accounts/restrict-personal-namespace-enabled-setting.png){% endif %} ## 实施有关复刻私有或内部仓库的策略 在企业拥有的所有组织中，您可以允许有权访问私有或内部仓库的人员复刻仓库、永远不允许分支私有或内部仓库，或者允许所有者在组织级别管理设置。 +{% ifversion enterprise-namespace-repo-setting %} +{% note %} + +**Note:** If {% ifversion ghec %}your enterprise uses {% data variables.product.prodname_emus %} and {% endif %}your "Repository creation" policy prevents enterprise members from creating repositories owned by their user accounts, members will not be allowed to fork a repository in their user accounts, regardless of your "Repository forking" policy. + +{% endnote %} +{% endif %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} 3. 在“Repository forking”（仓库复刻）下，审查有关更改设置的信息。 {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} 4. 在“Repository forking（仓库复刻）”下，使用下拉菜单并选择策略。 - ![带有仓库复刻策略选项的下拉菜单](/assets/images/help/business-accounts/repository-forking-policy-drop-down.png) - -{% ifversion innersource-fork-policies %} + ![带有仓库复刻策略选项的下拉菜单](/assets/images/help/business-accounts/repository-forking-policy-drop-down.png){% ifversion innersource-fork-policies %} 5. 如果启用了复刻，则可以指定允许用户复刻存储库的位置。 查看有关更改设置的信息并选择策略。 - ![显示存储库复刻策略选项列表的屏幕截图](/assets/images/help/business-accounts/repository-forking-policy-settings.png) -{% endif %} - + ![显示存储库复刻策略选项列表的屏幕截图](/assets/images/help/business-accounts/repository-forking-policy-settings.png){% endif %} ## 执行邀请{% ifversion ghec %} 外部{% endif %} 协作者参与仓库的策略 @@ -140,8 +143,6 @@ shortTitle: 仓库管理策略 ![带邀请策略选项的下拉菜单](/assets/images/enterprise/business-accounts/repository-invitation-policy-drop-down.png) {% endif %} -{% ifversion ghec or ghes or ghae %} - ## 对默认分支名称实施策略 在企业拥有的所有组织中，您可以为成员创建的任何新仓库设置默认分支名称。 您可以选择在所有组织中强制实施默认分支名称，或允许个别组织设置不同的名称。 @@ -152,8 +153,6 @@ shortTitle: 仓库管理策略 4. （可选）要对企业中的所有组织强制实施默认分支名称，请选择 **Enforce across this enterprise（在整个企业中实施）**。 ![强制实施复选框](/assets/images/help/business-accounts/default-branch-name-enforce.png) 5. 单击 **Update（更新）**。 ![更新按钮](/assets/images/help/business-accounts/default-branch-name-update.png) -{% endif %} - ## 执行更改仓库可见性的策略 在您的企业拥有的所有组织中，您可以允许具有管理员权限的成员更改仓库的可见性、将仓库可见性更改限制为组织所有者或允许所有者在组织级别管理设置。 当您阻止成员更改仓库可见性时，只有企业所有者可以更改仓库的可见性。 @@ -163,9 +162,8 @@ shortTitle: 仓库管理策略 {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} -5. 在“Repository visibility change”下，检查有关更改设置的信息。 {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} - -{% data reusables.enterprise-accounts.repository-visibility-policy %} +1. 在“Repository visibility change”下，检查有关更改设置的信息。 {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +1. 在“Repository visibility change（仓库可见性更改）”下，使用下拉菜单选择策略。 ![带有仓库可见性策略选项的下拉菜单](/assets/images/help/business-accounts/repository-visibility-policy-drop-down.png) ## 执行仓库删除和转移的策略 diff --git a/translations/zh-CN/content/authentication/connecting-to-github-with-ssh/about-ssh.md b/translations/zh-CN/content/authentication/connecting-to-github-with-ssh/about-ssh.md index a411922d2f..53b7c7225e 100644 --- a/translations/zh-CN/content/authentication/connecting-to-github-with-ssh/about-ssh.md +++ b/translations/zh-CN/content/authentication/connecting-to-github-with-ssh/about-ssh.md @@ -1,6 +1,6 @@ --- title: About SSH -intro: 'Using the SSH protocol, you can connect and authenticate to remote servers and services. With SSH keys, you can connect to {% data variables.product.product_name %} without supplying your username and personal access token at each visit.' +intro: 'Using the SSH protocol, you can connect and authenticate to remote servers and services. With SSH keys, you can connect to {% data variables.product.product_name %} without supplying your username and personal access token at each visit.{% ifversion ssh-commit-verification %} You can also use an SSH key to sign commits.{% endif %}' redirect_from: - /articles/about-ssh - /github/authenticating-to-github/about-ssh @@ -16,7 +16,7 @@ topics: {% data reusables.ssh.about-ssh %} For more information about SSH, see [Secure Shell](https://en.wikipedia.org/wiki/Secure_Shell) on Wikipedia. -When you set up SSH, you will need to generate a new private SSH key and add it to the SSH agent. You must also add the public SSH key to your account on {% data variables.product.product_name %} before you use the key to authenticate. For more information, see "[Generating a new SSH key and adding it to the ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)" and "[Adding a new SSH key to your {% data variables.product.prodname_dotcom %} account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)." +When you set up SSH, you will need to generate a new private SSH key and add it to the SSH agent. You must also add the public SSH key to your account on {% data variables.product.product_name %} before you use the key to authenticate{% ifversion ssh-commit-verification %} or sign commits{% endif %}. For more information, see "[Generating a new SSH key and adding it to the ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)"{% ifversion ssh-commit-verification %}, {% else %} and{% endif %} "[Adding a new SSH key to your {% data variables.product.prodname_dotcom %} account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account){% ifversion ssh-commit-verification %}" and "[About commit signature verification](/articles/about-commit-signature-verification){% endif %}." You can further secure your SSH key by using a hardware security key, which requires the physical hardware security key to be attached to your computer when the key pair is used to authenticate with SSH. You can also secure your SSH key by adding your key to the ssh-agent and using a passphrase. For more information, see "[Working with SSH key passphrases](/github/authenticating-to-github/working-with-ssh-key-passphrases)." @@ -33,7 +33,6 @@ Organizations that use {% data variables.product.prodname_ghe_cloud %} can provi {% else ghec or ghes or ghae %} If you're a member of an organization that provides SSH certificates, you can use your certificate to access that organization's repositories without adding the certificate to your account on {% data variables.product.product_name %}. You cannot use your certificate to access forks of the organization's repositories, if the forks is owned by your personal account. For more information, see "[About SSH certificate authorities](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities)." {% endif %} - ## Further reading - "[Troubleshooting SSH](/articles/troubleshooting-ssh)" diff --git a/translations/zh-CN/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md b/translations/zh-CN/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md index a8d2c7aea6..0db0198132 100644 --- a/translations/zh-CN/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md +++ b/translations/zh-CN/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md @@ -19,6 +19,8 @@ shortTitle: 添加新的 SSH 密钥 {% data reusables.ssh.about-ssh %} 更多信息请参阅“[关于 SSH](/authentication/connecting-to-github-with-ssh/about-ssh)”。 +{% ifversion ssh-commit-verification %}You can also use SSH to sign commits and tags. For more information about commit signing, see "[About commit signature verification](/articles/about-commit-signature-verification)."{% endif %} + After you generate an SSH key pair, you must add the public key to {% ifversion fpt or ghec or ghes %}{% data variables.product.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %} to enable SSH access for your account. ## 基本要求 @@ -30,111 +32,45 @@ Before adding a new SSH key to your account on {% ifversion ghae %}{% data varia ## Adding a new SSH key to your account -在向您在 {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} 上的帐户添加新 SSH 密钥后，您可以重新配置任何本地存储库以使用 SSH。 更多信息请参阅“[将远程 URL 从 HTTPS 转换为 SSH](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-https-to-ssh)”。 +After adding a new SSH authentication key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you can reconfigure any local repositories to use SSH. 更多信息请参阅“[将远程 URL 从 HTTPS 转换为 SSH](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-https-to-ssh)”。 {% data reusables.ssh.key-type-support %} -{% mac %} - {% webui %} -1. 将 SSH 公钥复制到剪贴板。 - - 如果您的 SSH 公钥文件与示例代码不同，请修改文件名以匹配您当前的设置。 在复制密钥时，请勿添加任何新行或空格。 - - ```shell - $ pbcopy < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub - # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard - ``` - - {% tip %} - - **提示：**如果 `pbcopy` 不可用，可找到隐藏的 `.ssh` 文件夹，在常用的文本编辑器中打开该文件，并将其复制到剪贴板。 - - {% endtip %} - +{% data reusables.gpg.copy-ssh-public-key %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.ssh %} -4. 单击 **New SSH key（新 SSH 密钥）**或 **Add SSH key（添加 SSH 密钥）**。 ![SSH 密钥按钮](/assets/images/help/settings/ssh-add-ssh-key.png) -5. 在 "Title"（标题）字段中，为新密钥添加描述性标签。 例如，如果您使用的是个人 Mac，此密钥名称可能是 "Personal MacBook Air"。 -6. 将密钥粘贴到 "Key"（密钥）字段。 ![密钥字段](/assets/images/help/settings/ssh-key-paste.png) -7. 单击 **Add SSH key（添加 SSH 密钥）**。 ![添加密钥按钮](/assets/images/help/settings/ssh-add-key.png) +4. 单击 **New SSH key（新 SSH 密钥）**或 **Add SSH key（添加 SSH 密钥）**。 +{% ifversion ssh-commit-verification %} + ![SSH 密钥按钮](/assets/images/help/settings/ssh-add-ssh-key-with-auth.png) +{% else %} + ![SSH 密钥按钮](/assets/images/help/settings/ssh-add-ssh-key.png) +{% endif %} +5. 在 "Title"（标题）字段中，为新密钥添加描述性标签。 For example, if you're using a personal laptop, you might call this key "Personal laptop". +{% ifversion ssh-commit-verification %} +6. Select the type of key, either authentication or signing. For more information about commit signing, see "[About commit signature verification](/articles/about-commit-signature-verification)." +{% endif %} +7. 将密钥粘贴到 "Key"（密钥）字段。 +{% ifversion ssh-commit-verification %} + ![密钥字段](/assets/images/help/settings/ssh-key-paste-with-type.png) +{% else %} + ![密钥字段](/assets/images/help/settings/ssh-key-paste.png) +{% endif %} +8. 单击 **Add SSH key（添加 SSH 密钥）**。 ![添加密钥按钮](/assets/images/help/settings/ssh-add-key.png) {% data reusables.user-settings.sudo-mode-popup %} {% endwebui %} -{% endmac %} - -{% windows %} - -{% webui %} - -1. 将 SSH 公钥复制到剪贴板。 - - 如果您的 SSH 公钥文件与示例代码不同，请修改文件名以匹配您当前的设置。 在复制密钥时，请勿添加任何新行或空格。 - - ```shell - $ clip < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub - # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard - ``` - - {% tip %} - - **提示：**如果 `clip` 不可用，可找到隐藏的 `.ssh` 文件夹，在常用的文本编辑器中打开该文件，并将其复制到剪贴板。 - - {% endtip %} - -{% data reusables.user-settings.access_settings %} -{% data reusables.user-settings.ssh %} -4. 单击 **New SSH key（新 SSH 密钥）**或 **Add SSH key（添加 SSH 密钥）**。 ![SSH 密钥按钮](/assets/images/help/settings/ssh-add-ssh-key.png) -5. 在 "Title"（标题）字段中，为新密钥添加描述性标签。 例如，如果您使用的是个人 Mac，此密钥名称可能是 "Personal MacBook Air"。 -6. 将密钥粘贴到 "Key"（密钥）字段。 ![密钥字段](/assets/images/help/settings/ssh-key-paste.png) -7. 单击 **Add SSH key（添加 SSH 密钥）**。 ![添加密钥按钮](/assets/images/help/settings/ssh-add-key.png) -{% data reusables.user-settings.sudo-mode-popup %} - -{% endwebui %} - -{% endwindows %} - -{% linux %} - -{% webui %} - -1. 将 SSH 公钥复制到剪贴板。 - - 如果您的 SSH 公钥文件与示例代码不同，请修改文件名以匹配您当前的设置。 在复制密钥时，请勿添加任何新行或空格。 - - ```shell - $ cat ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub - # Then select and copy the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file - # displayed in the terminal to your clipboard - ``` - - {% tip %} - - **提示：**或者，您也可以找到隐藏的 `.ssh` 文件夹，在常用的文本编辑器中打开该文件，并将其复制到剪贴板。 - - {% endtip %} - -{% data reusables.user-settings.access_settings %} -{% data reusables.user-settings.ssh %} -4. 单击 **New SSH key（新 SSH 密钥）**或 **Add SSH key（添加 SSH 密钥）**。 ![SSH 密钥按钮](/assets/images/help/settings/ssh-add-ssh-key.png) -5. 在 "Title"（标题）字段中，为新密钥添加描述性标签。 例如，如果您使用的是个人 Mac，此密钥名称可能是 "Personal MacBook Air"。 -6. 将密钥粘贴到 "Key"（密钥）字段。 ![密钥字段](/assets/images/help/settings/ssh-key-paste.png) -7. 单击 **Add SSH key（添加 SSH 密钥）**。 ![添加密钥按钮](/assets/images/help/settings/ssh-add-key.png) -{% data reusables.user-settings.sudo-mode-popup %} - -{% endwebui %} - -{% endlinux %} - {% cli %} {% data reusables.cli.cli-learn-more %} 在使用 {% data variables.product.prodname_cli %} 将 SSH 密钥添加到帐户之前，必须向 {% data variables.product.prodname_cli %} 进行身份验证。 更多信息请参阅 {% data variables.product.prodname_cli %} 文档中的 [`gh auth login`](https://cli.github.com/manual/gh_auth_login)。 -要将 SSH 密钥添加到您的 GitHub 帐户，请使用 `ssh-key add` 子命令，指定您公钥。 +{% ifversion ssh-commit-verification %}At present, you can only use {% data variables.product.prodname_cli %} to add SSH authentication keys, you cannot add SSH signing keys.{% endif %} + +To add an SSH authentication key to your GitHub account, use the `ssh-key add` subcommand, specifying your public key. ```shell gh ssh-key add key-file diff --git a/translations/zh-CN/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md b/translations/zh-CN/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md index adb05a61f9..6c3a9ec7b0 100644 --- a/translations/zh-CN/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md +++ b/translations/zh-CN/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md @@ -1,6 +1,6 @@ --- -title: About commit signature verification -intro: 'Using GPG or S/MIME, you can sign tags and commits locally. These tags or commits are marked as verified on {% data variables.product.product_name %} so other people can be confident that the changes come from a trusted source.' +title: 关于提交签名验证 +intro: 'Using GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME, you can sign tags and commits locally. 这些标记或提交在 {% data variables.product.product_name %} 上标示为已验证，便于其他人信任更改来自可信的来源。' redirect_from: - /articles/about-gpg-commit-and-tag-signatures - /articles/about-gpg @@ -15,13 +15,22 @@ versions: topics: - Identity - Access management -shortTitle: Commit signature verification +shortTitle: 提交签名验证 --- -## About commit signature verification -You can sign commits and tags locally, to give other people confidence about the origin of a change you have made. If a commit or tag has a GPG or S/MIME signature that is cryptographically verifiable, GitHub marks the commit or tag {% ifversion fpt or ghec %}"Verified" or "Partially verified."{% else %}"Verified."{% endif %} +## 关于提交签名验证 -![Verified commit](/assets/images/help/commits/verified-commit.png) +您可以在本地签署提交和标签，让其他人对您所做更改的源充满信心。 If a commit or tag has a GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME signature that is cryptographically verifiable, {% data variables.product.product_name %} marks the commit or tag {% ifversion fpt or ghec %}"Verified" or "Partially verified."{% else %}"Verified."{% endif %} + +![验证的提交](/assets/images/help/commits/verified-commit.png) + +{% ifversion ghes or ghae %} +If a commit or tag has a signature that can't be verified, {% data variables.product.product_name %} marks the commit or tag "Unverified." +{% endif %} + +{% ifversion ssh-commit-verification %} +For most individual users, GPG or SSH will be the best choice for signing commits. S/MIME signatures are usually required in the context of a larger organization. SSH signatures are the simplest to generate. You can even upload your existing authentication key to {% data variables.product.product_name %} to also use as a signing key. Generating a GPG signing key is more involved than generating an SSH key, but GPG has features that SSH does not. A GPG key can expire or be revoked when no longer used. {% data variables.product.product_name %} shows commits that were signed with such a key as "Verified" unless the key was marked as compromised. SSH keys don't have this capability. +{% endif %} {% ifversion fpt or ghec %} Commits and tags have the following verification statuses, depending on whether you have enabled vigilant mode. By default vigilant mode is not enabled. For information on how to enable vigilant mode, see "[Displaying verification statuses for all of your commits](/github/authenticating-to-github/displaying-verification-statuses-for-all-of-your-commits)." @@ -30,39 +39,38 @@ Commits and tags have the following verification statuses, depending on whether Signing commits differs from signing off on a commit. For more information about signing off on commits, see "[Managing the commit signoff policy for your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository)." -### Default statuses +### 默认状态 -| Status | Description | -| -------------- | ----------- | -| **Verified** | The commit is signed and the signature was successfully verified. -| **Unverified** | The commit is signed but the signature could not be verified. -| No verification status | The commit is not signed. +| 状态 | 描述 | +| ------- | -------------- | +| **已验证** | 提交已签名且签名已成功验证。 | +| **未验证** | 提交已签名，但签名无法验证。 | +| 无验证状态 | 提交未签名。 | -### Signature verification for rebase and merge +### 用于变基和合并的签名验证 {% data reusables.pull_requests.rebase_and_merge_verification %} For more information, see "[Rebasing and merging your commits](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github#rebasing-and-merging-your-commits)." -### Statuses with vigilant mode enabled +### 启用了警戒模式的状态 {% data reusables.identity-and-permissions.vigilant-mode-verification-statuses %} -{% else %} -If a commit or tag has a signature that can't be verified, {% data variables.product.product_name %} marks the commit or tag "Unverified." {% endif %} + Repository administrators can enforce required commit signing on a branch to block all commits that are not signed and verified. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-signed-commits)." {% data reusables.identity-and-permissions.verification-status-check %} {% ifversion fpt or ghec or ghes > 3.4 %} -{% ifversion ghes %}If a site administrator has enabled web commit signing, {% data variables.product.product_name %} will automatically use GPG to sign commits you make using the web interface. Commits signed by {% data variables.product.product_name %} will have a verified status. You can verify the signature locally using the public key available at `https://HOSTNAME/web-flow.gpg`. For more information, see "[Configuring web commit signing](/admin/configuration/configuring-your-enterprise/configuring-web-commit-signing)." +{% ifversion ghes %}If a site administrator has enabled web commit signing, {% data variables.product.product_name %} will automatically use GPG to sign commits you make using the web interface. 由 {% data variables.product.product_name %} 签名的提交将具有已验证状态。 You can verify the signature locally using the public key available at `https://HOSTNAME/web-flow.gpg`. For more information, see "[Configuring web commit signing](/admin/configuration/configuring-your-enterprise/configuring-web-commit-signing)." {% else %}{% data variables.product.prodname_dotcom %} will automatically use GPG to sign commits you make using the web interface. Commits signed by {% data variables.product.prodname_dotcom %} will have a verified status. You can verify the signature locally using the public key available at https://github.com/web-flow.gpg. The full fingerprint of the key is `5DE3 E050 9C47 EA3C F04A 42D3 4AEE 18F8 3AFD EB23`. -You can optionally choose to have {% data variables.product.prodname_dotcom %} sign commits you make in {% data variables.product.prodname_github_codespaces %}. For more information about enabling GPG verification for your codespaces, see "[Managing GPG verification for {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)."{% endif %} +You can optionally choose to have {% data variables.product.prodname_dotcom %} GPG sign commits you make in {% data variables.product.prodname_github_codespaces %}. For more information about enabling GPG verification for your codespaces, see "[Managing GPG verification for {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)."{% endif %} {% endif %} -## GPG commit signature verification +## GPG 提交签名验证 You can use GPG to sign commits with a GPG key that you generate yourself. @@ -70,13 +78,32 @@ You can use GPG to sign commits with a GPG key that you generate yourself. To sign commits using GPG and have those commits verified on {% data variables.product.product_name %}, follow these steps: -1. [Check for existing GPG keys](/articles/checking-for-existing-gpg-keys) -2. [Generate a new GPG key](/articles/generating-a-new-gpg-key) -3. [Add a GPG key to your GitHub account](/articles/adding-a-gpg-key-to-your-github-account) -4. [Tell Git about your signing key](/articles/telling-git-about-your-signing-key) -5. [Sign commits](/articles/signing-commits) -6. [Sign tags](/articles/signing-tags) +1. [检查现有 GPG 密钥](/articles/checking-for-existing-gpg-keys) +2. [生成新 GPG 密钥](/articles/generating-a-new-gpg-key) +3. [添加 GPG 密钥到 GitHub 帐户](/articles/adding-a-gpg-key-to-your-github-account) +4. [将您的签名密钥告诉 Git](/articles/telling-git-about-your-signing-key) +5. [对提交签名](/articles/signing-commits) +6. [对标记签名](/articles/signing-tags) +{% ifversion ssh-commit-verification %} +## SSH commit signature verification + +You can use SSH to sign commits with an SSH public key that you generate yourself. If you already use an SSH key to authenticate with {% data variables.product.product_name %}, you can also upload that same key again for use as a signing key. There's no limit on the number of signing keys you can add to your account. + +{% data variables.product.product_name %} uses [ssh_data](https://github.com/github/ssh_data), an open source Ruby library, to confirm that your locally signed commits and tags are cryptographically verifiable against a public key you have added to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. + +{% data reusables.gpg.ssh-git-version %} + +To sign commits using SSH and have those commits verified on {% data variables.product.product_name %}, follow these steps: + +1. [Check for existing SSH keys](/articles/checking-for-existing-ssh-keys) +2. [Generate a new SSH key](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) +3. [Add a SSH signing key to your GitHub account](/articles/adding-a-new-ssh-key-to-your-github-account) +4. [将您的签名密钥告诉 Git](/articles/telling-git-about-your-signing-key) +5. [对提交签名](/articles/signing-commits) +6. [对标记签名](/articles/signing-tags) + +{% endif %} ## S/MIME commit signature verification You can use S/MIME to sign commits with an X.509 key issued by your organization. @@ -87,9 +114,9 @@ You can use S/MIME to sign commits with an X.509 key issued by your organization To sign commits using S/MIME and have those commits verified on {% data variables.product.product_name %}, follow these steps: -1. [Tell Git about your signing key](/articles/telling-git-about-your-signing-key) -2. [Sign commits](/articles/signing-commits) -3. [Sign tags](/articles/signing-tags) +1. [将您的签名密钥告诉 Git](/articles/telling-git-about-your-signing-key) +2. [对提交签名](/articles/signing-commits) +3. [对标记签名](/articles/signing-tags) You don't need to upload your public key to {% data variables.product.product_name %}. @@ -101,8 +128,8 @@ Organizations and {% data variables.product.prodname_github_apps %} that require Signature verification for bots will only work if the request is verified and authenticated as the {% data variables.product.prodname_github_app %} or bot and contains no custom author information, custom committer information, and no custom signature information, such as Commits API. {% endif %} -## Further reading +## 延伸阅读 -- "[Signing commits](/articles/signing-commits)" -- "[Signing tags](/articles/signing-tags)" -- "[Troubleshooting commit signature verification](/articles/troubleshooting-commit-signature-verification)" +- "[对提交签名](/articles/signing-commits)" +- "[对标记签名](/articles/signing-tags)" +- "[提交签名验证故障排除](/articles/troubleshooting-commit-signature-verification)" diff --git a/translations/zh-CN/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md b/translations/zh-CN/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md index 056ffdc6fa..5a6d0ce316 100644 --- a/translations/zh-CN/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md +++ b/translations/zh-CN/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md @@ -19,7 +19,7 @@ redirect_from: 当您在计算机上本地工作时，Git 允许您设置更改的作者和提交者的身份。 这可能会使其他人难以确信您创建的提交和标记实际上是由您创建的。 为了帮助解决这个问题，您可以签署您的提交和标签。 更多信息请参阅“[签名提交](/github/authenticating-to-github/signing-commits)”和“[签名标记](/github/authenticating-to-github/signing-tags)”。 {% data variables.product.prodname_dotcom %} 使用验证状态标记已签名的提交和标记。 -默认情况下，如果提交和标记使用已成功验证的 GPG 或 S/MIME 密钥签名，则标记为“已验证”。 如果提交或标记具有 {% data variables.product.prodname_dotcom %} 无法验证的签名，则我们会将提交或标记标示为“未验证”。 在所有其他情况下，都不会显示验证状态。 +By default commits and tags are marked "Verified" if they are signed with a GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME key that was successfully verified. 如果提交或标记具有 {% data variables.product.prodname_dotcom %} 无法验证的签名，则我们会将提交或标记标示为“未验证”。 在所有其他情况下，都不会显示验证状态。 但是，您可以通过在 {% data variables.product.prodname_dotcom %} 设置中启用警戒模式，让其他用户对您的提交和标签所赋予的身份更加有信心。 启用警戒模式后，您的所有提交和标记都将被标记为三个验证状态之一。 diff --git a/translations/zh-CN/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md b/translations/zh-CN/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md index 7caea0a09c..b7cf6f3f03 100644 --- a/translations/zh-CN/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md +++ b/translations/zh-CN/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md @@ -29,11 +29,11 @@ topics: {% data reusables.command_line.open_the_multi_os_terminal %} 3. 生成 GPG 密钥对。 由于 GPG 有多个版本，因此您可能需要查询相关的[_手册页_](https://en.wikipedia.org/wiki/Man_page)以找到适当的密钥生成命令。 密钥必须使用 RSA。 - 如果您使用的是 2.1.17 或更高版本，请粘贴以下文本以生成 GPG 密钥对。 - ```shell + ```shell{:copy} $ gpg --full-generate-key ``` - 如果使用的不是 2.1.17 或更高版本，则 `gpg --full-generate-key` 命令无效。 请粘贴以下文本并跳到第 6 步。 - ```shell + ```shell{:copy} $ gpg --default-new-key-algo rsa4096 --gen-key ``` 4. 在提示时，指定要生成的密钥类型，或按 `Enter` 键接受默认值。 @@ -52,10 +52,10 @@ topics: {% data reusables.gpg.list-keys-with-note %} {% data reusables.gpg.copy-gpg-key-id %} 10. 粘贴下面的文本（替换为您要使用的 GPG 密钥 ID）。 在此例中，GPG 密钥 ID 是 `3AA5C34371567BD2`： - ```shell - $ gpg --armor --export 3AA5C34371567BD2 - # Prints the GPG key ID, in ASCII armor format - ``` + ```shell{:copy} + $ gpg --armor --export 3AA5C34371567BD2 + # Prints the GPG key ID, in ASCII armor format + ``` 11. 复制 GPG 密钥，从 `-----BEGIN PGP PUBLIC KEY BLOCK-----` 开始，到 `-----END PGP PUBLIC KEY BLOCK-----` 结束。 12. [将 GPG 密钥添加到 GitHub 帐户](/articles/adding-a-gpg-key-to-your-github-account)。 diff --git a/translations/zh-CN/content/authentication/managing-commit-signature-verification/index.md b/translations/zh-CN/content/authentication/managing-commit-signature-verification/index.md index 034ec9b921..770a7485dc 100644 --- a/translations/zh-CN/content/authentication/managing-commit-signature-verification/index.md +++ b/translations/zh-CN/content/authentication/managing-commit-signature-verification/index.md @@ -1,6 +1,6 @@ --- title: 管理提交签名验证 -intro: '您可以使用 GPG 或 S/MIME 在本地对工作进行签名。 {% data variables.product.product_name %} 将会验证这些签名，以便其他人知道提交来自可信的来源。{% ifversion fpt %} {% data variables.product.product_name %} 将自动使用 {% data variables.product.product_name %} web 界面{% endif %}对您的提交签名。' +intro: '{% data variables.product.product_name %} will verify GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME signatures so other people will know that your commits come from a trusted source.{% ifversion fpt %} {% data variables.product.product_name %} will automatically sign commits you make using the {% data variables.product.product_name %} web interface.{% endif %}' redirect_from: - /articles/generating-a-gpg-key - /articles/signing-commits-with-gpg diff --git a/translations/zh-CN/content/authentication/managing-commit-signature-verification/signing-commits.md b/translations/zh-CN/content/authentication/managing-commit-signature-verification/signing-commits.md index 2df3b1df59..653f346d7f 100644 --- a/translations/zh-CN/content/authentication/managing-commit-signature-verification/signing-commits.md +++ b/translations/zh-CN/content/authentication/managing-commit-signature-verification/signing-commits.md @@ -1,6 +1,6 @@ --- title: 对提交签名 -intro: 您可以使用 GPG 或 S/MIME 在本地对提交进行签名。 +intro: 'You can sign commits locally using GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME.' redirect_from: - /articles/signing-commits-and-tags-using-gpg - /articles/signing-commits-using-gpg @@ -52,9 +52,5 @@ topics: ## 延伸阅读 -* "[检查现有 GPG 密钥](/articles/checking-for-existing-gpg-keys)" -* "[生成新 GPG 密钥](/articles/generating-a-new-gpg-key)" -* "[添加 GPG 密钥到 GitHub 帐户](/articles/adding-a-gpg-key-to-your-github-account)" * "[向 Git 告知您的签名密钥](/articles/telling-git-about-your-signing-key)" -* "[将电子邮件与 GPG 密钥关联](/articles/associating-an-email-with-your-gpg-key)" * "[对标记签名](/articles/signing-tags)" diff --git a/translations/zh-CN/content/authentication/managing-commit-signature-verification/signing-tags.md b/translations/zh-CN/content/authentication/managing-commit-signature-verification/signing-tags.md index dbec2ce8fb..9caca61dbc 100644 --- a/translations/zh-CN/content/authentication/managing-commit-signature-verification/signing-tags.md +++ b/translations/zh-CN/content/authentication/managing-commit-signature-verification/signing-tags.md @@ -1,6 +1,6 @@ --- title: 对标记签名 -intro: 您可以使用 GPG 或 S/MIME 在本地对标记进行签名。 +intro: 'You can sign tags locally using GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME.' redirect_from: - /articles/signing-tags-using-gpg - /articles/signing-tags @@ -32,9 +32,6 @@ topics: ## 延伸阅读 - "[查看仓库的标记](/articles/viewing-your-repositorys-tags)" -- "[检查现有 GPG 密钥](/articles/checking-for-existing-gpg-keys)" -- "[生成新 GPG 密钥](/articles/generating-a-new-gpg-key)" -- "[添加 GPG 密钥到 GitHub 帐户](/articles/adding-a-gpg-key-to-your-github-account)" - "[向 Git 告知您的签名密钥](/articles/telling-git-about-your-signing-key)" - "[将电子邮件与 GPG 密钥关联](/articles/associating-an-email-with-your-gpg-key)" - "[对提交签名](/articles/signing-commits)" diff --git a/translations/zh-CN/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md b/translations/zh-CN/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md index 9a644896d8..14345ee266 100644 --- a/translations/zh-CN/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md +++ b/translations/zh-CN/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md @@ -1,6 +1,6 @@ --- title: 将您的签名密钥告知 Git -intro: 要在本地对提交签名，您需要通知 Git 您想要使用的 GPG 或 X.509 密钥。 +intro: 'To sign commits locally, you need to inform Git that there''s a GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or X.509 key you''d like to use.' redirect_from: - /articles/telling-git-about-your-gpg-key - /articles/telling-git-about-your-signing-key @@ -52,8 +52,6 @@ shortTitle: 将您的签名密钥告诉 Git $ killall gpg-agent ``` -{% data reusables.gpg.x-509-key %} - {% endmac %} {% windows %} @@ -75,8 +73,6 @@ shortTitle: 将您的签名密钥告诉 Git {% data reusables.gpg.copy-gpg-key-id %} {% data reusables.gpg.paste-gpg-key-id %} -{% data reusables.gpg.x-509-key %} - {% endwindows %} {% linux %} @@ -101,15 +97,25 @@ shortTitle: 将您的签名密钥告诉 Git ```bash $ [ -f ~/.bashrc ] && echo 'export GPG_TTY=$(tty)' >> ~/.bashrc ``` - {% endlinux %} +{% ifversion ssh-commit-verification %} +## Telling Git about your SSH key + +You can use an existing SSH key to sign commits and tags, or generate a new one specifically for signing. 更多信息请参阅“[生成新的 SSH 密钥并添加到 ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)”。 + +{% data reusables.gpg.ssh-git-version %} + +{% data reusables.command_line.open_the_multi_os_terminal %} +{% data reusables.gpg.configure-ssh-signing %} +{% data reusables.gpg.copy-ssh-public-key %} +{% data reusables.gpg.paste-ssh-public-key %} + +{% endif %} + +{% data reusables.gpg.x-509-key %} ## 延伸阅读 -- "[检查现有 GPG 密钥](/articles/checking-for-existing-gpg-keys)" -- "[生成新 GPG 密钥](/articles/generating-a-new-gpg-key)" -- "[在 GPG 密钥中使用经验证的电子邮件地址](/articles/using-a-verified-email-address-in-your-gpg-key)" -- "[添加 GPG 密钥到 GitHub 帐户](/articles/adding-a-gpg-key-to-your-github-account)" -- "[将电子邮件与 GPG 密钥关联](/articles/associating-an-email-with-your-gpg-key)" +- "[Adding a new SSH key to your GitHub account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)." - "[对提交签名](/articles/signing-commits)" - "[对标记签名](/articles/signing-tags)" diff --git a/translations/zh-CN/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md b/translations/zh-CN/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md index 8a1141c9fe..7a608784d7 100644 --- a/translations/zh-CN/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md +++ b/translations/zh-CN/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md @@ -22,7 +22,10 @@ shortTitle: 检查验证状态 1. 在 {% data variables.product.product_name %} 上，导航到您的拉取请求。 {% data reusables.repositories.review-pr-commits %} 3. 在提交的缩写提交哈希旁边，有一个框，显示您的提交签名已验证{% ifversion fpt or ghec %}、部分验证{% endif %}或未验证。 ![已签名提交](/assets/images/help/commits/gpg-signed-commit-verified-without-details.png) -4. 要查看有关提交签名的更详细信息，请单击 **Verified（已验证）**{% ifversion fpt or ghec %}、**Partially verified（部分验证）**{% endif %}或 **Unverified（未验证）**。 ![经验证签名提交](/assets/images/help/commits/gpg-signed-commit_verified_details.png) +4. 要查看有关提交签名的更详细信息，请单击 **Verified（已验证）**{% ifversion fpt or ghec %}、**Partially verified（部分验证）**{% endif %}或 **Unverified（未验证）**。 GPG signed commits will show the ID of the key that was used. ![Verified GPG signed commit](/assets/images/help/commits/gpg-signed-commit_verified_details.png) +{% ifversion ssh-commit-verification %} + SSH signed commits will show the signature of the public key that was used. ![Verified SSH signed commit](/assets/images/help/commits/ssh-signed-commit-verified-details.png) +{% endif %} ## 检查标记签名验证状态 diff --git a/translations/zh-CN/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md b/translations/zh-CN/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md index e7fb70174a..81683b18f8 100644 --- a/translations/zh-CN/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md +++ b/translations/zh-CN/content/billing/managing-billing-for-github-packages/about-billing-for-github-packages.md @@ -49,9 +49,9 @@ All data transferred out, when triggered by {% data variables.product.prodname_a Storage usage is shared with build artifacts produced by {% data variables.product.prodname_actions %} for repositories owned by your account. For more information, see "[About billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/about-billing-for-github-actions)." -{% data variables.product.prodname_dotcom %} charges usage to the account that owns the repository where the package is published. If your account's usage surpasses these limits and you have set a spending limit above $0 USD, you will pay $0.25 USD per GB of storage per day and $0.50 USD per GB of data transfer. +{% data variables.product.prodname_dotcom %} charges usage to the account that owns the repository where the package is published. If your account's usage surpasses these limits and you have set a spending limit above $0 USD, you will pay $0.008 USD per GB of storage per day and $0.50 USD per GB of data transfer. -For example, if your organization uses {% data variables.product.prodname_team %}, allows unlimited spending, uses 150GB of storage, and has 50GB of data transfer out during a month, the organization would have overages of 148GB for storage and 40GB for data transfer for that month. The storage overage would cost $0.25 USD per GB per day or $37 USD. The overage for data transfer would cost $0.50 USD per GB or $20 USD. +For example, if your organization uses {% data variables.product.prodname_team %}, allows unlimited spending, uses 150GB of storage, and has 50GB of data transfer out during a month, the organization would have overages of 148GB for storage and 40GB for data transfer for that month. The storage overage would cost $0.008 USD per GB per day or approximately $37 USD for a 31-day month. The overage for data transfer would cost $0.50 USD per GB or $20 USD. {% data reusables.dotcom_billing.pricing_calculator.pricing_cal_packages %} diff --git a/translations/zh-CN/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md b/translations/zh-CN/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md index a66a670f5f..c2cba44e7f 100644 --- a/translations/zh-CN/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md +++ b/translations/zh-CN/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md @@ -32,7 +32,7 @@ There are a few approaches for tackling newly committed credentials, but one exa {% note %} - **Note:** You can automate this step. For large enterprises and organizations with hundreds of repositories, manually following up is unsustainable. You could incorporate automation into the webhook process defined in the first step. The webhook payload contains repository and organization information about the leaked secret. Using this information, you can contact the current maintainers on the repository and create a email/message to the responsible people or open an issue. + **Note:** You can automate this step. For large enterprises and organizations with hundreds of repositories, manually following up is unsustainable. You could incorporate automation into the webhook process defined in the first step. The webhook payload contains repository and organization information about the leaked secret. Using this information, you can contact the current maintainers on the repository and create an email/message to the responsible people or open an issue. {% endnote %} 3. **Educate**: Create an internal training document assigned to the developer who committed the secret. Within this training document, you can explain the risks created by committing secrets and direct them to your best practice information about using secrets securely in development. If the a developer doesn't learn from the experience and continues to commit secrets, you could create an escalation process, but education usually works well. diff --git a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md index a5948aba46..23e20a25a3 100644 --- a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md +++ b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md @@ -43,8 +43,8 @@ By default, the code scanning alerts page is filtered to show alerts for the def ![Summary of alerts](/assets/images/help/repository/code-scanning-click-alert.png) {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %} - {% data reusables.code-scanning.alert-default-branch %} - ![The "Affected branches" section in an alert](/assets/images/help/repository/code-scanning-affected-branches.png){% endif %} + {% data reusables.code-scanning.alert-default-branch %} + ![The "Affected branches" section in an alert](/assets/images/help/repository/code-scanning-affected-branches.png){% endif %} 1. Optionally, if the alert highlights a problem with data flow, click **Show paths** to display the path from the data source to the sink where it's used. {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %} ![The "Show paths" link on an alert](/assets/images/help/repository/code-scanning-show-paths.png) diff --git a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md index 3df17ec3a9..3b895243e4 100644 --- a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md +++ b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md @@ -32,6 +32,12 @@ topics: 您必须在构建代码的容器中运行 {% data variables.product.prodname_codeql %}。 无论您使用的是 {% data variables.product.prodname_codeql_cli %}{% ifversion codeql-runner-supported %}、 {% data variables.product.prodname_codeql_runner %}、{% endif %} 还是 {% data variables.product.prodname_actions %}，这都适用。 对于 {% data variables.product.prodname_codeql_cli %} {% ifversion codeql-runner-supported %}或 {% data variables.product.prodname_codeql_runner %}{% endif %}，请参阅“[在 CI 系统中安装 {% data variables.product.prodname_codeql_cli %}](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)”{% ifversion codeql-runner-supported %} 或“[在 CI 系统](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)中运行 {% data variables.product.prodname_codeql_runner %}”{% endif %}以了解更多信息。 如果您使用 {% data variables.product.prodname_actions %}，请配置工作流程以在同一容器中运行所有操作。 更多信息请参阅“[示例工作流程](#example-workflow)”。 +{% note %} + +**Note:** {% data reusables.code-scanning.non-glibc-linux-support %} + +{% endnote %} + ## 依赖项 如果您使用的容器缺少某些依赖项（例如，Git 必须安装并添加到 PATH 变量），您可能难以运行 {% data variables.product.prodname_code_scanning %}。 If you encounter dependency issues, review the list of software typically included on {% data variables.product.prodname_dotcom %}'s runner images. 有关更多信息，请在以下位置查看特定于版本的 `readme` 文件： diff --git a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md index 52e0b98fd3..32cea9db26 100644 --- a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md +++ b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md @@ -151,25 +151,29 @@ The names of the {% data variables.product.prodname_code_scanning %} analysis ch ![{% data variables.product.prodname_code_scanning %} pull request checks](/assets/images/help/repository/code-scanning-pr-checks.png) -When the {% data variables.product.prodname_code_scanning %} jobs complete, {% data variables.product.prodname_dotcom %} works out whether any alerts were added by the pull request and adds the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" entry to the list of checks. After {% data variables.product.prodname_code_scanning %} has been performed at least once, you can click **Details** to view the results of the analysis. If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion fpt or ghes > 3.2 or ghae or ghec %}an "Analysis not found"{% else %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check. +When the {% data variables.product.prodname_code_scanning %} jobs complete, {% data variables.product.prodname_dotcom %} works out whether any alerts were added by the pull request and adds the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" entry to the list of checks. After {% data variables.product.prodname_code_scanning %} has been performed at least once, you can click **Details** to view the results of the analysis. -{% ifversion fpt or ghes > 3.2 or ghae or ghec %} - ![Analysis not found for commit message](/assets/images/help/repository/code-scanning-analysis-not-found.png) +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-7095 %} + +{% elsif ghes < 3.5 or ghae %} +If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion ghes > 3.2 or ghae %}an "Analysis not found"{% elsif ghes = 3.2 %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check. + +{% ifversion ghes > 3.2 or ghae %} + ![Analysis not found for commit message](/assets/images/enterprise/3.4/repository/code-scanning-analysis-not-found.png) The table lists one or more categories. Each category relates to specific analyses, for the same tool and commit, performed on a different language or a different part of the code. For each category, the table shows the two analyses that {% data variables.product.prodname_code_scanning %} attempted to compare to determine which alerts were introduced or fixed in the pull request. For example, in the screenshot above, {% data variables.product.prodname_code_scanning %} found an analysis for the merge commit of the pull request, but no analysis for the head of the main branch. -{% else %} - ![Missing analysis for commit message](/assets/images/enterprise/3.2/repository/code-scanning-missing-analysis.png) -{% endif %} -{% ifversion fpt or ghes > 3.2 or ghae or ghec %} ### Reasons for the "Analysis not found" message -{% else %} + +{% elsif ghes = 3.2 %} + ![Missing analysis for commit message](/assets/images/enterprise/3.2/repository/code-scanning-missing-analysis.png) + ### Reasons for the "Missing analysis" message {% endif %} -After {% data variables.product.prodname_code_scanning %} has analyzed the code in a pull request, it needs to compare the analysis of the topic branch (the branch you used to create the pull request) with the analysis of the base branch (the branch into which you want to merge the pull request). This allows {% data variables.product.prodname_code_scanning %} to compute which alerts are newly introduced by the pull request, which alerts were already present in the base branch, and whether any existing alerts are fixed by the changes in the pull request. Initially, if you use a pull request to add {% data variables.product.prodname_code_scanning %} to a repository, the base branch has not yet been analyzed, so it's not possible to compute these details. In this case, when you click through from the results check on the pull request you will see the {% ifversion fpt or ghes > 3.2 or ghae or ghec %}"Analysis not found"{% else %}"Missing analysis for base commit SHA-HASH"{% endif %} message. +After {% data variables.product.prodname_code_scanning %} has analyzed the code in a pull request, it needs to compare the analysis of the topic branch (the branch you used to create the pull request) with the analysis of the base branch (the branch into which you want to merge the pull request). This allows {% data variables.product.prodname_code_scanning %} to compute which alerts are newly introduced by the pull request, which alerts were already present in the base branch, and whether any existing alerts are fixed by the changes in the pull request. Initially, if you use a pull request to add {% data variables.product.prodname_code_scanning %} to a repository, the base branch has not yet been analyzed, so it's not possible to compute these details. In this case, when you click through from the results check on the pull request you will see the {% ifversion ghes > 3.2 or ghae %}"Analysis not found"{% elsif ghes = 3.2 %}"Missing analysis for base commit SHA-HASH"{% endif %} message. There are other situations where there may be no analysis for the latest commit to the base branch for a pull request. These include: @@ -177,7 +181,7 @@ There are other situations where there may be no analysis for the latest commit To check whether a branch has been scanned, go to the {% data variables.product.prodname_code_scanning_capc %} page, click the **Branch** drop-down and select the relevant branch. -![Choose a branch from the Branch drop-down menu](/assets/images/help/repository/code-scanning-branch-dropdown.png) + ![Choose a branch from the Branch drop-down menu](/assets/images/help/repository/code-scanning-branch-dropdown.png) The solution in this situation is to add the name of the base branch to the `on:push` and `on:pull_request` specification in the {% data variables.product.prodname_code_scanning %} workflow on that branch and then make a change that updates the open pull request that you want to scan. @@ -189,6 +193,8 @@ There are other situations where there may be no analysis for the latest commit Merge a trivial change into the base branch to trigger {% data variables.product.prodname_code_scanning %} on this latest commit, then push a change to the pull request to retrigger {% data variables.product.prodname_code_scanning %}. +{% endif %} + ## Next steps After setting up {% data variables.product.prodname_code_scanning %}, and allowing its actions to complete, you can: diff --git a/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md index daeb17e483..74df7049d2 100644 --- a/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md +++ b/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md @@ -45,9 +45,15 @@ If you upload a second SARIF file for a commit with the same category and from t If you're new to SARIF and want to learn more, see Microsoft's [`SARIF tutorials`](https://github.com/microsoft/sarif-tutorials) repository. -## Preventing duplicate alerts using fingerprints +## Providing data to track {% data variables.product.prodname_code_scanning %} alerts across runs -Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the right line of code when files are edited. +Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the correct line of code when files are edited. The `ruleID` for a result has to be the same across analysis. + +### Reporting consistent filepaths + +The filepath has to be consistent across the runs to enable a computation of a stable fingerprint. If the filepaths differ for the same result, each time there is a new analysis a new alert will be created, and the old one will be closed. This will cause having multiple alerts for the same result. + +### Including data for fingerprint generation {% data variables.product.prodname_dotcom %} uses the `partialFingerprints` property in the OASIS standard to detect when two results are logically identical. For more information, see the "[partialFingerprints property](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" entry in the OASIS documentation. @@ -77,6 +83,12 @@ You can check a SARIF file is compatible with {% data variables.product.prodname If you use a code analysis engine other than {% data variables.product.prodname_codeql %}, you can review the supported SARIF properties to optimize how your analysis results will appear on {% data variables.product.prodname_dotcom %}. +{% note %} + +**Note:** You must supply an explicit value for any property marked as "required". The empty string is not supported for required properties. + +{% endnote %} + Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.product.prodname_code_scanning %} will only use the following supported properties. ### `sarifLog` object @@ -138,7 +150,7 @@ Each `result` object contains details for one alert in the codebase. Within the | `level`| **Optional.** The severity of the result. This level overrides the default severity defined by the rule. {% data variables.product.prodname_code_scanning_capc %} uses the level to filter results by severity on {% data variables.product.prodname_dotcom %}. | `message.text`| **Required.** A message that describes the result. {% data variables.product.prodname_code_scanning_capc %} displays the message text as the title of the result. Only the first sentence of the message will be displayed when visible space is limited. | `locations[]`| **Required.** The set of locations where the result was detected up to a maximum of 10. Only one location should be included unless the problem can only be corrected by making a change at every specified location. **Note:** At least one location is required for {% data variables.product.prodname_code_scanning %} to display a result. {% data variables.product.prodname_code_scanning_capc %} will use this property to decide which file to annotate with the result. Only the first value of this array is used. All other values are ignored. -| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Preventing duplicate alerts using fingerprints](#preventing-duplicate-alerts-using-fingerprints)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. +| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Providing data to track code scanning alerts across runs](#providing-data-to-track-code-scanning-alerts-across-runs)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. | `codeFlows[].threadFlows[].locations[]`| **Optional.** An array of `location` objects for a `threadFlow` object, which describes the progress of a program through a thread of execution. A `codeFlow` object describes a pattern of code execution used to detect a result. If code flows are provided, {% data variables.product.prodname_code_scanning %} will expand code flows on {% data variables.product.prodname_dotcom %} for the relevant result. For more information, see the [`location` object](#location-object). | `relatedLocations[]`| A set of locations relevant to this result. {% data variables.product.prodname_code_scanning_capc %} will link to related locations when they are embedded in the result message. For more information, see the [`location` object](#location-object). @@ -204,7 +216,7 @@ These example SARIF output files show supported properties and example values. ### Example with minimum required properties -This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties or don't include values, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. +This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties, omit values, or use an empty string, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. ```json { diff --git a/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md b/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md index 1e03a239f3..193ee54f5a 100644 --- a/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md +++ b/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md @@ -58,7 +58,7 @@ For more information see the [`upload-sarif` action](https://github.com/github/c The `upload-sarif` action can be configured to run when the `push` and `scheduled` event occur. For more information about {% data variables.product.prodname_actions %} events, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#preventing-duplicate-alerts-using-fingerprints)." +If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#providing-data-to-track-code-scanning-alerts-across-runs)." {% data reusables.code-scanning.upload-sarif-alert-limit %} diff --git a/translations/zh-CN/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md b/translations/zh-CN/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md index 2b61634b57..d24d4342bd 100644 --- a/translations/zh-CN/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md +++ b/translations/zh-CN/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md @@ -37,20 +37,40 @@ topics: {% data variables.product.product_name %} 在检测到您的代码库正在使用具有已知安全风险的依赖项时会生成 {% data variables.product.prodname_dependabot_alerts %}。 对于启用了 {% data variables.product.prodname_dependabot_security_updates %} 的仓库，当 {% data variables.product.product_name %} 在默认分支中检测到有漏洞的依赖项时，{% data variables.product.prodname_dependabot %} 会创建拉取请求来修复它。 拉取请求会将依赖项升级到避免漏洞所需的最低安全版本。 -{% ifversion dependabot-most-important-sort-option %} 默认情况下，{% data variables.product.prodname_dependabot_alerts %} 按重要性顺序显示在 {% data variables.product.prodname_dependabot_alerts %} 选项卡中，但您可以按其他条件对警报进行排序。 {% endif %}{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5638 %}您可以使用 {% data variables.product.prodname_dependabot_alerts %} 选项卡中的下拉菜单对 {% data variables.product.prodname_dependabot_alerts %} 进行排序和过滤，也可以在搜索栏中键入过滤条件作为`键:值`对。 可用的过滤器是存储库（例如 `repo:my-repository`）、包（例如 `package:django`）、生态系统（例如 `ecosystem:npm`）、清单（例如 `manifest:webwolf/pom.xml`）、状态（例如 `is:open`） 以及公告是否有补丁（例如 `has: patch`）。{% ifversion dependabot-alerts-development-label %} 还可以使用 `scope`（例如：`scope:development` 或 `scope:runtime`）筛选具有依赖关系范围数据的警报。 使用 `scope:development`，警报列表将仅显示开发期间使用的依赖项，而不显示生产期间使用的依赖项。{% endif %} - 每个 {% data variables.product.prodname_dependabot %} 警报都有一个唯一的数字标识符，{% data variables.product.prodname_dependabot_alerts %} 选项卡列出了每个检测到的漏洞的警报。 旧版 {% data variables.product.prodname_dependabot_alerts %} 按依赖项对漏洞进行分组，并为每个依赖项生成一个警报。 如果导航到旧版 {% data variables.product.prodname_dependabot %} 警报，则会将您重定向到为该包筛选的 {% data variables.product.prodname_dependabot_alerts %} 选项卡。 {% endif %} + +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5638 %} +You can filter and sort {% data variables.product.prodname_dependabot_alerts %} using a variety of filters and sort options available on the user interface. For more information, see "[Prioritizing {% data variables.product.prodname_dependabot_alerts %}](#prioritizing-across--data-variablesproductprodname_dependabot_alerts-)" below. + +## Prioritizing {% data variables.product.prodname_dependabot_alerts %} + +{% data variables.product.company_short %} helps you prioritize fixing {% data variables.product.prodname_dependabot_alerts %}. {% ifversion dependabot-most-important-sort-option %} By default, {% data variables.product.prodname_dependabot_alerts %} are sorted by importance. The "Most important" sort order helps you prioritize which {% data variables.product.prodname_dependabot_alerts %} to focus on first. 警报根据其潜在影响、可操作性和相关性进行排名。 我们的优先级计算不断改进，包括 CVSS 分数、依赖范围以及是否为警报找到有漏洞的函数调用等因素。 + +![带有"最重要"排序”的“排序”下拉列表的屏幕截图](/assets/images/help/dependabot/dependabot-alerts-sort-dropdown.png) {% endif %} +{% data reusables.dependabot.dependabot-alerts-filters %} + +In addition to the filters available via the search bar, you can sort and filter {% data variables.product.prodname_dependabot_alerts %} using the dropdown menus at the top of the alert list. The search bar also allows for full text searching of alerts and related security advisories. You can search for part of a security advisory name or description to return the alerts in your repository that relate to that security advisory. For example, searching for `yaml.load() API could execute arbitrary code` will return {% data variables.product.prodname_dependabot_alerts %} linked to "[PyYAML insecurely deserializes YAML strings leading to arbitrary code execution](https://github.com/advisories/GHSA-rprw-h62v-c2w7)" as the search string appears in the advisory description. + +{% endif %} + +{% ifversion dependabot-bulk-alerts %} + ![{% data variables.product.prodname_dependabot_alerts %} 选项卡中过滤器和排序菜单的屏幕截图](/assets/images/help/graphs/dependabot-alerts-filters-checkbox.png){% elsif ghes = 3.5 %} +You can select a filter in a dropdown menu at the top of the list, then click the filter that you would like to apply. ![Screenshot of the filter and sort menus in the {% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/enterprise/3.5/dependabot/dependabot-alerts-filters.png){% endif %} + {% ifversion dependabot-alerts-development-label %} ## 支持的生态系统和依赖范围清单 - {% data reusables.dependabot.dependabot-alerts-dependency-scope %} -列为开发依赖项的包的警报在 {% data variables.product.prodname_dependabot_alerts %} 页上标有 `Development` 标签，并且还可以通过 `scope` 筛选器进行筛选。 ![在警报列表中显示"开发"标签的屏幕截图](/assets/images/help/repository/dependabot-alerts-development-label.png) +列为开发依赖项的包的警报在 {% data variables.product.prodname_dependabot_alerts %} 页上标有 `Development` 标签，并且还可以通过 `scope` 筛选器进行筛选。 -开发范围的包上警报的警报详细信息页显示“标记”部分，其中包含 `Development` 标签。 ![在警报详细信息页面中显示"标记"部分的屏幕截图](/assets/images/help/repository/dependabot-alerts-tags-section.png) +![在警报列表中显示"开发"标签的屏幕截图](/assets/images/help/repository/dependabot-alerts-development-label.png) + +开发范围的包上警报的警报详细信息页显示“标记”部分，其中包含 `Development` 标签。 + +![在警报详细信息页面中显示"标记"部分的屏幕截图](/assets/images/help/repository/dependabot-alerts-tags-section.png) {% endif %} @@ -90,23 +110,10 @@ topics: {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-dependabot-alerts %} -1. （可选）若要筛选警报，请选择 **Repository（仓库）**、**Package（包）**、**Ecosystem（生态系统）**或 **Manifest（清单）**下拉菜单，然后单击要应用的筛选器。 您还可以在搜索栏中键入过滤条件。 例如 `ecosystem:npm`{% ifversion ghes < 3.7 or ghae-issue-5638 %} 或 `has:patch`{% endif %}{% ifversion dependabot-alerts-development-label %}、`has:patch` 或 `scope:development`{% endif %}。 要对警报进行排序，请选择 **Sort（排序）**下拉菜单，然后单击要作为排序依据的选项，或在搜索栏中键入 `sort:`，然后从建议中选择一个选项（例如，`sort:newest`）。 - - {% ifversion dependabot-most-important-sort-option %} - {% note %} - - **注意：** 默认情况下，{% data variables.product.prodname_dependabot_alerts %} 按重要性排序。 “最重要”排序可帮助您确定要首先关注的 {% data variables.product.prodname_dependabot_alerts %} 的优先级。 警报根据其潜在影响、可操作性和相关性进行排名。 我们的优先级计算不断改进，包括 CVSS 分数、依赖范围以及是否为警报找到有漏洞的函数调用等因素。 - {% endnote %} - - ![带有"最重要"排序”的“排序”下拉列表的屏幕截图](/assets/images/help/dependabot/dependabot-alerts-sort-dropdown.png) - {% endif %} - - 还可以单击警报上的标签以仅显示该类型的警报。{% ifversion dependabot-alerts-development-label %} 例如，单击警报列表中的 `Development` 标签将仅显示与开发中使用的依赖项相关的警报，而不显示与生产中使用的依赖项相关的警报。 有关支持的生态系统列表的信息，请参阅[依赖项范围支持的生态系统和清单](#supported-ecosystems-and-manifests-for-dependency-scope)”。 - -{% endif %} +1. Optionally, to filter alerts, select a filter in a dropdown menu then click the filter that you would like to apply. 您还可以在搜索栏中键入过滤条件。 For more information about filtering and sorting alerts, see "[Prioritizing {% data variables.product.prodname_dependabot_alerts %}](#prioritizing-across--data-variablesproductprodname_dependabot_alerts-)." {%- ifversion dependabot-bulk-alerts %} ![{% data variables.product.prodname_dependabot_alerts %} 选项卡中过滤器和排序菜单的屏幕截图](/assets/images/help/graphs/dependabot-alerts-filters-checkbox.png){% else %} - ![Screenshot of the filter and sort menus in the {% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/enterprise/3.5/dependabot/dependabot-alerts-filters.png){% endif %} +![Screenshot of the filter and sort menus in the {% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/enterprise/3.5/dependabot/dependabot-alerts-filters.png){% endif %} 1. 单击要查看的警报。{% ifversion dependabot-bulk-alerts %} ![Alert selected in list of alerts](/assets/images/help/graphs/click-alert-in-alerts-list-checkbox.png){% else %} ![Alert selected in list of alerts](/assets/images/enterprise/3.5/dependabot/click-alert-in-alerts-list-ungrouped.png){% endif %} @@ -156,7 +163,12 @@ topics: 如果计划大量工作来升级依赖项，或者决定不需要修复警报，则可以忽略警报。 通过忽略已评估的警报，可以更轻松地在新警报出现时对其进行分类。 1. 查看警报的详细信息。 更多信息请参阅“[查看有漏洞的依赖项](#viewing-dependabot-alerts)”（上文）。 -1. 选择“Dismiss（忽略）”下拉列表，然后单击忽略警报的原因。{% ifversion reopen-dependabot-alerts %} 未修复的已忽略警报可以稍后重新打开。{% endif %} ![选择通过 "Dismiss（忽略）"下拉菜单忽略警报的原因](/assets/images/help/repository/dependabot-alert-dismiss-drop-down-ungrouped.png) +1. 选择“Dismiss（忽略）”下拉列表，然后单击忽略警报的原因。{% ifversion reopen-dependabot-alerts %} 未修复的已忽略警报可以稍后重新打开。{% endif %} +{% ifversion dependabot-alerts-dismissal-comment %}1. Optionally, add a dismissal comment. The dismissal comment will be added to the alert timeline and can be used as justification during auditing and reporting. You can retrieve or set a comment by using the GraphQL API. The comment is contained in the `dismissComment` field. For more information, see "[{% data variables.product.prodname_dependabot_alerts %}](/graphql/reference/objects#repositoryvulnerabilityalert)" in the GraphQL API documentation. + ![Screenshot showing how to dismiss an alert via the "Dismiss" drop-down, with the option to add a dismissal comment](/assets/images/help/repository/dependabot-alerts-dismissal-comment.png) +1. Click **Dismiss alert**. +{% else %} + ![选择通过 "Dismiss（忽略）"下拉菜单忽略警报的原因](/assets/images/help/repository/dependabot-alert-dismiss-drop-down-ungrouped.png){% endif %} {% ifversion dependabot-bulk-alerts %} ### 一次忽略多个警报 @@ -185,7 +197,7 @@ You can view all open alerts, and you can reopen alerts that have been previousl {%- else %} ![显示"已关闭"选项的屏幕截图](/assets/images/help/repository/dependabot-alerts-closed.png) {%- endif %} -1. Click the alert that you would like to view or update. +1. 单击要查看或更新的警报。 {%- ifversion dependabot-bulk-alerts %} ![显示突出显示的 dependabot 警报的屏幕截图](/assets/images/help/repository/dependabot-alerts-select-closed-alert-checkbox.png) diff --git a/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md b/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md index 25ac6542b6..b99c74265b 100644 --- a/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md +++ b/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md @@ -416,7 +416,7 @@ updates: ### `open-pull-requests-limit` -默认情况下， {% data variables.product.prodname_dependabot %} 最多打开五个版本更新的拉取请求。 一旦有五个打开的拉取请求，新的请求将被阻止，直到您合并或关闭一些打开的请求，之后可以在后续更新中打开新的拉取请求。 使用 `open-pull-requests-limit` 可更改此限制。 这也提供了一个简单的方法来暂时禁用包管理器的版本更新。 +默认情况下， {% data variables.product.prodname_dependabot %} 最多打开五个版本更新的拉取请求。 Once there are five open pull requests from {% data variables.product.prodname_dependabot %}, {% data variables.product.prodname_dependabot %} will not open any new requests until some of those open requests are merged or closed. 使用 `open-pull-requests-limit` 可更改此限制。 这也提供了一个简单的方法来暂时禁用包管理器的版本更新。 此选项对安全更新没有影响，因为安全更新具有单独的内部限制：10 个打开的拉取请求。 diff --git a/translations/zh-CN/content/code-security/secret-scanning/about-secret-scanning.md b/translations/zh-CN/content/code-security/secret-scanning/about-secret-scanning.md index 481ec138e4..0110c45c23 100644 --- a/translations/zh-CN/content/code-security/secret-scanning/about-secret-scanning.md +++ b/translations/zh-CN/content/code-security/secret-scanning/about-secret-scanning.md @@ -39,7 +39,7 @@ Service providers can partner with {% data variables.product.company_short %} to {% ifversion secret-scanning-push-protection %} -You can also enable {% data variables.product.prodname_secret_scanning %} as a push protection for a repository or an organization. When you enable this feature, {% data variables.product.prodname_secret_scanning %} prevents contributors from pushing code with a detected secret. To proceed, contributors must either remove the secret(s) from the push or, if needed, bypass the protection. For more information, see "[Protecting pushes with {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." +You can also enable {% data variables.product.prodname_secret_scanning %} as a push protection for a repository or an organization. When you enable this feature, {% data variables.product.prodname_secret_scanning %} prevents contributors from pushing code with a detected secret. To proceed, contributors must either remove the secret(s) from the push or, if needed, bypass the protection. {% ifversion push-protection-custom-link-orgs %}Admins can also specify a custom link that is displayed to the contributor when a push is blocked; the link can contain resources specific to the organization to aid contributors. {% endif %}For more information, see "[Protecting pushes with {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." {% endif %} diff --git a/translations/zh-CN/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md b/translations/zh-CN/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md index 39b0c164bf..295f0e2982 100644 --- a/translations/zh-CN/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md +++ b/translations/zh-CN/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md @@ -60,17 +60,29 @@ For information on the secrets and service providers supported for push protecti 在命令行上一次最多会显示五个检测到的机密。 如果已在存储库中检测到特定机密，并且警报已存在，{% data variables.product.prodname_dotcom %} 不会阻止该机密。 -![显示当用户尝试将密钥推送到存储库时推送被阻止的屏幕截图](/assets/images/help/repository/secret-scanning-push-protection-with-link.png) +{% ifversion push-protection-custom-link-orgs %} + +Organization admins can provide a custom link that will be displayed when a push is blocked. This custom link can contain organization-specific resources and advice, such as directions on using a recommended secrets vault or who to contact for questions relating to the blocked secret. + +{% ifversion push-protection-custom-link-orgs-beta %}{% data reusables.advanced-security.custom-link-beta %}{% endif %} + +![Screenshot showing that a push is blocked when a user attempts to push a secret to a repository](/assets/images/help/repository/secret-scanning-push-protection-with-custom-link.png) + +{% else %} + +![Screenshot showing that a push is blocked when a user attempts to push a secret to a repository](/assets/images/help/repository/secret-scanning-push-protection-with-link.png) + +{% endif %} {% data reusables.secret-scanning.push-protection-remove-secret %} For more information about remediating blocked secrets, see "[Pushing a branch blocked by push protection](/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection#resolving-a-blocked-push-on-the-command-line)." -如果确认某个机密是真实的，并且打算稍后修复它，则应尽快修复。 例如，您可以撤销密钥，并从存储库的提交历史记录中删除密钥。 Real secrets that have been exposed must be revoked to avoid unauthorized access. You might consider first rotating the secret before revoking it. 更多信息请参阅“[从仓库中删除敏感数据](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)”。 +If you confirm a secret is real and that you intend to fix it later, you should aim to remediate the secret as soon as possible. For example, you might revoke the secret and remove the secret from the repository's commit history. Real secrets that have been exposed must be revoked to avoid unauthorized access. You might consider first rotating the secret before revoking it. For more information, see "[Removing sensitive data from a repository](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)." {% data reusables.secret-scanning.push-protection-multiple-branch-note %} ### 允许推送被阻止的机密 -如果 {% data variables.product.prodname_dotcom %} 阻止了您认为可以安全推送的机密，则可以允许该机密并说明应允许该机密的原因。 +If {% data variables.product.prodname_dotcom %} blocks a secret that you believe is safe to push, you can allow the secret and specify the reason why it should be allowed. {% data reusables.secret-scanning.push-protection-allow-secrets-alerts %} @@ -86,25 +98,33 @@ For information on the secrets and service providers supported for push protecti {% data reusables.secret-scanning.push-protection-web-ui-choice %} -{% data variables.product.prodname_dotcom %} 将在 Web UI 中一次仅显示一个检测到的机密。 如果已在存储库中检测到特定机密，并且警报已存在，{% data variables.product.prodname_dotcom %} 不会阻止该机密。 +{% data variables.product.prodname_dotcom %} will only display one detected secret at a time in the web UI. 如果已在存储库中检测到特定机密，并且警报已存在，{% data variables.product.prodname_dotcom %} 不会阻止该机密。 -可以使用 Web UI 从文件中删除机密。 删除机密后，页面顶部的横幅将更改，并告诉您现在可以提交更改。 +{% ifversion push-protection-custom-link-orgs %} - ![显示密钥修复后允许在 Web UI 中提交的屏幕截图](/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-allowed.png) +Organization admins can provide a custom link that will be displayed when a push is blocked. This custom link can contain resources and advice specific to your organization. For example, the custom link can point to a README file with information about the organization's secret vault, which teams and individuals to escalate questions to, or the organization's approved policy for working with secrets and rewriting commit history. + +{% ifversion push-protection-custom-link-orgs-beta %}{% data reusables.advanced-security.custom-link-beta %}{% endif %} + +{% endif %} + +You can remove the secret from the file using the web UI. 删除机密后，页面顶部的横幅将更改，并告诉您现在可以提交更改。 + + ![Screenshot showing commit in web ui allowed after secret fixed](/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-allowed.png) ### 绕过密钥的推送保护 {% data reusables.secret-scanning.push-protection-remove-secret %} For more information about remediating blocked secrets, see "[Pushing a branch blocked by push protection](/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection#resolving-a-blocked-push-in-the-web-ui)." -如果确认某个机密是真实的，并且打算稍后修复它，则应尽快修复。 更多信息请参阅“[从仓库中删除敏感数据](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)”。 +If you confirm a secret is real and that you intend to fix it later, you should aim to remediate the secret as soon as possible. For more information, see "[Removing sensitive data from a repository](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)." -如果 {% data variables.product.prodname_dotcom %} 阻止了您认为可以安全推送的机密，则可以允许该机密并说明应允许该机密的原因。 +If {% data variables.product.prodname_dotcom %} blocks a secret that you believe is safe to push, you can allow the secret and specify the reason why it should be allowed. {% data reusables.secret-scanning.push-protection-allow-secrets-alerts %} {% data reusables.secret-scanning.push-protection-allow-email %} -如果确认某个机密是真实的，并且打算稍后修复它，则应尽快修复。 +If you confirm a secret is real and that you intend to fix it later, you should aim to remediate the secret as soon as possible. 1. 在 {% data variables.product.prodname_dotcom %} 阻止提交时显示在页面顶部的横幅中，单击 **Bypass protection（绕过保护）**。 {% data reusables.secret-scanning.push-protection-choose-allow-secret-options %} diff --git a/translations/zh-CN/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md b/translations/zh-CN/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md index 58a18f2a13..6cbded5445 100644 --- a/translations/zh-CN/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md +++ b/translations/zh-CN/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md @@ -26,6 +26,14 @@ The push protection feature of {% data variables.product.prodname_secret_scannin {% endtip %} +{% ifversion push-protection-custom-link-orgs %} + +Organization admins can provide a custom link that will be included in the message from {% data variables.product.product_name %} when your push is blocked. This custom link can contain resources and advice specific to your organization and its policies. + +{% ifversion push-protection-custom-link-orgs-beta %}{% data reusables.advanced-security.custom-link-beta %}{% endif %} + +{% endif %} + ## Resolving a blocked push on the command line {% data reusables.secret-scanning.push-protection-command-line-choice %} diff --git a/translations/zh-CN/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md b/translations/zh-CN/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md index a5ab209231..c9a6991945 100644 --- a/translations/zh-CN/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md +++ b/translations/zh-CN/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md @@ -12,25 +12,25 @@ shortTitle: 私有映像注册表 ## 关于私人映像注册表和 {% data variables.product.prodname_github_codespaces %} -注册表是用于存储、管理和提取专用容器映像的安全空间。 您可以使用一个来存储一个或多个映像。 注册表的示例很多，例如 {% data variables.product.prodname_dotcom %} 容器注册表、Azure 容器注册表或 DockerHub。 +注册表是用于存储、管理和提取专用容器映像的安全空间。 您可以使用一个来存储一个或多个映像。 There are many examples of registries, such as {% data variables.product.prodname_container_registry %}, {% data variables.product.prodname_npm_registry %}, Azure Container Registry, or DockerHub. -{% data variables.product.prodname_dotcom %} 容器注册表可以配置为无缝拉取容器映像，而无需向 {% data variables.product.prodname_github_codespaces %} 提供任何身份验证凭据。 对于其他映像注册表，必须在 {% data variables.product.prodname_dotcom %} 中创建机密以存储访问详细信息，这将允许 {% data variables.product.prodname_codespaces %} 访问存储在该注册表中的映像。 +{% data variables.product.prodname_ghcr_and_npm_registry %} can be configured to allow container images to be pulled seamlessly into {% data variables.product.prodname_github_codespaces %} during codespace creation, without having to provide any authentication credentials. 对于其他映像注册表，必须在 {% data variables.product.prodname_dotcom %} 中创建机密以存储访问详细信息，这将允许 {% data variables.product.prodname_codespaces %} 访问存储在该注册表中的映像。 -## 访问存储在 {% data variables.product.prodname_dotcom %} 容器注册表中的映像 +## Accessing images stored in {% data variables.product.prodname_ghcr_and_npm_registry %} -{% data variables.product.prodname_dotcom %} 容器注册表是 {% data variables.product.prodname_codespaces %} 使用 devcontainer 容器映像的最简单方法。 +{% data variables.product.prodname_ghcr_and_npm_registry %} provide the easiest way for {% data variables.product.prodname_codespaces %} to consume dev container images. -更多信息请参阅“[使用容器注册表](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)”。 +For more information, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)" and "[Working with the npm registry](/packages/working-with-a-github-packages-registry/working-with-the-npm-registry)". ### 访问发布到与代码空间相同的仓库的映像 -如果将容器映像发布到启动代码空间的同一仓库中的 {% data variables.product.prodname_dotcom %} 容器注册表，则在创建代码空间时将自动能够获取该映像。 无需提供任何其他凭据，除非在发布容器映像时未选中 **Inherit access from repo（从仓库继承访问权限）**选项。 +If you publish a container image to {% data variables.product.prodname_ghcr_or_npm_registry %} in the same repository that the codespace is being launched in, you will automatically be able to fetch that image on codespace creation. 无需提供任何其他凭据，除非在发布容器映像时未选中 **Inherit access from repo（从仓库继承访问权限）**选项。 #### 从发布映像的仓库继承访问权限 -默认情况下，将容器映像发布到 {% data variables.product.prodname_dotcom %} 容器注册表时，该映像将继承从中发布映像的仓库的访问设置。 例如，如果仓库是公共的，则映像也是公共的。 如果仓库是私有的，则映像也是私有的，但可以从仓库访问。 +By default, when you publish a container image to {% data variables.product.prodname_ghcr_or_npm_registry %}, the image inherits the access setting of the repository from which the image was published. 例如，如果仓库是公共的，则映像也是公共的。 如果仓库是私有的，则映像也是私有的，但可以从仓库访问。 -此行为由 **Inherit access from repo（从仓库继承访问权限）**选项控制。 **通过** {% data variables.product.prodname_actions %} 发布时，默认情况下会选择从仓库继承访问权限，但在使用个人访问令牌 (PAT) 直接发布到 {% data variables.product.prodname_dotcom %} 容器注册表时，不会选择从仓库继承访问权限。 +此行为由 **Inherit access from repo（从仓库继承访问权限）**选项控制。 **Inherit access from repo** is selected by default when publishing via {% data variables.product.prodname_actions %}, but not when publishing directly to {% data variables.product.prodname_ghcr_or_npm_registry %} using a Personal Access Token (PAT). 如果在发布映像时未选择 **Inherit access from repo（从仓库继承访问权限）**选项，则可以手动将仓库添加到已发布容器映像的访问控制中。 更多信息请参阅“[配置包的访问控制和可见性](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#inheriting-access-for-a-container-image-from-a-repository)”。 @@ -46,13 +46,13 @@ shortTitle: 私有映像注册表 ### 从代码空间发布容器映像 -从代码空间到容器注册表 {% data variables.product.prodname_dotcom %} 的无缝访问仅限于拉取容器映像。 如果要从代码空间内部发布容器映像，则必须结合使用个人访问令牌 (PAT) 与 `write:packages` 作用域。 +Seamless access from a codespace to {% data variables.product.prodname_ghcr_or_npm_registry %} is limited to pulling container images. 如果要从代码空间内部发布容器映像，则必须结合使用个人访问令牌 (PAT) 与 `write:packages` 作用域。 -我们建议通过 {% data variables.product.prodname_actions %} 发布映像。 更多信息请参阅“[发布 Docker 映像](/actions/publishing-packages/publishing-docker-images)”。 +我们建议通过 {% data variables.product.prodname_actions %} 发布映像。 For more information, see "[Publishing Docker images](/actions/publishing-packages/publishing-docker-images)" and "[Publishing Node.js packages](/actions/publishing-packages/publishing-nodejs-packages)." ## 访问存储在其他容器注册表中的映像 -如果要从不是 {% data variables.product.prodname_dotcom %} 容器注册表的注册表访问容器映像，{% data variables.product.prodname_codespaces %} 将检查是否存在三个机密，这些机密定义了容器注册表的服务器名称、用户名和个人访问令牌 (PAT)。 如果找到这些密钥，{% data variables.product.prodname_github_codespaces %} 将在代码空间中提供注册表。 +If you are accessing a container image from a registry that isn't {% data variables.product.prodname_ghcr_or_npm_registry %}, {% data variables.product.prodname_codespaces %} checks for the presence of three secrets, which define the server name, username, and personal access token (PAT) for a container registry. 如果找到这些密钥，{% data variables.product.prodname_github_codespaces %} 将在代码空间中提供注册表。 - `<*>_CONTAINER_REGISTRY_SERVER` - `<*>_CONTAINER_REGISTRY_USER` diff --git a/translations/zh-CN/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md b/translations/zh-CN/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md index 77bd7be249..9781ece278 100644 --- a/translations/zh-CN/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md +++ b/translations/zh-CN/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md @@ -90,15 +90,13 @@ You can add further script, preferences, configuration files to your dotfiles re If your codespace fails to pick up configuration settings from dotfiles, see "[Troubleshooting dotfiles for {% data variables.product.prodname_codespaces %}](/codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces)." -## Other available settings - You can also personalize {% data variables.product.prodname_codespaces %} using additional [{% data variables.product.prodname_codespaces %} settings](https://github.com/settings/codespaces): -- To set your default region, see "[Setting your default region for {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces)." -- To set your editor, see "[Setting your default editor for {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces)." -- To add encrypted secrets, see "[Managing encrypted secrets for {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces)." - To enable GPG verification, see "[Managing GPG verification for {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)." -- To allow your codespaces to access other repositories, see "[Managing repository access for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces)." +- To set your editor, see "[Setting your default editor for {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces)." +- To set how long a codespace can remain unused before it is automatically stopped, see "[Setting your timeout period for GitHub Codespaces](/codespaces/customizing-your-codespace/setting-your-timeout-period-for-github-codespaces)." +- To set the period for which your unused codespaces are retained, see "[Configuring automatic deletion of your codespaces](/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces)." +- To set your default region, see "[Setting your default region for {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces)." ## Further reading diff --git a/translations/zh-CN/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/translations/zh-CN/content/codespaces/developing-in-codespaces/creating-a-codespace.md index 38467f41a7..1f4dee6dd1 100644 --- a/translations/zh-CN/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ b/translations/zh-CN/content/codespaces/developing-in-codespaces/creating-a-codespace.md @@ -2,7 +2,6 @@ title: 创建代码空间 intro: 您可以为仓库中的分支创建代码空间以便在线开发。 product: '{% data reusables.gated-features.codespaces %}' -permissions: '{% data reusables.codespaces.availability %}' redirect_from: - /github/developing-online-with-github-codespaces/creating-a-codespace - /github/developing-online-with-codespaces/creating-a-codespace @@ -21,7 +20,7 @@ shortTitle: 创建代码空间 可以在 {% data variables.product.prodname_dotcom_the_website %} 上、{% data variables.product.prodname_vscode %} 中或使用 {% data variables.product.prodname_cli %} 创建代码空间。 {% data reusables.codespaces.codespaces-are-personal %} -代码空间与仓库的特定分支相关联，且仓库不能为空。 {% data reusables.codespaces.concurrent-codespace-limit %} 更多信息请参阅“[删除代码空间](/github/developing-online-with-codespaces/deleting-a-codespace)”。 +代码空间与仓库的特定分支相关联，且仓库不能为空。 {% data reusables.codespaces.concurrent-codespace-limit %} 创建代码空间时，需要执行一些步骤并将您连接到开发环境。 @@ -45,27 +44,22 @@ shortTitle: 创建代码空间 ## 访问 {% data variables.product.prodname_github_codespaces %} -{% data reusables.codespaces.availability %} - 当您访问 {% data variables.product.prodname_github_codespaces %} 时，在查看仓库时会看到 **{% octicon "code" aria-label="The code icon" %} Code（代码）**下拉菜单中的“Codespaces（代码空间）”选项卡。 -在以下条件下，您可以访问代码空间： +You'll have access to {% data variables.product.prodname_github_codespaces %} under the following conditions: -* 您是已启用 {% data variables.product.prodname_codespaces %} 并设定支出限额的组织的成员。 -* 组织所有者已授予您访问 {% data variables.product.prodname_codespaces %}。 -* 仓库归启用 {% data variables.product.prodname_codespaces %} 的组织所有。 +Either all of these are true: +* You are a member, or outside collaborator, of an organization that has enabled {% data variables.product.prodname_codespaces %} and set a spending limit. +* The organization owner has allowed you to create codespaces at the organization's expense. +* The repository for which you want to create a codespace is owned by this organization. -{% note %} +Or both of these are true: +* You are participating in the beta of {% data variables.product.prodname_codespaces %} for individual users. +* Either you own the repository for which you want to create a codespace, or it is owned by an organization of which you are either a member or an outside collaborator. -**注意：** 已使用个人 {% data variables.product.prodname_dotcom %} 帐户加入测试版的个人不会失去 {% data variables.product.prodname_codespaces %} 访问权限，但个人的 {% data variables.product.prodname_codespaces %} 将继续保留在测试版中。 +Before {% data variables.product.prodname_codespaces %} can be used in an organization, an owner or billing manager must have set a spending limit. For more information, see "[About spending limits for Codespaces](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces#about-spending-limits-for-codespaces)." -{% endnote %} - -组织所有者可以允许组织的所有成员创建代码空间，将代码空间创建限制为选定的组织成员，或者禁用代码空间的创建。 有关管理对组织内代码空间的访问的更多信息，请参阅“[为组织中的用户启用代码空间](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization#enable-codespaces-for-users-in-your-organization)”。 - -在组织中使用 {% data variables.product.prodname_codespaces %} 之前，所有者或帐单管理员必须设定支出限额。 更多信息请参阅“[关于代码空间的支出限额](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces#about-spending-limits-for-codespaces)”。 - -如果想为您的个人帐户或其他用户拥有的仓库创建代码空间， 并且您有权在已启用 {% data variables.product.prodname_github_codespaces %} 的组织中创建仓库， 您可以将用户拥有的仓库复刻到该组织，然后为该复刻创建一个代码空间。 +Organization owners can specify who can create and use codespaces at the organization's expense. Organization owners can also prevent any codespace usage being charged to the organization. For more information, see "[Enabling {% data variables.product.prodname_github_codespaces %} for your organization](/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization#choose-who-can-create-codespaces-that-are-billed-to-your-organization)." ## 创建代码空间 @@ -82,43 +76,43 @@ shortTitle: 创建代码空间 1. 使用默认选项或在配置高级选项后创建代码空间： - * **使用默认选项** + * **Use the default options** - 要使用默认选项创建代码空间，请单击 **Create codespace on BRANCH（在 [分支] 上创建代码空间）**。 + To create a codespace using the default options, click **Create codespace on BRANCH**. - （可选）在单击 **Create codespace on BRANCH（在 [分支] 上创建代码空间）**之前，可以单击按钮侧面的向下箭头以查看将用于代码空间的计算机类型。 + Optionally, before clicking **Create codespace on BRANCH**, you can click the down arrow at the side of the button to see what machine type will be used for your codespace. - ![查看默认计算机类型](/assets/images/help/codespaces/default-machine-type.png) + ![View the default machine type](/assets/images/help/codespaces/default-machine-type.png) {% note %} - **注意**：默认情况下，将选择对存储库有效的资源最少的计算机类型。 + **Note**: The machine type with the lowest resources that are valid for the repository is selected by default. {% endnote %} - * **配置选项** + * **Configure options** - 要为代码空间配置高级选项，例如不同的计算机类型或特定 `devcontainer.json` 文件： + To configure advanced options for your codespace, such as a different machine type or a particular `devcontainer.json` file: - 1. 单击 **Create codespace on BRANCH（在 [分支] 上创建代码空间）**按钮侧面的向下箭头，然后单击 **Configure and create codespace（配置并创建代码空间）**。 - 1. 单击 **Configure and create codespace（配置并创建代码空间）**按钮。 - 1. 在代码空间的选项页面上，从下拉菜单中选择首选选项。 + 1. Click the down arrow at the side of the **Create codespace on BRANCH** button, then click **Configure and create codespace**. + 1. Click the **Configure and create codespace** button. + 1. On the options page for your codespace, choose your preferred options from the drop-down menus. - ![代码空间选项页](/assets/images/help/codespaces/advanced-options.png) + ![The codespace options page](/assets/images/help/codespaces/advanced-options.png) {% note %} **注：** - * 您可以为选项页面添加书签，以便快速为此存储库和分支创建代码空间。 - * [https://github.com/codespaces/new](https://github.com/codespaces/new) 页面提供了一种为任何存储库和分支创建代码空间的快速方法。 You can get to this page quickly by typing `codespace.new` into your browser's address bar. - * 有关 `devcontainer.json` 文件的详细信息，请参阅“[开发容器简介](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers#devcontainerjson)”。 - * 有关计算机类型的详细信息，请参阅“[更改代码空间的计算机类型](/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace#about-machine-types)”。 + * You can bookmark the options page to give you a quick way to create a codespace for this repository and branch. + * The [https://github.com/codespaces/new](https://github.com/codespaces/new) page provides a quick way to create a codespace for any repository and branch. You can get to this page quickly by typing `codespace.new` into your browser's address bar. + * For more information about the `devcontainer.json` file, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers#devcontainerjson)." + * For more information about machine types, see "[Changing the machine type for your codespace](/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace#about-machine-types)." * {% data reusables.codespaces.codespaces-machine-type-availability %} {% endnote %} - 1. 单击 **Start session（开始会话）**。 + 1. Click **Start session**. {% endwebui %} @@ -132,7 +126,7 @@ shortTitle: 创建代码空间 {% data reusables.cli.cli-learn-more %} -要创建新的代码空间，请使用 `gh codespace create` 子命令。 +To create a new codespace, use the `gh codespace create` subcommand. ```shell gh codespace create @@ -140,17 +134,17 @@ gh codespace create You are prompted to choose a repository, a branch, a dev container configuration file (if more than one is available), and a machine type (if more than one is available). -或者，您可以使用标志来指定部分或全部选项： +Alternatively, you can use flags to specify some or all of the options: ```shell gh codespace create -r owner/repo -b branch --devcontainer-path path -m machine-type ``` -In this example, replace `owner/repo` with the repository identifier. 将 `branch` 替换为您希望在代码空间中最初检出的分支的名称或提交的完整 SHA 哈希。 如果使用 `-r` 标志而不使用 `b` 标志，则将从默认分支创建代码空间。 +In this example, replace `owner/repo` with the repository identifier. Replace `branch` with the name of the branch, or the full SHA hash of the commit, that you want to be initially checked out in the codespace. If you use the `-r` flag without the `b` flag, the codespace is created from the default branch. Replace `path` with the path to the dev container configuration file you want to use for the new codespace. If you omit this flag and more than one dev container file is available you will be prompted to choose one from a list. For more information about the dev container configuration file, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers)." -将 `machine-type` 替换为可用计算机类型的有效标识符。 标识符是字符串，例如：`basicLinux32gb` 和 `standardLinux32gb`。 可用的计算机类型取决于仓库、您的个人帐户和您的位置。 如果输入无效或不可用的计算机类型，则错误消息中将显示可用类型。 如果省略此标志，并且有多个计算机类型可用，系统将提示您从列表中选择一个计算机类型。 +Replace `machine-type` with a valid identifier for an available machine type. Identifiers are strings such as: `basicLinux32gb` and `standardLinux32gb`. The type of machines that are available depends on the repository, your personal account, and your location. If you enter an invalid or unavailable machine type, the available types are shown in the error message. If you omit this flag and more than one machine type is available you will be prompted to choose one from a list. For full details of the options for this command, see [the {% data variables.product.prodname_cli %} manual](https://cli.github.com/manual/gh_codespace_create). diff --git a/translations/zh-CN/content/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace.md b/translations/zh-CN/content/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace.md index 50c475d75f..32ddbd2164 100644 --- a/translations/zh-CN/content/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace.md +++ b/translations/zh-CN/content/codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace.md @@ -2,7 +2,6 @@ title: 代码空间的默认环境变量 shortTitle: 默认环境变量 product: '{% data reusables.gated-features.codespaces %}' -permissions: '{% data reusables.codespaces.availability %}' intro: '{% data variables.product.prodname_dotcom %} 为每个代码空间设置默认环境变量。' versions: fpt: '*' diff --git a/translations/zh-CN/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md b/translations/zh-CN/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md index e341666a31..4adad5ddd2 100644 --- a/translations/zh-CN/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md +++ b/translations/zh-CN/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md @@ -2,7 +2,6 @@ title: Developing in a codespace intro: 'You can open a codespace on {% data variables.product.product_name %}, then develop using {% data variables.product.prodname_vscode %}''s features.' product: '{% data reusables.gated-features.codespaces %}' -permissions: 'You can develop in codespaces you''ve created for repositories owned by organizations using {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %}.' redirect_from: - /github/developing-online-with-github-codespaces/developing-in-a-codespace - /github/developing-online-with-codespaces/developing-in-a-codespace diff --git a/translations/zh-CN/content/codespaces/developing-in-codespaces/renaming-a-codespace.md b/translations/zh-CN/content/codespaces/developing-in-codespaces/renaming-a-codespace.md index c60f982d9a..99fe098d58 100644 --- a/translations/zh-CN/content/codespaces/developing-in-codespaces/renaming-a-codespace.md +++ b/translations/zh-CN/content/codespaces/developing-in-codespaces/renaming-a-codespace.md @@ -27,7 +27,9 @@ To find the display name of a codespace: ![Screenshot of the Remote Explorer in VS Code](/assets/images/help/codespaces/codespaces-remote-explorer.png) +{% indented_data_reference reusables.codespaces.remote-explorer spaces=2 %} - In a terminal window on your local machine, use this {% data variables.product.prodname_cli %} command: `gh codespace list`. + ### Permanent codespace names In addition to the display name, when you create a codespace, a permanent name is also assigned to the codespace. The name is a combination of your {% data variables.product.company_short %} handle, the repository name, and some random characters. 例如： `octocat-myrepo-gmc7`。 You can't change this name. diff --git a/translations/zh-CN/content/codespaces/guides.md b/translations/zh-CN/content/codespaces/guides.md index bcefb99ad0..61c57221b9 100644 --- a/translations/zh-CN/content/codespaces/guides.md +++ b/translations/zh-CN/content/codespaces/guides.md @@ -40,7 +40,6 @@ includeGuides: - /codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization - /codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization - /codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces - - /codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces - /codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types - /codespaces/managing-codespaces-for-your-organization/retricting-the-idle-timeout-period - /codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces diff --git a/translations/zh-CN/content/codespaces/index.md b/translations/zh-CN/content/codespaces/index.md index 598718d558..25a51a7b8b 100644 --- a/translations/zh-CN/content/codespaces/index.md +++ b/translations/zh-CN/content/codespaces/index.md @@ -7,11 +7,11 @@ introLinks: quickstart: /codespaces/getting-started/quickstart featuredLinks: guides: - - /billing/managing-billing-for-github-codespaces/about-billing-for-codespaces - /codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization - - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project - - /codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces - /codespaces/developing-in-codespaces/codespaces-lifecycle + - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project + - /codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces + - /billing/managing-billing-for-github-codespaces/about-billing-for-codespaces popular: - /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces - /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces diff --git a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md index 8d8d58ac5a..ff040d9a82 100644 --- a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md +++ b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md @@ -1,9 +1,9 @@ --- title: Enabling GitHub Codespaces for your organization -shortTitle: Enable Codespaces -intro: 'You can control which users in your organization can use {% data variables.product.prodname_github_codespaces %}.' +shortTitle: 'Enable {% data variables.product.prodname_codespaces %}' +intro: "You can control which users in your organization can use {% data variables.product.prodname_github_codespaces %} at the organization's expense." product: '{% data reusables.gated-features.codespaces %}' -permissions: 'To manage user permissions for {% data variables.product.prodname_github_codespaces %} for an organization, you must be an organization owner.' +permissions: "To alter an organization's billing settings, you must be an organization owner." redirect_from: - /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization - /codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization @@ -13,25 +13,23 @@ versions: type: how_to topics: - Codespaces - - Permissions + - Billing - Administrator --- - ## About enabling {% data variables.product.prodname_github_codespaces %} for your organization -Organization owners can control which users in your organization can create and use codespaces. +Organization owners can control which users in your organization can create and use codespaces at the organization's expense. -To use codespaces in your organization, you must do the following: +Only people who can clone a repository can create a codespace for that repository. To allow people to create codespaces for repositories owned by your organization, you must: + +- Ensure that users have at least write access to the repositories where they want to use a codespace. For more information, see "[Managing teams and people with access to your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." +- Ensure that your organization does not have an IP address allow list enabled. For more information, see "[Managing allowed IP addresses for your organization](/{% ifversion fpt %}enterprise-cloud@latest/{% endif %}organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} + +To allow people to create codespaces for which your organization will be billed, you must: -- Ensure that users have [at least write access](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization) to the repositories where they want to use a codespace. -- [Enable {% data variables.product.prodname_github_codespaces %} for users in your organization](#enable-codespaces-for-users-in-your-organization). You can choose to allow {% data variables.product.prodname_codespaces %} for selected users or only for specific users. - [Set a spending limit](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces) -- Ensure that your organization does not have an IP address allow list enabled. For more information, see "[Managing allowed IP addresses for your organization](/{% ifversion fpt %}enterprise-cloud@latest/{% endif %}organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} - -By default, a codespace can only access the repository from which it was created. If you want codespaces in your organization to be able to access other organization repositories that the codespace creator can access, see "[Managing access and security for {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)." - -## Enable {% data variables.product.prodname_codespaces %} for users in your organization +- [Choose who can create codespaces that are billed to your organization](#choose-who-can-create-codespaces-that-are-billed-to-your-organization) {% ifversion fpt %} {% note %} @@ -40,31 +38,44 @@ By default, a codespace can only access the repository from which it was created {% endnote %} {% endif %} + +By default, a codespace can only access the repository from which it was created. If you want codespaces in your organization to be able to access other organization repositories that the codespace creator can access, see "[Managing repository access for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces)." + +## Choose who can create codespaces that are billed to your organization + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.click-codespaces %} -1. Under "User permissions", select one of the following options: +1. Under "Billing," select one of the following options: - * **Selected users** to select specific organization members to use {% data variables.product.prodname_codespaces %}. - * **Allow for all members** to allow all your organization members to use {% data variables.product.prodname_codespaces %}. - * **Allow for all members and outside collaborators** to allow all your organization members as well as outside collaborators to use {% data variables.product.prodname_codespaces %}. + * **Disabled** - Your organization will not be charged for codespace usage. {% data variables.product.prodname_codespaces %} created for your organization's repositories will be billed to the individual users who create them. + * **Selected members** - {% data variables.product.prodname_codespaces %} created for your organization's repositories by selected members will be billed to the organization. + * **All members** - {% data variables.product.prodname_codespaces %} created for your organization's repositories by members of your organization will be billed to the organization. + * **All members and outside collaborators** - {% data variables.product.prodname_codespaces %} created for your organization's repositories by organization members and outside collaborators will be billed to the organization. - ![Radio buttons for "User permissions"](/assets/images/help/codespaces/org-user-permission-settings-outside-collaborators.png) + ![Radio buttons for "Billing"](/assets/images/help/codespaces/codespaces-org-billing-settings.png) {% note %} - **Note:** When you select **Allow for all members and outside collaborators**, all outside collaborators who have been added to specific repositories can create and use {% data variables.product.prodname_codespaces %}. Your organization will be billed for all usage incurred by outside collaborators. For more information on managing outside collaborators, see "[About outside collaborators](/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization#about-outside-collaborators)." + **Note:** When you select **All members and outside collaborators**, all outside collaborators who have been added to specific repositories can create and use {% data variables.product.prodname_codespaces %} for those repositories, and your organization will be billed for this usage. For more information on managing outside collaborators, see "[About outside collaborators](/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization#about-outside-collaborators)." {% endnote %} 1. Click **Save**. +1. If you chose **Selected members**, an input box is displayed for you to enter the names of users you want to select. + + ![Input box for selecting users](/assets/images/help/codespaces/codespaces-org-billing-add-users.png) ## Disabling {% data variables.product.prodname_codespaces %} for your organization +You can prevent the creation and use of codespaces billable to your organization. + +{% data reusables.codespaces.codespaces-disabling-org-billing %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.click-codespaces %} -1. Under "User permissions", select **Disabled**. +1. Under "Billing," select **Disabled**. ## Setting a spending limit diff --git a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-github-codespaces-in-your-organization.md b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-github-codespaces-in-your-organization.md index 013b8ed73a..c137d5d4cb 100644 --- a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-github-codespaces-in-your-organization.md +++ b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-github-codespaces-in-your-organization.md @@ -35,11 +35,15 @@ redirect_from: ## 禁用或限制 {% data variables.product.prodname_codespaces %} -您可以在组织或存储库中禁用 {% data variables.product.prodname_codespaces %}。 更多信息请参阅“[管理组织的代码空间的存储库访问](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)”。 +You can disable all use of {% data variables.product.prodname_github_codespaces %} that would be billed to your organization. Alternatively, you can specify which organization members or collaborators can use {% data variables.product.prodname_codespaces %} at your organization's expense. 更多信息请参阅“[为组织启用 {% data variables.product.prodname_github_codespaces %}](/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization)”。 -您还可以限制可以使用 {% data variables.product.prodname_codespaces %} 的单个用户。 更多信息请参阅“[管理组织的用户权限](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)”。 +{% data reusables.codespaces.codespaces-disabling-org-billing %} -您可以限制可用于组织拥有的存储库的计算机类型选择。 这使您可以防止人们使用资源过多的计算机作为其代码空间。 更多信息请参阅“[限制对机器类型的访问](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types)”。 +You can configure which repositories can be accessed from codespaces created for a particular repository. 更多信息请参阅“[管理代码空间中对其他存储库的访问](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)”。 + +You can limit the choice of types of machine that are available for codespaces created from repositories owned by your organization. This allows you to prevent people using overly resourced machines for their codespaces, and incurring unnecessary charges. 更多信息请参阅“[限制对机器类型的访问](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types)”。 + +You can also restrict how long a codespace can remain unused before it is automatically deleted. This can help to reduce storage costs for {% data variables.product.prodname_codespaces %}. 更多信息请参阅“[限制代码空间的保留期](/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces)”。 ## 删除未使用的代码空间 @@ -47,6 +51,6 @@ redirect_from: {% note %} -**注意：**只有创建代码空间的人才能将其删除。 目前，组织所有者无法删除其组织内创建的代码空间。 +**Note:** Codespaces are automatically deleted after they have been stopped and have remained inactive for a defined number of days. 更多信息请参阅“[限制代码空间的保留期](/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces)”。 A codespace can only be manually deleted by the person who created the codespace. {% endnote %} diff --git a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md index 4a1d730e30..6ed526bda6 100644 --- a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md +++ b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md @@ -20,7 +20,7 @@ redirect_from: {% warning %} -**Deprecation note**: The access and security setting described below is now deprecated and is documented here for reference only. 要启用对其他存储库的扩展访问权限，请将请求的权限添加到开发容器定义中。 更多信息请参阅“[管理代码空间中对其他存储库的访问](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)”。 +**Deprecation note**: The access and security setting described below is now deprecated and is documented here for reference only. To enable expanded access to other repositories, add the requested permissions to your `devcontainer.json` configuration file. 更多信息请参阅“[管理代码空间中对其他存储库的访问](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)”。 {% endwarning %} diff --git a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md index 8f5b7859ab..7aeeca7a28 100644 --- a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md +++ b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types.md @@ -43,6 +43,8 @@ topics: 如果添加组织范围的策略，则应将其设置为可用于组织中任何存储库的最大计算机类型选择范围。 然后，您可以添加特定于存储库的策略以进一步限制选择。 +{% data reusables.codespaces.codespaces-org-policies-note %} + ## 添加策略以限制可用的计算机类型 {% data reusables.profile.access_org %} diff --git a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md index 378aadb5c4..9c949fd36f 100644 --- a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md +++ b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md @@ -40,6 +40,8 @@ topics: 如果添加具有超时约束的组织范围策略，则应将超时设置为可接受的最长期限。 然后，您可以添加单独的策略，将组织中特定存储库的最大超时时间设置为较短的时间段。 +{% data reusables.codespaces.codespaces-org-policies-note %} + ## 添加策略以设置最大空闲超时期限 {% data reusables.profile.access_org %} diff --git a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md index eb1e426089..fa311c168f 100644 --- a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md +++ b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md @@ -26,6 +26,8 @@ topics: 如果添加具有保留约束的组织范围策略，则应将保留期设置为可接受的最长期限。 然后，您可以添加单独的策略，将组织中特定存储库的最大保留期设置为较短的时间段。 +{% data reusables.codespaces.codespaces-org-policies-note %} + ## 添加策略以设置最大代码空间保留期 {% data reusables.profile.access_org %} diff --git a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md index 53eae0a4cb..dd31d3f907 100644 --- a/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md +++ b/translations/zh-CN/content/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports.md @@ -36,6 +36,8 @@ topics: 如果添加组织范围的策略，则应将其设置为适用于组织中的任何存储库的最宽松的可见性选项。 然后，您可以添加特定于存储库的策略以进一步限制选择。 +{% data reusables.codespaces.codespaces-org-policies-note %} + ## 添加策略以限制端口可见性选项 {% data reusables.profile.access_org %} diff --git a/translations/zh-CN/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md b/translations/zh-CN/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md index de501910ce..4eb5788be3 100644 --- a/translations/zh-CN/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md +++ b/translations/zh-CN/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md @@ -132,7 +132,3 @@ If additional repository permissions are defined in the `devcontainer.json` file 1. 如果您选择了“Selected repositories（所选仓库）”，请选择下拉菜单，然后单击一个仓库，以允许该仓库的代码空间访问您拥有的其他仓库。 对于您要允许其代码空间访问您拥有的其他仓库的所有仓库重复此操作。 !["所选仓库" 下拉菜单](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) - -## 延伸阅读 - -- "[管理组织的代码空间的存储库访问](/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces)" diff --git a/translations/zh-CN/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md b/translations/zh-CN/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md index c245c0e369..fab8cd9dd6 100644 --- a/translations/zh-CN/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md +++ b/translations/zh-CN/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md @@ -31,6 +31,7 @@ redirect_from: 每个代码空间还有一个 ID（标识符）。 默认情况下，这在 {% data variables.product.prodname_vscode %} 中不显示，因此您可能需要先更新 {% data variables.product.prodname_github_codespaces %} 扩展的设置，然后才能访问该 ID。 1. 在 {% data variables.product.prodname_vscode %}、浏览器或桌面中的左侧活动栏中，单击 **Remote Explorer（远程资源管理器）**以显示代码空间的详细信息。 -2. 如果侧边栏包含“Codespace Performance（代码空间性能）”部分，请将鼠标悬停在“Codespace ID（代码空间 ID）”上，然后单击剪贴板图标以复制 ID。 -3. 如果未显示信息，请单击活动栏左下角的 {% octicon "gear" aria-label="The gear icon" %} 以显示“Settings（设置）”选项卡。 -4. 展开 **Extensions（扩展）**，然后单击 **{% data variables.product.prodname_github_codespaces %}** 以显示扩展的设置。 然后启用 **Show Performance Explorer（显示性能资源管理器）**在边栏中显示“Codespace Performance（代码空间性能）”部分。 ![显示性能信息所需的代码空间 ID 和设置](/assets/images/help/codespaces/find-codespace-id.png) +{% indented_data_reference reusables.codespaces.remote-explorer spaces=3 %} +1. 如果侧边栏包含“Codespace Performance（代码空间性能）”部分，请将鼠标悬停在“Codespace ID（代码空间 ID）”上，然后单击剪贴板图标以复制 ID。 +1. 如果未显示信息，请单击活动栏左下角的 {% octicon "gear" aria-label="The gear icon" %} 以显示“Settings（设置）”选项卡。 +1. 展开 **Extensions（扩展）**，然后单击 **{% data variables.product.prodname_github_codespaces %}** 以显示扩展的设置。 然后启用 **Show Performance Explorer（显示性能资源管理器）**在边栏中显示“Codespace Performance（代码空间性能）”部分。 ![显示性能信息所需的代码空间 ID 和设置](/assets/images/help/codespaces/find-codespace-id.png) diff --git a/translations/zh-CN/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md b/translations/zh-CN/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md index d8628bd47f..882d2985d2 100644 --- a/translations/zh-CN/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md +++ b/translations/zh-CN/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms.md @@ -539,7 +539,7 @@ body: ### 示例 -``` +```yaml body: - type: dropdown attributes: @@ -552,7 +552,7 @@ body: 通过确保 `options` 数组中不存在重复选项，可以修复此错误。 -``` +```yaml body: - type: dropdown attributes: @@ -570,7 +570,7 @@ body: ### 示例 -``` +```yaml body: - type: dropdown attributes: @@ -585,7 +585,7 @@ body: 可以通过删除 "None" 作为选项来修复该错误。 如果您希望贡献者能够表明他们不喜欢这些类型的馅饼，可以另外删除`必要的`验证。 -``` +```yaml body: - type: dropdown attributes: @@ -605,7 +605,7 @@ body: ### 示例 -``` +```yaml body: - type: dropdown attributes: @@ -618,7 +618,7 @@ body: 可以通过将每个有问题的选项括在引号中来修复该错误，以防止它们被处理为布尔值。 -``` +```yaml body: - type: dropdown attributes: @@ -629,6 +629,36 @@ body: - Maybe ``` +## Body cannot be empty + +The template body `key:value` pair can not be empty. For more information about which top-level keys are required, see "[Syntax for issue forms](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax)." + +The error can be fixed by adding the `body:` section. + +### 示例 + +```yaml +name: Support Request +description: Something went wrong and you need help? +--- +body: +- type: textarea + attributes: + label: "What's wrong?" +``` + +In this example, the error can be fixed by deleting the `---` (document separator) between the headers and the `body` section. + +```yaml +name: Support Request +description: Something went wrong and you need help? + +body: +- type: textarea + attributes: + label: "What's wrong?" +``` + ## 延伸阅读 - [YAML](https://yaml.org/) diff --git a/translations/zh-CN/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md b/translations/zh-CN/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md index d0e1dd4592..52e1519479 100644 --- a/translations/zh-CN/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md +++ b/translations/zh-CN/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md @@ -23,6 +23,8 @@ When an organization has an allow list, third-party applications that connect vi ## Adding an IP address allow list to a {% data variables.product.prodname_github_app %} +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.apps.settings-step %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} diff --git a/translations/zh-CN/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md b/translations/zh-CN/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md index ca89fbc56b..f864c2ad9a 100644 --- a/translations/zh-CN/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md +++ b/translations/zh-CN/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md @@ -1,5 +1,5 @@ --- -title: Rate limits for GitHub Apps +title: GitHub 应用程序的速率限制 intro: '{% data reusables.shortdesc.rate_limits_github_apps %}' redirect_from: - /early-access/integrations/rate-limits @@ -14,7 +14,7 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: Rate limits +shortTitle: 速率限制 --- {% data reusables.enterprise.rate_limit %} @@ -23,49 +23,49 @@ shortTitle: Rate limits {% ifversion ghec or fpt %} -## About rate limits for apps +## 关于应用程序的速率限制 -Rate limits for {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} depend on the plan for the organization where you install the application. For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products)" and "[Types of {% data variables.product.company_short %} accounts](/get-started/learning-about-github/types-of-github-accounts#organization-accounts)." +{% data variables.product.prodname_github_apps %} 和 {% data variables.product.prodname_oauth_apps %} 的速率限制取决于安装应用程序的组织的计划。 更多信息请参阅“[{% data variables.product.company_short %} 的产品](/get-started/learning-about-github/githubs-products)”和“[{% data variables.product.company_short %} 帐户类型](/get-started/learning-about-github/types-of-github-accounts#organization-accounts)”。 {% endif %} -## Server-to-server requests +## 服务器到服务器请求 {% ifversion ghec or fpt %} -### Default server-to-server rate limits for {% data variables.product.prodname_dotcom_the_website %} +### {% data variables.product.prodname_dotcom_the_website %} 的默认服务器到服务器速率限制 {% endif %} -{% data variables.product.prodname_github_apps %} making server-to-server requests use the installation's minimum rate limit of 5,000 requests per hour. If an application is installed on an organization with more than 20 users, the application receives another 50 requests per hour for each user. Installations that have more than 20 repositories receive another 50 requests per hour for each repository. The maximum rate limit for an installation is 12,500 requests per hour. +发出服务器-服务器请求的 {% data variables.product.prodname_github_apps %} 使用安装的最低速率限制为每小时 5,000 个请求。 如果应用程序安装在具有 20 个以上用户的组织中，则该应用程序每小时为每个用户再接收 50 个请求。 具有 20 个以上仓库的安装每小时会为每个仓库再接收 50 个请求。 安装的最大速率限制为每小时 12,500 个请求。 {% ifversion fpt or ghec %} -### Server-to-server rate limits for {% data variables.product.prodname_ghe_cloud %} +### {% data variables.product.prodname_ghe_cloud %} 的服务器到服务器速率限制 {% endif %} {% ifversion fpt or ghec %} -{% data variables.product.prodname_github_apps %} that are installed on an organization or a repository within an enterprise on {% data variables.product.product_location %} are subject to a limit of 15,000 requests per hour. +{% data variables.product.prodname_github_apps %} that are installed on an organization within an enterprise on {% data variables.product.product_location %} are subject to a limit of 15,000 requests per hour per organization that has installed the app. {% endif %} -## User-to-server requests +## 用户到服务器请求 -{% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} can also act on behalf of a user, making user-to-server requests after the user authorizes the app. For more information, see "[Authorizing {% data variables.product.prodname_github_apps %}](/authentication/keeping-your-account-and-data-secure/authorizing-github-apps)" and "[Authorizing {% data variables.product.prodname_oauth_apps %}](/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps)." +{% data variables.product.prodname_github_apps %} 和 {% data variables.product.prodname_oauth_apps %} 还可以代表用户执行操作，在用户授权应用后发出用户到服务器的请求。 更多信息请参阅“[授权 {% data variables.product.prodname_github_apps %}](/authentication/keeping-your-account-and-data-secure/authorizing-github-apps)”和“[授权 {% data variables.product.prodname_oauth_apps %}](/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps)”。 -User-to-server requests from {% data variables.product.prodname_oauth_apps %} are authenticated with an OAuth token. User-to-server requests from {% data variables.product.prodname_github_apps %} are authenticated with either an OAuth token or an expiring user access token. For more information, see "[Identifying and authorizing users for {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps#identifying-and-authorizing-users-for-github-apps)" and "[Authorizing {% data variables.product.prodname_oauth_apps %}](/developers/apps/building-oauth-apps/authorizing-oauth-apps)." +来自 {% data variables.product.prodname_oauth_apps %} 的用户到服务器请求使用 OAuth 令牌进行身份验证。 来自 {% data variables.product.prodname_github_apps %} 的用户到服务器请求使用 OAuth 令牌或即将过期的用户访问令牌进行身份验证。 更多信息请参阅“[识别和授权 {% data variables.product.prodname_github_apps %} 的用户](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps#identifying-and-authorizing-users-for-github-apps)”和“[授权 {% data variables.product.prodname_oauth_apps %}](/developers/apps/building-oauth-apps/authorizing-oauth-apps)”。 {% ifversion fpt or ghec %} -### Default user-to-server rate limits for {% data variables.product.prodname_dotcom_the_website %} +### {% data variables.product.prodname_dotcom_the_website %} 的默认用户到服务器速率限制 {% endif %} {% ifversion ghec %} -The rate limits for user-to-server requests made by {% data variables.product.prodname_github_apps %} depend on where the app is installed. If the app is installed on organizations or repositories owned by an enterprise on {% data variables.product.product_location %}, then the rate is higher than for installations outside an enterprise. +{% data variables.product.prodname_github_apps %} 发出的用户到服务器请求的速率限制取决于应用程序的安装位置。 如果应用程序安装在 {% data variables.product.product_location %} 上由企业拥有的组织或存储库上，则速率高于企业外部的安装。 {% endif %} @@ -73,13 +73,13 @@ The rate limits for user-to-server requests made by {% data variables.product.pr {% ifversion fpt or ghec %} -### User-to-server rate limits for {% data variables.product.prodname_ghe_cloud %} +### {% data variables.product.prodname_ghe_cloud %} 的用户到服务器速率限制 {% data reusables.apps.user-to-server-rate-limits-ghec %} {% endif %} -## Further reading +## 延伸阅读 -- "[Rate limiting](/rest/overview/resources-in-the-rest-api#rate-limiting)" in the REST API documentation -- "[Resource limitations](/graphql/overview/resource-limitations)" in the GraphQL API documentation +- REST API 文档中的“[速率限制](/rest/overview/resources-in-the-rest-api#rate-limiting)” +- GraphQL API 文档中的“[资源限制](/graphql/overview/resource-limitations)” diff --git a/translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md b/translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md index 165e374169..c3f1afcd31 100644 --- a/translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -39,46 +39,49 @@ X-Accepted-OAuth-Scopes: user ## 可用作用域 -| 名称 | 描述 | -| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |{% ifversion not ghae %} -| **`（无作用域）`** | 授予对公共信息的只读访问权限（包括用户个人资料信息、公共仓库信息和 gist）{% endif %}{% ifversion ghes or ghae %} -| **`site_admin`** | 授予站点管理员对 [{% data variables.product.prodname_ghe_server %} 管理 API 端点](/rest/reference/enterprise-admin)的访问权限。{% endif %} -| **`repo`** | Grants full access to public{% ifversion ghec or ghes or ghae %}, internal,{% endif %} and private repositories including read and write access to code, commit statuses, repository invitations, collaborators, deployment statuses, and repository webhooks. **Note**: In addition to repository related resources, the `repo` scope also grants access to manage organization-owned resources including projects, invitations, team memberships and webhooks. This scope also grants the ability to manage projects owned by users. | -|  `repo:status` | 授予对{% ifversion fpt %}公共和私有{% elsif ghec or ghes %}公共、私有和内部{% elsif ghae %}私有和内部{% endif %}仓库中的提交状态的读/写访问权限。 仅在授予其他用户或服务对私有仓库提交状态的访问权限而*不*授予对代码的访问权限时，才需要此作用域。 | -|  `repo_deployment` | 授予对{% ifversion not ghae %}公共{% else %}内部{% endif %}和私有仓库的[部署状态](/rest/reference/repos#deployments)的访问权限。 仅在授予其他用户或服务对部署状态的访问权限而*不*授予对代码的访问权限时，才需要此作用域。{% ifversion not ghae %} -|  `public_repo` | 将访问权限限制为公共仓库。 这包括对公共仓库和组织的代码、提交状态、仓库项目、协作者以及部署状态的读取/写入权限。 标星公共仓库也需要此权限。{% endif %} -|  `repo:invite` | 授予接受/拒绝仓库协作邀请的权限。 仅在授予其他用户或服务对邀请的访问权限而*不*授予对代码的访问权限时，才需要此作用域。{% ifversion fpt or ghes or ghec %} -|  `security_events` | 授予：
    对 [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning) 中安全事件的读取和写入权限
    对 {%- ifversion ghec %}[{% data variables.product.prodname_secret_scanning %} API](/rest/reference/secret-scanning) 中安全事件的读取和写入权限
    {%- endif %}仅在授予其他用户或服务对安全事件的访问权限而*不*授予对代码的访问权限时，才需要此作用域。{% endif %} -| **`admin:repo_hook`** | 授予对{% ifversion fpt %}公共或私有{% elsif ghec or ghes %}公共、私有或内部{% elsif ghae %}私有或内部{% endif %}仓库中仓库挂钩的读取、写入、ping 和删除访问权限。 `repo` {% ifversion fpt or ghec or ghes %}和 `public_repo` 范围授予{% else %}范围授予{% endif %}对仓库（包括仓库挂钩）的完全访问权限。 使用 `admin:repo_hook` 作用域将访问权限限制为仅仓库挂钩。 | -|  `write:repo_hook` | 授予对{% ifversion fpt %}公共或私有{% elsif ghec or ghes %}公共、私有或内部{% elsif ghae %}私有或内部{% endif %}仓库中挂钩的读取、写入和 ping 访问权限。 | -|  `read:repo_hook` | 授予对{% ifversion fpt %}公共或私有{% elsif ghec or ghes %}公共、私有或内部{% elsif ghae %}私有或内部{% endif %}仓库中挂钩的读取和 ping 访问权限。 | -| **`admin:org`** | 全面管理组织及其团队、项目和成员。 | -|  `write:org` | 对组织成员身份、组织项目和团队成员身份的读取和写入权限。 | -|  `read:org` | 对组织成员身份、组织项目和团队成员身份的只读权限。 | -| **`admin:public_key`** | 全面管理公钥。 | -|  `write:public_key` | 创建、列出和查看公钥的详细信息。 | -|  `read:public_key` | 列出和查看公钥的详细信息。 | -| **`admin:org_hook`** | 授予对组织挂钩的读取、写入、ping 和删除权限。 **注：**OAuth 令牌只能对由 OAuth 应用程序创建的组织挂钩执行这些操作。 个人访问令牌只能对用户创建的组织挂钩执行这些操作。 | -| **`gist`** | 授予对 gist 的写入权限。 | -| **`通知`** | 授予：
    * 对用户通知的读取权限
    * 对线程的标记读取权限
    * 对仓库的关注和取消关注权限，以及
    * 对线程订阅的读取、写入和删除权限。 | -| **`用户`** | 仅授予对个人资料的读取/写入权限。 请注意，此作用域包括 `user:email` 和 `user:follow`。 | -|  `read:user` | 授予读取用户个人资料数据的权限。 | -|  `user:email` | 授予对用户电子邮件地址的读取权限。 | -|  `user:follow` | 授予关注或取消关注其他用户的权限。{% ifversion projects-oauth-scope %} -| **`project`** | Grants read/write access to user and organization {% data variables.projects.projects_v2 %}. | -|  `read:project` | Grants read only access to user and organization {% data variables.projects.projects_v2 %}.{% endif %} -| **`delete_repo`** | 授予删除可管理仓库的权限。 | -| **`write:discussion`** | 授予对团队讨论的读取和写入权限。 | -|  `read:discussion` | 允许对团队讨论进行读取访问。 | -| **`write:packages`** | 授予在 {% data variables.product.prodname_registry %} 中上传或发布包的权限。 更多信息请参阅“[发布包](/github/managing-packages-with-github-packages/publishing-a-package)”。 | -| **`read:packages`** | 授予从 {% data variables.product.prodname_registry %} 下载或安装包的权限。 更多信息请参阅“[安装包](/github/managing-packages-with-github-packages/installing-a-package)”。 | -| **`delete:packages`** | 授予从 {% data variables.product.prodname_registry %} 删除包的权限。 更多信息请参阅“[删除和恢复软件包](/packages/learn-github-packages/deleting-and-restoring-a-package)”。 | -| **`admin:gpg_key`** | 全面管理 GPG 密钥。 | -|  `write:gpg_key` | 创建、列出和查看 GPG 密钥的详细信息。 | -|  `read:gpg_key` | 列出和查看 GPG 密钥的详细信息。{% ifversion fpt or ghec %} -| **`代码空间`** | 授予创建和管理代码空间的能力。 Codespaces 可以暴露可能有不同范围集的 GITHUB_TOKEN。 更多信息请参阅“[{% data variables.product.prodname_github_codespaces %} 中的安全性](/codespaces/codespaces-reference/security-in-github-codespaces#authentication)”。{% endif %} -| **`工作流程`** | 授予添加和更新 {% data variables.product.prodname_actions %} 工作流程文件的权限。 如果在同一仓库中的另一个分支上存在相同的文件(具有相同的路径和内容)，则工作流程文件可以在没有此作用域的情况下提交。 工作流程文件可以暴露可能有不同范围集的 `GITHUB_TOKEN`。 更多信息请参阅“[工作流程中的身份验证](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)。 | - +| 名称 | 描述 | +| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |{% ifversion not ghae %} +| **`（无作用域）`** | 授予对公共信息的只读访问权限（包括用户个人资料信息、公共仓库信息和 gist）{% endif %}{% ifversion ghes or ghae %} +| **`site_admin`** | 授予站点管理员对 [{% data variables.product.prodname_ghe_server %} 管理 API 端点](/rest/reference/enterprise-admin)的访问权限。{% endif %} +| **`repo`** | Grants full access to public{% ifversion ghec or ghes or ghae %}, internal,{% endif %} and private repositories including read and write access to code, commit statuses, repository invitations, collaborators, deployment statuses, and repository webhooks. **Note**: In addition to repository related resources, the `repo` scope also grants access to manage organization-owned resources including projects, invitations, team memberships and webhooks. This scope also grants the ability to manage projects owned by users. | +|  `repo:status` | 授予对{% ifversion fpt %}公共和私有{% elsif ghec or ghes %}公共、私有和内部{% elsif ghae %}私有和内部{% endif %}仓库中的提交状态的读/写访问权限。 仅在授予其他用户或服务对私有仓库提交状态的访问权限而*不*授予对代码的访问权限时，才需要此作用域。 | +|  `repo_deployment` | 授予对{% ifversion not ghae %}公共{% else %}内部{% endif %}和私有仓库的[部署状态](/rest/reference/repos#deployments)的访问权限。 仅在授予其他用户或服务对部署状态的访问权限而*不*授予对代码的访问权限时，才需要此作用域。{% ifversion not ghae %} +|  `public_repo` | 将访问权限限制为公共仓库。 这包括对公共仓库和组织的代码、提交状态、仓库项目、协作者以及部署状态的读取/写入权限。 标星公共仓库也需要此权限。{% endif %} +|  `repo:invite` | 授予接受/拒绝仓库协作邀请的权限。 仅在授予其他用户或服务对邀请的访问权限而*不*授予对代码的访问权限时，才需要此作用域。{% ifversion fpt or ghes or ghec %} +|  `security_events` | 授予：
    对 [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning) 中安全事件的读取和写入权限
    对 {%- ifversion ghec %}[{% data variables.product.prodname_secret_scanning %} API](/rest/reference/secret-scanning) 中安全事件的读取和写入权限
    {%- endif %}仅在授予其他用户或服务对安全事件的访问权限而*不*授予对代码的访问权限时，才需要此作用域。{% endif %} +| **`admin:repo_hook`** | 授予对{% ifversion fpt %}公共或私有{% elsif ghec or ghes %}公共、私有或内部{% elsif ghae %}私有或内部{% endif %}仓库中仓库挂钩的读取、写入、ping 和删除访问权限。 `repo` {% ifversion fpt or ghec or ghes %}和 `public_repo` 范围授予{% else %}范围授予{% endif %}对仓库（包括仓库挂钩）的完全访问权限。 使用 `admin:repo_hook` 作用域将访问权限限制为仅仓库挂钩。 | +|  `write:repo_hook` | 授予对{% ifversion fpt %}公共或私有{% elsif ghec or ghes %}公共、私有或内部{% elsif ghae %}私有或内部{% endif %}仓库中挂钩的读取、写入和 ping 访问权限。 | +|  `read:repo_hook` | 授予对{% ifversion fpt %}公共或私有{% elsif ghec or ghes %}公共、私有或内部{% elsif ghae %}私有或内部{% endif %}仓库中挂钩的读取和 ping 访问权限。 | +| **`admin:org`** | 全面管理组织及其团队、项目和成员。 | +|  `write:org` | 对组织成员身份、组织项目和团队成员身份的读取和写入权限。 | +|  `read:org` | 对组织成员身份、组织项目和团队成员身份的只读权限。 | +| **`admin:public_key`** | 全面管理公钥。 | +|  `write:public_key` | 创建、列出和查看公钥的详细信息。 | +|  `read:public_key` | 列出和查看公钥的详细信息。 | +| **`admin:org_hook`** | 授予对组织挂钩的读取、写入、ping 和删除权限。 **注：**OAuth 令牌只能对由 OAuth 应用程序创建的组织挂钩执行这些操作。 个人访问令牌只能对用户创建的组织挂钩执行这些操作。 | +| **`gist`** | 授予对 gist 的写入权限。 | +| **`通知`** | 授予：
    * 对用户通知的读取权限
    * 对线程的标记读取权限
    * 对仓库的关注和取消关注权限，以及
    * 对线程订阅的读取、写入和删除权限。 | +| **`用户`** | 仅授予对个人资料的读取/写入权限。 请注意，此作用域包括 `user:email` 和 `user:follow`。 | +|  `read:user` | 授予读取用户个人资料数据的权限。 | +|  `user:email` | 授予对用户电子邮件地址的读取权限。 | +|  `user:follow` | 授予关注或取消关注其他用户的权限。{% ifversion projects-oauth-scope %} +| **`project`** | Grants read/write access to user and organization {% data variables.projects.projects_v2 %}. | +|  `read:project` | Grants read only access to user and organization {% data variables.projects.projects_v2 %}.{% endif %} +| **`delete_repo`** | 授予删除可管理仓库的权限。 | +| **`write:discussion`** | 授予对团队讨论的读取和写入权限。 | +|  `read:discussion` | 允许对团队讨论进行读取访问。 | +| **`write:packages`** | 授予在 {% data variables.product.prodname_registry %} 中上传或发布包的权限。 更多信息请参阅“[发布包](/github/managing-packages-with-github-packages/publishing-a-package)”。 | +| **`read:packages`** | 授予从 {% data variables.product.prodname_registry %} 下载或安装包的权限。 更多信息请参阅“[安装包](/github/managing-packages-with-github-packages/installing-a-package)”。 | +| **`delete:packages`** | 授予从 {% data variables.product.prodname_registry %} 删除包的权限。 更多信息请参阅“[删除和恢复软件包](/packages/learn-github-packages/deleting-and-restoring-a-package)”。 | +| **`admin:gpg_key`** | 全面管理 GPG 密钥。 | +|  `write:gpg_key` | 创建、列出和查看 GPG 密钥的详细信息。 | +|  `read:gpg_key` | 列出和查看 GPG 密钥的详细信息。{% ifversion fpt or ghec %} +| **`代码空间`** | 授予创建和管理代码空间的能力。 Codespaces 可以暴露可能有不同范围集的 GITHUB_TOKEN。 更多信息请参阅“[{% data variables.product.prodname_github_codespaces %} 中的安全性](/codespaces/codespaces-reference/security-in-github-codespaces#authentication)”。{% endif %} +| **`工作流程`** | 授予添加和更新 {% data variables.product.prodname_actions %} 工作流程文件的权限。 如果在同一仓库中的另一个分支上存在相同的文件(具有相同的路径和内容)，则工作流程文件可以在没有此作用域的情况下提交。 工作流程文件可以暴露可能有不同范围集的 `GITHUB_TOKEN`。 For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)."{% ifversion not fpt %} +| **`admin:enterprise`** | Gives full control of enterprise functionality. For more information, see "[Managing enterprise accounts](/graphql/guides/managing-enterprise-accounts)" in the GraphQL API documentation.

    Includes `manage_runners:enterprise`{% ifversion ghec or ghes > 3.3 %}, `manage_billing:enterprise`,{% endif %} and `read:enterprise`. | +|  `manage_runners:enterprise` | Gives full control over self-hosted runners within the enterprise. 更多信息请参阅“[关于自托管运行器](/actions/hosting-your-own-runners/about-self-hosted-runners)”。 {% ifversion ghec or ghes > 3.3 %} +|  `manage_billing:enterprise` | Read and write enterprise billing data. For more information, see "[Billing](/rest/billing)" in the REST API documentation. {% endif %} +|  `read:enterprise` | Read all data on an enterprise profile. Does not include profile data of enterprise members or organizations.{% endif %} {% note %} **注：**您的 OAuth 应用程序可以在初始重定向中请求作用域。 您可以使用 `%20` 以空格分隔多个作用域来指定它们： diff --git a/translations/zh-CN/content/developers/index.md b/translations/zh-CN/content/developers/index.md index 065e92c08c..f26e8479f2 100644 --- a/translations/zh-CN/content/developers/index.md +++ b/translations/zh-CN/content/developers/index.md @@ -1,6 +1,29 @@ --- title: 开发者 -intro: '通过与我们的 API 集成，自定义您的 {% data variables.product.prodname_dotcom %} 工作流程，以及构建并与社区分享应用程序，更深入地了解 {% data variables.product.prodname_dotcom %}。' +intro: 'Go deeper with {% data variables.product.prodname_dotcom %} by integrating with our APIs and webhooks, customizing your {% data variables.product.prodname_dotcom %} workflow, and building and sharing apps with the community.' +introLinks: + About apps: /developers/apps/getting-started-with-apps/about-apps +layout: product-landing +featuredLinks: + guides: + - /developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps + - /developers/apps/building-github-apps/creating-a-github-app + - /developers/apps/building-github-apps/authenticating-with-github-apps + - /developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps + popular: + - /developers/webhooks-and-events/webhooks/webhook-events-and-payloads + - /developers/apps/building-github-apps/creating-a-github-app + - /developers/apps/building-github-apps/authenticating-with-github-apps + - /developers/webhooks-and-events/webhooks/about-webhooks + - /developers/apps/building-oauth-apps/creating-an-oauth-app + - /developers/apps/building-oauth-apps/authorizing-oauth-apps + - /developers/github-marketplace/github-marketplace-overview/about-github-marketplace + guideCards: + - /developers/webhooks-and-events/webhooks/creating-webhooks + - /developers/apps/guides/using-the-github-api-in-your-app + - /developers/apps/guides/creating-ci-tests-with-the-checks-api +changelog: + label: apps versions: fpt: '*' ghes: '*' diff --git a/translations/zh-CN/content/developers/overview/about-githubs-apis.md b/translations/zh-CN/content/developers/overview/about-githubs-apis.md index 1283836233..41ecd4fb28 100644 --- a/translations/zh-CN/content/developers/overview/about-githubs-apis.md +++ b/translations/zh-CN/content/developers/overview/about-githubs-apis.md @@ -15,17 +15,3 @@ topics: --- GitHub API 有两个稳定版本：[REST API](/rest) 和 [GraphQL API](/graphql)。 - -## 已弃用版本 - -### 测试版 - -我们在 2014 年 4 月 22 日弃用了测试版 API。 - -### v2 - -我们在 2012 年 6 月 12 日取消了对 API v2 的支持。 - -### v1 - -我们在 2012 年 6 月 12 日取消了对 API v1 的支持。 diff --git a/translations/zh-CN/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md b/translations/zh-CN/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md index bc200e0243..863cf93064 100644 --- a/translations/zh-CN/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md +++ b/translations/zh-CN/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md @@ -37,12 +37,12 @@ $ export SECRET_TOKEN=your_token ## 验证来自 GitHub 的有效负载 -设置密钥令牌后，{% data variables.product.product_name %} 使用它为每个有效负载创建一个哈希签名。 此哈希签名包含在每个请求的标头中，作为 `X-Hub-Signature-256`。 +设置密钥令牌后，{% data variables.product.product_name %} 使用它为每个有效负载创建一个哈希签名。 This hash signature is included with the headers of each request as `x-hub-signature-256`. {% ifversion fpt or ghes or ghec %} {% note %} -**注：** 为了向后兼容，我们还包括使用 SHA-1 哈希函数生成的 `X-Hub-Signature` 标头。 如果可能，我们建议您使用 `X-Hub-Signature-256` 标头以提高安全性。 下面的示例演示使用 `X-Hub-Signature-256` 标头。 +**Note:** For backward-compatibility, we also include the `x-hub-signature` header that is generated using the SHA-1 hash function. If possible, we recommend that you use the `x-hub-signature-256` header for improved security. The example below demonstrates using the `x-hub-signature-256` header. {% endnote %} {% endif %} diff --git a/translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/index.md b/translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/index.md index 4f13ba2d73..8dde88fa15 100644 --- a/translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/index.md +++ b/translations/zh-CN/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/index.md @@ -9,8 +9,8 @@ redirect_from: versions: fpt: '*' children: - - /use-github-at-your-educational-institution - /github-global-campus-for-students - /github-global-campus-for-teachers + - /use-github-at-your-educational-institution --- diff --git a/translations/zh-CN/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md b/translations/zh-CN/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md index 01287f5260..781329de10 100644 --- a/translations/zh-CN/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md +++ b/translations/zh-CN/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-a-group-assignment.md @@ -55,7 +55,7 @@ redirect_from: ### 选择作业类型 -在“Individual or group assignment（个人或小组作业）”下，选择下拉菜单，然后单击 **Group assignment（小组作业）**。 创建作业后不可更改作业类型。 如果要创建个人作业，请参阅“[创建个人作业](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)”。 +在“Individual or group assignment（个人或小组作业）”下，选择下拉菜单，然后单击 **Group assignment（小组作业）**。 创建作业后不可更改作业类型。 If you'd rather create an individual assignment, see "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)." ### 确定作业的团队 diff --git a/translations/zh-CN/content/get-started/exploring-projects-on-github/following-organizations.md b/translations/zh-CN/content/get-started/exploring-projects-on-github/following-organizations.md index 64d7144396..b3e02489ca 100644 --- a/translations/zh-CN/content/get-started/exploring-projects-on-github/following-organizations.md +++ b/translations/zh-CN/content/get-started/exploring-projects-on-github/following-organizations.md @@ -7,15 +7,11 @@ topics: - Profile --- -{% note %} - -**Note:** The ability to follow organizations is currently in public beta and subject to change. - -{% endnote %} +{% data reusables.organizations.follow-organizations-beta %} ## About followers on {% data variables.product.product_name %} -When you follow organizations, you'll see their public activity on your personal dashboard. For more information, see "[About your personal dashboard](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community)." +{% data reusables.organizations.about-following-organizations %} For more information, see "[About your personal dashboard](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community)." You can unfollow an organization if you do not wish to see their {% ifversion fpt or ghec %}public{% endif %} activity on {% data variables.product.product_name %}. diff --git a/translations/zh-CN/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md b/translations/zh-CN/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md index 97b049d2de..30a25ec8ae 100644 --- a/translations/zh-CN/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md +++ b/translations/zh-CN/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md @@ -58,11 +58,21 @@ If you have existing source code or repositories stored locally on your computer ![Create New Repository drop-down](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Change the current working directory to your local project. -4. Initialize the local directory as a Git repository. - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. Add the files in your new local repository. This stages them for the first commit. + ```shell $ git add . # Adds the files in the local repository and stages them for commit. {% data reusables.git.unstage-codeblock %} @@ -95,10 +105,19 @@ If you have existing source code or repositories stored locally on your computer ![Create New Repository drop-down](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Change the current working directory to your local project. -4. Initialize the local directory as a Git repository. - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. Add the files in your new local repository. This stages them for the first commit. ```shell $ git add . @@ -132,10 +151,19 @@ If you have existing source code or repositories stored locally on your computer ![Create New Repository drop-down](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Change the current working directory to your local project. -4. Initialize the local directory as a Git repository. - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. Add the files in your new local repository. This stages them for the first commit. ```shell $ git add . diff --git a/translations/zh-CN/content/get-started/quickstart/be-social.md b/translations/zh-CN/content/get-started/quickstart/be-social.md index 496c283694..fe037d3c37 100644 --- a/translations/zh-CN/content/get-started/quickstart/be-social.md +++ b/translations/zh-CN/content/get-started/quickstart/be-social.md @@ -58,7 +58,23 @@ topics: ![切换帐户上下文下拉列表](/assets/images/help/overview/dashboard-contextswitcher.png) -### 在 {% data variables.product.prodname_dotcom %} 上探索其他项目 +{% ifversion for-you-feed %} + +## 关注组织 + +{% data reusables.organizations.follow-organizations-beta %} + +{% data reusables.organizations.about-following-organizations %} + +To follow an organization, in the header of the organization's page, click **Follow**. + +![组织标题的屏幕截图，突出显示了“关注”按钮](/assets/images/help/profile/organization-profile-following.png) + +For more information, see "[Following organizations](/get-started/exploring-projects-on-github/following-organizations)." + +{% endif %} + +## 在 {% data variables.product.prodname_dotcom %} 上探索其他项目 您可以在 {% data variables.product.prodname_dotcom %} 的 Explore（探索）页面上发现新的和有趣的项目。 您可以为有趣的项目加注星标，以便以后再次轻松找到它们。 访问您的星标页面，查看所有已加星标的项目。 有关星标的更多信息，请参阅“[使用星标保存仓库](/get-started/exploring-projects-on-github/saving-repositories-with-stars)”。 diff --git a/translations/zh-CN/content/get-started/quickstart/set-up-git.md b/translations/zh-CN/content/get-started/quickstart/set-up-git.md index 7458dc102e..cf58ba5012 100644 --- a/translations/zh-CN/content/get-started/quickstart/set-up-git.md +++ b/translations/zh-CN/content/get-started/quickstart/set-up-git.md @@ -41,17 +41,17 @@ If you do not need to work with files locally, {% data variables.product.product 1. [Download and install the latest version of Git](https://git-scm.com/downloads). -{% note %} + {% note %} + + **Note**: If you are using a Chrome OS device, additional set up is required: + + 1. Install a terminal emulator such as Termux from the Google Play Store on your Chrome OS device. + 1. From the terminal emulator that you installed, install Git. For example, in Termux, enter `apt install git` and then type `y` when prompted. + + {% endnote %} -**Note**: If you are using a Chrome OS device, additional set up is required: - -2. Install a terminal emulator such as Termux from the Google Play Store on your Chrome OS device. -3. From the terminal emulator that you installed, install Git. For example, in Termux, enter `apt install git` and then type `y` when prompted. - -{% endnote %} - -2. [Set your username in Git](/github/getting-started-with-github/setting-your-username-in-git). -3. [Set your commit email address in Git](/articles/setting-your-commit-email-address). +1. [Set your username in Git](/github/getting-started-with-github/setting-your-username-in-git). +1. [Set your commit email address in Git](/articles/setting-your-commit-email-address). ## Authenticating with {% data variables.product.prodname_dotcom %} from Git diff --git a/translations/zh-CN/content/index.md b/translations/zh-CN/content/index.md index fbfc13a557..5e385e9de5 100644 --- a/translations/zh-CN/content/index.md +++ b/translations/zh-CN/content/index.md @@ -19,6 +19,7 @@ redirect_from: - /troubleshooting-common-issues versions: '*' children: + - search - get-started - account-and-profile - authentication diff --git a/translations/zh-CN/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md b/translations/zh-CN/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md index 113f7e274f..011d82a7f3 100644 --- a/translations/zh-CN/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md +++ b/translations/zh-CN/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md @@ -24,7 +24,7 @@ shortTitle: 转移议题 {% endnote %} -转让议题时，评论、标签和受理人将保留。 不会保留议题的里程碑。 此议题将留在任何用户拥有或组织范围的项目板上，并从任何仓库项目板中删除。 更多信息请参阅“[关于项目板](/articles/about-project-boards)”。 +转让议题时，评论和受理人将保留。 Labels and milestones are also retained if they're present in the target repository, with labels matching by name and milestones matching by both name and due date. 此议题将留在任何用户拥有或组织范围的项目板上，并从任何仓库项目板中删除。 更多信息请参阅“[关于项目板](/articles/about-project-boards)”。 议题中提及的人员或团队将收到通知，告知他们该议题已转让给新仓库。 原来的 URL 会重定向到新议题的 URL。 在新仓库中没有读取权限的人员将看到一个横幅，告知他们该议题已转让给他们无法访问的新仓库。 diff --git a/translations/zh-CN/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md b/translations/zh-CN/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md index 9f5fa57f5d..b6e248b0a4 100644 --- a/translations/zh-CN/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md +++ b/translations/zh-CN/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md @@ -36,15 +36,22 @@ permissions: Organization owners can manage allowed IP addresses for an organiza ## 添加允许的 IP 地址 +{% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} + +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} {% data reusables.identity-and-permissions.ip-allow-lists-add-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-add-description %} {% data reusables.identity-and-permissions.ip-allow-lists-add-entry %} +{% data reusables.identity-and-permissions.check-ip-address %} ## 启用允许的 IP 地址 +{% data reusables.identity-and-permissions.about-enabling-allowed-ip-addresses %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} @@ -69,6 +76,8 @@ permissions: Organization owners can manage allowed IP addresses for an organiza ## 编辑允许的 IP 地址 +{% data reusables.identity-and-permissions.about-editing-ip-allow-list-entries %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} @@ -76,6 +85,18 @@ permissions: Organization owners can manage allowed IP addresses for an organiza {% data reusables.identity-and-permissions.ip-allow-lists-edit-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-description %} 1. 单击 **Update（更新）**。 +{% data reusables.identity-and-permissions.check-ip-address %} + +{% ifversion ip-allow-list-address-check %} +## Checking if an IP address is permitted + +{% data reusables.identity-and-permissions.about-checking-ip-address %} + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +{% data reusables.organizations.security %} +{% data reusables.identity-and-permissions.check-ip-address-step %} +{% endif %} ## 删除允许的 IP 地址 diff --git a/translations/zh-CN/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md b/translations/zh-CN/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md index d5cee8b617..686a427ea5 100644 --- a/translations/zh-CN/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md +++ b/translations/zh-CN/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md @@ -740,7 +740,7 @@ For more information, see "[Managing the publication of {% data variables.produc | Action | Description |------------------|------------------- |`create` | Triggered when an organization owner creates a new custom repository role. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." -|`destroy` | Triggered when a organization owner deletes a custom repository role. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." +|`destroy` | Triggered when an organization owner deletes a custom repository role. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." |`update` | Triggered when an organization owner edits an existing custom repository role. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." {% endif %} diff --git a/translations/zh-CN/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md b/translations/zh-CN/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md index a9eba76639..723c3c29cb 100644 --- a/translations/zh-CN/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md +++ b/translations/zh-CN/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md @@ -1,6 +1,6 @@ --- title: 为组织启用或禁用 GitHub 讨论 -intro: '您可以使用组织中的 {% data variables.product.prodname_discussions %} 作为组织进行对话的位置，这些对话不特定于组织中的单个存储库。' +intro: 'You can use {% data variables.product.prodname_discussions %} in an organization as a place for your organization to have conversations that aren''t specific to a single repository within your organization.' permissions: 'Organization owners can enable {% data variables.product.prodname_discussions %} for their organization.' versions: feature: discussions diff --git a/translations/zh-CN/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md b/translations/zh-CN/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md index c5da05e4d3..d1b4d72d71 100644 --- a/translations/zh-CN/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md +++ b/translations/zh-CN/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md @@ -92,9 +92,10 @@ redirect_from: - **设置交互限制**：暂时限制某些用户在公共存储库中发表评论、打开议题或创建拉取请求，以强制执行一段有限的活动。 更多信息请参阅“[限制存储库中的交互](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)”。 {%- endif %} - **设置社交预览**：将识别图像添加到存储库，该图像在链接存储库时显示在社交媒体平台上。 更多信息请参阅“[自定义仓库的社交媒体审查](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview)”。 -- **推送提交到受保护分支**：推送到标记为受保护分支的分支。 +- **推送提交到受保护分支**：推送到标记为受保护分支的分支。 Branch protection rules will still apply and could result in a push being rejected. - **创建受保护的标记**：创建与标记保护规则匹配的标记。 更多信息请参阅“[配置标记保护规则](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules)”。 -- **删除受保护的标记**：删除与标记保护规则匹配的标记。 更多信息请参阅“[配置标记保护规则](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules)”。 +- **删除受保护的标记**：删除与标记保护规则匹配的标记。 For more information, see "[Configuring tag protection rules](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules)."{% ifversion bypass-branch-protections %} +- **Bypass branch protections**: Push to a protected branch without needing to comply with branch protection rules.{% endif %} ### 安全 diff --git a/translations/zh-CN/content/packages/index.md b/translations/zh-CN/content/packages/index.md index 4773b4809f..785f176d68 100644 --- a/translations/zh-CN/content/packages/index.md +++ b/translations/zh-CN/content/packages/index.md @@ -18,6 +18,7 @@ featuredLinks: guideCards: - '{% ifversion docker-ghcr-enterprise-migration %}/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry{% endif %}' - '{% ifversion fpt or ghec or ghes > 3.4 %}/packages/working-with-a-github-packages-registry/working-with-the-container-registry{% else %}/packages/working-with-a-github-packages-registry/working-with-the-docker-registry{% endif %}' + - '{% ifversion packages-npm-v2 %}/packages/working-with-a-github-packages-registry/working-with-the-npm-registry{% endif %}' - /packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry changelog: label: packages diff --git a/translations/zh-CN/content/packages/learn-github-packages/about-permissions-for-github-packages.md b/translations/zh-CN/content/packages/learn-github-packages/about-permissions-for-github-packages.md index c05ba2a02f..de17d09ee4 100644 --- a/translations/zh-CN/content/packages/learn-github-packages/about-permissions-for-github-packages.md +++ b/translations/zh-CN/content/packages/learn-github-packages/about-permissions-for-github-packages.md @@ -18,20 +18,22 @@ shortTitle: 关于权限 仓库作用域的包从拥有该包的仓库继承权限和可见性。 通过转到仓库的主页并单击页面右侧的 **Packages（包）**链接，您可以找到作用域为仓库的包。 {% ifversion fpt or ghec %}更多信息请参阅“[将仓库连接到包](/packages/learn-github-packages/connecting-a-repository-to-a-package)”。{% endif %} -下面的 {% data variables.product.prodname_registry %} 注册表使用仓库作用域的权限： +The {% data variables.product.prodname_registry %} registries below **only** use repository-scoped permissions: {% ifversion not fpt or ghec %}- Docker 注册表 (`docker.pkg.github.com`){% endif %} - - npm 注册表 + {% ifversion packages-npm-v2 %}{% else %}- npm registry{% endif %} - RubyGems 注册表 - Apache Maven 注册表 - NuGet 注册表 +{% ifversion packages-npm-v2 %}For {% data variables.product.prodname_ghcr_and_npm_registry %}, you can choose to allow packages to be scoped to a user, an organization, or linked to a repository.{% endif %} + {% ifversion fpt or ghec %} ## 用户/组织作用域包的精细权限 具有精细权限的包仅限于个人用户或组织帐户。 您可以从与包相连（或链接）的仓库分别更改包的访问控制和可见性。 -目前，只有 {% data variables.product.prodname_container_registry %} 为容器映像包提供精细权限。 +Currently, the {% data variables.product.prodname_ghcr_and_npm_registry %} offer granular permissions for your container image packages. ## 容器映像的可见性和访问权限 diff --git a/translations/zh-CN/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md b/translations/zh-CN/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md index 4b2ca5591c..c0ebb3641a 100644 --- a/translations/zh-CN/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md +++ b/translations/zh-CN/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md @@ -16,7 +16,7 @@ shortTitle: 访问控制和可见性 具有精细权限的包仅限于个人用户或组织帐户。 您可以从与包相连（或链接）的仓库分别更改包的访问控制和可见性。 -目前，您只能对 {% data variables.product.prodname_container_registry %} 使用粒度权限。 我们的其他包注册表（如 npm 注册表）不支持粒度权限。{% ifversion docker-ghcr-enterprise-migration %} 有关迁移到 {% data variables.product.prodname_container_registry %} 的详细信息，请参阅“[从 Docker 注册表迁移到 {% data variables.product.prodname_container_registry %}](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)”。{% endif %} +目前，您只能对 {% data variables.product.prodname_ghcr_and_npm_registry %} 使用粒度权限。 Granular permissions are not supported in our other package registries, such as the RubyGems registry.{% ifversion docker-ghcr-enterprise-migration %} For more information about migration to the {% data variables.product.prodname_container_registry %}, see "[Migrating to the {% data variables.product.prodname_container_registry %} from the Docker registry](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)."{% endif %} 有关仓库作用域的包、与包相关的 PAT 作用域或管理操作工作流程的权限的更多信息，请参阅“[关于 GitHub Packages 的权限](/packages/learn-github-packages/about-permissions-for-github-packages)”。 @@ -95,7 +95,7 @@ shortTitle: 访问控制和可见性 {% ifversion fpt or ghec %} ## 确保 {% data variables.product.prodname_codespaces %} 访问您的软件包 -默认情况下，代码空间可以无缝访问 {% data variables.product.prodname_dotcom %} 容器注册表中的某些包，例如在选中了 **Inherit access（继承访问）**选项的同一仓库中发布的包。 有关自动配置哪些访问权限的详细信息，请参阅“[访问存储在容器注册表 {% data variables.product.prodname_dotcom %} 中的映像](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-images-stored-in-github-container-registry)”。 +By default, a codespace can seamlessly access certain packages in the {% data variables.product.prodname_ghcr_and_npm_registry %}, such as those published in the same repository with the **Inherit access** option selected. For more information on which access is automatically configured, see "[Allowing your codespace to access a private image registry](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-images-stored-in-container-registry-and-npm-registry)." 否则，为了确保代码空间能够访问您的软件包，必须授予对启动代码空间的仓库的访问权限。 diff --git a/translations/zh-CN/content/packages/learn-github-packages/deleting-and-restoring-a-package.md b/translations/zh-CN/content/packages/learn-github-packages/deleting-and-restoring-a-package.md index f7e9663049..8e50d7fe16 100644 --- a/translations/zh-CN/content/packages/learn-github-packages/deleting-and-restoring-a-package.md +++ b/translations/zh-CN/content/packages/learn-github-packages/deleting-and-restoring-a-package.md @@ -23,12 +23,12 @@ shortTitle: 删除和恢复包 - 整个私有包 - 整个公共包（如果任何包版本不超过 5000 次下载） - 私有包的特定版本 -- 公共包的特定版本（如果包版本不超过 5000 次下载） +- 公共包的特定版本（如果包版本不超过 5,000 次下载） {% note %} **注:** -- 如果任何版本的包下载量超过 5000 次，则无法删除公共包。 在这种情况下，请联系 [GitHub 支持](https://support.github.com/contact?tags=docs-packages) 获取更多帮助。 +- 如果任何版本的包下载量超过 5,000 次，则无法删除公共包。 在这种情况下，请联系 [GitHub 支持](https://support.github.com/contact?tags=docs-packages) 获取更多帮助。 - 删除公共包时，请注意，您可能会破坏依赖于包的项目。 {% endnote %} @@ -46,7 +46,7 @@ shortTitle: 删除和恢复包 {% endif %} -对于从仓库继承其权限和访问权限的包，您可以使用 GraphQL 删除特定的包版本。{% ifversion fpt or ghec %} {% data variables.product.prodname_registry %} GraphQL API 不支持使用包命名空间的容器或 Docker 映像 `https://ghcr.io/OWNER/PACKAGE-NAME`。{% endif %} 有关 GraphQL 支持的更多信息，请参阅“[使用 GraphQL 删除存储库范围包的版本](#deleting-a-version-of-a-repository-scoped-package-with-graphql)”。 +For packages that inherit their permissions and access from repositories, you can use GraphQL to delete a specific package version.{% data reusables.package_registry.no-graphql-to-delete-packages %} For more information about GraphQL support, see "[Deleting a version of a repository-scoped package with GraphQL](#deleting-a-version-of-a-repository-scoped-package-with-graphql)." {% endif %} @@ -54,17 +54,19 @@ shortTitle: 删除和恢复包 对于从仓库继承其访问权限的包，如果您拥有仓库管理权限，则可以删除包。 -{% data variables.product.prodname_registry %} 上仓库范围的包中包括以下包： -- npm -- RubyGems -- maven -- Gradle -- NuGet -{% ifversion not fpt or ghec %}- Docker 映像位于 `docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`{% endif %} +The {% data variables.product.prodname_registry %} registries below **only** use repository-scoped permissions: + + {% ifversion not fpt or ghec %}- Docker 映像位于 `docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`{% endif %} + {% ifversion packages-npm-v2 %}{% else %}- npm{% endif %} + - RubyGems 注册表 + - Apache Maven 注册表 + - NuGet 注册表 + +{% ifversion packages-npm-v2 %}For {% data variables.product.prodname_ghcr_and_npm_registry %}, you can choose to allow packages to be scoped to a user, an organization, or linked to a repository.{% endif %} {% ifversion fpt or ghec %} -要删除与仓库分开的具有粒度权限的软件包，例如存储在 `https://ghcr.io/OWNER/PACKAGE-NAME` 上的容器映像，您必须对该包具有管理员访问权限。 更多信息请参阅“[关于 {% data variables.product.prodname_registry %} 的权限](/packages/learn-github-packages/about-permissions-for-github-packages)”。 +To delete a package that has granular permissions separate from a repository, such as container images stored at `https://ghcr.io/OWNER/PACKAGE-NAME` or `https://npm.pkg.github.com/OWNER/PACKAGE-NAME`, you must have admin access to the package. 更多信息请参阅“[关于 {% data variables.product.prodname_registry %} 的权限](/packages/learn-github-packages/about-permissions-for-github-packages)”。 {% endif %} @@ -86,9 +88,7 @@ shortTitle: 删除和恢复包 对于从仓库继承其许可和访问权限的包，您可以使用 GraphQL 删除特定的包版本。 -{% ifversion fpt or ghec %} -对于在 `ghcr.io` 上的容器或 Docker 映像，GraphQL 不受支持，但您可以使用 REST API。 更多信息请参阅“[{% data variables.product.prodname_registry %} API](/rest/reference/packages)”。 -{% endif %} +{% data reusables.package_registry.no-graphql-to-delete-packages %}{% ifversion fpt or ghec %} You can however use the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)."{% endif %} 在 GraphQL API 中使用 `deletePackageVersion` 突变。 必须使用具有 `read:packages`、`delete:packages` 和 `repo` 作用域的令牌。 有关令牌的更多信息，请参阅“[关于 {% data variables.product.prodname_registry %}](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)”。 diff --git a/translations/zh-CN/content/packages/learn-github-packages/introduction-to-github-packages.md b/translations/zh-CN/content/packages/learn-github-packages/introduction-to-github-packages.md index fc5090006e..5450ffcff9 100644 --- a/translations/zh-CN/content/packages/learn-github-packages/introduction-to-github-packages.md +++ b/translations/zh-CN/content/packages/learn-github-packages/introduction-to-github-packages.md @@ -51,7 +51,7 @@ For more information about the configuration of {% data variables.product.prodna | | | |--------------------|--------------------| -| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_container_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

    For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | +| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_ghcr_and_npm_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

    For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | | Visibility | {% data reusables.package_registry.public-or-private-packages %} | For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." @@ -101,7 +101,9 @@ For more information about Docker and the {% data variables.product.prodname_con ## Managing packages {% ifversion fpt or ghec %} -You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." +You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." + +{% data reusables.package_registry.no-graphql-to-delete-packages %} {% endif %} {% ifversion ghes %} @@ -112,7 +114,9 @@ You can delete a private or public package in the {% data variables.product.prod You can delete a version of a package in the {% data variables.product.product_name %} user interface or using the GraphQL API. {% endif %} -When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and "[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." +When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. + +For more information, see {% ifversion ghes or ghae %}"[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and {% endif %}"[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "[`package` webhook event](/webhooks/event-payloads/#package)." diff --git a/translations/zh-CN/content/packages/learn-github-packages/viewing-packages.md b/translations/zh-CN/content/packages/learn-github-packages/viewing-packages.md index 5b7d3a04e9..40686593f0 100644 --- a/translations/zh-CN/content/packages/learn-github-packages/viewing-packages.md +++ b/translations/zh-CN/content/packages/learn-github-packages/viewing-packages.md @@ -23,15 +23,15 @@ versions: 查看包的权限取决于几个因素。 默认情况下，您可以查看您发布的所有包。 -仓库作用域的包从拥有该包的仓库继承权限和可见性。 下面的注册表使用此类权限：{% ifversion not fpt or ghec %} +仓库作用域的包从拥有该包的仓库继承权限和可见性。 The registries below **only** use this type of permissions:{% ifversion not fpt or ghec %} - Docker 注册表 (`docker.pkg.github.com`){% endif %} -- npm 注册表 +{% ifversion packages-npm-v2 %}{% else %}- npm registry{% endif %} - RubyGems 注册表 - Apache Maven 注册表 - NuGet 注册表 {% ifversion fpt or ghec %} -容器注册表提供粒度权限和可见性设置，可针对个人用户或组织帐户拥有的每个包进行自定义。 您可以选择使用粒度权限或连接包到仓库并继承它的权限。 更多信息请参阅“[将仓库连接到包](/packages/learn-github-packages/connecting-a-repository-to-a-package)”。 +The {% data variables.product.prodname_ghcr_and_npm_registry %} offer you the option of granular permissions and visibility settings that can be customized for each package owned by a personal user or organization account. 您可以选择使用粒度权限或连接包到仓库并继承它的权限。 更多信息请参阅“[将仓库连接到包](/packages/learn-github-packages/connecting-a-repository-to-a-package)”。 {% endif %} 更多信息请参阅“[关于 GitHub Packages 的权限](/packages/learn-github-packages/about-permissions-for-github-packages)”{% ifversion fpt or ghec %} 或“[配置包的访问控制和可见性](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)”。{% endif %} diff --git a/translations/zh-CN/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md b/translations/zh-CN/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md index abf40d8435..6b3f8fc7cd 100644 --- a/translations/zh-CN/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md +++ b/translations/zh-CN/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md @@ -24,9 +24,9 @@ shortTitle: Publish & install with Actions You can extend the CI and CD capabilities of your repository by publishing or installing packages as part of your workflow. {% ifversion fpt or ghec %} -### Authenticating to the {% data variables.product.prodname_container_registry %} +### Authenticating to the {% data variables.product.prodname_ghcr_and_npm_registry %} -{% data reusables.package_registry.authenticate_with_pat_for_container_registry %} +{% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} {% endif %} @@ -40,7 +40,7 @@ You can reference the `GITHUB_TOKEN` in your workflow file using the {% raw %}`{ {% note %} -**Note:** Repository-owned packages include RubyGems, npm, Apache Maven, NuGet, {% ifversion fpt or ghec %}and Gradle. {% else %}Gradle, and Docker packages that use the package namespace `docker.pkg.github.com`.{% endif %} +**Note:** Some registries, such as RubyGems, {% ifversion packages-npm-v2 %}{% else %}npm, {% endif %}Apache Maven, NuGet, {% ifversion fpt or ghec %}and Gradle{% else %}Gradle, and Docker packages that use the package namespace `docker.pkg.github.com`{% endif %}, only allow repository-owned packages. With {% data variables.product.prodname_ghcr_and_npm_registry_full %} you can choose to allow packages to be owned by a user, an organization, or linked to a repository. {% endnote %} @@ -49,11 +49,11 @@ When you enable GitHub Actions, GitHub installs a GitHub App on your repository. {% data variables.product.prodname_registry %} allows you to push and pull packages through the `GITHUB_TOKEN` available to a {% data variables.product.prodname_actions %} workflow. {% ifversion fpt or ghec %} -## About permissions and package access for {% data variables.product.prodname_container_registry %} +## About permissions and package access for {% data variables.product.prodname_ghcr_and_npm_registry %} -The {% data variables.product.prodname_container_registry %} (`ghcr.io`) allows users to create and administer containers as free-standing resources at the organization level. Containers can be owned by an organization or personal account and you can customize access to each of your containers separately from repository permissions. +The {% data variables.product.prodname_ghcr_and_npm_registry_full %} allows users to create and administer packages as free-standing resources at the organization level. Packages can be owned by an organization or personal account and you can customize access to each of your packages separately from repository permissions. -All workflows accessing the {% data variables.product.prodname_container_registry %} should use the `GITHUB_TOKEN` instead of a personal access token. For more information about security best practices, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)." +All workflows accessing the {% data variables.product.prodname_ghcr_and_npm_registry %} should use the `GITHUB_TOKEN` instead of a personal access token. For more information about security best practices, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)." ## Default permissions and access settings for containers modified through workflows @@ -484,9 +484,9 @@ Installing packages hosted by {% data variables.product.prodname_registry %} thr {% data reusables.package_registry.actions-configuration %} {% ifversion fpt or ghec %} -## Upgrading a workflow that accesses `ghcr.io` +## Upgrading a workflow that accesses a registry using a PAT -The {% data variables.product.prodname_container_registry %} supports the `GITHUB_TOKEN` for easy and secure authentication in your workflows. If your workflow is using a personal access token (PAT) to authenticate to `ghcr.io`, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. +The {% data variables.product.prodname_ghcr_and_npm_registry %} support the `GITHUB_TOKEN` for easy and secure authentication in your workflows. If your workflow is using a personal access token (PAT) to authenticate to the registry, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. For more information about the `GITHUB_TOKEN`, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)." @@ -504,9 +504,9 @@ Using the `GITHUB_TOKEN` instead of a PAT, which includes the `repo` scope, incr {% endnote %} 1. Optionally, using the "role" drop-down menu, select the default access level that you'd like the repository to have to your container image. ![Permission access levels to give to repositories](/assets/images/help/package-registry/repository-permission-options-for-package-access-through-actions.png) -1. Open your workflow file. On the line where you log in to `ghcr.io`, replace your PAT with {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. +1. Open your workflow file. On the line where you log in to the registry, replace your PAT with {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. -For example, this workflow publishes a Docker image using {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} to authenticate. +For example, this workflow publishes a Docker image to the {% data variables.product.prodname_container_registry %} and uses {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} to authenticate. ```yaml{:copy} name: Demo Push diff --git a/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md b/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md index 02708a404d..98ac905c0a 100644 --- a/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md +++ b/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md @@ -42,7 +42,9 @@ When installing or publishing a Docker image, the {% data variables.product.prod ## Authenticating to the {% data variables.product.prodname_container_registry %} -{% data reusables.package_registry.authenticate_with_pat_for_container_registry %} +{% ifversion fpt or ghec or ghes > 3.4 %} +To authenticate to the {% data variables.product.prodname_container_registry %} (`ghcr.io`) within a {% data variables.product.prodname_actions %} workflow, use the `GITHUB_TOKEN` for the best security and experience. {% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} +{% endif %} {% ifversion ghes %}Ensure that you replace `HOSTNAME` with {% data variables.product.product_location_enterprise %} hostname or IP address in the examples below.{% endif %} diff --git a/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md index 6714384e4d..8007cd2b6f 100644 --- a/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md +++ b/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -21,6 +21,8 @@ shortTitle: npm registry {% data reusables.package_registry.admins-can-configure-package-types %} +{% ifversion packages-npm-v2 %} +{% else %} ## Limits for published npm versions If you publish over 1,000 npm package versions to {% data variables.product.prodname_registry %}, you may see performance issues and timeouts occur during usage. @@ -28,12 +30,17 @@ If you publish over 1,000 npm package versions to {% data variables.product.prod In the future, to improve performance of the service, you won't be able to publish more than 1,000 versions of a package on {% data variables.product.prodname_dotcom %}. Any versions published before hitting this limit will still be readable. If you reach this limit, consider deleting package versions or contact Support for help. When this limit is enforced, our documentation will be updated with a way to work around this limit. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" or "[Contacting Support](/packages/learn-github-packages/about-github-packages#contacting-support)." +{% endif %} ## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} -{% data reusables.package_registry.authenticate-packages-github-token %} +{% ifversion packages-npm-v2 %} +{% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} + +You can also choose to give access permissions to packages independently for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_actions %}. For more information, see "[Ensuring Codespaces access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-codespaces-access-to-your-package) and [Ensuring workflow access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package)." +{% endif %} ### Authenticating with a personal access token @@ -94,12 +101,24 @@ $ npm login --scope=@OWNER --registry=https://HOSTNAME/_regist {% endnote %} -By default, {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the name field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. You can add a summary for the package listing page by including a *README.md* file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. +{% ifversion packages-npm-v2 %} +The {% data variables.product.prodname_registry %} registry stores npm packages within your organization or personal account, and allows you to associate a package with a repository. You can choose whether to inherit permissions from a repository, or set granular permissions independently of a repository. +{% endif %} + +By default, {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the name field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. If you're running [npm v8.5.3](https://github.com/npm/cli/releases/tag/v8.5.3) or later, you can add a summary for the package listing page by including a *README.md* file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. You can publish multiple packages to the same {% data variables.product.prodname_dotcom %} repository by including a `URL` field in the *package.json* file. For more information, see "[Publishing multiple packages to the same repository](#publishing-multiple-packages-to-the-same-repository)." +{% ifversion fpt or ghec %} +When a package is published, it isn't automatically linked to a repository. You can however choose to link your published package to a repository using the user interface or command line. For more information, see "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)." +{% endif %} + You can set up the scope mapping for your project using either a local *.npmrc* file in the project or using the `publishConfig` option in the *package.json*. {% data variables.product.prodname_registry %} only supports scoped npm packages. Scoped packages have names with the format of `@owner/name`. Scoped packages always begin with an `@` symbol. You may need to update the name in your *package.json* to use the scoped name. For example, `"name": "@codertocat/hello-world-npm"`. +{% ifversion packages-npm-v2 %} +When you first publish a package, the default visibility is private. When a package is linked to repository, the package visibility is dependent on the repository's visibility. To change the visibility or set access permissions, see "[Configuring a package's access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." +{% endif %} + {% data reusables.package_registry.viewing-packages %} ### Publishing a package using a local *.npmrc* file diff --git a/translations/zh-CN/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/translations/zh-CN/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index f059be99c2..011aa305ca 100644 --- a/translations/zh-CN/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/translations/zh-CN/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -46,7 +46,7 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} 4. 在 "Custom domain（自定义域）"下，输入自定义域，然后单击 **Save（保存）**。 If you are publishing your site from a branch, this will create a commit that adds a `CNAME` file to the root of your source branch. If you are publishing your site with a custom {% data variables.product.prodname_actions %} workflow , no `CNAME` file is created. For more information about your publishing source, see "[Configuring a publishing source for your GitHub Pages site](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." ![保存自定义域按钮](/assets/images/help/pages/save-custom-subdomain.png) -5. 导航到您的 DNS 提供程序并创建 `CNAME` 记录，使子域指向您站点的默认域。 例如，如果要对您的用户站点使用子域 `www.example.com`，您可以创建 `CNAME` 记录，使 `www.example.com` 指向 `.github.io`。 如果要对您的组织站点使用子域 `www.anotherexample.com`，您可以创建 `CNAME` 记录，使 `www.anotherexample.com` 指向 `.github.io`。 `CNAME` 记录应该始终指向 `.github.io` 或 `.github.io`，不包括仓库名称。 {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} +5. 导航到您的 DNS 提供程序并创建 `CNAME` 记录，使子域指向您站点的默认域。 例如，如果要对您的用户站点使用子域 `www.example.com`，您可以创建 `CNAME` 记录，使 `www.example.com` 指向 `.github.io`。 如果要对您的组织站点使用子域 `another.example.com`，您可以创建 `CNAME` 记录，使 `another.example.com` 指向 `.github.io`。 `CNAME` 记录应该始终指向 `.github.io` 或 `.github.io`，不包括仓库名称。 {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} {% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %} {% data reusables.command_line.open_the_multi_os_terminal %} diff --git a/translations/zh-CN/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md b/translations/zh-CN/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md deleted file mode 100644 index 428105234f..0000000000 --- a/translations/zh-CN/content/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: 使用主题选择器将主题添加到 GitHub Pages 站点 -intro: '您可以将主题添加到 {% data variables.product.prodname_pages %} 站点，以自定义站点的外观。' -redirect_from: - - /articles/creating-a-github-pages-site-with-the-jekyll-theme-chooser - - /articles/adding-a-jekyll-theme-to-your-github-pages-site-with-the-jekyll-theme-chooser - - /articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser - - /github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser -product: '{% data reusables.gated-features.pages %}' -versions: - fpt: '*' - ghec: '*' -topics: - - Pages -shortTitle: 将主题添加到 Pages 站点 -permissions: 'People with admin permissions for a repository can use the theme chooser to add a theme to a {% data variables.product.prodname_pages %} site.' ---- - -## 关于主题选择器 - -{% ifversion pages-custom-workflow %} - -{% note %} - -**Note**: The Jekyll theme chooser is not supported for {% data variables.product.prodname_pages %} sites that are published with a custom {% data variables.product.prodname_actions %} workflow. If you build your site with Jekyll and publish your site with a custom {% data variables.product.prodname_actions %} workflow, you can add a theme by editing the `_config.yml` file. For more information, see "[Adding a theme to your GitHub Pages site using Jekyll](/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll)." - -{% endnote %} - -{% endif %} - -主题选择器可用于向仓库添加 Jekyll 主题。 有关 Jekyll 的更多信息，请参阅“[关于 {% data variables.product.prodname_pages %} 和 Jekyll](/articles/about-github-pages-and-jekyll)”。 - -主题选择器如何工作取决于您的资源库是公共的还是私有的。 - - 如果已为仓库启用 {% data variables.product.prodname_pages %}，主题选择器会将主题添加到当前发布源。 - - 如果您的仓库是公共的，并且已对仓库禁用 {% data variables.product.prodname_pages %}，则使用主题选择器将启用 {% data variables.product.prodname_pages %} 并将默认分支配置为发布源。 - - 如果您的仓库是公共的，并且已对仓库禁用 {% data variables.product.prodname_pages %}，则必须先通过配置发布源来启用 {% data variables.product.prodname_pages %}，然后才可使用主题选择器。 - -有关发布源的更多信息，请参阅“[关于 {% data variables.product.prodname_pages %}](/articles/about-github-pages#publishing-sources-for-github-pages-sites)”。 - -如果以前曾手动向仓库添加 Jekyll 主题，则这些文件在使用主题选择器后也可能应用。 为避免冲突，请先删除所有手动添加的主题文件夹和文件，然后再使用主题选择器。 更多信息请参阅“[使用 Jekyll 添加主题到 {% data variables.product.prodname_pages %} 站点](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)”。 - -## 使用主题选择器添加主题 - -{% data reusables.pages.navigate-site-repo %} -{% data reusables.repositories.sidebar-settings %} -{% data reusables.pages.sidebar-pages %} -3. 在“{% data variables.product.prodname_pages %}”下，单击 **Choose a theme（选择主题）**或 **Change theme（更改主题）**。 ![选择主题按钮](/assets/images/help/pages/choose-a-theme.png) -4. 在页面顶部单击所需的主题，然后单击 **Select theme（选择主题）**。 ![主题选项和选择主题按钮](/assets/images/help/pages/select-theme.png) -5. 系统可能会提示您编辑站点的 *README.md* 文件。 - - 要稍后编辑该文件，请单击 **Cancel（取消）**。 ![编辑文件时取消链接](/assets/images/help/pages/cancel-edit.png) - - 要现在编辑文件，请参阅“[编辑文件](/repositories/working-with-files/managing-files/editing-files)”。 - -您选择的主题将自动应用到仓库中的 Markdown 文件。 要将主题应用到仓库中的 HTML 文件，您需要添加 YAML 前页，以指定每个文件的布局。 更多信息请参阅 Jekyll 网站上的“[前页](https://jekyllrb.com/docs/front-matter/)”。 - -## 延伸阅读 - -- Jekyll 网站上的[主题](https://jekyllrb.com/docs/themes/) diff --git a/translations/zh-CN/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md b/translations/zh-CN/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md index a86fd08e5e..f23f188829 100644 --- a/translations/zh-CN/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md +++ b/translations/zh-CN/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md @@ -59,9 +59,9 @@ shortTitle: 创建 GitHub Pages 站点 您可以通过创建更多新文件向网站添加更多页面。 每个文件都将在网站上与发布源相同的目录结构中。 例如，如果项目网站的发布源是 `gh-pages` 分支，并且您在 `gh-pages` 分支上创建了名为 `/about/contact-us.md` 的新文件，该文件将在 {% ifversion fpt or ghec %}`https://.github.io//{% else %}`http(s):///pages///{% endif %}about/contact-us.html` 下。 -您还可以添加主题以自定义网站的外观。 更多信息请参阅{% ifversion fpt or ghec %}“[使用主题选择器添加主题到 {% data variables.product.prodname_pages %} 站点](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser){% else %}”[使用 Jekyll 添加主题到 {% data variables.product.prodname_pages %} 站点](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll){% endif %}”。 +您还可以添加主题以自定义网站的外观。 For more information, see "[Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)". -要更多地自定义您的站点，您可以使用 Jekyl - 内置 {% data variables.product.prodname_pages %} 支持的静态站点生成器。 更多信息请参阅“[关于 {% data variables.product.prodname_pages %} 和 Jekyll](/articles/about-github-pages-and-jekyll)”。 +要更多地自定义您的站点，您可以使用 Jekyl - 内置 {% data variables.product.prodname_pages %} 支持的静态站点生成器。 For more information, see "[About {% data variables.product.prodname_pages %} and Jekyll](/articles/about-github-pages-and-jekyll)". ## 延伸阅读 diff --git a/translations/zh-CN/content/pages/getting-started-with-github-pages/index.md b/translations/zh-CN/content/pages/getting-started-with-github-pages/index.md index 3453f678b9..07fea23be9 100644 --- a/translations/zh-CN/content/pages/getting-started-with-github-pages/index.md +++ b/translations/zh-CN/content/pages/getting-started-with-github-pages/index.md @@ -17,7 +17,6 @@ topics: children: - /about-github-pages - /creating-a-github-pages-site - - /adding-a-theme-to-your-github-pages-site-with-the-theme-chooser - /configuring-a-publishing-source-for-your-github-pages-site - /changing-the-visibility-of-your-github-pages-site - /creating-a-custom-404-page-for-your-github-pages-site diff --git a/translations/zh-CN/content/pages/index.md b/translations/zh-CN/content/pages/index.md index 70438f474b..960da5849a 100644 --- a/translations/zh-CN/content/pages/index.md +++ b/translations/zh-CN/content/pages/index.md @@ -12,7 +12,6 @@ featuredLinks: - '{% ifversion fpt or ghec %}/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site{% endif %}' - '{% ifversion ghes or ghae %}/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll{% endif %}' - '{% ifversion ghec %}/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site{% endif %}' - - '{% ifversion fpt %}/pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser{% endif %}' - '{% ifversion ghes or ghae %}/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll{% endif %}' popular: - '{% ifversion fpt or ghec %}/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages{% endif %}' diff --git a/translations/zh-CN/content/pages/quickstart.md b/translations/zh-CN/content/pages/quickstart.md index 33bd9f080a..f140259365 100644 --- a/translations/zh-CN/content/pages/quickstart.md +++ b/translations/zh-CN/content/pages/quickstart.md @@ -26,11 +26,12 @@ product: '{% data reusables.gated-features.pages %}' 1. 输入 `username.github.io` 作为存储库名称。 将 `username` 替换为您的 {% data variables.product.prodname_dotcom %} 用户名。 例如，如果您的用户名是 `octocat`，则存储库名称应为 `octocat.github.io`。 ![存储库名称字段](/assets/images/help/pages/create-repository-name-pages.png) {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -1. 单击 **Choose a theme（选择主题）**。 ![选择主题按钮](/assets/images/help/pages/choose-theme.png) -2. 主题选择器将打开。 浏览可用的主题，然后单击 **Select theme（选择主题）**以选择主题。 以后更改主题很容易，因此，如果您不确定，请暂时选择一个。 ![主题选项和选择主题按钮](/assets/images/help/pages/select-theme.png) -3. 选择主题后，存储库的 `README.md` 文件将在文件编辑器中打开。 `README.md` 文件是您将为网站编写内容的位置。 您可以编辑文件或暂时保留默认内容。 -4. 编辑完文件后，单击 **Commit changes（提交更改）**。 -5. 访问 `username.github.io` 以查看您的新网站。 **注：**对站点的更改在推送到 {% data variables.product.product_name %} 后，最长可能需要 20 分钟才会发布。 +1. Under "Build and deployment", under "Source", select **Deploy from a branch**. +1. Under "Build and deployment", under "Branch", use the **None** or **Branch** drop-down menu and select a publishing source. + + ![用于选择发布源的下拉菜单](/assets/images/help/pages/publishing-source-drop-down.png) +1. Optionally, open the `README.md` file of your repository. `README.md` 文件是您将为网站编写内容的位置。 您可以编辑文件或暂时保留默认内容。 +1. 访问 `username.github.io` 以查看您的新网站。 **注：**对站点的更改在推送到 {% data variables.product.product_name %} 后，最长可能需要 10 分钟才会发布。 ## 更改标题和说明 diff --git a/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md b/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md index e777c04c96..7ca4698585 100644 --- a/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md +++ b/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md @@ -75,9 +75,9 @@ kramdown: {% data reusables.pages.add-jekyll-theme %} 更多信息请参阅 Jekyll 文档中的“[主题](https://jekyllrb.com/docs/themes/)”。 {% ifversion fpt or ghec %} -您可以在 {% data variables.product.prodname_dotcom %} 上添加支持的主题到站点。 更多信息请参阅 {% data variables.product.prodname_pages %} 站点上“[支持的主题](https://pages.github.com/themes/)"和"[使用主题选择器添加主题到 {% data variables.product.prodname_pages %} 站点](/articles/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser)”。 +您可以在 {% data variables.product.prodname_dotcom %} 上添加支持的主题到站点。 For more information, see "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site and [Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll"](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll). -要使用 {% data variables.product.prodname_dotcom %} 上托管的任何其他开源 Jekyll 主题，您可以手动添加主题。{% else %} 您可以手动添加主题到站点。{% endif %} 更多信息请参阅{% ifversion fpt or ghec %} [{% data variables.product.prodname_dotcom %}](https://github.com/topics/jekyll-theme) 上托管的主题和 {% else %}{% data variables.product.prodname_pages %} 站点上 "[支持的主题](https://pages.github.com/themes/)"和{% endif %}“[使用 Jekyll 添加主题到 {% data variables.product.prodname_pages %} 站点](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)”。 +To use any other open source Jekyll theme hosted on {% data variables.product.prodname_dotcom %}, you can add the theme manually.{% else %} You can add a theme to your site manually.{% endif %} For more information, see{% ifversion fpt or ghec %} [themes hosted on {% data variables.product.prodname_dotcom %}](https://github.com/topics/jekyll-theme) and{% else %} "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site and{% endif %} "[Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)". 您可以通过编辑主题文件来覆盖任何主题的默认值。 更多信息请参阅您的主题文档和 Jekyll 文档中的“[覆盖主题默认值](https://jekyllrb.com/docs/themes/#overriding-theme-defaults)“。 diff --git a/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md b/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md index 9e84172aa2..8579be29e2 100644 --- a/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md +++ b/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md @@ -26,7 +26,7 @@ shortTitle: Jekyll build errors for Pages {% note %} -**Note:** It can take up to 20 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}. +**Note:** It can take up to 10 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}. {% endnote %} diff --git a/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md b/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md index 88f387e8f1..e866b334d6 100644 --- a/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md +++ b/translations/zh-CN/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md @@ -6,6 +6,7 @@ redirect_from: - /articles/adding-a-jekyll-theme-to-your-github-pages-site - /articles/adding-a-theme-to-your-github-pages-site-using-jekyll - /github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-using-jekyll + - /pages/getting-started-with-github-pages/adding-a-theme-to-your-github-pages-site-with-the-theme-chooser product: '{% data reusables.gated-features.pages %}' versions: fpt: '*' diff --git a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md index 8698f67c7b..7f57608d45 100644 --- a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md +++ b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md @@ -27,7 +27,7 @@ redirect_from: 1. 在“Pull Requests（拉取请求）”列表中，单击要添加到合并队列的拉取请求。 1. 单击 **Merge when ready（准备就绪时合并）**将拉取请求添加到合并队列中。 或者，如果您是管理员，则可以： - - 如果分支保护设置允许，可直接合并请求，方法是选中 **Merge without waiting for requirements to be met (administrators only)（合并，而无需等待满足要求 [仅限管理员]）**，并遵循标准流程。 ![合并队列选项](/assets/images/help/pull_requests/merge-queue-options.png) + - Directly merge the pull request by checking **Merge without waiting for requirements to be met ({% ifversion bypass-branch-protections %}bypass branch protections{% else %}administrators only{% endif %})**, if allowed by branch protection settings, and follow the standard flow. ![合并队列选项](/assets/images/help/pull_requests/merge-queue-options.png) {% tip %} diff --git a/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md b/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md index 2301006a77..c6cc4aba8d 100644 --- a/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md +++ b/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md @@ -32,7 +32,10 @@ topics: 默认情况下，每个分支保护规则都禁止强制推送到匹配的分支并阻止删除匹配的分支。 您可以选择禁用这些限制并启用其他分支保护设置。 -默认情况下，分支保护规则的限制不适用于对仓库具有管理员权限的人。 您也可以选择包括管理员。 +{% ifversion bypass-branch-protections %} +By default, the restrictions of a branch protection rule don't apply to people with admin permissions to the repository or custom roles with the "bypass branch protections" permission. You can optionally apply the restrictions to administrators and roles with the "bypass branch protections" permission, too. For more information, see "[Managing custom repository roles for an organization](/en/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". +{% else %} +默认情况下，分支保护规则的限制不适用于对仓库具有管理员权限的人。 You can optionally choose to include administrators, too.{% endif %} {% data reusables.repositories.branch-rules-example %} 关于分支名称模式的更多信息，请参阅“[管理分支保护规则](/github/administering-a-repository/managing-a-branch-protection-rule)”。 @@ -52,7 +55,7 @@ topics: {%- ifversion required-deployments %} - [要求部署在合并之前成功](#require-deployments-to-succeed-before-merging) {%- endif %} -- [包括管理员](#include-administrators) +{% ifversion bypass-branch-protections %}- [Do not allow bypassing the above settings](#do-not-allow-bypassing-the-above-settings){% else %}- [Include administrators](#include-administrators){% endif %} - [限制谁可以推送到匹配的分支](#restrict-who-can-push-to-matching-branches) - [允许强制推送](#allow-force-pushes) - [允许删除](#allow-deletions) @@ -124,7 +127,7 @@ remote: error: Changes have been requested. {% endnote %} -如果提交已进行签名和验证，则始终可以将本地提交推送到分支。 {% ifversion fpt or ghec %}您也可以使用 {% data variables.product.product_name %} 上的拉请求将已经签名和验证的提交合并到分支。 但除非您是拉取请求的作者，否则不能将拉取请求压缩并合并到 {% data variables.product.product_name %} 。{% else %}但不能将拉取请求合并到 {% data variables.product.product_name %} 上的分支。{% endif %} 您可以在本地{% ifversion fpt or ghec %}压缩和{% endif %}合并拉取请求。 更多信息请参阅“[在本地检出拉取请求](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally)”。 +如果提交已进行签名和验证，则始终可以将本地提交推送到分支。 {% ifversion fpt or ghec %}您也可以使用 {% data variables.product.product_name %} 上的拉请求将已经签名和验证的提交合并到分支。 但除非您是拉取请求的作者，否则不能将拉取请求压缩并合并到 {% data variables.product.product_name %} 。{% else %}但不能将拉取请求合并到 {% data variables.product.product_name %} 上的分支。{% endif %} 您可以在本地 {% ifversion fpt or ghec %}压缩和{% endif %}合并拉取请求。 更多信息请参阅“[在本地检出拉取请求](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally)”。 {% ifversion fpt or ghec %} 有关合并方法的更多信息，请参阅“[关于 {% data variables.product.prodname_dotcom %} 上的合并方法](/github/administering-a-repository/about-merge-methods-on-github)”。{% endif %} @@ -149,9 +152,15 @@ remote: error: Changes have been requested. 您可以要求先将更改成功部署到特定环境，然后才能合并分支。 例如，可以使用此规则确保在更改合并到默认分支之前，将更改成功部署到过渡环境。 -### 包括管理员 +{% ifversion bypass-branch-protections %}### Do not allow bypassing the above settings{% else %} +### Include administrators{% endif %} -默认情况下，受保护分支规则不适用于对仓库具有管理员权限的人。 您可以启用此设置将管理员纳入受保护分支规则。 +{% ifversion bypass-branch-protections %} +By default, the restrictions of a branch protection rule do not apply to people with admin permissions to the repository or custom roles with the "bypass branch protections" permission in a repository. + +You can enable this setting to apply the restrictions to admins and roles with the "bypass branch protections" permission, too. For more information, see "[Managing custom repository roles for an organization](/en/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". +{% else %} +默认情况下，受保护分支规则不适用于对仓库具有管理员权限的人。 You can enable this setting to include administrators in your protected branch rules.{% endif %} ### 限制谁可以推送到匹配的分支 diff --git a/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md b/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md index b372bcf39a..796bcbeb76 100644 --- a/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md +++ b/translations/zh-CN/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md @@ -84,7 +84,7 @@ shortTitle: 分支保护规则 {%- ifversion required-deployments %} 1. （可选）要选择在合并之前必须将更改成功部署到哪些环境，请选择 **Require deployments to succeed before merging（在合并之前需要部署成功）**，然后选择环境。 ![需要成功部署选项](/assets/images/help/repository/require-successful-deployment.png) {%- endif %} -1. （可选）选择 **Apply the rules above to administrators（将上述规则应用于管理员）**。 ![将上述规则应用于管理员复选框](/assets/images/help/repository/include-admins-protected-branches.png) +1. Optionally, select {% ifversion bypass-branch-protections %}**Do not allow bypassing the above settings**. ![Do not allow bypassing the above settings checkbox](/assets/images/help/repository/do-not-allow-bypassing-the-above-settings.png){% else %}**Apply the rules above to administrators**. ![Apply the rules above to administrators checkbox](/assets/images/help/repository/include-admins-protected-branches.png){% endif %} 1. （可选）{% ifversion fpt or ghec %}如果仓库由组织拥有，可使用 {% data variables.product.prodname_team %} 或 {% data variables.product.prodname_ghe_cloud %}{% endif %} 启用分支限制。 - 选择 **Restrict who can push to matching branches（限制谁可以推送到匹配分支）**。 ![Branch restriction checkbox](/assets/images/help/repository/restrict-branch.png){% ifversion restrict-pushes-create-branch %} - （可选）要同时限制创建匹配分支，请选择 **Restrict pushes that create matching branches（限制创建匹配分支的推送）**。 ![Branch creation restriction checkbox](/assets/images/help/repository/restrict-branch-create.png){% endif %} diff --git a/translations/zh-CN/content/rest/deployments/deployments.md b/translations/zh-CN/content/rest/deployments/deployments.md index d129c2157d..2672ba8287 100644 --- a/translations/zh-CN/content/rest/deployments/deployments.md +++ b/translations/zh-CN/content/rest/deployments/deployments.md @@ -19,7 +19,7 @@ miniTocMaxHeadingLevel: 3 部署状态还可以包含可选的 `description` 和 `log_url`，强烈建议使用它们，因为它们使部署状态更有用。 `log_url` 是部署输出的完整 URL，`description` 是关于部署过程中所发生情况的高级摘要。 -在创建新的部署和部署状态时，GitHub 将分发 `deployment` 和 `deployment_status` 事件。 这些事件允许第三方集成接收对部署请求的响应，并在取得进展时更新部署的状态。 +在创建新的部署和部署状态时，GitHub 将分发 `deployment` 和 `deployment_status` 事件。 These events allow third-party integrations to receive and respond to deployment requests, and update the status of a deployment as progress is made. 下面是一个说明这些交互的工作方式的简单序列图。 diff --git a/translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md b/translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md index 2c60bf90f8..fa8cc66f45 100644 --- a/translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md +++ b/translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md @@ -1,6 +1,6 @@ --- -title: Getting started with the Checks API -intro: 'The Check Runs API enables you to build GitHub Apps that run powerful checks against code changes in a repository. You can create apps that perform continuous integration, code linting, or code scanning services and provide detailed feedback on commits.' +title: 检查 API 入门指南 +intro: 检查运行 API 使您能够构建 GitHub 应用程序，以针对仓库中的代码更改运行强大的检查。 您可以创建应用程序以执行持续集成 、代码分析或代码扫描服务，并提供有关提交的详细反馈。 versions: fpt: '*' ghes: '*' @@ -8,58 +8,58 @@ versions: ghec: '*' topics: - API -shortTitle: Get started - Checks API +shortTitle: 开始 - 检查 API --- -## Overview +## 概览 -Rather than binary pass/fail build statuses, GitHub Apps can report rich statuses, annotate lines of code with detailed information, and re-run tests. The Checks API functionality is available exclusively to your GitHub Apps. +GitHub 应用程序可以报告丰富的状态信息、提供详细的代码行注释以及重新运行测试，而不是提供二进制的通过/失败构建状态。 Checks API 功能专用于您的 GitHub 应用程序。 -For an example of how to use the Checks API with a {% data variables.product.prodname_github_app %}, see "[Creating CI tests with the Checks API](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/)." +关于如何将检查 API 用于 {% data variables.product.prodname_github_app %} 的示例，请参阅“[使用检查 API 创建 CI 测试](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/)”。 -## About check suites +## 关于检查套件 -When someone pushes code to a repository, GitHub creates a check suite for the last commit. A check suite is a collection of the [check runs](/rest/reference/checks#check-runs) created by a single GitHub App for a specific commit. Check suites summarize the status and conclusion of the check runs that a suite includes. +当有人向仓库推送代码时，GitHub 会为最新的提交创建一个检查套件。 检查套件是单个 GitHub 应用程序为特定提交而创建的[检查运行](/rest/reference/checks#check-runs)的集合。 检查套件汇总了套件所含检查运行的状态和结论。 -![Check suites workflow](/assets/images/check_suites.png) +![检查套件工作流程](/assets/images/check_suites.png) -The check suite reports the highest priority check run `conclusion` in the check suite's `conclusion`. For example, if three check runs have conclusions of `timed_out`, `success`, and `neutral` the check suite conclusion will be `timed_out`. +检查套件在其 `conclusion` 中报告优先级最高的检查运行 `conclusion` 。 例如，如果三个检查运行的结论分别为 `timed_out`、`success` 和 `neutral`，则检查套件的结论将为 `timed_out`。 -By default, GitHub creates a check suite automatically when code is pushed to the repository. This default flow sends the `check_suite` event (with `requested` action) to all GitHub App's that have the `checks:write` permission. When your GitHub App receives the `check_suite` event, it can create new check runs for the latest commit. GitHub automatically adds new check runs to the correct [check suite](/rest/reference/checks#check-suites) based on the check run's repository and SHA. +默认情况下，当代码被推送到仓库时，GitHub 会自动创建一个检查套件。 此默认流程会将 `check_suite` 事件（使用 `requested` 操作）发送到具有 `checks:write` 权限的所有 GitHub 应用程序。 当您的 GitHub 应用程序收到 `check_suite` 事件时，它可以为最新的提交创建新的检查运行。 GitHub 根据检查运行的仓库和 SHA，自动将新的检查运行添加到适当的[检查套件](/rest/reference/checks#check-suites)中。 -If you don't want to use the default automatic flow, you can control when you create check suites. To change the default settings for the creation of check suites, use the [Update repository preferences for check suites](/rest/reference/checks#update-repository-preferences-for-check-suites) endpoint. All changes to the automatic flow settings are recorded in the audit log for the repository. If you have disabled the automatic flow, you can create a check suite using the [Create a check suite](/rest/reference/checks#create-a-check-suite) endpoint. You should continue to use the [Create a check run](/rest/reference/checks#create-a-check-run) endpoint to provide feedback on a commit. +如果您不想使用默认的自动流程，您可以控制何时创建检查套件。 要更改用于创建检查套件的默认设置，请使用[更新检查套件的仓库首选项](/rest/reference/checks#update-repository-preferences-for-check-suites)端点。 对自动流程设置的所有更改都被记录在仓库的审核日志中。 如果您禁用了自动流程，您可以使用[创建检查套件](/rest/reference/checks#create-a-check-suite)端点来创建一个检查套件。 您应该继续使用[创建检查运行](/rest/reference/checks#create-a-check-run)端点来提供对提交的反馈。 {% data reusables.apps.checks-availability %} -To use the check suites API, the GitHub App must have the `checks:write` permission and can also subscribe to the [check_suite](/webhooks/event-payloads/#check_suite) webhook. +要使用检查套件 API，GitHub 应用程序必须具有 `checks:write` 权限并且可以订阅 [check_suite](/webhooks/event-payloads/#check_suite) web 挂钩。 {% data reusables.shortdesc.authenticating_github_app %} -## About check runs +## 关于检查运行 -A check run is an individual test that is part of a check suite. Each run includes a status and conclusion. +检查运行是检查套件中的单个测试。 每个运行都包含状态和结论。 -![Check runs workflow](/assets/images/check_runs.png) +![检查运行工作流程](/assets/images/check_runs.png) -If a check run is in a incomplete state for more than 14 days, then the check run's `conclusion` becomes `stale` and appears on {% data variables.product.prodname_dotcom %} as stale with {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Only {% data variables.product.prodname_dotcom %} can mark check runs as `stale`. For more information about possible conclusions of a check run, see the [`conclusion` parameter](/rest/reference/checks#create-a-check-run--parameters). +If a check run is in an incomplete state for more than 14 days, then the check run's `conclusion` becomes `stale` and appears on {% data variables.product.prodname_dotcom %} as stale with {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. 只有 {% data variables.product.prodname_dotcom %} 可以将检查运行标记为 `stale`。 有关检查运行之可能结论的更多信息，请参阅 [`conclusion` 参数](/rest/reference/checks#create-a-check-run--parameters)。 -As soon as you receive the [`check_suite`](/webhooks/event-payloads/#check_suite) webhook, you can create the check run, even if the check is not complete. You can update the `status` of the check run as it completes with the values `queued`, `in_progress`, or `completed`, and you can update the `output` as more details become available. A check run can contain timestamps, a link to more details on your external site, detailed annotations for specific lines of code, and information about the analysis performed. +一旦收到 [`check_suite`](/webhooks/event-payloads/#check_suite) web 挂钩，您即可创建检查运行，即使检查尚未完成。 您可以在检查运行完成时使用值 `queued`、`in_progress` 或 `completed` 来更新其 `status`， 并且可以在更多详细信息可用时更新 `output`。 检查运行可以包含时间戳、指向外部站点上更多详细信息的链接、特定代码行的详细注释以及有关所执行分析的信息。 -![Check run annotation](/assets/images/check_run_annotations.png) +![检查运行注释](/assets/images/check_run_annotations.png) -A check can also be manually re-run in the GitHub UI. See "[About status checks](/articles/about-status-checks#checks)" for more details. When this occurs, the GitHub App that created the check run will receive the [`check_run`](/webhooks/event-payloads/#check_run) webhook requesting a new check run. If you create a check run without creating a check suite, GitHub creates the check suite for you automatically. +还可以在 GitHub UI 中手动重新运行检查。 更多信息请参阅“[关于状态检查](/articles/about-status-checks#checks)”。 发生这种情况时，创建检查运行的 GitHub 应用程序将收到请求新检查运行的 [`check_run`](/webhooks/event-payloads/#check_run) web 挂钩。 如果您创建检查运行时没有创建检查套件，GitHub 将自动为您创建检查套件。 {% data reusables.apps.checks-availability %} -To use the Check Runs API, the GitHub App must have the `checks:write` permission and can also subscribe to the [check_run](/webhooks/event-payloads#check_run) webhook. +要使用检查运行 API，GitHub 应用程序必须具有 `checks:write` 权限并且可以订阅 [ccheck_run](/webhooks/event-payloads#check_run) web 挂钩。 -## Check runs and requested actions +## 检查运行和请求的操作 -When you set up a check run with requested actions (not to be confused with {% data variables.product.prodname_actions %}), you can display a button in the pull request view on {% data variables.product.prodname_dotcom %} that allows people to request your {% data variables.product.prodname_github_app %} to perform additional tasks. +在设置带有请求操作（不要与 {% data variables.product.prodname_actions %} 混淆）的检查运行时，您可以在 {% data variables.product.prodname_dotcom %} 上的拉取请求视图中显示一个按钮，以允许用户请求您的 {% data variables.product.prodname_github_app %} 执行额外任务。 -For example, a code linting app could use requested actions to display a button in a pull request to automatically fix detected syntax errors. +例如，代码分析应用程序可以使用请求的操作在拉取请求中显示一个按钮，以自动修复检测到的语法错误。 -To create a button that can request additional actions from your app, use the [`actions` object](/rest/reference/checks#create-a-check-run--parameters) when you [Create a check run](/rest/reference/checks/#create-a-check-run). For example, the `actions` object below displays a button in a pull request with the label "Fix this." The button appears after the check run completes. +要创建可从您的程序请求额外操作的按钮，请在[创建检查运行](/rest/reference/checks/#create-a-check-run)时使用 [`actions` 对象](/rest/reference/checks#create-a-check-run--parameters)。 例如，下面的 `actions` 对象在拉取请求中显示一个按钮，标签为“Fix this（修复此问题）”。 该按钮在检查运行完成后显示。 ```json "actions": [{ @@ -69,14 +69,14 @@ To create a button that can request additional actions from your app, use the [` }] ``` - ![Check run requested action button](/assets/images/github-apps/github_apps_checks_fix_this_button.png) + ![检查运行请求操作按钮](/assets/images/github-apps/github_apps_checks_fix_this_button.png) -When a user clicks the button, {% data variables.product.prodname_dotcom %} sends the [`check_run.requested_action` webhook](/webhooks/event-payloads/#check_run) to your app. When your app receives a `check_run.requested_action` webhook event, it can look for the `requested_action.identifier` key in the webhook payload to determine which button was clicked and perform the requested task. +当用户单击该按钮时，{% data variables.product.prodname_dotcom %} 会将 [`check_run.requested_action` web 挂钩](/webhooks/event-payloads/#check_run)发送到您的应用程序。 当您的应用程序收到 `check_run.requested_action` web 挂钩事件时，它可以在 web 挂钩有效负载中查找 `requested_action.identifier` 键，以确定单击了哪个按钮，并执行请求的任务。 -For a detailed example of how to set up requested actions with the Checks API, see "[Creating CI tests with the Checks API](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/#part-2-creating-the-octo-rubocop-ci-test)." +关于如何使用检查 API 设置请求操作的详细示例，请参阅“[使用检查 API 创建 CI 测试](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/#part-2-creating-the-octo-rubocop-ci-test)”。 {% ifversion fpt or ghec %} -## Retention of checks data +## 检查数据的保留 {% data reusables.pull_requests.retention-checks-data %} {% endif %} diff --git a/translations/zh-CN/content/rest/guides/getting-started-with-the-rest-api.md b/translations/zh-CN/content/rest/guides/getting-started-with-the-rest-api.md index 43842732b4..5a497e6737 100644 --- a/translations/zh-CN/content/rest/guides/getting-started-with-the-rest-api.md +++ b/translations/zh-CN/content/rest/guides/getting-started-with-the-rest-api.md @@ -1,9 +1,6 @@ --- title: REST API 入门指南 -intro: 从身份验证和一些端点示例开始，了解使用 REST API 的基础。 -redirect_from: - - /guides/getting-started - - /v3/guides/getting-started +intro: 'Learn how to use the {% data variables.product.prodname_dotcom %} REST API.' versions: fpt: '*' ghes: '*' @@ -11,418 +8,754 @@ versions: ghec: '*' topics: - API -shortTitle: 开始 - REST API +shortTitle: Using the API +miniTocMaxHeadingLevel: 3 --- +## About the {% data variables.product.prodname_dotcom %} REST API -让我们逐步了解在处理一些日常用例时涉及的核心 API 概念。 +This article describes how to use the {% data variables.product.prodname_dotcom %} REST API using {% data variables.product.prodname_cli %}, JavaScript, or cURL. For a quickstart guide, see "[Quickstart for GitHub REST API](/rest/quickstart)." -{% data reusables.rest-api.dotcom-only-guide-note %} +When you make a request to the REST API, you will specify an HTTP method and a path. Additionally, you might also specify request headers and path, query, or body parameters. The API will return the response status code, response headers, and potentially a response body. -## 概览 +The REST API reference documentation describes the HTTP method, path, and parameters for every operation. It also displays example requests and responses for each operation. For more information, see the [REST reference documentation](/rest). -大多数应用程序将使用您选择的语言 中现有的 [wrapper 库][wrappers]，但您必须先熟悉基础 API HTTP 方法。 +## Making a request -没有比使用 [cURL][curl] 更容易的入手方式了。{% ifversion fpt or ghec %} 如果您使用其他客户的，请注意，您需要在请求中发送有效的 [用户代理标头](/rest/overview/resources-in-the-rest-api#user-agent-required)。{% endif %} +To make a request, first find the HTTP method and the path for the operation that you want to use. For example, the "Get Octocat" operation uses the `GET` method and the `/octocat` path. For the full reference documentation for this operation, see "[Get Octocat](/rest/meta#get-octocat)." -### Hello World +{% cli %} -让我们先测试设置。 打开命令提示符并输入以下命令： +{% note %} + +**Note**: You must install {% data variables.product.prodname_cli %} in order to use the commands in the {% data variables.product.prodname_cli %} examples. For installation instructions, see the [{% data variables.product.prodname_cli %} repository](https://github.com/cli/cli#installation). + +{% endnote %} + +If you are not already authenticated to {% data variables.product.prodname_cli %}, you must use the `gh auth login` subcommand to authenticate before making any requests. For more information, see "[Authenticating](#authenticating)." + +To make a request using {% data variables.product.prodname_cli %}, use the `api` subcommand along with the path. Use the `--method` or `-X` flag to specify the method. ```shell -$ curl https://api.github.com/zen - -> Keep it logically awesome. +gh api /octocat --method GET ``` -响应将是我们设计理念中的随机选择。 +{% endcli %} -Next, let's `GET` [Chris Wanstrath's][defunkt github] [GitHub profile][users api]: +{% javascript %} + +{% note %} + +**Note**: You must install and import `octokit` in order to use the Octokit.js library used in the JavaScript examples. For more information, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). + +{% endnote %} + +To make a request using JavaScript, you can use Octokit.js. For more information, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). + +First, create an instance of `Octokit`.{% ifversion ghes or ghae %} Set the base URL to `{% data variables.product.api_url_code %}`. Replace `[hostname]` with the name of {% data variables.product.product_location %}.{% endif %} + +```javascript +const octokit = new Octokit({ {% ifversion ghes or ghae %} + baseUrl: "{% data variables.product.api_url_code %}", +{% endif %}}); +``` + +Then, use the `request` method to make requests. Pass the HTTP method and path as the first argument. + +```javascript +await octokit.request("GET /octocat", {}); +``` + +{% endjavascript %} + +{% curl %} + +Prepend the base URL for the {% data variables.product.prodname_dotcom %} REST API, `{% data variables.product.api_url_code %}`, to the path to get the full URL: `{% data variables.product.api_url_code %}/octocat`.{% ifversion ghes or ghae %} Replace `[hostname]` with the name of {% data variables.product.product_location %}.{% endif %} + +Use the `curl` command in your command line. Use the `--request` or `-X` flag followed by the HTTP method. Use the `--url` flag followed by the full URL. ```shell -# GET /users/defunkt -$ curl https://api.github.com/users/defunkt - -> { -> "login": "defunkt", -> "id": 2, -> "node_id": "MDQ6VXNlcjI=", -> "avatar_url": "https://avatars.githubusercontent.com/u/2?v=4", -> "gravatar_id": "", -> "url": "https://api.github.com/users/defunkt", -> "html_url": "https://github.com/defunkt", -> ... -> } +curl --request GET \ +--url "https://api.github.com/octocat" ``` -Mmmmm, tastes like [JSON][json]. 我们来添加 `-i` 标志以包含标头： +{% note %} + +**Note**: If you get a message similar to "command not found: curl", you may need to download and install cURL. For more information, see [the cURL project download page](https://curl.se/download.html). + +{% endnote %} + +{% endcurl %} + +Continue reading to learn how to authenticate, send parameters, and use the response. + +## Authenticating + +Many operations require authentication or return additional information if you are authenticated. Additionally, you can make more requests per hour when you are authenticated.{% cli %} Although some REST API operations are accessible without authentication, you must authenticate to {% data variables.product.prodname_cli %} in order to use the `api` subcommand.{% endcli %} + +### 关于令牌 + +You can authenticate your request by adding a token. + +If you want to use the {% data variables.product.company_short %} REST API for personal use, you can create a personal access token (PAT). The REST API operations used in this article require `repo` scope for personal access tokens. Other operations may require different scopes. 有关创建个人访问令牌的更多信息，请参阅“[创建个人访问令牌](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)”。 + +If you want to use the API on behalf of an organization or another user, {% data variables.product.company_short %} recommends that you use a {% data variables.product.prodname_github_app %}. If an operation is available to {% data variables.product.prodname_github_apps %}, the REST reference documentation for that operation will say "Works with GitHub Apps." The REST API operations used in this article require `issues` read and write permissions for {% data variables.product.prodname_github_apps %}. Other operations may require different permissions. For more information, see "[Creating a GitHub App](/developers/apps/building-github-apps/creating-a-github-app)", "[Authenticating with GitHub Apps](/developers/apps/building-github-apps/authenticating-with-github-apps), and "[Identifying and authorizing users for GitHub Apps](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps)." + +If you want to use the API in a {% data variables.product.prodname_actions %} workflow, {% data variables.product.company_short %} recommends that you authenticate with the built-in `GITHUB_TOKEN` instead of creating a token. You can grant permissions to the `GITHUB_TOKEN` with the `permissions` key. 更多信息请参阅“[自动令牌身份验证](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token)”。 + +### Authentication example + +{% cli %} + +With {% data variables.product.prodname_cli %}, you don't need to create an access token in advance. Use the `auth login` subcommand to authenticate to {% data variables.product.prodname_cli %}: ```shell -$ curl -i https://api.github.com/users/defunkt - -> HTTP/2 200 -> server: GitHub.com -> date: Thu, 08 Jul 2021 07:04:08 GMT -> content-type: application/json; charset=utf-8 -> cache-control: public, max-age=60, s-maxage=60 -> vary: Accept, Accept-Encoding, Accept, X-Requested-With -> etag: W/"61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0" -> last-modified: Fri, 01 Nov 2019 21:56:00 GMT -> x-github-media-type: github.v3; format=json -> access-control-expose-headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, Deprecation, Sunset -> access-control-allow-origin: * -> strict-transport-security: max-age=31536000; includeSubdomains; preload -> x-frame-options: deny -> x-content-type-options: nosniff -> x-xss-protection: 0 -> referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin -> content-security-policy: default-src 'none' -> x-ratelimit-limit: 60 -> x-ratelimit-remaining: 53 -> x-ratelimit-reset: 1625731053 -> x-ratelimit-resource: core -> x-ratelimit-used: 7 -> accept-ranges: bytes -> content-length: 1305 -> x-github-request-id: 9F60:7019:ACC5CD5:B03C931:60E6A368 -> -> { -> "login": "defunkt", -> "id": 2, -> "node_id": "MDQ6VXNlcjI=", -> "avatar_url": "https://avatars.githubusercontent.com/u/2?v=4", -> "gravatar_id": "", -> "url": "https://api.github.com/users/defunkt", -> "html_url": "https://github.com/defunkt", -> -> ... -> } +gh auth login ``` -响应标头中有一些有趣的地方。 果然，`Content-Type` 为 `application/json`。 +You can use the `--scopes` flag to specify what scopes you want. If you want to authenticate with a token that you created, you can use the `--with-token` flag. For more information, see the [{% data variables.product.prodname_cli %} `auth login` documentation](https://cli.github.com/manual/gh_auth_login). -任何以 `X-` 开头的标头都是自定义标头，不包含在 HTTP 规范中。 例如，请注意 `X-RateLimit-Limit` 和 `X-RateLimit-Remaining` 标头。 This pair of headers indicate [how many requests a client can make][rate-limiting] in a rolling time period (typically an hour) and how many of those requests the client has already spent. +{% endcli %} -## 身份验证 - -未经身份验证的客户端每小时可以发出 60 个请求。 要每小时发出更多请求，我们需要进行_身份验证_。 In fact, doing anything interesting with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API requires [authentication][authentication]. - -### 使用个人访问令牌 - -使用 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 进行身份验证的最简单和最佳的方式是[通过 OAuth 令牌](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens)使用基本身份验证。 OAuth tokens include [personal access tokens][personal token]. - -使用 `-u` 标志设置您的用户名： - -```shell -$ curl -i -u your_username {% data variables.product.api_url_pre %}/users/octocat - -``` - -出现提示时，您可以输入 OAuth 令牌，但我们建议您为它设置一个变量： - -您可以使用 `-u "your_username:$token"` 并为 `token` 设置一个变量，以避免您的令牌留在 shell 历史记录中，这种情况应尽量避免。 - -```shell -$ curl -i -u your_username:$token {% data variables.product.api_url_pre %}/users/octocat - -``` - -进行身份验证时，您应该会看到您的速率限制达到每小时 5,000 个请求，如 `X-RateLimit-Limit` 标头中所示。 除了每小时提供更多调用次数之外，身份验证还使您能够使用 API 读取和写入私有信息。 - -You can easily [create a **personal access token**][personal token] using your [Personal access tokens settings page][tokens settings]: +{% javascript %} {% warning %} -为了帮助保护您的信息安全，我们强烈建议为您的个人访问令牌设置一个到期日。 +**Warning**: Treat your access token like a password. + +To keep your token secure, you can store your token as a secret and run your script through {% data variables.product.prodname_actions %}. 更多信息请参阅“[加密密码](/actions/security-guides/encrypted-secrets)”。 + +{% ifversion ghec or fpt %}You can also store your token as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} + +If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. {% endwarning %} -{% ifversion fpt or ghes or ghec %} -![个人令牌选择](/assets/images/personal_token.png) +To authenticate with the Octokit.js library, you can pass your token when you create an instance of `Octokit`. Replace `YOUR-TOKEN` with your token.{% ifversion ghes or ghae %} Replace `[hostname]` with the name of {% data variables.product.product_location %}.{% endif %} + +```javascript +const octokit = new Octokit({ {% ifversion ghes or ghae %} + baseUrl: "{% data variables.product.api_url_code %}",{% endif %} + auth: 'YOUR-TOKEN', +}); +``` + +{% endjavascript %} + +{% curl %} + +{% warning %} + +**Warning**: Treat your access token like a password. + +To help keep your account secure, you can use {% data variables.product.prodname_cli %} instead of cURL. {% data variables.product.prodname_cli %} will take care of authentication for you. For more information, see the {% data variables.product.prodname_cli %} version of this page. + +{% ifversion ghec or fpt %}You can also store your token as a {% data variables.product.prodname_codespaces %} secret and use the command line through {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} + +If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. + +{% endwarning %} + +With cURL, you will send an `Authorization` header with your token. Replace `YOUR-TOKEN` with your token: + +```shell +curl --request GET \ +--url "https://api.github.com/octocat" \ +--header "Authorization: Bearer YOUR-TOKEN" +``` + +{% note %} + +**Note:** In most cases, you can use `Authorization: Bearer` or `Authorization: token`. JSON web tokens (JWTs) will only work with `Authorization: Bearer`. + +{% endnote %} + +{% endcurl %} + +### Authentication example for {% data variables.product.prodname_actions %} + +{% cli %} + +You can also use the `run` keyword to execute {% data variables.product.prodname_cli %} commands in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." + +Instead of using the `gh auth login` command, pass your token as an environment variable called `GH_TOKEN`. {% data variables.product.prodname_dotcom %} recommends that you authenticate with the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." 有关机密的更多信息，请参阅“[加密密码](/actions/security-guides/encrypted-secrets)”。 + +```yaml +jobs: + use_api: + runs-on: ubuntu-latest + permissions: {} + steps: + - env: + GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + gh api /octocat +``` + +{% endcli %} + +{% javascript %} + +You can also use the `run` keyword to execute your JavaScript scripts in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." + +{% data variables.product.prodname_dotcom %} recommends that you authenticate with the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." 有关机密的更多信息，请参阅“[加密密码](/actions/security-guides/encrypted-secrets)”。 + +The following example workflow: + +1. Checks out the repository content +1. Sets up Node.js +1. Installs `octokit` +1. Stores the value of `GITHUB_TOKEN` as an environment variable called `TOKEN` and runs `.github/actions-scripts/use-the-api.mjs`, which can access that environment variable as `process.env.TOKEN` + +Example workflow: + +```yaml +on: + workflow_dispatch: +jobs: + use_api_via_script: + runs-on: ubuntu-latest + permissions: {} + steps: + - name: Check out repo content + uses: {% data reusables.actions.action-checkout %} + + - name: Setup Node + uses: {% data reusables.actions.action-setup-node %} + with: + node-version: '16.15.0' + cache: npm + + - name: Install dependencies + run: npm install octokit + + - name: Run script + env: + TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + node .github/actions-scripts/use-the-api.mjs +``` + +Example JavaScript script, with the file path `.github/actions-scripts/use-the-api.mjs`: + +```javascript +import { Octokit } from "octokit"; + +const octokit = new Octokit({ {% ifversion ghes or ghae %} + baseUrl: "{% data variables.product.api_url_code %}",{% endif %} + auth: process.env.TOKEN, +}); + +await octokit.request("GET /octocat", {}); +``` + +Instead of storing your script in a separate file and executing the script from your workflow, you can use the `actions/github-script` action to run a script. For more information, see the [actions/github-script README](https://github.com/actions/github-script). + +```yaml +jobs: + use_api_via_script: + runs-on: ubuntu-latest + permissions: {} + steps: + - uses: {% data reusables.actions.action-github-script %} + with: + github-token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + script: | + await github.request('GET /octocat', {}) +``` + +{% endjavascript %} + +{% curl %} + +You can also use the `run` keyword to execute cURL commands in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." + +{% data variables.product.prodname_dotcom %} recommends that you authenticate with the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." 有关机密的更多信息，请参阅“[加密密码](/actions/security-guides/encrypted-secrets)”。 + +```yaml +jobs: + use_api: + runs-on: ubuntu-latest + permissions: {} + steps: + - env: + GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + curl --request GET \ + --url "https://api.github.com/octocat" \ + --header "Authorization: Bearer $GH_TOKEN" +``` + +{% endcurl %} + +## Using headers + +Most operations specify that you should pass an `Accept` header with a value of `application/vnd.github.v3+json`. Other operations may specify that you should send a different `Accept` header or additional headers. + +{% cli %} + +To send a header with {% data variables.product.prodname_cli %}, use the `--header` or `-H` flag followed by the header in `key: value` format. + +```shell +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /octocat +``` + +{% endcli %} + +{% javascript %} + +The Octokit.js library automatically passes the `Accept: application/vnd.github.v3+json` header. To pass additional headers or a different `Accept` header, add a `headers` property to the object that is passed as a second argument to the `request` method. The value of the `headers` property is an object with the header names as keys and header values as values. For example, to send a `content-type` header with a value of `text/plain`: + +```javascript +await octokit.request("GET /octocat", { + headers: { + "content-type": "text/plain", + }, +}); +``` + +{% endjavascript %} + +{% curl %} + +To send a header with cURL, use the `--header` or `-H` flag followed by the header in `key: value` format. + +```shell +curl --request GET \ +--url "https://api.github.com/octocat" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" +``` + +{% endcurl %} + +## Using path parameters + +Path parameters modify the operation path. For example, the "List repository issues" path is `/repos/{owner}/{repo}/issues`. The curly brackets `{}` denote path parameters that you need to specify. In this case, you must specify the repository owner and name. For the reference documentation for this operation, see "[List repository issues](/rest/issues/issues#list-repository-issues)." + +{% cli %} + +{% ifversion ghes or ghae %} +{% note %} + +**Note:** In order for this command to work for {% data variables.product.product_location %}, replace `octocat/Spoon-Knife` with a repository owned by {% data variables.product.product_location %}. Otherwise, rerun the `gh auth login` command to authenticate to {% data variables.product.prodname_dotcom_the_website %} instead of {% data variables.product.product_location %}. + +{% endnote %} {% endif %} -{% ifversion ghae %} -![个人令牌选择](/assets/images/help/personal_token_ghae.png) +To get issues from the `octocat/Spoon-Knife` repository, replace `{owner}` with `octocat` and `{repo}` with `Spoon-Knife`. + +```shell +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues +``` + +{% endcli %} + +{% javascript %} + +{% ifversion ghes or ghae %} +{% note %} + +**Note:** In order for this example to work for {% data variables.product.product_location %}, replace `octocat/Spoon-Knife` with a repository owned by {% data variables.product.product_location %}. Otherwise, create a new `Octokit` instance and do not specify `baseURL`. + +{% endnote %} {% endif %} -使用到期的个人访问令牌的 API 请求将通过 `GitHub-Authentication-Token-Expiration` 标头返回该令牌的到期日期。 当令牌接近其过期日期时，您可以使用脚本中的标头来提供警告信息。 +When you make a request with Octokit.js, all parameters, including path parameters, are passed in an object as the second argument to the `request` method. To get issues from the `octocat/Spoon-Knife` repository, specify `owner` as `octocat` and `repo` as `Spoon-Knife`. -### 获取自己的用户个人资料 - -在正确验证身份后，您可以利用与 {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} 上的帐户相关的权限。 。 例如，尝试获取 - -```shell -$ curl -i -u your_username:your_token {% data variables.product.api_url_pre %}/user - -> { -> ... -> "plan": { -> "space": 2516582, -> "collaborators": 10, -> "private_repos": 20, -> "name": "medium" -> } -> ... -> } +```javascript +await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife" +}); ``` -This time, in addition to the same set of public information we retrieved for [@defunkt][defunkt github] earlier, you should also see the non-public information for your user profile. 例如，您将在响应中看到 `plan` 对象，它提供有关帐户的 {% data variables.product.product_name %} 计划的详细信息。 +{% endjavascript %} -### 对应用程序使用 OAuth 令牌 +{% curl %} -需要代表其他用户使用 API 读取或写入私有信息的应用程序应使用 [OAuth][oauth]。 +To get issues from the `octocat/Spoon-Knife` repository, replace `{owner}` with `octocat` and `{repo}` with `Spoon-Knife`. To build the full path, prepend the base URL for the {% data variables.product.prodname_dotcom %} REST API, `https://api.github.com`: `https://api.github.com/repos/octocat/Spoon-Knife/issues`. -OAuth 使用_令牌_。 令牌具有两大特点： +{% ifversion ghes or ghae %} +{% note %} -* **可撤销访问权限**：用户可以随时撤销对第三方应用程序的授权 -* **有限访问权限**：用户可以在授权第三方应用程序前审查令牌将提供的具体访问权限。 +**Note:** If you want to use {% data variables.product.product_location %} instead of {% data variables.product.prodname_dotcom_the_website %}, use `{% data variables.product.api_url_code %}` instead of `https://api.github.com` and replace `[hostname]` with the name of {% data variables.product.product_location %}. Replace `octocat/Spoon-Knife` with a repository owned by {% data variables.product.product_location %}. -令牌应通过 [web 工作流程][webflow]进行创建。 应用程序将用户发送到 {% data variables.product.product_name %} 进行登录。 {% data variables.product.product_name %} 随后显示一个对话框，指示应用程序的名称以及应用程序经用户授权后具有的权限级别。 经用户授权访问后，{% data variables.product.product_name %} 将用户重定向到应用程序： - -![GitHub 的 OAuth 提示](/assets/images/oauth_prompt.png) - -**像对待密码一样对待 OAuth 令牌！**不要与其他用户共享它们，也不要将其存储在不安全的地方。 这些示例中的令牌是假的，并且更改了名称以免波及无辜。 - -Now that we've got the hang of making authenticated calls, let's move along to the [Repositories API][repos-api]. - -## 仓库 - -几乎任何有意义的 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 使用都会涉及某种级别的仓库信息。 信息。 We can [`GET` repository details][get repo] in the same way we fetched user details earlier: +{% endnote %} +{% endif %} ```shell -$ curl -i {% data variables.product.api_url_pre %}/repos/twbs/bootstrap +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" ``` -In the same way, we can [view repositories for the authenticated user][user repos api]: +{% endcurl %} + +The operation returns a list of issues and data about each issue. For more information about using the response, see the "[Using the response](#using-the-response)" section. + +## Using query parameters + +Query parameters allow you to control what data is returned for a request. For example, a query parameter may let you specify how many items are returned when the response is paginated. + +By default, the "List repository issues" operation returns thirty issues, sorted in descending order by the date they were created. You can use the `per_page` parameter to return two issues instead of 30. You can use the `sort` parameter to sort the issues by the date they were last updated instead of by the date they were created. You can use the `direction` parameter to sort the results in ascending order instead of descending order. + +{% cli %} + +For {% data variables.product.prodname_cli %}, use the `-F` flag to pass a parameter that is a number, Boolean, or null. Use `-f` to pass string parameters. + +{% note %} + +**Note**: {% data variables.product.prodname_cli %} does not currently accept parameters that are arrays. For more information, see [this issue](https://github.com/cli/cli/issues/1484). + +{% endnote %} ```shell -$ curl -i -H "Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a" \ - {% data variables.product.api_url_pre %}/user/repos +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 -f sort=updated -f direction=asc ``` -Or, we can [list repositories for another user][other user repos api]: +{% endcli %} + +{% javascript %} + +When you make a request with Octokit.js, all parameters, including query parameters, are passed in an object as the second argument to the `request` method. + +```javascript +await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + per_page: 2, + sort: "updated", + direction: "asc", +}); +``` + +{% endjavascript %} + +{% curl %} + +For cURL, add a `?` to the end of the path, then append your query parameter name and value in the form `parameter_name=value`. Separate multiple query parameters with `&`. ```shell -$ curl -i {% data variables.product.api_url_pre %}/users/octocat/repos +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2&sort=updated&direction=asc" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" ``` -Or, we can [list repositories for an organization][org repos api]: +{% endcurl %} + +The operation returns a list of issues and data about each issue. For more information about using the response, see the "[Using the response](#using-the-response)" section. + +## Using body parameters + +Body parameters allow you to pass additional data to the API. For example, the "Create an issue" operation requires you to specify a title for the new issue. It also lets you specify other information, such as text to put in the issue body. For the full reference documentation for this operation, see "[Create an issue](/rest/issues/issues#create-an-issue)." + +The "Create an issue" operation uses the same path as the "List repository issues" operation in the examples above, but it uses a `POST` method instead of a `GET` method. + +{% cli %} + +For {% data variables.product.prodname_cli %}, use the `-F` flag to pass a parameter that is a number, Boolean, or null. Use `-f` to pass string parameters. + +{% note %} + +**Note**: {% data variables.product.prodname_cli %} does not currently accept parameters that are arrays. For more information, see [this issue](https://github.com/cli/cli/issues/1484). + +{% endnote %} ```shell -$ curl -i {% data variables.product.api_url_pre %}/orgs/octo-org/repos +gh api --header 'Accept: application/vnd.github.v3+json' --method POST /repos/octocat/Spoon-Knife/issues -f title="Created with the REST API" -f body="This is a test issue created by the REST API" ``` -从这些调用返回的信息将取决于我们进行身份验证时令牌所具有的作用域： +{% endcli %} -{%- ifversion fpt or ghec or ghes %} -* A token with `public_repo` [scope][scopes] returns a response that includes all public repositories we have access to see on {% data variables.product.product_location %}. -{%- endif %} -* A token with `repo` [scope][scopes] returns a response that includes all {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories we have access to see on {% data variables.product.product_location %}. +{% javascript %} -As the [docs][repos-api] indicate, these methods take a `type` parameter that can filter the repositories returned based on what type of access the user has for the repository. 这样，我们可以只获取直接拥有的仓库、组织仓库或用户通过团队进行协作的仓库。 +When you make a request with Octokit.js, all parameters, including body parameters, are passed in an object as the second argument to the `request` method. + +```javascript +await octokit.request("POST /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + title: "Created with the REST API", + body: "This is a test issue created by the REST API", +}); +``` + +{% endjavascript %} + +{% curl %} + +For cURL, use the `--data` flag to pass the body parameters in a JSON object. ```shell -$ curl -i "{% data variables.product.api_url_pre %}/users/octocat/repos?type=owner" +curl --request POST \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" \ +--data '{ + "title": "Created with the REST API", + "body": "This is a test issue created by the REST API" +}' ``` -在此示例中，我们只获取 octocat 拥有的仓库，而没有获取她协作的仓库。 请注意上面的引用 URL。 根据您的 shell 设置，cURL 有时需要一个引用 URL，否则它会忽略查询字符串。 +{% endcurl %} -### 创建仓库 +The operation creates an issue and returns data about the new issue. In the response, find the `html_url` of your issue and navigate to your issue in the browser. For more information about using the response, see the "[Using the response](#using-the-response)" section. -获取现有仓库的信息是一种常见的用例，但 -{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 也支持创建新的仓库。 To [create a repository][create repo], -我们需要 `POST` 一些包含详细信息和配置选项的JSON。 +## Using the response + +### About the response code and headers + +Every request will return an HTTP status code that indicates the success of the response. For more information about response codes, see [the MDN HTTP response status code documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status). + +Additionally, the response will include headers that give more details about the response. Headers that start with `X-` or `x-` are custom to {% data variables.product.company_short %}. For example, the `x-ratelimit-remaining` and `x-ratelimit-reset` headers tell you how many requests you can make in a time period. + +{% cli %} + +To view the status code and headers, use the `--include` or `--i` flag when you send your request. + +For example, this request: ```shell -$ curl -i -H "Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a" \ - -d '{ - "name": "blog", - "auto_init": true, - "private": true, - "gitignore_template": "nanoc" - }' \ - {% data variables.product.api_url_pre %}/user/repos +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 --include ``` -In this minimal example, we create a new private repository for our blog (to be served on [GitHub Pages][pages], perhaps). 虽然博客 {% ifversion not ghae %}将是公开的{% else %}可供所有企业成员访问{% endif %}，但我们已经将仓库设置为私有。 In this single step, we'll also initialize it with a README and a [nanoc][nanoc]-flavored [.gitignore template][gitignore templates]. - -生成的仓库可在 `https://github.com//blog` 上找到。 要在您拥有的组织下创建仓库，只需将 API 方法从 `/user/repos` 更改为 `/orgs//repos`。 - -接下来，我们将获取新创建的仓库： +returns the response code and headers like: ```shell -$ curl -i {% data variables.product.api_url_pre %}/repos/pengwynn/blog - -> HTTP/2 404 - -> { -> "message": "Not Found" -> } +HTTP/2.0 200 OK +Access-Control-Allow-Origin: * +Access-Control-Expose-Headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset +Cache-Control: private, max-age=60, s-maxage=60 +Content-Security-Policy: default-src 'none' +Content-Type: application/json; charset=utf-8 +Date: Thu, 04 Aug 2022 19:56:41 GMT +Etag: W/"a63dfbcfdb73621e9d2e89551edcf9856731ced534bd7f1e114a5da1f5f73418" +Link: ; rel="next", ; rel="last" +Referrer-Policy: origin-when-cross-origin, strict-origin-when-cross-origin +Server: GitHub.com +Strict-Transport-Security: max-age=31536000; includeSubdomains; preload +Vary: Accept, Authorization, Cookie, X-GitHub-OTP, Accept-Encoding, Accept, X-Requested-With +X-Accepted-Oauth-Scopes: repo +X-Content-Type-Options: nosniff +X-Frame-Options: deny +X-Github-Api-Version-Selected: 2022-08-09 +X-Github-Media-Type: github.v3; format=json +X-Github-Request-Id: 1C73:26D4:E2E500:1EF78F4:62EC2479 +X-Oauth-Client-Id: 178c6fc778ccc68e1d6a +X-Oauth-Scopes: gist, read:org, repo, workflow +X-Ratelimit-Limit: 15000 +X-Ratelimit-Remaining: 14996 +X-Ratelimit-Reset: 1659645499 +X-Ratelimit-Resource: core +X-Ratelimit-Used: 4 +X-Xss-Protection: 0 ``` -哦，不！ 它去哪儿了？ 因为我们创建仓库为 _私有_，所以需要经过身份验证才能看到它。 如果您是一位资深的 HTTP 用户，您可能会预期返回 `403`。 由于我们不想泄露有关私有仓库的信息，因此在本例中，{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 返回 `404`，就好像说“我们既不能确认也不能否认这个仓库的存在”。 +In this example, the response code is `200`, which indicates a successful request. -## 议题 +{% endcli %} -{% data variables.product.product_name %} 上的议题 UI 旨在提供“恰到好处”的工作流程，不会妨碍您的其他工作。 With the {% data variables.product.product_name %} [Issues API][issues-api], you can pull data out or create issues from other tools to create a workflow that works for your team. +{% javascript %} -与 github.com 一样，API 为经过身份验证的用户提供了一些查看议题的方法。 To [see all your issues][get issues api], call `GET /issues`: +When you make a request with Octokit.js, the `request` method returns a promise. If the request was successful, the promise resolves to an object that includes the HTTP status code of the response (`status`) and the response headers (`headers`). If an error occurs, the promise resolves to an object that includes the HTTP status code of the response (`status`) and the response headers (`response.headers`). + +You can use a `try/catch` block to catch an error if it occurs. For example, if the request in the following script is successful, the script will log the status code and the value of the `x-ratelimit-remaining` header. If the request was not successful, the script will log the status code, the value of the `x-ratelimit-remaining` header, and the error message. + +```javascript +try { + const result = await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + per_page: 2, + }); + + console.log(`Success! Status: ${result.status}. Rate limit remaining: ${result.headers["x-ratelimit-remaining"]}`) + +} catch (error) { + console.log(`Error! Status: ${error.status}. Rate limit remaining: ${error.headers["x-ratelimit-remaining"]}. Message: ${error.response.data.message}`) +} +``` + +{% endjavascript %} + +{% curl %} + +To view the status code and headers, use the `--include` or `--i` flag when you send your request. + +For example, this request: ```shell -$ curl -i -H "Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a" \ - {% data variables.product.api_url_pre %}/issues +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" \ +--include ``` -To get only the [issues under one of your {% data variables.product.product_name %} organizations][get issues api], call `GET -/orgs//issues`: +returns the response code and headers like: ```shell -$ curl -i -H "Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a" \ - {% data variables.product.api_url_pre %}/orgs/rails/issues +HTTP/2 200 +server: GitHub.com +date: Thu, 04 Aug 2022 20:07:51 GMT +content-type: application/json; charset=utf-8 +cache-control: public, max-age=60, s-maxage=60 +vary: Accept, Accept-Encoding, Accept, X-Requested-With +etag: W/"7fceb7e8c958d3ec4d02524b042578dcc7b282192e6c939070f4a70390962e18" +x-github-media-type: github.v3; format=json +link: ; rel="next", ; rel="last" +access-control-expose-headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset +access-control-allow-origin: * +strict-transport-security: max-age=31536000; includeSubdomains; preload +x-frame-options: deny +x-content-type-options: nosniff +x-xss-protection: 0 +referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin +content-security-policy: default-src 'none' +x-ratelimit-limit: 15000 +x-ratelimit-remaining: 14996 +x-ratelimit-reset: 1659645535 +x-ratelimit-resource: core +x-ratelimit-used: 4 +accept-ranges: bytes +content-length: 4936 +x-github-request-id: 14E0:4BC6:F1B8BA:208E317:62EC2715 ``` -We can also get [all the issues under a single repository][repo issues api]: +In this example, the response code is `200`, which indicates a successful request. + +{% endcurl %} + +### About the response body + +Many operations will return a response body. Unless otherwise specified, the response body is in JSON format. For example, this request returns a list of issues with data about each issue: + +{% cli %} ```shell -$ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 ``` -### 分页 +{% endcli %} -一个 Rails 规模的项目有数千个议题。 We'll need to [paginate][pagination], making multiple API calls to get the data. 我们来重复上次调用，这次请注意响应标头： +{% javascript %} + +```javascript +await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + per_page: 2, +}); +``` + +{% endjavascript %} + +{% curl %} ```shell -$ curl -i {% data variables.product.api_url_pre %}/repos/rails/rails/issues - -> HTTP/2 200 - -> ... -> Link: <{% data variables.product.api_url_pre %}/repositories/8514/issues?page=2>; rel="next", <{% data variables.product.api_url_pre %}/repositories/8514/issues?page=30>; rel="last" -> ... +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" ``` -The [`Link` header][link-header] provides a way for a response to link to external resources, in this case additional pages of data. 由于我们的调用发现的议题超过 30 个（默认页面大小），因此 API 将告诉我们在哪里可以找到结果的下一页和最后一页。 +{% endcurl %} -### 创建议题 +Unlike the GraphQL API where you specify what information you want, the REST API typically returns more information than you need. If desired, you can parse the response to pull out specific pieces of information. -Now that we've seen how to paginate lists of issues, let's [create an issue][create issue] from the API. +{% cli %} -要创建议题，我们需要进行身份验证，因此我们将在标头中传递 OAuth 令牌。 此外，我们还将 JSON 正文中的标题、正文和标签传递到要在其中创建议题的仓库下的 `/issues` 路径： +For example, you can use `>` to redirect the response to a file: ```shell -$ curl -i -H 'Authorization: token ghp_16C7e42F292c6912E7710c838347Ae178B4a' \ -$ -d '{ \ -$ "title": "New logo", \ -$ "body": "We should have one", \ -$ "labels": ["design"] \ -$ }' \ -$ {% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/issues - -> HTTP/2 201 -> Location: {% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/issues/17 -> X-RateLimit-Limit: 5000 - -> { -> "pull_request": { -> "patch_url": null, -> "html_url": null, -> "diff_url": null -> }, -> "created_at": "2012-11-14T15:25:33Z", -> "comments": 0, -> "milestone": null, -> "title": "New logo", -> "body": "We should have one", -> "user": { -> "login": "pengwynn", -> "gravatar_id": "7e19cd5486b5d6dc1ef90e671ba52ae0", -> "avatar_url": "https://secure.gravatar.com/avatar/7e19cd5486b5d6dc1ef90e671ba52ae0?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", -> "id": 865, -> "url": "{% data variables.product.api_url_pre %}/users/pengwynn" -> }, -> "closed_at": null, -> "updated_at": "2012-11-14T15:25:33Z", -> "number": 17, -> "closed_by": null, -> "html_url": "https://github.com/pengwynn/api-sandbox/issues/17", -> "labels": [ -> { -> "color": "ededed", -> "name": "design", -> "url": "{% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/labels/design" -> } -> ], -> "id": 8356941, -> "assignee": null, -> "state": "open", -> "url": "{% data variables.product.api_url_pre %}/repos/pengwynn/api-sandbox/issues/17" -> } +gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 > data.json ``` -JSON 响应的 `Location` 响应标头和 `url` 字段为我们提供了一些新建议题的指示。 - -## 条件请求 - -通过缓存未更改的信息来遵守速率限制，是成为一个良好 API 公民的重要特质。 The API supports [conditional requests][conditional-requests] and helps you do the right thing. 请注意我们为获取 defunkt 的个人资料而进行的第一个调用： +Then you can use jq to get the title and author ID of each issue: ```shell -$ curl -i {% data variables.product.api_url_pre %}/users/defunkt - -> HTTP/2 200 -> etag: W/"61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0" +jq '.[] | {title: .title, authorID: .user.id}' data.json ``` -除了 JSON 正文之外，还要注意 HTTP 状态代码 `200` 和 `Etag` 标头。 The [ETag][etag] is a fingerprint of the response. 如果我们在后续调用中传递它，则可以告诉 API 仅在资源发生改变的情况才将其再次提供给我们。 +The previous two commands return something like: + +``` +{ + "title": "Update index.html", + "authorID": 10701255 +} +{ + "title": "Edit index file", + "authorID": 53709285 +} +``` + +For more information about jq, see [the jq documentation](https://stedolan.github.io/jq/) and [jq play](https://jqplay.org/). + +{% endcli %} + +{% javascript %} + +For example, you can get the title and author ID of each issue: + +```javascript +try { + const result = await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + per_page: 2, + }); + + const titleAndAuthor = result.data.map(issue => {title: issue.title, authorID: issue.user.id}) + + console.log(titleAndAuthor) + +} catch (error) { + console.log(`Error! Status: ${error.status}. Message: ${error.response.data.message}`) +} +``` + +{% endjavascript %} + +{% curl %} + +For example, you can use `>` to redirect the response to a file: ```shell -$ curl -i -H 'If-None-Match: "61e964bf6efa3bc3f9e8549e56d4db6e0911d8fa20fcd8ab9d88f13d513f26f0"' \ -$ {% data variables.product.api_url_pre %}/users/defunkt - -> HTTP/2 304 +curl --request GET \ +--url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ +--header "Accept: application/vnd.github.v3+json" \ +--header "Authorization: Bearer YOUR-TOKEN" > data.json ``` -`304` 状态表示该资源自上次请求以来没有发生改变，该响应将不包含任何正文。 As a bonus, `304` responses don't count against your [rate limit][rate-limiting]. +Then you can use jq to get the title and author ID of each issue: -现在您了解 {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API 的基础知识了！ +```shell +jq '.[] | {title: .title, authorID: .user.id}' data.json +``` -* 基本 & OAuth 身份验证 -* 获取和创建仓库及议题 -* 条件请求 +The previous two commands return something like: -Keep learning with the next API guide [Basics of Authentication][auth guide]! +``` +{ + "title": "Update index.html", + "authorID": 10701255 +} +{ + "title": "Edit index file", + "authorID": 53709285 +} +``` -[wrappers]: /libraries/ -[curl]: http://curl.haxx.se/ -[oauth]: /apps/building-integrations/setting-up-and-registering-oauth-apps/ -[webflow]: /apps/building-oauth-apps/authorizing-oauth-apps/ -[scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ -[repos-api]: /rest/reference/repos -[repos-api]: /rest/reference/repos -[pages]: http://pages.github.com -[nanoc]: http://nanoc.ws/ -[gitignore templates]: https://github.com/github/gitignore -[issues-api]: /rest/reference/issues -[link-header]: https://www.w3.org/wiki/LinkHeader -[conditional-requests]: /rest#conditional-requests -[rate-limiting]: /rest/overview/resources-in-the-rest-api#rate-limit-http-headers -[rate-limiting]: /rest/overview/resources-in-the-rest-api#rate-limit-http-headers -[users api]: /rest/reference/users#get-a-user -[defunkt github]: https://github.com/defunkt -[defunkt github]: https://github.com/defunkt -[json]: http://en.wikipedia.org/wiki/JSON -[authentication]: /rest#authentication -[personal token]: /articles/creating-an-access-token-for-command-line-use -[personal token]: /articles/creating-an-access-token-for-command-line-use -[tokens settings]: https://github.com/settings/tokens -[pagination]: /rest#pagination -[get repo]: /rest/reference/repos#get-a-repository -[create repo]: /rest/reference/repos#create-a-repository-for-the-authenticated-user -[create issue]: /rest/reference/issues#create-an-issue -[auth guide]: /guides/basics-of-authentication -[user repos api]: /rest/reference/repos#list-repositories-for-the-authenticated-user -[other user repos api]: /rest/reference/repos#list-repositories-for-a-user -[org repos api]: /rest/reference/repos#list-organization-repositories -[get issues api]: /rest/reference/issues#list-issues-assigned-to-the-authenticated-user -[get issues api]: /rest/reference/issues#list-issues-assigned-to-the-authenticated-user -[repo issues api]: /rest/reference/issues#list-repository-issues -[etag]: http://en.wikipedia.org/wiki/HTTP_ETag +For more information about jq, see [the jq documentation](https://stedolan.github.io/jq/) and [jq play](https://jqplay.org/). + +{% endcurl %} + +## 后续步骤 + +This article demonstrated how to list and create issues in a repository. For more practice, try to comment on an issue, edit the title of an issue, or close an issue. For more information about these operations, see "[Create an issue comment](/rest/issues#create-an-issue-comment)" and "[Update an issue](/rest/issues/issues#update-an-issue)." + +For more information about the operations that you can use, see the [REST reference documentation](/rest). diff --git a/translations/zh-CN/content/rest/index.md b/translations/zh-CN/content/rest/index.md index 4a6122dd8e..85a18075e9 100644 --- a/translations/zh-CN/content/rest/index.md +++ b/translations/zh-CN/content/rest/index.md @@ -3,7 +3,8 @@ title: GitHub REST API shortTitle: REST API intro: '要创建集成、检索数据和自动化工作流程，请使用 {% data variables.product.prodname_dotcom %} REST API 构建。' introLinks: - quickstart: /rest/guides/getting-started-with-the-rest-api + quickstart: /rest/quickstart + overview: /rest/guides/getting-started-with-the-rest-api featuredLinks: guides: - /rest/guides/getting-started-with-the-rest-api @@ -31,6 +32,7 @@ versions: ghae: '*' ghec: '*' children: + - /quickstart - /overview - /guides - /actions diff --git a/translations/zh-CN/content/rest/quickstart.md b/translations/zh-CN/content/rest/quickstart.md new file mode 100644 index 0000000000..921fba0090 --- /dev/null +++ b/translations/zh-CN/content/rest/quickstart.md @@ -0,0 +1,351 @@ +--- +title: Quickstart for GitHub REST API +intro: 'Learn how to get started with the {% data variables.product.prodname_dotcom %} REST API.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +shortTitle: 快速入门 +topics: + - API +redirect_from: + - /guides/getting-started + - /v3/guides/getting-started +miniTocMaxHeadingLevel: 3 +--- + +This article describes how to quickly get started with the {% data variables.product.prodname_dotcom %} REST API using {% data variables.product.prodname_cli %}, JavaScript, or cURL. For a more detailed guide, see "[Getting started with the REST API](/rest/guides/getting-started-with-the-rest-api)." + +{% cli %} + +## Getting started using {% data variables.product.prodname_cli %} + +### Using {% data variables.product.prodname_cli %} in the command line + +{% data variables.product.prodname_cli %} is the easiest way to use the {% data variables.product.prodname_dotcom %} REST API from the command line. + +1. Install {% data variables.product.prodname_cli %} if you haven't installed it yet. For installation instructions, see the [{% data variables.product.prodname_cli %} repository](https://github.com/cli/cli#installation). +1. Use the `auth login` subcommand to authenticate to {% data variables.product.prodname_cli %}. For more information, see the [{% data variables.product.prodname_cli %} `auth login` documentation](https://cli.github.com/manual/gh_auth_login). + + ```shell + gh auth login + ``` + +1. Use the `api` subcommand to make your API request. For more information, see the [{% data variables.product.prodname_cli %} `api` documentation](https://cli.github.com/manual/gh_api). + + ```shell + gh api repos/octocat/Spoon-Knife/issues + ``` + +### Using {% data variables.product.prodname_cli %} in {% data variables.product.prodname_actions %} + +You can also use {% data variables.product.prodname_cli %} in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Using GitHub CLI in workflows](/actions/using-workflows/using-github-cli-in-workflows)." + +Instead of using the `gh auth login` command, pass an access token as an environment variable called `GH_TOKEN`. {% data variables.product.prodname_dotcom %} recommends that you use the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." 有关机密的更多信息，请参阅“[加密密码](/actions/security-guides/encrypted-secrets)”。 + +```yaml +on: + workflow_dispatch: +jobs: + use_api: + runs-on: ubuntu-latest + permissions: + issues: read + steps: + - env: + GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + gh api repos/octocat/Spoon-Knife/issues +``` + +If you are authenticating with a {% data variables.product.prodname_github_app %}, you can create an installation access token within your workflow: + +1. Store your {% data variables.product.prodname_github_app %}'s ID as a secret. In the following example, replace `APP_ID` with the name of the secret. 您可以在应用的设置页面上或通过应用 API 找到应用 ID。 更多信息请参阅“[应用程序](/rest/apps/apps#get-an-app)”。 有关机密的更多信息，请参阅“[加密密码](/actions/security-guides/encrypted-secrets)”。 +1. 为应用生成私钥。 Store the contents of the resulting file as a secret. （存储文件的全部内容，包括 `-----BEGIN RSA PRIVATE KEY-----` 和 `-----END RSA PRIVATE KEY-----`）。 In the following example, replace `APP_PEM` with the name of the secret. 更多信息请参阅“[向 {% data variables.product.prodname_github_apps %} 验证](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)”。 +1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. 例如： + +```yaml +{% data reusables.actions.actions-not-certified-by-github-comment %} + +on: + workflow_dispatch: +jobs: + track_pr: + runs-on: ubuntu-latest + steps: + - name: Generate token + id: generate_token + uses: tibdex/github-app-token@36464acb844fc53b9b8b2401da68844f6b05ebb0 + with: + app_id: {% raw %}${{ secrets.APP_ID }}{% endraw %} + private_key: {% raw %}${{ secrets.APP_PEM }}{% endraw %} + + - name: Use API + env: + GH_TOKEN: {% raw %}${{ steps.generate_token.outputs.token }}{% endraw %} + run: | + gh api repos/octocat/Spoon-Knife/issues +``` + +{% endcli %} + +{% javascript %} + +## Getting started using JavaScript + +You can use Octokit.js to interact with the {% data variables.product.prodname_dotcom %} REST API in your JavaScript scripts. For more information, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). + +### Using Octokit.js + +1. Create an access token. For example, create a personal access token (PAT) or a {% data variables.product.prodname_github_app %} user-to-server access token. For more information, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)" or "[Identifying and authorizing users for GitHub Apps](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps)." + + {% warning %} + + **Warning**: Treat your access token like a password. + + To keep your token secure, you can store your token as a secret and run your script through {% data variables.product.prodname_actions %}. For more information, see the "[Using Octokit.js in {% data variables.product.prodname_actions %}](#using-octokitjs-in-github-actions)" section. + + {%- ifversion fpt or ghec %} + + You can also store your token as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} + + If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. + + {% endwarning %} + +1. Install `octokit`. For example, `npm install octokit`. For other ways to install or load `octokit`, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). +1. Import `octokit` in your script. For example, `import { Octokit } from "octokit";`. For other ways to import `octokit`, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). +1. Create an instance of `Octokit` with your token. Replace `YOUR-TOKEN` with your token. + + ```javascript + const octokit = new Octokit({ + auth: 'YOUR-TOKEN' + }); + ``` + +1. Use `octokit.request` to execute your request. Send the HTTP method and path as the first argument. Specify any path, query, and body parameters in an object as the second argument. For example, in the following request the HTTP method is `GET`, the path is `/repos/{owner}/{repo}/issues`, and the parameters are `owner: "octocat"` and `repo: "Spoon-Knife"`. + + ```javascript + await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + }); + ``` + +### Using Octokit.js in {% data variables.product.prodname_actions %} + +You can also execute your JavaScript scripts in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." + +{% data variables.product.prodname_dotcom %} recommends that you use the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." 有关机密的更多信息，请参阅“[加密密码](/actions/security-guides/encrypted-secrets)”。 + +The following example workflow: + +1. Checks out the repository content +1. Sets up Node.js +1. Installs `octokit` +1. Stores the value of `GITHUB_TOKEN` as an environment variable called `TOKEN` and runs `.github/actions-scripts/use-the-api.mjs`, which can access that environment variable as `process.env.TOKEN` + +Example workflow: + +```yaml +on: + workflow_dispatch: +jobs: + use_api_via_script: + runs-on: ubuntu-latest + permissions: + issues: read + steps: + - name: Check out repo content + uses: {% data reusables.actions.action-checkout %} + + - name: Setup Node + uses: {% data reusables.actions.action-setup-node %} + with: + node-version: '16.15.0' + cache: npm + + - name: Install dependencies + run: npm install octokit + + - name: Run script + run: | + node .github/actions-scripts/use-the-api.mjs + env: + TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} +``` + +Example JavaScript script, with the file path `.github/actions-scripts/use-the-api.mjs`: + +```javascript +import { Octokit } from "octokit" + +const octokit = new Octokit({ + auth: process.env.TOKEN +}); + +try { + const result = await octokit.request("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "Spoon-Knife", + }); + + const titleAndAuthor = result.data.map(issue => {title: issue.title, authorID: issue.user.id}) + + console.log(titleAndAuthor) + +} catch (error) { + console.log(`Error! Status: ${error.status}. Message: ${error.response.data.message}`) +} +``` + +If you are authenticating with a {% data variables.product.prodname_github_app %}, you can create an installation access token within your workflow: + +1. Store your {% data variables.product.prodname_github_app %}'s ID as a secret. In the following example, replace `APP_ID` with the name of the secret. 您可以在应用的设置页面上或通过应用 API 找到应用 ID。 更多信息请参阅“[应用程序](/rest/apps/apps#get-an-app)”。 有关机密的更多信息，请参阅“[加密密码](/actions/security-guides/encrypted-secrets)”。 +1. 为应用生成私钥。 Store the contents of the resulting file as a secret. （存储文件的全部内容，包括 `-----BEGIN RSA PRIVATE KEY-----` 和 `-----END RSA PRIVATE KEY-----`）。 In the following example, replace `APP_PEM` with the name of the secret. 更多信息请参阅“[向 {% data variables.product.prodname_github_apps %} 验证](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)”。 +1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. 例如： + +```yaml +{% data reusables.actions.actions-not-certified-by-github-comment %} + +on: + workflow_dispatch: +jobs: + use_api_via_script: + runs-on: ubuntu-latest + steps: + - name: Check out repo content + uses: {% data reusables.actions.action-checkout %} + + - name: Setup Node + uses: {% data reusables.actions.action-setup-node %} + with: + node-version: '16.15.0' + cache: npm + + - name: Install dependencies + run: npm install octokit + + - name: Generate token + id: generate_token + uses: tibdex/github-app-token@36464acb844fc53b9b8b2401da68844f6b05ebb0 + with: + app_id: {% raw %}${{ secrets.APP_ID }}{% endraw %} + private_key: {% raw %}${{ secrets.APP_PEM }}{% endraw %} + + - name: Run script + run: | + node .github/actions-scripts/use-the-api.mjs + env: + TOKEN: {% raw %}${{ steps.generate_token.outputs.token }}{% endraw %} +``` + +{% endjavascript %} + +{% curl %} + +## Getting started using cURL + +### Using cURL in the command line + +{% note %} + +**Note:** If you want to make API requests from the command line, {% data variables.product.prodname_dotcom %} recommends that you use {% data variables.product.prodname_cli %}, which simplifies authentication and requests. For more information about getting started with the REST API using {% data variables.product.prodname_cli %}, see the {% data variables.product.prodname_cli %} version of this article. + +{% endnote %} + +1. Install cURL if cURL isn't already installed on your machine. To check if cURL is installed, execute `curl --version` in the command line. If the output is information about the cURL version, cURL is installed. If you get a message similar to `command not found: curl`, you need to download and install cURL. For more information, see [the cURL project download page](https://curl.se/download.html). +1. Create an access token. For example, create a personal access token (PAT) or a {% data variables.product.prodname_github_app %} user-to-server access token. For more information, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)" or "[Identifying and authorizing users for GitHub Apps](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps)." + + {% warning %} + + **Warning**: Treat your access token like a password. + + {%- ifversion fpt or ghec %} + + To keep your token secure, you can store your token as a {% data variables.product.prodname_codespaces %} secret and use the command line through {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} + + You can also use {% data variables.product.prodname_cli %} instead of cURL. {% data variables.product.prodname_cli %} will take care of authentication for you. For more information, see the {% data variables.product.prodname_cli %} version of this page. + + If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. + + {% endwarning %} + +1. Use the `cURL` command to make your request. Pass your token in an `Authorization` header. Replace `YOUR-TOKEN` with your token. + + ```shell + curl --request GET \ + --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ + --header "Accept: application/vnd.github.v3+json" \ + --header "Authorization: Bearer YOUR-TOKEN" + ``` + + {% note %} + + **Note:** In most cases, you can use `Authorization: Bearer` or `Authorization: token`. JSON web tokens (JWTs) only work with `Authorization: Bearer`. + + {% endnote %} + +### Using cURL in {% data variables.product.prodname_actions %} + +You can also use cURL in your {% data variables.product.prodname_actions %} workflows. + +{% data variables.product.prodname_dotcom %} recommends that you use the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." 有关机密的更多信息，请参阅“[加密密码](/actions/security-guides/encrypted-secrets)”。 + +```yaml +on: + workflow_dispatch: +jobs: + use_api: + runs-on: ubuntu-latest + permissions: + issues: read + steps: + - env: + GH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + run: | + curl --request GET \ + --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ + --header "Accept: application/vnd.github.v3+json" \ + --header "Authorization: Bearer $GH_TOKEN" +``` + +If you are authenticating with a {% data variables.product.prodname_github_app %}, you can create an installation access token within your workflow: + +1. Store your {% data variables.product.prodname_github_app %}'s ID as a secret. In the following example, replace `APP_ID` with the name of the secret. 您可以在应用的设置页面上或通过应用 API 找到应用 ID。 更多信息请参阅“[应用程序](/rest/apps/apps#get-an-app)”。 有关机密的更多信息，请参阅“[加密密码](/actions/security-guides/encrypted-secrets)”。 +1. 为应用生成私钥。 Store the contents of the resulting file as a secret. （存储文件的全部内容，包括 `-----BEGIN RSA PRIVATE KEY-----` 和 `-----END RSA PRIVATE KEY-----`）。 In the following example, replace `APP_PEM` with the name of the secret. 更多信息请参阅“[向 {% data variables.product.prodname_github_apps %} 验证](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)”。 +1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. 例如： + +```yaml +{% data reusables.actions.actions-not-certified-by-github-comment %} + +on: + workflow_dispatch: +jobs: + use_api: + runs-on: ubuntu-latest + steps: + - name: Generate token + id: generate_token + uses: tibdex/github-app-token@36464acb844fc53b9b8b2401da68844f6b05ebb0 + with: + app_id: {% raw %}${{ secrets.APP_ID }}{% endraw %} + private_key: {% raw %}${{ secrets.APP_PEM }}{% endraw %} + + - name: Use API + env: + GH_TOKEN: {% raw %}${{ steps.generate_token.outputs.token }}{% endraw %} + run: | + curl --request GET \ + --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ + --header "Accept: application/vnd.github.v3+json" \ + --header "Authorization: Bearer $GH_TOKEN" +``` + +{% endcurl %} + +## 后续步骤 + +For a more detailed guide, see "[Getting started with the REST API](/rest/guides/getting-started-with-the-rest-api)." diff --git a/translations/zh-CN/content/rest/teams/external-groups.md b/translations/zh-CN/content/rest/teams/external-groups.md index 0fa02a12f7..77405ae5f3 100644 --- a/translations/zh-CN/content/rest/teams/external-groups.md +++ b/translations/zh-CN/content/rest/teams/external-groups.md @@ -19,7 +19,7 @@ miniTocMaxHeadingLevel: 3 **注意：** -- 外部组 API 仅适用于属于使用 {% data variables.product.prodname_emus %} 的企业中的组织。 更多信息请参阅“[关于企业管理用户](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)”。 +- The external groups API is only available for organizations that are part of an enterprise using {% data variables.product.prodname_emus %}. 更多信息请参阅“[关于企业管理用户](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)”。 - 如果您的组织使用团队同步，则可以使用团队同步 API。 更多信息请参阅“[团队同步 API](#team-synchronization)”。 {% endnote %} diff --git a/translations/zh-CN/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md b/translations/zh-CN/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md index 096e87b9cd..9dfa58adf6 100644 --- a/translations/zh-CN/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md +++ b/translations/zh-CN/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md @@ -25,7 +25,7 @@ shortTitle: 赞助贡献者 您可以代表您的个人帐户赞助一个帐户，以投资您个人受益的项目。 您可以代表您的组织赞助帐户，原因有很多。 - 维护组织工作所依赖的特定库 -- 投资于作为一个组织所依赖的生态系统（如区块链） +- Investing in the ecosystem you rely on as an organization (such as blockchain) - 作为重视开源的组织，培养品牌知名度 - 感谢开源开发者构建库来补充您的组织提供的产品 diff --git a/translations/zh-CN/data/features/actions-oidc-hardening-config.yml b/translations/zh-CN/data/features/actions-oidc-hardening-config.yml new file mode 100644 index 0000000000..f3048bac8b --- /dev/null +++ b/translations/zh-CN/data/features/actions-oidc-hardening-config.yml @@ -0,0 +1,6 @@ +#Reference: #7336 +#General versioning for oidc hardening options +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' diff --git a/translations/zh-CN/data/features/actions-reusable-workflow-matrix.yml b/translations/zh-CN/data/features/actions-reusable-workflow-matrix.yml new file mode 100644 index 0000000000..6ab9b12b6b --- /dev/null +++ b/translations/zh-CN/data/features/actions-reusable-workflow-matrix.yml @@ -0,0 +1,7 @@ +#Reference: #7094 +#Documentation for allowing matrix jobs to call reusable workflows. +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7094' diff --git a/translations/zh-CN/data/features/bypass-branch-protections.yml b/translations/zh-CN/data/features/bypass-branch-protections.yml new file mode 100644 index 0000000000..d955962e56 --- /dev/null +++ b/translations/zh-CN/data/features/bypass-branch-protections.yml @@ -0,0 +1,7 @@ +#Issue: 6667 +#Description: Allow merging pull requests without complying with branch protection rules. +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-6667' diff --git a/translations/zh-CN/data/features/dependabot-alerts-dismissal-comment.yml b/translations/zh-CN/data/features/dependabot-alerts-dismissal-comment.yml new file mode 100644 index 0000000000..e2c2294cea --- /dev/null +++ b/translations/zh-CN/data/features/dependabot-alerts-dismissal-comment.yml @@ -0,0 +1,6 @@ +#Reference: Issue #7673 - Dependabot alerts: optional comment with dismissal - [GA] +versions: + fpt: '*' + ghec: '*' + ghes: '>3.6' + ghae: 'issue-7673' diff --git a/translations/zh-CN/data/features/dependabot-alerts-vulnerable-calls.yml b/translations/zh-CN/data/features/dependabot-alerts-vulnerable-calls.yml index 84825c368b..a7f772a7c5 100644 --- a/translations/zh-CN/data/features/dependabot-alerts-vulnerable-calls.yml +++ b/translations/zh-CN/data/features/dependabot-alerts-vulnerable-calls.yml @@ -3,5 +3,4 @@ versions: fpt: '*' ghec: '*' - ghes: '>3.5' ghae: 'issue-6076' diff --git a/translations/zh-CN/data/features/enterprise-namespace-repo-setting.yml b/translations/zh-CN/data/features/enterprise-namespace-repo-setting.yml new file mode 100644 index 0000000000..e20549f3ea --- /dev/null +++ b/translations/zh-CN/data/features/enterprise-namespace-repo-setting.yml @@ -0,0 +1,6 @@ +#Reference: #7757 +#Setting to disable personal namespace repo creation for EMUs, GHES 3.7+ and GHAE 3.7+ users +versions: + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7757' diff --git a/translations/zh-CN/data/features/ip-allow-list-address-check.yml b/translations/zh-CN/data/features/ip-allow-list-address-check.yml new file mode 100644 index 0000000000..c4dda87a70 --- /dev/null +++ b/translations/zh-CN/data/features/ip-allow-list-address-check.yml @@ -0,0 +1,3 @@ +versions: + ghec: '*' + ghae: 'issue-7818' diff --git a/translations/zh-CN/data/features/multiple-accounts-one-workstation.yml b/translations/zh-CN/data/features/multiple-accounts-one-workstation.yml new file mode 100644 index 0000000000..9fce93b34e --- /dev/null +++ b/translations/zh-CN/data/features/multiple-accounts-one-workstation.yml @@ -0,0 +1,5 @@ +#Issue #7330 +#Documentation for managing multiple GitHub accounts on one workstation +versions: + fpt: '*' + ghec: '*' diff --git a/translations/zh-CN/data/features/nested-reusable-workflow.yml b/translations/zh-CN/data/features/nested-reusable-workflow.yml new file mode 100644 index 0000000000..95d7cb5a56 --- /dev/null +++ b/translations/zh-CN/data/features/nested-reusable-workflow.yml @@ -0,0 +1,7 @@ +#Issues 7093 +#Reusable workflows can call other reusable workflows +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7093' diff --git a/translations/zh-CN/data/features/packages-npm-v2.yml b/translations/zh-CN/data/features/packages-npm-v2.yml new file mode 100644 index 0000000000..572e412e4a --- /dev/null +++ b/translations/zh-CN/data/features/packages-npm-v2.yml @@ -0,0 +1,5 @@ +#Issue 7039 +#npm Package Registry Improvements (v2) GA +versions: + fpt: '*' + ghec: '*' diff --git a/translations/zh-CN/data/features/push-protection-custom-link-orgs-beta.yml b/translations/zh-CN/data/features/push-protection-custom-link-orgs-beta.yml new file mode 100644 index 0000000000..509caa9fb4 --- /dev/null +++ b/translations/zh-CN/data/features/push-protection-custom-link-orgs-beta.yml @@ -0,0 +1,8 @@ +#Issue 7299 +#Push protection custom links beta flags +#See "push-protection-custom-link-orgs" for the feature +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7299' diff --git a/translations/zh-CN/data/features/push-protection-custom-link-orgs.yml b/translations/zh-CN/data/features/push-protection-custom-link-orgs.yml new file mode 100644 index 0000000000..fce23efa96 --- /dev/null +++ b/translations/zh-CN/data/features/push-protection-custom-link-orgs.yml @@ -0,0 +1,8 @@ +#Issue 7299 +#Push protection custom links +#See "push-protection-custom-link-orgs-beta" for the beta flags +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.7' + ghae: 'issue-7299' diff --git a/translations/zh-CN/data/features/ssh-commit-verification.yml b/translations/zh-CN/data/features/ssh-commit-verification.yml new file mode 100644 index 0000000000..7851b1c8b7 --- /dev/null +++ b/translations/zh-CN/data/features/ssh-commit-verification.yml @@ -0,0 +1,8 @@ +#Reference: github/docs-content#6709 +#Initial docs for showing SSH signed commits as verified and +#uploading SSH signing keys +versions: + fpt: '*' + ghec: '*' + ghes: '>= 3.7' + ghae: '*' diff --git a/translations/zh-CN/data/features/streaming-datadog.yml b/translations/zh-CN/data/features/streaming-datadog.yml new file mode 100644 index 0000000000..ab90546c8d --- /dev/null +++ b/translations/zh-CN/data/features/streaming-datadog.yml @@ -0,0 +1,4 @@ +#Reference #7495 +#Documentation for audit log streaming to a Datadog endpoint +versions: + ghec: '*' diff --git a/translations/zh-CN/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml b/translations/zh-CN/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml index 862699bc95..7fd339f381 100644 --- a/translations/zh-CN/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml +++ b/translations/zh-CN/data/graphql/ghae/graphql_upcoming_changes.public-ghae.yml @@ -154,16 +154,9 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: 重大 owner: lukewar - - - location: ProjectNextFieldType.TASKS - description: '`TASKS` will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.' - reason: '''ProjectNext'' API 已被弃用，取而代之的是功能更强大的 ''ProjectV2'' API。' - date: '2022-10-01T00:00:00+00:00' - criticality: 重大 - owner: lukewar - location: ProjectNextFieldType.TEXT - description: '`TEXT` will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.' + description: '“TEXT”将被删除。请按照 https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ 的 ProjectV2 指南，找到合适的替代项。' reason: '''ProjectNext'' API 已被弃用，取而代之的是功能更强大的 ''ProjectV2'' API。' date: '2022-10-01T00:00:00+00:00' criticality: 重大 @@ -175,6 +168,13 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: 重大 owner: lukewar + - + location: ProjectNextFieldType.TRACKS + description: '“TRACKS”将被删除。请按照 https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ 的 ProjectV2 指南，找到合适的替代项。' + reason: '''ProjectNext'' API 已被弃用，取而代之的是功能更强大的 ''ProjectV2'' API。' + date: '2022-10-01T00:00:00+00:00' + criticality: 重大 + owner: lukewar - location: RemovePullRequestFromMergeQueueInput.branch description: '`branch` 将被删除。' diff --git a/translations/zh-CN/data/graphql/ghec/graphql_upcoming_changes.public.yml b/translations/zh-CN/data/graphql/ghec/graphql_upcoming_changes.public.yml index 74549f78c1..7e11c0b196 100644 --- a/translations/zh-CN/data/graphql/ghec/graphql_upcoming_changes.public.yml +++ b/translations/zh-CN/data/graphql/ghec/graphql_upcoming_changes.public.yml @@ -574,16 +574,9 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: 重大 owner: lukewar - - - location: ProjectNextFieldType.TASKS - description: '`TASKS` will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.' - reason: '''ProjectNext'' API 已被弃用，取而代之的是功能更强大的 ''ProjectV2'' API。' - date: '2022-10-01T00:00:00+00:00' - criticality: 重大 - owner: lukewar - location: ProjectNextFieldType.TEXT - description: '`TEXT` will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.' + description: '“TEXT”将被删除。请按照 https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ 的 ProjectV2 指南，找到合适的替代项。' reason: '''ProjectNext'' API 已被弃用，取而代之的是功能更强大的 ''ProjectV2'' API。' date: '2022-10-01T00:00:00+00:00' criticality: 重大 @@ -595,6 +588,13 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: 重大 owner: lukewar + - + location: ProjectNextFieldType.TRACKS + description: '“TRACKS”将被删除。请按照 https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ 的 ProjectV2 指南，找到合适的替代项。' + reason: '''ProjectNext'' API 已被弃用，取而代之的是功能更强大的 ''ProjectV2'' API。' + date: '2022-10-01T00:00:00+00:00' + criticality: 重大 + owner: lukewar - location: ProjectNextItem.content description: '“content”将被删除。请按照 https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ 的 ProjectV2 指南，找到合适的替代项。' @@ -994,6 +994,13 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: 重大 owner: lukewar + - + location: ProjectView.groupedItems + description: '`groupedItems` will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.' + reason: '''ProjectNext'' API 已被弃用，取而代之的是功能更强大的 ''ProjectV2'' API。' + date: '2022-10-01T00:00:00+00:00' + criticality: 重大 + owner: lukewar - location: ProjectView.items description: '“items”将被删除。请按照 https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ 的 ProjectV2 指南，找到合适的替代项。' diff --git a/translations/zh-CN/data/graphql/graphql_upcoming_changes.public.yml b/translations/zh-CN/data/graphql/graphql_upcoming_changes.public.yml index 74549f78c1..7e11c0b196 100644 --- a/translations/zh-CN/data/graphql/graphql_upcoming_changes.public.yml +++ b/translations/zh-CN/data/graphql/graphql_upcoming_changes.public.yml @@ -574,16 +574,9 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: 重大 owner: lukewar - - - location: ProjectNextFieldType.TASKS - description: '`TASKS` will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.' - reason: '''ProjectNext'' API 已被弃用，取而代之的是功能更强大的 ''ProjectV2'' API。' - date: '2022-10-01T00:00:00+00:00' - criticality: 重大 - owner: lukewar - location: ProjectNextFieldType.TEXT - description: '`TEXT` will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.' + description: '“TEXT”将被删除。请按照 https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ 的 ProjectV2 指南，找到合适的替代项。' reason: '''ProjectNext'' API 已被弃用，取而代之的是功能更强大的 ''ProjectV2'' API。' date: '2022-10-01T00:00:00+00:00' criticality: 重大 @@ -595,6 +588,13 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: 重大 owner: lukewar + - + location: ProjectNextFieldType.TRACKS + description: '“TRACKS”将被删除。请按照 https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ 的 ProjectV2 指南，找到合适的替代项。' + reason: '''ProjectNext'' API 已被弃用，取而代之的是功能更强大的 ''ProjectV2'' API。' + date: '2022-10-01T00:00:00+00:00' + criticality: 重大 + owner: lukewar - location: ProjectNextItem.content description: '“content”将被删除。请按照 https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ 的 ProjectV2 指南，找到合适的替代项。' @@ -994,6 +994,13 @@ upcoming_changes: date: '2022-10-01T00:00:00+00:00' criticality: 重大 owner: lukewar + - + location: ProjectView.groupedItems + description: '`groupedItems` will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.' + reason: '''ProjectNext'' API 已被弃用，取而代之的是功能更强大的 ''ProjectV2'' API。' + date: '2022-10-01T00:00:00+00:00' + criticality: 重大 + owner: lukewar - location: ProjectView.items description: '“items”将被删除。请按照 https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ 的 ProjectV2 指南，找到合适的替代项。' diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-2/17.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-2/17.yml index 4d76e62101..bb150ca808 100644 --- a/translations/zh-CN/data/release-notes/enterprise-server/3-2/17.yml +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-2/17.yml @@ -7,3 +7,12 @@ sections: **HIGH**: Previously installed apps on user accounts were automatically granted permission to access an organization on scoped access tokens after the user account was transformed into an organization account. This vulnerability was reported via the [GitHub Bug Bounty program](https://bounty.github.com). bugs: - When a custom dormancy threshold was set for the instance, suspending all dormant users did not reliably respect the threshold. For more information about dormancy, see "[Managing dormant users](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)." + known_issues: + - 在新建的没有任何用户的 {% data variables.product.prodname_ghe_server %} 实例上，攻击者可以创建第一个管理员用户。 + - 自定义防火墙规则在升级过程中被删除。 + - Git LFS 跟踪的文件[通过 Web 界面上传](https://github.com/blog/2105-upload-files-to-your-repositories) 被错误地直接添加到仓库。 + - 如果议题包含文件路径长于 255 个字符的同一仓库中 blob 的永久链接，则议题无法关闭。 + - 当“用户可以搜索 GitHub.com”与 {% data variables.product.prodname_github_connect %} 一起启用时，私有和内部存储库中的议题不会包含在 {% data variables.product.prodname_dotcom_the_website %} 搜索结果中。 + - '{% data variables.product.prodname_registry %} npm 注册表不再返回元数据响应的时间值。这样做是为了大幅改善性能。作为元数据响应的一部分，我们继续拥有返回时间值所需的所有数据，并将在我们解决现有性能问题后恢复返回这个值。' + - 特定于处理预接收挂钩的资源限制可能会导致某些预接收挂钩失败。 + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-3/12.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-3/12.yml index bdd7c88536..c5393b6c21 100644 --- a/translations/zh-CN/data/release-notes/enterprise-server/3-3/12.yml +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-3/12.yml @@ -9,3 +9,14 @@ sections: - When a custom dormancy threshold was set for the instance, suspending all dormant users did not reliably respect the threshold. For more information about dormancy, see "[Managing dormant users](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)." changes: - 'The enterprise audit log now includes more user-generated events, such as `project.create`. The REST API also returns additional user-generated events, such as `repo.create`. For more information, see "[Accessing the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)" and "[Using the audit log API for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)."' + known_issues: + - 升级到 {% data variables.product.prodname_ghe_server %} 3.3 后，{% data variables.product.prodname_actions %} 可能无法自动启动。要解决此问题，请通过 SSH 连接到设备并运行“ghe-actions-start”命令。 + - 在新建的没有任何用户的 {% data variables.product.prodname_ghe_server %} 实例上，攻击者可以创建第一个管理员用户。 + - 自定义防火墙规则在升级过程中被删除。 + - Git LFS 跟踪的文件[通过 Web 界面上传](https://github.com/blog/2105-upload-files-to-your-repositories) 被错误地直接添加到仓库。 + - 如果议题包含文件路径长于 255 个字符的同一仓库中 blob 的永久链接，则议题无法关闭。 + - 当“用户可以搜索 GitHub.com”与 {% data variables.product.prodname_github_connect %} 一起启用时，私有和内部存储库中的议题不会包含在 {% data variables.product.prodname_dotcom_the_website %} 搜索结果中。 + - '{% data variables.product.prodname_registry %} npm 注册表不再返回元数据响应的时间值。这样做是为了大幅改善性能。作为元数据响应的一部分，我们继续拥有返回时间值所需的所有数据，并将在我们解决现有性能问题后恢复返回这个值。' + - 特定于处理预接收挂钩的资源限制可能会导致某些预接收挂钩失败。 + - '{% data variables.product.prodname_actions %} 存储设置在选择“Force Path Style（强制路径样式）”时无法验证和保存在 {% data variables.enterprise.management_console %} 中，而必须使用“ghe-actions-precheck”命令行实用程序进行配置。' + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-4/7.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-4/7.yml index 4ac13d11b8..479702d0d7 100644 --- a/translations/zh-CN/data/release-notes/enterprise-server/3-4/7.yml +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-4/7.yml @@ -12,3 +12,15 @@ sections: changes: - '`pre_receive_hook.rejected_push` events were not displayed in the enterprise audit log.' - Both migration archives for repositories and archive exports for user accounts include release reactions. + known_issues: + - 在新建的没有任何用户的 {% data variables.product.prodname_ghe_server %} 实例上，攻击者可以创建第一个管理员用户。 + - 自定义防火墙规则在升级过程中被删除。 + - Git LFS 跟踪的文件[通过 Web 界面上传](https://github.com/blog/2105-upload-files-to-your-repositories) 被错误地直接添加到仓库。 + - 如果议题包含文件路径长于 255 个字符的同一仓库中 blob 的永久链接，则议题无法关闭。 + - 当“用户可以搜索 GitHub.com”与 {% data variables.product.prodname_github_connect %} 一起启用时，私有和内部存储库中的议题不会包含在 {% data variables.product.prodname_dotcom_the_website %} 搜索结果中。 + - '{% data variables.product.prodname_registry %} npm 注册表不再返回元数据响应的时间值。这样做是为了大幅改善性能。作为元数据响应的一部分，我们继续拥有返回时间值所需的所有数据，并将在我们解决现有性能问题后恢复返回这个值。' + - 特定于处理预接收挂钩的资源限制可能会导致某些预接收挂钩失败。 + - | + 在多个级别（例如，企业和组织）上使用“--ephemeral”参数注册自托管运行器后，运行器可能会陷入空闲状态并需要重新注册。[更新时间：2022 年 6 月 17 日] + - After upgrading to {% data variables.product.prodname_ghe_server %} 3.4, releases may appear to be missing from repositories. This can occur when the required Elasticsearch index migrations have not successfully completed. + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-5/4.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-5/4.yml index 2d66fe18bf..ed005d20b8 100644 --- a/translations/zh-CN/data/release-notes/enterprise-server/3-5/4.yml +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-5/4.yml @@ -18,3 +18,13 @@ sections: - The light high contrast theme was unavailable in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3, but is now available in 3.5.4. For more information, see "[Managing your theme settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings)." changes: - '`pre_receive_hook.rejected_push` events were not displayed in the enterprise audit log.' + known_issues: + - 在新建的没有任何用户的 {% data variables.product.prodname_ghe_server %} 实例上，攻击者可以创建第一个管理员用户。 + - 自定义防火墙规则在升级过程中被删除。 + - Git LFS 跟踪的文件[通过 Web 界面上传](https://github.com/blog/2105-upload-files-to-your-repositories) 被错误地直接添加到仓库。 + - 如果议题包含文件路径长于 255 个字符的同一仓库中 blob 的永久链接，则议题无法关闭。 + - 对 GitHub Connect 启用“用户可以搜索 GitHub.com”后，私有和内部仓库中的议题不包括在 GitHub.com 搜索结果中。 + - '{% data variables.product.prodname_registry %} npm 注册表不再返回元数据响应的时间值。这样做是为了大幅改善性能。作为元数据响应的一部分，我们继续拥有返回时间值所需的所有数据，并将在我们解决现有性能问题后恢复返回这个值。' + - 特定于处理预接收挂钩的资源限制可能会导致某些预接收挂钩失败。 + - Actions services need to be restarted after restoring an appliance from a backup taken on a different host. + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-6/0-rc1.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-6/0-rc1.yml index a729a01d0e..e7834b56ee 100644 --- a/translations/zh-CN/data/release-notes/enterprise-server/3-6/0-rc1.yml +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-6/0-rc1.yml @@ -80,8 +80,6 @@ sections: notes: - | Enterprise owners on instances with a GitHub Advanced Security license can see an overview of Dependabot alerts for the entire instance, including a repository-centric view of application security risks, and an alert-centric view of all secret scanning and Dependabot alerts. The views are in beta and subject to change, and alert-centric views for code scanning are planned for a future release of GitHub Enterprise Server. For more information, see "[Viewing the security overview](/code-security/security-overview/viewing-the-security-overview#viewing-the-security-overview-for-an-enterprise)." - - | - Dependabot alerts show users if repository code calls vulnerable functions. Individual alerts display a "vulnerable call" label and code snippet, and users can filter search by `has:vulnerable-calls`. Vulnerable functions are curated during publication to the [GitHub Advisory Database](https://github.com/advisories). New incoming Python advisories will be supported, and GitHub is backfilling known vulnerable functions for historical Python advisories. After beta testing with Python, GitHub will add support for other ecosystems. For more information, see "[Viewing and updating Dependabot alerts](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts)." - | Users can select multiple Dependabot alerts, then dismiss or reopen or dismiss the alerts. For example, from the **Closed alerts** tab, you can select multiple alerts that have been previously dismissed, and then reopen them all at once. For more information, see "[About Dependabot alerts](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies)." - | diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-6/0.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-6/0.yml index 5a6efee21d..3c0b6c491c 100644 --- a/translations/zh-CN/data/release-notes/enterprise-server/3-6/0.yml +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-6/0.yml @@ -79,8 +79,6 @@ sections: notes: - | Enterprise owners on instances with a GitHub Advanced Security license can see an overview of Dependabot alerts for the entire instance, including a repository-centric view of application security risks, and an alert-centric view of all secret scanning and Dependabot alerts. The views are in beta and subject to change, and alert-centric views for code scanning are planned for a future release of GitHub Enterprise Server. For more information, see "[Viewing the security overview](/code-security/security-overview/viewing-the-security-overview#viewing-the-security-overview-for-an-enterprise)." - - | - Dependabot alerts show users if repository code calls vulnerable functions. Individual alerts display a "vulnerable call" label and code snippet, and users can filter search by `has:vulnerable-calls`. Vulnerable functions are curated during publication to the [GitHub Advisory Database](https://github.com/advisories). New incoming Python advisories will be supported, and GitHub is backfilling known vulnerable functions for historical Python advisories. After beta testing with Python, GitHub will add support for other ecosystems. For more information, see "[Viewing and updating Dependabot alerts](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts)." - | Users can select multiple Dependabot alerts, then dismiss or reopen or dismiss the alerts. For example, from the **Closed alerts** tab, you can select multiple alerts that have been previously dismissed, and then reopen them all at once. For more information, see "[About Dependabot alerts](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies)." - | @@ -213,3 +211,4 @@ sections: - In a repository's settings, enabling the option to allow users with read access to create discussions does not enable this functionality. - In some cases, users cannot convert existing issues to discussions. - Custom patterns for secret scanning have `.*` as an end delimiter, specifically in the "After secret" field. This delimiter causes inconsistencies in scans for secrets across repositories, and you may notice gaps in a repository's history where no scans completed. Incremental scans may also be impacted. To prevent issues with scans, modify the end of the pattern to remove the `.*` delimiter. + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/zh-CN/data/reusables/accounts/create-personal-access-tokens.md b/translations/zh-CN/data/reusables/accounts/create-personal-access-tokens.md new file mode 100644 index 0000000000..5278d0c246 --- /dev/null +++ b/translations/zh-CN/data/reusables/accounts/create-personal-access-tokens.md @@ -0,0 +1 @@ +1. For each of your accounts, create a dedicated PAT with `repo` scope. 更多信息请参阅“[创建个人访问令牌](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)”。 \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/contacting-support.md b/translations/zh-CN/data/reusables/actions/contacting-support.md index 29b5768a68..be2a8c8dc1 100644 --- a/translations/zh-CN/data/reusables/actions/contacting-support.md +++ b/translations/zh-CN/data/reusables/actions/contacting-support.md @@ -5,5 +5,5 @@ If you need help with anything related to workflow configuration, such as syntax 如有以下任意情况，无论您的使用或预期使用是否属于使用限制类别，都请联系 {% data variables.contact.contact_support %}： * 如果您认为您的帐户受到不正确的限制 -* 如果您在执行您的操作之一时遇到意外错误，例如：唯一的 ID +* If you encounter an unexpected error when executing one of your actions * 如果你遇到与预期矛盾现有行为，但不一定是文件记录的情况。 diff --git a/translations/zh-CN/data/reusables/actions/github_sha_description.md b/translations/zh-CN/data/reusables/actions/github_sha_description.md new file mode 100644 index 0000000000..8f9ce93590 --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/github_sha_description.md @@ -0,0 +1 @@ +触发工作流程的提交 SHA。 此提交 SHA 的值取决于触发工作流程的事件。 更多信息请参阅“[触发工作流程的事件](/actions/using-workflows/events-that-trigger-workflows)”。 例如 `ffac537e6cbbf934b08745a378932722df287a53`。 \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/use-request-body-api.md b/translations/zh-CN/data/reusables/actions/use-request-body-api.md new file mode 100644 index 0000000000..1d37d0c4f0 --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/use-request-body-api.md @@ -0,0 +1 @@ +To apply this configuration, submit a request to the API endpoint and include the required configuration in the request body. For more information, see "[Set the customization template for an OIDC subject claim for an organization](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization)". \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/advanced-security/custom-link-beta.md b/translations/zh-CN/data/reusables/advanced-security/custom-link-beta.md new file mode 100644 index 0000000000..a79fc22417 --- /dev/null +++ b/translations/zh-CN/data/reusables/advanced-security/custom-link-beta.md @@ -0,0 +1,5 @@ +{% note %} + +**Note:** The ability to add resource links to blocked push messages is currently in public beta and subject to change. + +{% endnote %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/advanced-security/secret-scanning-push-protection-org.md b/translations/zh-CN/data/reusables/advanced-security/secret-scanning-push-protection-org.md index 5a86f3e78c..ebddd40be1 100644 --- a/translations/zh-CN/data/reusables/advanced-security/secret-scanning-push-protection-org.md +++ b/translations/zh-CN/data/reusables/advanced-security/secret-scanning-push-protection-org.md @@ -1,2 +1,6 @@ 1. 在“{% data variables.product.prodname_secret_scanning_caps %}”下的“Push protection（推送保护）”下，单击 **Enable all（启用所有）**。 ![显示如何为组织启用 {% data variables.product.prodname_secret_scanning %} 推送保护的屏幕截图](/assets/images/help/organizations/secret-scanning-enable-push-protection.png) -1. （可选）单击“自动为添加到 {% data variables.product.prodname_secret_scanning %} 的私有仓库启用”。 +1. Optionally, click "Automatically enable for private repositories added to {% data variables.product.prodname_secret_scanning %}."{% ifversion push-protection-custom-link-orgs %} +1. Optionally, to include a custom link in the message that members will see when they attempt to push a secret, select **Add a resource link in the CLI and web UI when a commit is blocked**, then type a URL, and click **Save link**. + {% ifversion push-protection-custom-link-orgs-beta %}{% indented_data_reference reusables.advanced-security.custom-link-beta spaces=3 %}{% endif %} + + ![Screenshot showing checkbox and text field for enabling a custom link](/assets/images/help/organizations/secret-scanning-custom-link.png){% endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/code-scanning/licensing-note.md b/translations/zh-CN/data/reusables/code-scanning/licensing-note.md index aada4a282a..78daff0333 100644 --- a/translations/zh-CN/data/reusables/code-scanning/licensing-note.md +++ b/translations/zh-CN/data/reusables/code-scanning/licensing-note.md @@ -1,8 +1,12 @@ {% note %} -**注意：** {% ifversion fpt %} - {% data variables.product.prodname_codeql_cli %} 可在公共存储库上免费使用。 {% data variables.product.prodname_codeql_cli %} 也可用于使用 {% data variables.product.prodname_ghe_cloud %} 并有 {% data variables.product.prodname_GH_advanced_security %} 许可证的组织拥有的私有存储库。 有关信息请参阅“[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} 条款和条件](https://securitylab.github.com/tools/codeql/license)”和“[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)”。 -{%- elsif ghec %} {% data variables.product.prodname_codeql_cli %} 可以免费用于在 {% data variables.product.prodname_dotcom_the_website %}上维护的公共存储库，并可用于具有 {% data variables.product.prodname_advanced_security %} 许可证的客户拥有的私有存储库。 有关信息请参阅“[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} 条款和条件](https://securitylab.github.com/tools/codeql/license)”和“[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)”。 -{%- elsif ghes or ghae %}{% data variables.product.prodname_codeql_cli %} 可用于拥有 {% data variables.product.prodname_advanced_security %} 许可证的客户。 +**Notes:** {% ifversion fpt %} +- The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories. {% data variables.product.prodname_codeql_cli %} 也可用于使用 {% data variables.product.prodname_ghe_cloud %} 并有 {% data variables.product.prodname_GH_advanced_security %} 许可证的组织拥有的私有存储库。 有关信息请参阅“[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} 条款和条件](https://securitylab.github.com/tools/codeql/license)”和“[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)”。 +{%- elsif ghec %} +- The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories that are maintained on {% data variables.product.prodname_dotcom_the_website %}, and available to use on private repositories that are owned by customers with an {% data variables.product.prodname_advanced_security %} license. 有关信息请参阅“[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} 条款和条件](https://securitylab.github.com/tools/codeql/license)”和“[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)”。 +{%- elsif ghes or ghae %} +- {% data variables.product.prodname_codeql_cli %} 可用于拥有 {% data variables.product.prodname_advanced_security %} 许可证的客户。 {% endif %} +- {% data reusables.code-scanning.non-glibc-linux-support %} + {% endnote %} diff --git a/translations/zh-CN/data/reusables/code-scanning/non-glibc-linux-support.md b/translations/zh-CN/data/reusables/code-scanning/non-glibc-linux-support.md new file mode 100644 index 0000000000..2a1c2a8e53 --- /dev/null +++ b/translations/zh-CN/data/reusables/code-scanning/non-glibc-linux-support.md @@ -0,0 +1 @@ +The {% data variables.product.prodname_codeql_cli %} is currently not compatible with non-glibc Linux distributions such as (musl-based) Alpine Linux. \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/codespaces/availability.md b/translations/zh-CN/data/reusables/codespaces/availability.md deleted file mode 100644 index 586d18c9f5..0000000000 --- a/translations/zh-CN/data/reusables/codespaces/availability.md +++ /dev/null @@ -1 +0,0 @@ -代码空间可用于使用 {% data variables.product.prodname_team %} 和 {% data variables.product.prodname_ghe_cloud %} 的组织拥有的存储库。 diff --git a/translations/zh-CN/data/reusables/codespaces/click-remote-explorer-icon-vscode.md b/translations/zh-CN/data/reusables/codespaces/click-remote-explorer-icon-vscode.md index 0eae7a1f6f..f4258a8c1b 100644 --- a/translations/zh-CN/data/reusables/codespaces/click-remote-explorer-icon-vscode.md +++ b/translations/zh-CN/data/reusables/codespaces/click-remote-explorer-icon-vscode.md @@ -1 +1,5 @@ -1. 在 {% data variables.product.prodname_vscode_shortname %} 中，从左侧边栏单击 Remote Explorer 图标。 ![{% data variables.product.prodname_vscode %} 中的 Remote Explorer 图标](/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png) +1. 在 {% data variables.product.prodname_vscode_shortname %} 中，从左侧边栏单击 Remote Explorer 图标。 + + ![{% data variables.product.prodname_vscode %} 中的 Remote Explorer 图标](/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png) + +{% indented_data_reference reusables.codespaces.remote-explorer spaces=3 %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/codespaces/codespaces-disabling-org-billing.md b/translations/zh-CN/data/reusables/codespaces/codespaces-disabling-org-billing.md new file mode 100644 index 0000000000..a3d7ca0c7a --- /dev/null +++ b/translations/zh-CN/data/reusables/codespaces/codespaces-disabling-org-billing.md @@ -0,0 +1,5 @@ +{% note %} + +**Note**: If you disable billable codespaces use for your organization, anyone who can create codespaces as an individual user, and can clone a repository in your organization, will still be able to create a codespace for that repository. However, this will not incur any charge for your organization. For information about restricting access to a repository, see "[Managing teams and people with access to your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." + +{% endnote %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/codespaces/codespaces-org-policies-note.md b/translations/zh-CN/data/reusables/codespaces/codespaces-org-policies-note.md new file mode 100644 index 0000000000..69e6530791 --- /dev/null +++ b/translations/zh-CN/data/reusables/codespaces/codespaces-org-policies-note.md @@ -0,0 +1,5 @@ +{% note %} + +**Note**: Organization policies you define for {% data variables.product.prodname_codespaces %} only apply to codespaces for which your organization will be billed. If an individual user creates a codespace for a repository in your organization, and the organization is not billed, then the codespace will not be bound by these policies. For information on how to choose who can create codespaces that are billed to your organization, see "[Enabling {% data variables.product.prodname_github_codespaces %} for your organization](https://docs-internal-29134-ad7bd8.preview.ghdocs.com/en/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization#choose-who-can-create-codespaces-that-are-billed-to-your-organization)." + +{% endnote %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/codespaces/codespaces-spending-limit-requirement.md b/translations/zh-CN/data/reusables/codespaces/codespaces-spending-limit-requirement.md index e0b45cbee3..2e4bd63ee8 100644 --- a/translations/zh-CN/data/reusables/codespaces/codespaces-spending-limit-requirement.md +++ b/translations/zh-CN/data/reusables/codespaces/codespaces-spending-limit-requirement.md @@ -1,9 +1,9 @@ {% note %} -**注意：**必须先设置支出限额，然后才能使用 {% data variables.product.prodname_codespaces %}。 +**Note:** You must set a non-zero spending limit before you can use {% data variables.product.prodname_codespaces %}. {% endnote %} -默认情况下，您的组织或企业的 {% data variables.product.prodname_github_codespaces %} 支出限制为 $0，这将阻止创建新代码空间或打开现有代码空间。 若要允许用户在组织中创建代码空间，请将限制设置为大于 $0 的值。 +By default, your organization or enterprise will have a {% data variables.product.prodname_github_codespaces %} spending limit of $0. This prevents new codespaces from being created, or existing codespaces from being opened, if this would incur a billable cost to your organization or enterprise. 若要允许用户在组织中创建代码空间，请将限制设置为大于 $0 的值。 {% data reusables.billing.overages-billed-monthly %} diff --git a/translations/zh-CN/data/reusables/codespaces/concurrent-codespace-limit.md b/translations/zh-CN/data/reusables/codespaces/concurrent-codespace-limit.md index b1b4c3dcdd..a73657b7b9 100644 --- a/translations/zh-CN/data/reusables/codespaces/concurrent-codespace-limit.md +++ b/translations/zh-CN/data/reusables/codespaces/concurrent-codespace-limit.md @@ -1 +1 @@ -每个仓库甚至每个分支可创建多个代码空间。 但是，每个个人帐户都有 10 个代码空间的限制。 如果您已达到上限，想要创建一个新的代码空间，必须先删除一个旧代码空间。 +每个仓库甚至每个分支可创建多个代码空间。 diff --git a/translations/zh-CN/data/reusables/codespaces/remote-explorer.md b/translations/zh-CN/data/reusables/codespaces/remote-explorer.md new file mode 100644 index 0000000000..c46ed9b539 --- /dev/null +++ b/translations/zh-CN/data/reusables/codespaces/remote-explorer.md @@ -0,0 +1,9 @@ +{% note %} + +**Note**: If the Remote Explorer is not displayed in the Activity Bar: + +1. Access the command palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux). +1. Type: `codespaces`. +1. Click **Codespaces: Details**. + +{% endnote %} diff --git a/translations/zh-CN/data/reusables/dependabot/dependabot-alerts-filters.md b/translations/zh-CN/data/reusables/dependabot/dependabot-alerts-filters.md new file mode 100644 index 0000000000..29684cdd92 --- /dev/null +++ b/translations/zh-CN/data/reusables/dependabot/dependabot-alerts-filters.md @@ -0,0 +1,17 @@ +You can sort and filter {% data variables.product.prodname_dependabot_alerts %} by typing filters as `key:value` pairs into the search bar. + +| 选项 | 描述 | 示例 | +|:---------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `生态系统` | Displays alerts for the selected ecosystem | Use `ecosystem:npm` to show {% data variables.product.prodname_dependabot_alerts %} for npm |{% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-7891 %} +| `has` | Displays alerts meeting the selected filter criteria | Use `has:patch` to show alerts related to advisories that have a patch{% ifversion dependabot-alerts-vulnerable-calls %}
    Use `has:vulnerable-calls` to show alerts relating to calls to vulnerable functions{% endif %} +{% endif %} +| `is` | Displays alerts based on their state | Use `is:open` to show open alerts | +| `manifest` | Displays alerts for the selected manifest | Use `manifest:webwolf/pom.xml` to show alerts on the pom.xml file of the webwolf application | +| `package` | Displays alerts for the selected package | Use `package:django` to show alerts for django | +| `解决方法` | Displays alerts of the selected resolution status | Use `resolution:no-bandwidth` to show alerts previously parked due to lack of resources or time to fix them | +| `repo` | Displays alerts based on the repository they relate to
    Note that this filter is only available on the security overview. For more information, see "[About the security overview](/code-security/security-overview/about-the-security-overview)" | Use `repo:octocat-repo` to show alerts in the repository called `octocat-repo` |{%- ifversion dependabot-alerts-development-label %} +| `作用域` | Displays alerts based on the scope of the dependency they relate to | Use `scope:development` to show alerts for dependencies that are only used during development +{% endif %} +| `严重程度` | Displays alerts based on their level of severity | Use `severity:high` to show alerts with a severity of High |{%- ifversion dependabot-most-important-sort-option %} +| `排序` | Displays alerts according to the selected sort order | The default sorting option for alerts is `sort:most-important`, which ranks alerts by importance
    Use `sort:newest` to show the latest alerts reported by {% data variables.product.prodname_dependabot %} +{% endif %} diff --git a/translations/zh-CN/data/reusables/discussions/starting-a-poll.md b/translations/zh-CN/data/reusables/discussions/starting-a-poll.md index bc71d6007a..d8375089ed 100644 --- a/translations/zh-CN/data/reusables/discussions/starting-a-poll.md +++ b/translations/zh-CN/data/reusables/discussions/starting-a-poll.md @@ -5,5 +5,5 @@ 1. 键入投票的标题和可选正文。 ![显示标题和正文文本字段的屏幕截图](/assets/images/help/discussions/new-poll-title-and-body-fields.png) 1. 输入投票问题。 ![显示投票问题的文本字段的屏幕截图](/assets/images/help/discussions/new-poll-question.png) 1. 为投票输入至少两个选项。 ![显示投票选项的文本字段的屏幕截图](/assets/images/help/discussions/new-poll-options.png) -1. （可选）要添加额外的投票选项，请单击 **Add an option（添加选项）**。 ![显示 "添加选项"按钮的屏幕截图](/assets/images/help/discussions/new-poll-add-option.png) +1. Optionally, to add an extra poll option, click **Add an option**. ![显示 "添加选项"按钮的屏幕截图](/assets/images/help/discussions/new-poll-add-option.png) 1. 点击 **Start poll（开始投票）**。 ![显示"开始投票"按钮的屏幕截图](/assets/images/help/discussions/new-poll-start-poll-button.png) diff --git a/translations/zh-CN/data/reusables/enterprise-accounts/repo-creation-policy.md b/translations/zh-CN/data/reusables/enterprise-accounts/repo-creation-policy.md index be5c8f8546..fa398e2027 100644 --- a/translations/zh-CN/data/reusables/enterprise-accounts/repo-creation-policy.md +++ b/translations/zh-CN/data/reusables/enterprise-accounts/repo-creation-policy.md @@ -1 +1,6 @@ -1. 在“Repository creation（仓库创建）”下，选择一个策略。 ![带有仓库创建策略选项的下拉菜单](/assets/images/help/business-accounts/repository-creation-policy-drop-down.png) +1. 在“Repository creation（仓库创建）”下，选择一个策略。 + {% ifversion enterprise-namespace-repo-setting %} + ![带有仓库创建策略选项的下拉菜单](/assets/images/help/business-accounts/restrict-personal-namespace-setting.png) + {% else %} + ![带有仓库创建策略选项的下拉菜单](/assets/images/help/business-accounts/repository-creation-policy-drop-down.png) + {% endif %} diff --git a/translations/zh-CN/data/reusables/enterprise-accounts/repository-visibility-policy.md b/translations/zh-CN/data/reusables/enterprise-accounts/repository-visibility-policy.md deleted file mode 100644 index 020b1d59e8..0000000000 --- a/translations/zh-CN/data/reusables/enterprise-accounts/repository-visibility-policy.md +++ /dev/null @@ -1 +0,0 @@ -1. 在“Repository visibility change（仓库可见性更改）”下，使用下拉菜单选择策略。 ![带有仓库可见性策略选项的下拉菜单](/assets/images/help/business-accounts/repository-visibility-policy-drop-down.png) diff --git a/translations/zh-CN/data/reusables/enterprise-accounts/security-tab.md b/translations/zh-CN/data/reusables/enterprise-accounts/security-tab.md index 361912ab4a..bb35e3750e 100644 --- a/translations/zh-CN/data/reusables/enterprise-accounts/security-tab.md +++ b/translations/zh-CN/data/reusables/enterprise-accounts/security-tab.md @@ -1,2 +1,7 @@ +{%- ifversion ghec or ghes > 3.4 or ghae-issue-7875 %} +1. In the left sidebar, click **Authentication security**. + {% ifversion ghae %}![Security tab in the enterprise account settings sidebar](/assets/images/enterprise/github-ae/enterprise-account-settings-authentication-security-tab.png){% else %}![Security tab in the enterprise account settings sidebar](/assets/images/help/business-accounts/enterprise-account-settings-authentication-security-tab.png){% endif %} +{%- else %} 1. 在左侧边栏中，单击 **Security（安全）**。 {% ifversion ghae %}![Security tab in the enterprise account settings sidebar](/assets/images/enterprise/github-ae/enterprise-account-settings-security-tab.png){% else %}![Security tab in the enterprise account settings sidebar](/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png){% endif %} +{%- endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md b/translations/zh-CN/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md index c5d6100063..d9e308eee9 100644 --- a/translations/zh-CN/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md +++ b/translations/zh-CN/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md @@ -1,4 +1,4 @@ -1. Define the key as a environment variable for {% data variables.product.product_name %}, replacing `` with the GPG key ID. +1. Define the key as an environment variable for {% data variables.product.product_name %}, replacing `` with the GPG key ID. ```bash{:copy} ghe-config "secrets.gpgverify.web-signing-key" "$(gpg --export-secret-keys -a | awk '{printf "%s\\n", $0}')" diff --git a/translations/zh-CN/data/reusables/git/cache-on-repository-path.md b/translations/zh-CN/data/reusables/git/cache-on-repository-path.md new file mode 100644 index 0000000000..ced81ebbd9 --- /dev/null +++ b/translations/zh-CN/data/reusables/git/cache-on-repository-path.md @@ -0,0 +1,5 @@ +1. To configure Git to cache credentials for each local directory where you clone a repository, enter the following command. + + ```shell{:copy} + git config --global credential.useHttpPath true + ``` diff --git a/translations/zh-CN/data/reusables/git/clear-stored-gcm-credentials.md b/translations/zh-CN/data/reusables/git/clear-stored-gcm-credentials.md new file mode 100644 index 0000000000..04e3de748e --- /dev/null +++ b/translations/zh-CN/data/reusables/git/clear-stored-gcm-credentials.md @@ -0,0 +1,5 @@ +- If the output is `manager-core`, you're using Git Credential Manager. To clear the credentials, run the following command. + + ```shell{:copy} + git credential-manager reject https://github.com + ``` diff --git a/translations/zh-CN/data/reusables/git/clear-the-stored-credentials.md b/translations/zh-CN/data/reusables/git/clear-the-stored-credentials.md new file mode 100644 index 0000000000..f723d7ab97 --- /dev/null +++ b/translations/zh-CN/data/reusables/git/clear-the-stored-credentials.md @@ -0,0 +1 @@ +1. If the output confirms that you're using a credential manager, clear the stored credentials for the credential manager. diff --git a/translations/zh-CN/data/reusables/git/confirm-credential-manager.md b/translations/zh-CN/data/reusables/git/confirm-credential-manager.md new file mode 100644 index 0000000000..68c6e99397 --- /dev/null +++ b/translations/zh-CN/data/reusables/git/confirm-credential-manager.md @@ -0,0 +1,5 @@ +1. To confirm your use of a credential manager, enter the following command and note the output. + + ```shell{:copy} + git config --get credential.helper + ``` diff --git a/translations/zh-CN/data/reusables/git/no-credential-manager.md b/translations/zh-CN/data/reusables/git/no-credential-manager.md new file mode 100644 index 0000000000..fe79c2ff04 --- /dev/null +++ b/translations/zh-CN/data/reusables/git/no-credential-manager.md @@ -0,0 +1 @@ +- If the output doesn't include the name of a credential manager, there is no credential manager configured, and you can proceed to the next step. \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/git/open-terminal.md b/translations/zh-CN/data/reusables/git/open-terminal.md new file mode 100644 index 0000000000..98b8f27c80 --- /dev/null +++ b/translations/zh-CN/data/reusables/git/open-terminal.md @@ -0,0 +1 @@ +1. 打开终端。 diff --git a/translations/zh-CN/data/reusables/git/provide-credentials.md b/translations/zh-CN/data/reusables/git/provide-credentials.md new file mode 100644 index 0000000000..351a1e87d1 --- /dev/null +++ b/translations/zh-CN/data/reusables/git/provide-credentials.md @@ -0,0 +1,3 @@ +1. The first time that you use Git to clone a repository or access data in a repository that you've already cloned, Git will request credentials. Provide the PAT for the account with access to the repository. + + Git will cache the PAT for the directory you're in, and you'll be able to access and write repository data on {% data variables.product.product_location %} using the correct account. diff --git a/translations/zh-CN/data/reusables/gpg/configure-ssh-signing.md b/translations/zh-CN/data/reusables/gpg/configure-ssh-signing.md new file mode 100644 index 0000000000..f0f489a73a --- /dev/null +++ b/translations/zh-CN/data/reusables/gpg/configure-ssh-signing.md @@ -0,0 +1,4 @@ +1. Configure Git to use SSH to sign commits and tags: + ```bash + $ git config --global gpg.format ssh + ``` \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/gpg/copy-gpg-key-id.md b/translations/zh-CN/data/reusables/gpg/copy-gpg-key-id.md index f5de6e1efb..51cdb3d2e3 100644 --- a/translations/zh-CN/data/reusables/gpg/copy-gpg-key-id.md +++ b/translations/zh-CN/data/reusables/gpg/copy-gpg-key-id.md @@ -1,9 +1,9 @@ 1. 从 GPG 密钥列表中复制您想要使用的 GPG 密钥 ID 的长形式。 在此例中，GPG 密钥 ID 是 `3AA5C34371567BD2`： - ```shell + ```shell{:copy} $ gpg --list-secret-keys --keyid-format=long /Users/hubot/.gnupg/secring.gpg ------------------------------------ sec 4096R/3AA5C34371567BD2 2016-03-10 [expires: 2017-03-10] uid Hubot ssb 4096R/42B317FD4BA89E7A 2016-03-10 - ``` + ``` diff --git a/translations/zh-CN/data/reusables/gpg/copy-ssh-public-key.md b/translations/zh-CN/data/reusables/gpg/copy-ssh-public-key.md new file mode 100644 index 0000000000..3c9ff53640 --- /dev/null +++ b/translations/zh-CN/data/reusables/gpg/copy-ssh-public-key.md @@ -0,0 +1,43 @@ +1. 将 SSH 公钥复制到剪贴板。 + + 如果您的 SSH 公钥文件与示例代码不同，请修改文件名以匹配您当前的设置。 在复制密钥时，请勿添加任何新行或空格。 +{% mac %} + + ```shell + $ pbcopy < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub + # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard + ``` + + {% tip %} + + **提示：**如果 `pbcopy` 不可用，可找到隐藏的 `.ssh` 文件夹，在常用的文本编辑器中打开该文件，并将其复制到剪贴板。 + + {% endtip %} +{% endmac %} +{% windows %} + + ```shell + $ clip < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub + # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard + ``` + + {% tip %} + + **提示：**如果 `clip` 不可用，可找到隐藏的 `.ssh` 文件夹，在常用的文本编辑器中打开该文件，并将其复制到剪贴板。 + + {% endtip %} +{% endwindows %} +{% linux %} + + ```shell + $ cat ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub + # Then select and copy the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file + # displayed in the terminal to your clipboard + ``` + + {% tip %} + + **提示：**或者，您也可以找到隐藏的 `.ssh` 文件夹，在常用的文本编辑器中打开该文件，并将其复制到剪贴板。 + + {% endtip %} +{% endlinux %} diff --git a/translations/zh-CN/data/reusables/gpg/list-keys-with-note.md b/translations/zh-CN/data/reusables/gpg/list-keys-with-note.md index 38cea23d74..3ad866aa38 100644 --- a/translations/zh-CN/data/reusables/gpg/list-keys-with-note.md +++ b/translations/zh-CN/data/reusables/gpg/list-keys-with-note.md @@ -1,10 +1,11 @@ - 1. 使用 `gpg --list-secret-keys --keyid-format=long` 命令列出您拥有其公钥和私钥的长形式 GPG 密钥。 签名提交或标记需要私钥。 - ```shell - $ gpg --list-secret-keys --keyid-format=long -``` - {% note %} - **注：**Linux上的一些 GPG 安装可能需要使用 `gpg2 --list-keyid-form LONG` 查看您现有密钥的列表。 在这种情况下，您还需要运行 `git config --global gpg.program gpg2` 来配置 Git 使用 `git gpg2`。 + ```shell{:copy} + $ gpg --list-secret-keys --keyid-format=long + ``` - {% endnote %} + {% note %} + + **注：**Linux上的一些 GPG 安装可能需要使用 `gpg2 --list-keyid-form LONG` 查看您现有密钥的列表。 在这种情况下，您还需要运行 `git config --global gpg.program gpg2` 来配置 Git 使用 `git gpg2`。 + + {% endnote %} diff --git a/translations/zh-CN/data/reusables/gpg/paste-ssh-public-key.md b/translations/zh-CN/data/reusables/gpg/paste-ssh-public-key.md new file mode 100644 index 0000000000..1274a0acb5 --- /dev/null +++ b/translations/zh-CN/data/reusables/gpg/paste-ssh-public-key.md @@ -0,0 +1,4 @@ +1. To set your SSH signing key in Git, paste the text below, substituting the contents of your clipboard for the key you'd like to use. Since the key contains spaces, you must wrap it in quotes: + ```bash + $ git config --global user.signingkey 'ssh-ed25519 AAAAC3(...) user@example.com' + ``` \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/gpg/ssh-git-version.md b/translations/zh-CN/data/reusables/gpg/ssh-git-version.md new file mode 100644 index 0000000000..d75ab5df71 --- /dev/null +++ b/translations/zh-CN/data/reusables/gpg/ssh-git-version.md @@ -0,0 +1,6 @@ + +{% note %} + +**Note:** SSH signature verification is available in Git 2.34 or later. 要更新 Git 版本，请参阅 [Git](https://git-scm.com/downloads) 网站。 + +{% endnote %} diff --git a/translations/zh-CN/data/reusables/gpg/x-509-key.md b/translations/zh-CN/data/reusables/gpg/x-509-key.md index b8ad4b392f..11c88ba0e0 100644 --- a/translations/zh-CN/data/reusables/gpg/x-509-key.md +++ b/translations/zh-CN/data/reusables/gpg/x-509-key.md @@ -1,5 +1,5 @@ -### 将您的 X.509 密钥告知 Git +## 将您的 X.509 密钥告知 Git 您可以使用 [smimesign](https://github.com/github/smimesign) 以 S/MIME 代替 GPG 对提交和标记签名。 diff --git a/translations/zh-CN/data/reusables/identity-and-permissions/about-adding-ip-allow-list-entries.md b/translations/zh-CN/data/reusables/identity-and-permissions/about-adding-ip-allow-list-entries.md new file mode 100644 index 0000000000..772581f87a --- /dev/null +++ b/translations/zh-CN/data/reusables/identity-and-permissions/about-adding-ip-allow-list-entries.md @@ -0,0 +1,3 @@ +You can create an IP allow list by adding entries that each contain an IP address or address range.{% ifversion ip-allow-list-address-check %} After you finish adding entries, you can check whether a particular IP address would be allowed by any of the enabled entries in your list.{% endif %} + +Before the list restricts access to {% ifversion ghae %}your enterprise{% else %}private assets owned by organizations in your enterprise{% endif %}, you must also enable allowed IP addresses. \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/identity-and-permissions/about-checking-ip-address.md b/translations/zh-CN/data/reusables/identity-and-permissions/about-checking-ip-address.md new file mode 100644 index 0000000000..dfdc758f91 --- /dev/null +++ b/translations/zh-CN/data/reusables/identity-and-permissions/about-checking-ip-address.md @@ -0,0 +1 @@ +You can check whether a particular IP address would be allowed by any of the enabled entries in your IP allow list, even if the list is not currently enabled. \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md b/translations/zh-CN/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md new file mode 100644 index 0000000000..d646e02ec5 --- /dev/null +++ b/translations/zh-CN/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md @@ -0,0 +1,5 @@ +You can edit an entry in your IP allow list. If you edit an enabled entry, changes are enforced immediately. + +{% ifversion ip-allow-list-address-check %} +After you finish editing entries, you can check whether a particular IP address would be allowed by any of the enabled entries in your list. +{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md b/translations/zh-CN/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md new file mode 100644 index 0000000000..f886df0690 --- /dev/null +++ b/translations/zh-CN/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md @@ -0,0 +1,5 @@ +After you create an IP allow list, you can enable allowed IP addresses. When you enable allowed IP addresses, {% data variables.product.company_short %} immediately enforces any enabled entries in your IP allow list. + +{% ifversion ip-allow-list-address-check %} +Before you enable allowed IP addresses, you can check whether a particular IP address would be allowed by any of the enabled entries in your list. For more information, see "[Checking if an IP address is permitted](#checking-if-an-ip-address-is-permitted)." +{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/identity-and-permissions/check-ip-address-step.md b/translations/zh-CN/data/reusables/identity-and-permissions/check-ip-address-step.md new file mode 100644 index 0000000000..5e73fdddcd --- /dev/null +++ b/translations/zh-CN/data/reusables/identity-and-permissions/check-ip-address-step.md @@ -0,0 +1 @@ +1. Under "Check your IP address", enter an IP address. ![Screenshot of the "Check IP address" text field](/assets/images/help/security/check-ip-address.png) \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/identity-and-permissions/check-ip-address.md b/translations/zh-CN/data/reusables/identity-and-permissions/check-ip-address.md new file mode 100644 index 0000000000..9a187752d6 --- /dev/null +++ b/translations/zh-CN/data/reusables/identity-and-permissions/check-ip-address.md @@ -0,0 +1,3 @@ +{%- ifversion ip-allow-list-address-check %} +1. Optionally, check if a particular IP address would be allowed by any of the enabled entries in your list. For more information, see "[Checking if an IP address is permitted](#checking-if-an-ip-address-is-permitted)." +{%- endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/identity-and-permissions/ip-allow-lists-enable.md b/translations/zh-CN/data/reusables/identity-and-permissions/ip-allow-lists-enable.md index be86d46b13..9e538b2c26 100644 --- a/translations/zh-CN/data/reusables/identity-and-permissions/ip-allow-lists-enable.md +++ b/translations/zh-CN/data/reusables/identity-and-permissions/ip-allow-lists-enable.md @@ -1 +1,3 @@ -要执行 IP 允许列表，必须先将 IP 地址添加到列表，然后启用 IP 允许列表。 您必须先添加当前 IP 地址或匹配范围，然后才能启用 IP 允许列表。 +To enforce the IP allow list, you must first add IP addresses to the list, then enable the IP allow list.{% ifversion ip-allow-list-address-check %} After you complete your list, you can check whether a particular IP address would be allowed by any of the enabled entries in the list.{% endif %} + +您必须先添加当前 IP 地址或匹配范围，然后才能启用 IP 允许列表。 diff --git a/translations/zh-CN/data/reusables/identity-and-permissions/ipv6-allow-lists.md b/translations/zh-CN/data/reusables/identity-and-permissions/ipv6-allow-lists.md new file mode 100644 index 0000000000..3c26491fe2 --- /dev/null +++ b/translations/zh-CN/data/reusables/identity-and-permissions/ipv6-allow-lists.md @@ -0,0 +1,7 @@ +{% ifversion fpt or ghec %} +{% note %} + +**Note:** {% data variables.product.company_short %} is gradually rolling out support for IPv6. As {% data variables.product.prodname_dotcom %} services continue to add IPv6 support, we will start recognizing IPv6 addresses of {% data variables.product.prodname_dotcom %} users. To prevent possible access interruptions, please ensure you have added any necessary IPv6 addresses to your IP allow list. + +{% endnote %} +{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/organizations/about-following-organizations.md b/translations/zh-CN/data/reusables/organizations/about-following-organizations.md new file mode 100644 index 0000000000..52e52467fb --- /dev/null +++ b/translations/zh-CN/data/reusables/organizations/about-following-organizations.md @@ -0,0 +1 @@ +When you follow organizations on {% data variables.product.product_name %}, you'll see their {% ifversion fpt or ghec %}public{% endif %} activity on your personal dashboard. This activity includes new discussions, sponsorships, and repositories. \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/organizations/follow-organizations-beta.md b/translations/zh-CN/data/reusables/organizations/follow-organizations-beta.md new file mode 100644 index 0000000000..27d068eb46 --- /dev/null +++ b/translations/zh-CN/data/reusables/organizations/follow-organizations-beta.md @@ -0,0 +1,5 @@ +{% note %} + +**注意：** 关注组织的功能目前处于公开测试阶段，可能会发生变化。 + +{% endnote %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/package_registry/authenticate-packages.md b/translations/zh-CN/data/reusables/package_registry/authenticate-packages.md index a766f6e96d..5ca4e91584 100644 --- a/translations/zh-CN/data/reusables/package_registry/authenticate-packages.md +++ b/translations/zh-CN/data/reusables/package_registry/authenticate-packages.md @@ -4,4 +4,4 @@ You can use a personal access token (PAT) to authenticate to {% data variables.p To authenticate to a {% data variables.product.prodname_registry %} registry within a {% data variables.product.prodname_actions %} workflow, you can use: - `GITHUB_TOKEN` to publish packages associated with the workflow repository. -- a PAT to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). +- a PAT with at least `packages:read` scope to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). diff --git a/translations/zh-CN/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md b/translations/zh-CN/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md deleted file mode 100644 index a54f9a0844..0000000000 --- a/translations/zh-CN/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md +++ /dev/null @@ -1,11 +0,0 @@ -{% ifversion fpt or ghec or ghes > 3.4 %} - -To authenticate to the {% data variables.product.prodname_container_registry %} within a {% data variables.product.prodname_actions %} workflow, use the `GITHUB_TOKEN` for the best security and experience. If your workflow is using a personal access token (PAT) to authenticate to `{% data reusables.package_registry.container-registry-hostname %}`, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. - -{% ifversion fpt or ghec %}For guidance on updating your workflows that authenticate to `{% data reusables.package_registry.container-registry-hostname %}` with a personal access token, see "[Upgrading a workflow that accesses `ghcr.io`](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#upgrading-a-workflow-that-accesses-ghcrio)."{% endif %} - -For more information about the `GITHUB_TOKEN`, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)." - -If you're using the {% data variables.product.prodname_container_registry %} in actions, follow our security best practices at "[Security hardening for GitHub Actions](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)." - -{% endif %} diff --git a/translations/zh-CN/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md b/translations/zh-CN/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md new file mode 100644 index 0000000000..9eb44525c7 --- /dev/null +++ b/translations/zh-CN/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md @@ -0,0 +1,7 @@ +If your workflow is using a personal access token (PAT) to authenticate to a registry, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. + +{% ifversion fpt or ghec %}For guidance on updating your workflows that authenticate to a registry with a personal access token, see "[Upgrading a workflow that accesses a registry using a PAT](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#upgrading-a-workflow-that-accesses-a-registry-using-a-pat)."{% endif %} + +有关 `GITHUB_TOKEN` 的更多信息，请参阅“[工作流程中的身份验证](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)”。 + +For more information about the best practises when using a registry in actions, see "[Security hardening for GitHub Actions](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)." diff --git a/translations/zh-CN/data/reusables/package_registry/no-graphql-to-delete-packages.md b/translations/zh-CN/data/reusables/package_registry/no-graphql-to-delete-packages.md new file mode 100644 index 0000000000..cbab609f2b --- /dev/null +++ b/translations/zh-CN/data/reusables/package_registry/no-graphql-to-delete-packages.md @@ -0,0 +1 @@ +{% ifversion fpt or ghec %} The {% data variables.product.prodname_registry %} GraphQL API does not support containers or Docker images that use the package namespace `https://ghcr.io/OWNER/PACKAGE-NAME`, or npm images that use the package namespace `https://npm.pkg.github.com/OWNER/PACKAGE-NAME`.{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md b/translations/zh-CN/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md index 313d4af669..eca96c2af5 100644 --- a/translations/zh-CN/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md +++ b/translations/zh-CN/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md @@ -1,16 +1,16 @@ -{% ifversion ghes > 3.1 or ghes < 3.5 %} +{% ifversion ghes < 3.5 %} -In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server 3.5 or later may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 when you upgrade from an earlier release to 3.5 or later. A fix for 3.5 and later will be available in an upcoming patch release. +In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server 3.5 or later may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 when you upgrade from an earlier release to 3.5 or later. A fix will be available in upcoming patch releases. -To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). [Updated: 2022-08-16] +To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). [Updated: 2022-08-26] -{% elsif ghes > 3.4 or ghes < 3.7 %} +{% elsif ghes = 3.5 or ghes = 3.6 %} -In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server {{ currentVersion }} may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 as you upgrade to the latest release. To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). +In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server {{ allVersions[currentVersion].currentRelease }} may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 as you upgrade to the latest release. To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). - To display the missing alerts for all repositories owned by an organization, organization owners can navigate to the organization's **Code security and analysis** settings, then click **Enable all** for secret scanning. 更多信息请参阅“[管理组织的安全和分析设置](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories)”。 - To display the missing alerts for an individual repository, people with admin access to the repository can disable then enable secret scanning for the repository. 更多信息请参阅“[管理仓库的安全和分析设置](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)”。 -A fix will be available in an upcoming patch release. [Updated: 2022-08-16] +A fix will be available in an upcoming patch release. [Updated: 2022-08-26] {% endif %} diff --git a/translations/zh-CN/data/reusables/secret-scanning/push-protection-web-ui-choice.md b/translations/zh-CN/data/reusables/secret-scanning/push-protection-web-ui-choice.md index 250e5c68e6..933b576cd0 100644 --- a/translations/zh-CN/data/reusables/secret-scanning/push-protection-web-ui-choice.md +++ b/translations/zh-CN/data/reusables/secret-scanning/push-protection-web-ui-choice.md @@ -2,5 +2,12 @@ 您将在页面顶部看到一个横幅，其中包含有关密钥位置的信息，并且密钥也将在文件中加下划线，以便您可以轻松找到它。 +{% ifversion push-protection-custom-link-orgs %} + + ![显示由于机密扫描推送保护而在 Web UI 中阻止提交的屏幕截图](/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-blocked-banner-with-link.png) + +{% else %} + ![显示由于机密扫描推送保护而在 Web UI 中阻止提交的屏幕截图](/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-blocked-banner.png) - \ No newline at end of file + +{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/ui.yml b/translations/zh-CN/data/ui.yml index 94597dcfdf..e8fea47fbb 100644 --- a/translations/zh-CN/data/ui.yml +++ b/translations/zh-CN/data/ui.yml @@ -32,6 +32,9 @@ search: search_error: 尝试执行搜索时出错。 description: 输入搜索词以在 GitHub 文档中查找。 label: 搜索 GitHub 文档 + results_found: Found {n} results in {s}ms + results_page: This is page {page} of {pages}. + nothing_found: Nothing found 😿 homepage: explore_by_product: 按产品浏览 version_picker: 版本 diff --git a/translations/zh-CN/data/variables/product.yml b/translations/zh-CN/data/variables/product.yml index 5d09c47040..7e67ff4653 100644 --- a/translations/zh-CN/data/variables/product.yml +++ b/translations/zh-CN/data/variables/product.yml @@ -112,6 +112,10 @@ prodname_registry: 'GitHub Packages' prodname_container_registry: 'Container registry' prodname_docker_registry_namespace: '{% ifversion fpt or ghec %}`docker.pkg.github.com`{% elsif ghes or ghae %}docker.HOSTNAME{% endif %}' prodname_container_registry_namespace: '{% ifversion fpt or ghec %}`ghcr.io`{% elsif ghes or ghae %}containers.HOSTNAME{% endif %}' +prodname_npm_registry: 'npm 注册表' +prodname_ghcr_and_npm_registry: '{% data variables.product.prodname_container_registry %}{% ifversion packages-npm-v2 %} and {% data variables.product.prodname_npm_registry %}{% endif %}' +prodname_ghcr_or_npm_registry: '{% data variables.product.prodname_container_registry %}{% ifversion packages-npm-v2 %} or {% data variables.product.prodname_npm_registry %}{% endif %}' +prodname_ghcr_and_npm_registry_full: '{% data variables.product.prodname_container_registry %} (`ghcr.io`){% ifversion packages-npm-v2 %} and {% data variables.product.prodname_npm_registry %} (`npm.pkg.github.com`){% endif %}' #GitHub Insights prodname_insights: 'GitHub Insights' #GitHub Sponsors
    Runner imageImagen de ejecutor Etiqueta de flujo de trabajo YAML Notas
    -Migrate to ubuntu-20.04 or ubuntu-22.04. Para obtener más información, consulta esta publicación del blog de GitHub. +Migrarse a ubuntu-20.04 o ubuntu-22.04. Para obtener más información, consulta esta publicación del blog de GitHub.