diff --git a/components/playground/content/actions/guides/building-and-testing-nodejs-or-python/python.tsx b/components/playground/content/actions/guides/building-and-testing-nodejs-or-python/python.tsx index d5fcdeeb81d5..3fa10aa614b9 100644 --- a/components/playground/content/actions/guides/building-and-testing-nodejs-or-python/python.tsx +++ b/components/playground/content/actions/guides/building-and-testing-nodejs-or-python/python.tsx @@ -513,7 +513,7 @@ const article: PlaygroundArticleT = { - name: Test with pytest run: pytest tests.py --doctest-modules --junitxml=junit/test-results-\${{ matrix.python-version }}.xml - name: Upload pytest test results - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: pytest-results-\${{ matrix.python-version }} path: junit/test-results-\${{ matrix.python-version }}.xml diff --git a/content/actions/automating-builds-and-tests/building-and-testing-java-with-ant.md b/content/actions/automating-builds-and-tests/building-and-testing-java-with-ant.md index b7edd8756f20..e2aadd74da4c 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-java-with-ant.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-java-with-ant.md @@ -119,7 +119,7 @@ steps: distribution: 'adopt' - run: ant -noinput -buildfile build.xml - - uses: actions/upload-artifact@v2 + - uses: actions/upload-artifact@v3 with: name: Package path: build/jar diff --git a/content/actions/automating-builds-and-tests/building-and-testing-java-with-gradle.md b/content/actions/automating-builds-and-tests/building-and-testing-java-with-gradle.md index 79432ec129e9..52579ef3e63c 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-java-with-gradle.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-java-with-gradle.md @@ -138,7 +138,7 @@ steps: uses: gradle/gradle-build-action@937999e9cc2425eddc7fd62d1053baf041147db7 with: arguments: build - - uses: actions/upload-artifact@v2 + - uses: actions/upload-artifact@v3 with: name: Package path: build/libs diff --git a/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md b/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md index a01a3409746d..4de00750fe07 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md @@ -140,7 +140,7 @@ steps: distribution: 'adopt' - run: mvn --batch-mode --update-snapshots verify - run: mkdir staging && cp target/*.jar staging - - uses: actions/upload-artifact@v2 + - uses: actions/upload-artifact@v3 with: name: Package path: staging diff --git a/content/actions/automating-builds-and-tests/building-and-testing-net.md b/content/actions/automating-builds-and-tests/building-and-testing-net.md index 9eb672e9dbcf..ef985f36347a 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-net.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-net.md @@ -218,7 +218,7 @@ jobs: - name: Test with dotnet run: dotnet test --logger trx --results-directory "TestResults-${{ matrix.dotnet-version }}" - name: Upload dotnet test results - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: dotnet-results-${{ matrix.dotnet-version }} path: TestResults-${{ matrix.dotnet-version }} diff --git a/content/actions/automating-builds-and-tests/building-and-testing-powershell.md b/content/actions/automating-builds-and-tests/building-and-testing-powershell.md index ef9a2f2452cb..41eba55818a4 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-powershell.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-powershell.md @@ -213,7 +213,7 @@ jobs: shell: pwsh run: Invoke-Pester Unit.Tests.ps1 -Passthru | Export-CliXml -Path Unit.Tests.xml - name: Upload test results - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: ubuntu-Unit-Tests path: Unit.Tests.xml diff --git a/content/actions/automating-builds-and-tests/building-and-testing-python.md b/content/actions/automating-builds-and-tests/building-and-testing-python.md index c67f6a545b7f..55b26976e9b2 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-python.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-python.md @@ -380,7 +380,7 @@ jobs: - name: Test with pytest run: pytest tests.py --doctest-modules --junitxml=junit/test-results-${{ matrix.python-version }}.xml - name: Upload pytest test results - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: pytest-results-${{ matrix.python-version }} path: junit/test-results-${{ matrix.python-version }}.xml diff --git a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-java-to-azure-app-service.md b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-java-to-azure-app-service.md index eeb673d93e8c..a84f2ab17ebc 100644 --- a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-java-to-azure-app-service.md +++ b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-java-to-azure-app-service.md @@ -95,7 +95,7 @@ jobs: run: mvn clean install - name: Upload artifact for deployment job - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: java-app path: '{% raw %}${{ github.workspace }}{% endraw %}/target/*.jar' @@ -109,7 +109,7 @@ jobs: steps: - name: Download artifact from build job - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: name: java-app diff --git a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-net-to-azure-app-service.md b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-net-to-azure-app-service.md index 765760f82800..2af59204d1b2 100644 --- a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-net-to-azure-app-service.md +++ b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-net-to-azure-app-service.md @@ -105,7 +105,7 @@ jobs: run: dotnet publish -c Release -o {% raw %}${{env.DOTNET_ROOT}}{% endraw %}/myapp - name: Upload artifact for deployment job - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: .net-app path: {% raw %}${{env.DOTNET_ROOT}}{% endraw %}/myapp @@ -119,7 +119,7 @@ jobs: steps: - name: Download artifact from build job - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: name: .net-app diff --git a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md index a60a1cffbab2..b6f6a3cbc0c8 100644 --- a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md +++ b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md @@ -100,7 +100,7 @@ jobs: npm run build --if-present npm run test --if-present - name: Upload artifact for deployment job - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: node-app path: . @@ -114,7 +114,7 @@ jobs: steps: - name: Download artifact from build job - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: name: node-app diff --git a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-php-to-azure-app-service.md b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-php-to-azure-app-service.md index 4e5e6d7c6ca2..83dd9b08eb1d 100644 --- a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-php-to-azure-app-service.md +++ b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-php-to-azure-app-service.md @@ -116,7 +116,7 @@ jobs: run: composer validate --no-check-publish && composer install --prefer-dist --no-progress - name: Upload artifact for deployment job - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: php-app path: . @@ -130,7 +130,7 @@ jobs: steps: - name: Download artifact from build job - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: name: php-app diff --git a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-python-to-azure-app-service.md b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-python-to-azure-app-service.md index e1c2993f7a63..770a41f52f6a 100644 --- a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-python-to-azure-app-service.md +++ b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-python-to-azure-app-service.md @@ -111,7 +111,7 @@ jobs: # Optional: Add a step to run tests here (PyTest, Django test suites, etc.) - name: Upload artifact for deployment jobs - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: python-app path: | @@ -126,7 +126,7 @@ jobs: steps: - name: Download artifact from build job - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: name: python-app path: . diff --git a/content/actions/learn-github-actions/contexts.md b/content/actions/learn-github-actions/contexts.md index 47f5f8227b11..ef802f8589f1 100644 --- a/content/actions/learn-github-actions/contexts.md +++ b/content/actions/learn-github-actions/contexts.md @@ -516,7 +516,7 @@ jobs: ./build.sh --log-path ${{ runner.temp }}/build_logs - name: Upload logs on fail if: ${{ failure() }} - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: Build failure logs path: ${{ runner.temp }}/build_logs @@ -598,7 +598,7 @@ jobs: - uses: actions/checkout@v2 - run: npm test > test-job-${{ strategy.job-index }}.txt - name: Upload logs - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: Build log for job ${{ strategy.job-index }} path: test-job-${{ strategy.job-index }}.txt diff --git a/content/actions/learn-github-actions/essential-features-of-github-actions.md b/content/actions/learn-github-actions/essential-features-of-github-actions.md index d817b01d1f23..9bfcb5e8ae83 100644 --- a/content/actions/learn-github-actions/essential-features-of-github-actions.md +++ b/content/actions/learn-github-actions/essential-features-of-github-actions.md @@ -75,7 +75,7 @@ jobs: run: | expr 1 + 1 > output.log - name: Upload output file - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: output-log-file path: output.log @@ -88,7 +88,7 @@ jobs: example-job: steps: - name: Download a single artifact - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: name: output-log-file ``` diff --git a/content/actions/migrating-to-github-actions/migrating-from-circleci-to-github-actions.md b/content/actions/migrating-to-github-actions/migrating-from-circleci-to-github-actions.md index aa34d59cd51d..9a50e9a5e0f3 100644 --- a/content/actions/migrating-to-github-actions/migrating-from-circleci-to-github-actions.md +++ b/content/actions/migrating-to-github-actions/migrating-from-circleci-to-github-actions.md @@ -157,7 +157,7 @@ GitHub Actions {% raw %} ```yaml - name: Upload math result for job 1 - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: homework path: math-homework.txt @@ -165,7 +165,7 @@ GitHub Actions ... - name: Download math result for job 1 - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: name: homework ``` diff --git a/content/actions/migrating-to-github-actions/migrating-from-gitlab-cicd-to-github-actions.md b/content/actions/migrating-to-github-actions/migrating-from-gitlab-cicd-to-github-actions.md index 1d15ec53f9d5..355ac71a6826 100644 --- a/content/actions/migrating-to-github-actions/migrating-from-gitlab-cicd-to-github-actions.md +++ b/content/actions/migrating-to-github-actions/migrating-from-gitlab-cicd-to-github-actions.md @@ -391,7 +391,7 @@ artifacts: {% raw %} ```yaml - name: Upload math result for job 1 - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: homework path: math-homework.txt diff --git a/content/actions/using-workflows/events-that-trigger-workflows.md b/content/actions/using-workflows/events-that-trigger-workflows.md index 855f74851d24..8964e7ea9381 100644 --- a/content/actions/using-workflows/events-that-trigger-workflows.md +++ b/content/actions/using-workflows/events-that-trigger-workflows.md @@ -1429,7 +1429,7 @@ jobs: run: | mkdir -p ./pr echo $PR_NUMBER > ./pr/pr_number - - uses: actions/upload-artifact@v2 + - uses: actions/upload-artifact@v3 with: name: pr_number path: pr/ diff --git a/content/actions/using-workflows/storing-workflow-data-as-artifacts.md b/content/actions/using-workflows/storing-workflow-data-as-artifacts.md index c7cbdedbca5e..ed6162ec6b3e 100644 --- a/content/actions/using-workflows/storing-workflow-data-as-artifacts.md +++ b/content/actions/using-workflows/storing-workflow-data-as-artifacts.md @@ -101,14 +101,14 @@ jobs: npm run build --if-present npm test - name: Archive production artifacts - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: dist-without-markdown path: | dist !dist/**/*.md - name: Archive code coverage results - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: code-coverage-report path: output/test/code-coverage.html @@ -120,7 +120,7 @@ You can define a custom retention period for individual artifacts created by a w ```yaml{:copy} - name: 'Upload Artifact' - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: my-artifact path: my_file.txt @@ -149,7 +149,7 @@ Specify an artifact's name to download an individual artifact. If you uploaded a ```yaml - name: Download a single artifact - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: name: my-artifact ``` @@ -158,7 +158,7 @@ You can also download all artifacts in a workflow run by not specifying a name. ```yaml - name: Download all workflow run artifacts - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 ``` If you download all workflow run's artifacts, a directory for each artifact is created using its name. @@ -200,7 +200,7 @@ jobs: run: | expr 3 + 7 > math-homework.txt - name: Upload math result for job 1 - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: homework path: math-homework.txt @@ -211,7 +211,7 @@ jobs: runs-on: windows-latest steps: - name: Download math result for job 1 - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: name: homework - shell: bash @@ -219,7 +219,7 @@ jobs: value=`cat math-homework.txt` expr $value \* 9 > math-homework.txt - name: Upload math result for job 2 - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: homework path: math-homework.txt @@ -230,7 +230,7 @@ jobs: runs-on: macOS-latest steps: - name: Download math result for job 2 - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: name: homework - name: Print the final result diff --git a/content/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md b/content/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md index 13089317add6..c55b49c3cf66 100644 --- a/content/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md +++ b/content/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md @@ -72,7 +72,7 @@ You can populate the runner tool cache by running a {% data variables.product.pr cd "${{ runner.tool_cache }}" tar -czf tool_cache.tar.gz * - name: Upload tool cache artifact - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: path: ${{runner.tool_cache}}/tool_cache.tar.gz ``` diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 26e56c841b12..bc64e00e3aac 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -80969,12 +80969,12 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" }, - "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"About secret scanning for private repositories\"\nfor a complete list of secret types (API slug).

" + "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

" }, { "name": "resolution", @@ -81088,12 +81088,12 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" }, - "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"About secret scanning for private repositories\"\nfor a complete list of secret types (API slug).

" + "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

" }, { "name": "resolution", @@ -81206,12 +81206,12 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" }, - "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"About secret scanning for private repositories\"\nfor a complete list of secret types (API slug).

" + "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

" }, { "name": "resolution", @@ -81264,7 +81264,7 @@ "category": "secret-scanning", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

\n

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.

", + "descriptionHTML": "

Lists secret scanning alerts for an eligible repository, from newest to oldest.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the repo scope or security_events scope.\nFor public repositories, you may instead use the public_repo scope.

\n

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.

", "responses": [ { "httpStatusCode": "200", @@ -81340,7 +81340,7 @@ "category": "secret-scanning", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

\n

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.

", + "descriptionHTML": "

Gets a single secret scanning alert detected in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the repo scope or security_events scope.\nFor public repositories, you may instead use the public_repo scope.

\n

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.

", "responses": [ { "httpStatusCode": "200", @@ -81468,7 +81468,7 @@ "slug": "update-a-secret-scanning-alert", "category": "secret-scanning", "notes": [], - "descriptionHTML": "

Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

\n

GitHub Apps must have the secret_scanning_alerts write permission to use this endpoint.

", + "descriptionHTML": "

Updates the status of a secret scanning alert in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the repo scope or security_events scope.\nFor public repositories, you may instead use the public_repo scope.

\n

GitHub Apps must have the secret_scanning_alerts write permission to use this endpoint.

", "bodyParameters": [ { "description": "

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

", @@ -81601,7 +81601,7 @@ "category": "secret-scanning", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

\n

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.

", + "descriptionHTML": "

Lists all locations for a given secret scanning alert for an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the repo scope or security_events scope.\nFor public repositories, you may instead use the public_repo scope.

\n

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.

", "responses": [ { "httpStatusCode": "200", diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json index 2d6c312a1c08..b2d7e325b88d 100644 --- a/lib/rest/static/decorated/ghes-3.1.json +++ b/lib/rest/static/decorated/ghes-3.1.json @@ -66019,12 +66019,12 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.1/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" }, - "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"About secret scanning for private repositories\"\nfor a complete list of secret types (API slug).

" + "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

" }, { "name": "resolution", diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index f957464e3569..7f0bc86e037c 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -68239,12 +68239,12 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.2/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" }, - "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"About secret scanning for private repositories\"\nfor a complete list of secret types (API slug).

" + "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

" }, { "name": "resolution", diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index cab60cf3ca46..0c28439fcb8c 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -68420,12 +68420,12 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.3/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.3/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" }, - "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"About secret scanning for private repositories\"\nfor a complete list of secret types (API slug).

" + "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

" }, { "name": "resolution", @@ -68538,12 +68538,12 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.3/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.3/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" }, - "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"About secret scanning for private repositories\"\nfor a complete list of secret types (API slug).

" + "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

" }, { "name": "resolution", diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json index 93eaf8d74759..d6af131243e4 100644 --- a/lib/rest/static/decorated/ghes-3.4.json +++ b/lib/rest/static/decorated/ghes-3.4.json @@ -72056,12 +72056,12 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.4/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" }, - "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"About secret scanning for private repositories\"\nfor a complete list of secret types (API slug).

" + "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

" }, { "name": "resolution", @@ -72175,12 +72175,12 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.4/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" }, - "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"About secret scanning for private repositories\"\nfor a complete list of secret types (API slug).

" + "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

" }, { "name": "resolution", @@ -72293,12 +72293,12 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.4/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" }, - "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"About secret scanning for private repositories\"\nfor a complete list of secret types (API slug).

" + "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

" }, { "name": "resolution", diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index c6a59bc5cd36..7fcd69471418 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -61132,12 +61132,12 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/github-ae@latest/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/github-ae@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" }, - "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"About secret scanning for private repositories\"\nfor a complete list of secret types (API slug).

" + "descriptionHTML": "

A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types (API slug).

" }, { "name": "resolution", diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index f1d4a68939bd..4cc5fb53706c 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -22928,7 +22928,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" @@ -103013,7 +103013,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" @@ -359526,7 +359526,7 @@ "/repos/{owner}/{repo}/secret-scanning/alerts": { "get": { "summary": "List secret scanning alerts for a repository", - "description": "Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "description": "Lists secret scanning alerts for an eligible repository, from newest to oldest.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", "tags": [ "secret-scanning" ], @@ -359568,7 +359568,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" @@ -359887,7 +359887,7 @@ "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { "get": { "summary": "Get a secret scanning alert", - "description": "Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "description": "Gets a single secret scanning alert detected in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", "tags": [ "secret-scanning" ], @@ -360174,7 +360174,7 @@ }, "patch": { "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.", + "description": "Updates the status of a secret scanning alert in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.", "operationId": "secret-scanning/update-alert", "tags": [ "secret-scanning" @@ -360520,7 +360520,7 @@ "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": { "get": { "summary": "List locations for a secret scanning alert", - "description": "Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "description": "Lists all locations for a given secret scanning alert for an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", "tags": [ "secret-scanning" ], diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json index c6b58e01dc26..5f9d90797459 100644 --- a/lib/rest/static/dereferenced/ghes-3.1.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json @@ -305005,7 +305005,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.1/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index ec65af732deb..e5e81823ad63 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -312390,7 +312390,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.2/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index 28133e5a1d5b..e4b1234df337 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -84262,7 +84262,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.3/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.3/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" @@ -315432,7 +315432,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.3/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.3/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json index 11b6cac73888..2376ce6cfff2 100644 --- a/lib/rest/static/dereferenced/ghes-3.4.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.4.deref.json @@ -29281,7 +29281,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.4/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" @@ -94318,7 +94318,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.4/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" @@ -329266,7 +329266,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.4/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string" diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 9f1ba67ef8d9..9f0fc2ea6283 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -286905,7 +286905,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/github-ae@latest/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/github-ae@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).", "required": false, "schema": { "type": "string"