diff --git a/.github/workflows/confirm-internal-staff-work-in-docs.yml b/.github/workflows/confirm-internal-staff-work-in-docs.yml index 76406163c4..cf10eacc96 100644 --- a/.github/workflows/confirm-internal-staff-work-in-docs.yml +++ b/.github/workflows/confirm-internal-staff-work-in-docs.yml @@ -61,7 +61,7 @@ jobs: owner: 'github', repo: 'docs-internal', title: `@${context.payload.sender.login} confirm that \#${issueNo} should be in the public github/docs repo`, - body: `@${context.payload.sender.login} opened https://github.com/github/docs/issues/${issueNo} publicly in the github/docs repo, instead of the private github/docs-internal repo.\n\n@${context.payload.sender.login}, please confirm that this belongs in the public repo and that no sensitive information was disclosed by commenting below and closing the issue.\n\nIf this was not intentional and sensitive information was shared, please delete https://github.com/github/docs/issues/${issueNo} and notify us in the \#docs-open-source channel.\n\nThanks! \n\n/cc @github/docs @github/docs-engineering`, + body: `@${context.payload.sender.login} opened https://github.com/github/docs/issues/${issueNo} publicly in the github/docs repo, instead of the private github/docs-internal repo.\n\n@${context.payload.sender.login}, please confirm that this belongs in the public repo and that no sensitive information was disclosed by commenting below and closing the issue.\n\nIf this was not intentional and sensitive information was shared, please delete https://github.com/github/docs/issues/${issueNo} and notify us in the \#docs-open-source channel.\n\nThanks!`, labels: ['OS confirmation'], }); diff --git a/assets/images/help/repository/code-scanning-free-text-search-areas.png b/assets/images/help/repository/code-scanning-free-text-search-areas.png new file mode 100644 index 0000000000..0799feb0a8 Binary files /dev/null and b/assets/images/help/repository/code-scanning-free-text-search-areas.png differ diff --git a/assets/images/help/repository/code-scanning-search-alerts.png b/assets/images/help/repository/code-scanning-search-alerts.png new file mode 100644 index 0000000000..e274f632dd Binary files /dev/null and b/assets/images/help/repository/code-scanning-search-alerts.png differ diff --git a/content/actions/guides/building-and-testing-xamarin-applications.md b/content/actions/guides/building-and-testing-xamarin-applications.md index dc5108d731..5c1e54b208 100644 --- a/content/actions/guides/building-and-testing-xamarin-applications.md +++ b/content/actions/guides/building-and-testing-xamarin-applications.md @@ -24,7 +24,7 @@ topics: This guide shows you how to create a workflow that performs continuous integration (CI) for your Xamarin project. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always healthy. -{% data variables.product.prodname_actions %}-hosted macOS runner stores Xamarin SDK versions and the associated Mono versions as a set of symlinks to Xamarin SDK locations that are available by a single bundle symlink. For a full list of available Xamarin SDK versions and their corresponding bundles, see the runners documentation: +For a full list of available Xamarin SDK versions on the {% data variables.product.prodname_actions %}-hosted macOS runners, see the documentation: * [macOS 10.15](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-10.15-Readme.md#xamarin-bundles) * [macOS 11](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-11-Readme.md#xamarin-bundles) @@ -41,7 +41,7 @@ We recommend that you have a basic understanding of Xamarin, .NET Core SDK, YAML ### Bulding Xamarin.iOS apps -The example below demonstrates how to change the default Xamarin bundle and build a Xamarin.iOS application. +The example below demonstrates how to change the default Xamarin SDK versions and build a Xamarin.iOS application. {% raw %} ```yaml @@ -55,34 +55,33 @@ jobs: runs-on: macos-latest steps: - - uses: actions/checkout@v2 - - name: Select default Xamarin bundle to 6_12_6 - run: | - XAMARIN_SDK=6_12_6 - $VM_ASSETS/select-xamarin-sdk.sh $XAMARIN_SDK + - uses: actions/checkout@v2 + - name: Set default Xamarin SDK versions + run: | + $VM_ASSETS/select-xamarin-sdk-v2.sh --mono=6.12 --ios=14.10 + + - name: Set default Xcode 12.3 + run: | + XCODE_ROOT=/Applications/Xcode_12.3.0.app + echo "MD_APPLE_SDK_ROOT=$XCODE_ROOT" >> $GITHUB_ENV + sudo xcode-select -s $XCODE_ROOT - - name: Set default Xcode 12.3 - run: | - XCODE_ROOT=/Applications/Xcode_12.3.0.app - echo "MD_APPLE_SDK_ROOT=$XCODE_ROOT" >> $GITHUB_ENV - sudo xcode-select -s $XCODE_ROOT + - name: Setup .NET Core SDK 5.0.x + uses: actions/setup-dotnet@v1 + with: + dotnet-version: '5.0.x' - - name: Setup .NET Core SDK 5.0.x - uses: actions/setup-dotnet@v1 - with: - dotnet-version: '5.0.x' + - name: Install dependencies + run: nuget restore - - name: Install dependencies - run: nuget restore - - - name: Build - run: msbuild /p:Configuration=Debug /p:Platform=iPhoneSimulator /t:Rebuild + - name: Build + run: msbuild /p:Configuration=Debug /p:Platform=iPhoneSimulator /t:Rebuild ``` {% endraw %} ### Bulding Xamarin.Android apps -The example below demonstrates how to change default the Xamarin bundle and build a Xamarin.Android application. +The example below demonstrates how to change default Xamarin SDK versions and build a Xamarin.Android application. {% raw %} ```yaml @@ -96,22 +95,21 @@ jobs: runs-on: macos-latest steps: - - uses: actions/checkout@v2 - - name: Select default Xamarin bundle to 6_12_6 - run: | - XAMARIN_SDK=6_12_6 - $VM_ASSETS/select-xamarin-sdk.sh $XAMARIN_SDK + - uses: actions/checkout@v2 + - name: Set default Xamarin SDK versions + run: | + $VM_ASSETS/select-xamarin-sdk-v2.sh --mono=6.10 --android=10.2 - - name: Setup .NET Core SDK 5.0.x - uses: actions/setup-dotnet@v1 - with: - dotnet-version: '5.0.x' + - name: Setup .NET Core SDK 5.0.x + uses: actions/setup-dotnet@v1 + with: + dotnet-version: '5.0.x' - - name: Install dependencies - run: nuget restore + - name: Install dependencies + run: nuget restore - - name: Build - run: msbuild /t:PackageForAndroid /p:Configuration=Debug + - name: Build + run: msbuild /t:PackageForAndroid /p:Configuration=Debug ``` {% endraw %} diff --git a/content/admin/configuration/configuring-network-settings/enabling-subdomain-isolation.md b/content/admin/configuration/configuring-network-settings/enabling-subdomain-isolation.md index e511962c4d..24195f507f 100644 --- a/content/admin/configuration/configuring-network-settings/enabling-subdomain-isolation.md +++ b/content/admin/configuration/configuring-network-settings/enabling-subdomain-isolation.md @@ -20,7 +20,7 @@ topics: Subdomain isolation mitigates cross-site scripting and other related vulnerabilities. For more information, see "[Cross-site scripting](http://en.wikipedia.org/wiki/Cross-site_scripting)" on Wikipedia. We highly recommend that you enable subdomain isolation on {% data variables.product.product_location %}. -When subdomain isolation is enabled, {% data variables.product.prodname_ghe_server %} replaces several paths with subdomains. +When subdomain isolation is enabled, {% data variables.product.prodname_ghe_server %} replaces several paths with subdomains. After enabling subdomain isolation, attempts to access the previous paths for some user-supplied content, such as `http(s)://HOSTNAME/raw/`, may return `404` errors. {% if currentVersion == "enterprise-server@2.22" %} To use Docker with {% data variables.product.prodname_registry %}, you must also enable subdomain isolation. For more information, see "[Working with the Docker registry](/enterprise/{{ currentVersion }}/user/packages/working-with-a-github-packages-registry/working-with-the-docker-registry)." diff --git a/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md b/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md index 99ff90e2ce..32e3ed3bc3 100644 --- a/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md +++ b/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md @@ -9,8 +9,12 @@ versions: free-pro-team: '*' enterprise-server: '>=3.1' github-ae: 'next' +type: how_to topics: - - Security + - Security policies + - Vulnerabilities + - Repositories + - Health --- ### About security policies diff --git a/content/code-security/getting-started/github-security-features.md b/content/code-security/getting-started/github-security-features.md index 23f1a0f553..6d4fe8d71e 100644 --- a/content/code-security/getting-started/github-security-features.md +++ b/content/code-security/getting-started/github-security-features.md @@ -5,8 +5,12 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: overview topics: - - Security + - Repositories + - Dependencies + - Vulnerabilities + - Advanced Security --- ### About {% data variables.product.prodname_dotcom %}'s security features diff --git a/content/code-security/getting-started/index.md b/content/code-security/getting-started/index.md index fcaa3f1e6f..45311d7a69 100644 --- a/content/code-security/getting-started/index.md +++ b/content/code-security/getting-started/index.md @@ -7,7 +7,9 @@ versions: enterprise-server: '>=3.0' github-ae: '*' topics: - - Security + - Repositories + - Dependencies + - Vulnerabilities children: - /github-security-features - /securing-your-repository diff --git a/content/code-security/getting-started/securing-your-organization.md b/content/code-security/getting-started/securing-your-organization.md index 78f69dcb27..10c35231d4 100644 --- a/content/code-security/getting-started/securing-your-organization.md +++ b/content/code-security/getting-started/securing-your-organization.md @@ -6,8 +6,12 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - Organizations + - Dependencies + - Vulnerabilities + - Advanced Security --- ### Introduction diff --git a/content/code-security/getting-started/securing-your-repository.md b/content/code-security/getting-started/securing-your-repository.md index 0127502206..538d63669d 100644 --- a/content/code-security/getting-started/securing-your-repository.md +++ b/content/code-security/getting-started/securing-your-repository.md @@ -9,8 +9,12 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - Repositories + - Dependencies + - Vulnerabilities + - Advanced Security --- ### Introduction diff --git a/content/code-security/index.md b/content/code-security/index.md index 1ef97457a4..ac825b049f 100644 --- a/content/code-security/index.md +++ b/content/code-security/index.md @@ -7,7 +7,9 @@ versions: enterprise-server: '>=3.0' github-ae: '*' topics: - - Security + - Repositories + - Dependencies + - Vulnerabilities children: - /getting-started - /secret-security diff --git a/content/code-security/secret-security/about-secret-scanning.md b/content/code-security/secret-security/about-secret-scanning.md index a0f8317edb..2fb3089672 100644 --- a/content/code-security/secret-security/about-secret-scanning.md +++ b/content/code-security/secret-security/about-secret-scanning.md @@ -11,8 +11,10 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: overview topics: - - Repositories + - Secret scanning + - Advanced Security --- {% data reusables.secret-scanning.beta %} diff --git a/content/code-security/secret-security/configuring-secret-scanning-for-your-repositories.md b/content/code-security/secret-security/configuring-secret-scanning-for-your-repositories.md index 9d43db7cd8..7f590ec28d 100644 --- a/content/code-security/secret-security/configuring-secret-scanning-for-your-repositories.md +++ b/content/code-security/secret-security/configuring-secret-scanning-for-your-repositories.md @@ -10,7 +10,10 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: + - Secret scanning + - Advanced Security - Repositories --- diff --git a/content/code-security/secret-security/index.md b/content/code-security/secret-security/index.md index 5326db7b82..39e0d908c4 100644 --- a/content/code-security/secret-security/index.md +++ b/content/code-security/secret-security/index.md @@ -8,6 +8,8 @@ versions: enterprise-server: '>=3.0' github-ae: '*' topics: + - Secret scanning + - Advanced Security - Repositories children: - /about-secret-scanning diff --git a/content/code-security/secret-security/managing-alerts-from-secret-scanning.md b/content/code-security/secret-security/managing-alerts-from-secret-scanning.md index 22d8987f8e..d662b959a5 100644 --- a/content/code-security/secret-security/managing-alerts-from-secret-scanning.md +++ b/content/code-security/secret-security/managing-alerts-from-secret-scanning.md @@ -8,7 +8,11 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: + - Secret scanning + - Advanced Security + - Alerts - Repositories --- diff --git a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning.md b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning.md index 7d67f606e0..56a42ec52c 100644 --- a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning.md +++ b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning.md @@ -10,8 +10,11 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: overview topics: - - Security + - Advanced Security + - Code scanning + - CodeQL --- diff --git a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md index 341d869358..8486ebbae8 100644 --- a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md +++ b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md @@ -11,8 +11,15 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - Actions + - Repositories + - Pull requests + - JavaScript + - Python --- diff --git a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md index cec538806d..88ad2e7595 100644 --- a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md +++ b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md @@ -13,8 +13,16 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - CodeQL + - Actions + - Repositories + - C/C++ + - C# + - Java --- diff --git a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md index 11308d3a67..a348f222a2 100644 --- a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md +++ b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/index.md @@ -10,7 +10,8 @@ versions: enterprise-server: '>=3.0' github-ae: '*' topics: - - Security + - Advanced Security + - Code scanning children: - /about-code-scanning - /triaging-code-scanning-alerts-in-pull-requests diff --git a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md index 70798cbef9..fcd488f4fe 100644 --- a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md +++ b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md @@ -13,8 +13,12 @@ redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/managing-alerts-from-code-scanning - /github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository - /code-security/secure-coding/managing-code-scanning-alerts-for-your-repository +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - Alerts + - Repositories --- @@ -48,7 +52,7 @@ You need write permission to view a summary of all the alerts for a repository o {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-code-scanning-alerts %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1"%} -1. Optionally, use the drop-down menus to filter alerts. For example, you can filter by the tool that was used to identify alerts. +1. Optionally, use{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.2" %} the free text search box or{% endif %} the drop-down menus to filter alerts. For example, you can filter by the tool that was used to identify alerts. ![Filter by tool](/assets/images/help/repository/code-scanning-filter-by-tool.png){% endif %} 1. Under "{% data variables.product.prodname_code_scanning_capc %}," click the alert you'd like to explore. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1"%} @@ -61,12 +65,49 @@ You need write permission to view a summary of all the alerts for a repository o 1. Alerts from {% data variables.product.prodname_codeql %} analysis include a description of the problem. Click **Show more** for guidance on how to fix your code. ![Details for an alert](/assets/images/help/repository/code-scanning-alert-details.png) +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.2" %} +### Searching {% data variables.product.prodname_code_scanning %} alerts + +You can search the list of alerts. This is useful if there is a large number of alerts in your repository, or if you don't know the exact name for an alert for example. {% data variables.product.product_name %} performs the free text search across: +- The name of the alert +- The alert description +- The alert details (this also includes the information hidden from view by default in the **Show more** collapsible section) + + ![The alert information used in searches](/assets/images/help/repository/code-scanning-free-text-search-areas.png) + +| Supported search | Syntax example | Results | +| ---- | ---- | ---- | +| Single word search | `injection` | Returns all the alerts containing the word `injection` | +| Multiple word search | `sql injection` | Returns all the alerts containing `sql` or `injection` | +| Exact match search
(use double quotes) | `"sql injection"` | Returns all the alerts containing the exact phrase `sql injection` | +| OR search | `sql OR injection` | Returns all the alerts containing `sql` or `injection` | +| AND search | `sql AND injection` | Returns all the alerts containing both words `sql` and `injection` | + +{% tip %} + +**Tips:** +- The multiple word search is equivalent to an OR search. +- The AND search will return results where the search terms are found _anywhere_, in any order in the alert name, description, or details. + +{% endtip %} + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-security %} +{% data reusables.repositories.sidebar-code-scanning-alerts %} +1. To the right of the **Filters** drop-down menus, type the keywords to search for in the free text search box. + ![The free text search box](/assets/images/help/repository/code-scanning-search-alerts.png) +2. Press return. The alert listing will contain the open {% data variables.product.prodname_code_scanning %} alerts matching your search criteria. + +{% endif %} + ### Fixing an alert Anyone with write permission for a repository can fix an alert by committing a correction to the code. If the repository has {% data variables.product.prodname_code_scanning %} scheduled to run on pull requests, it's best to raise a pull request with your correction. This will trigger {% data variables.product.prodname_code_scanning %} analysis of the changes and test that your fix doesn't introduce any new problems. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)" and "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." If you have write permission for a repository, you can view fixed alerts by viewing the summary of alerts and clicking **Closed**. For more information, see "[Viewing the alerts for a repository](#viewing-the-alerts-for-a-repository)." The "Closed" list shows fixed alerts and alerts that users have dismissed. +You can use{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.2" %} the free text search or{% endif %} the filters to display a subset of alerts and then in turn mark all matching alerts as closed. + Alerts may be fixed in one branch but not in another. You can use the "Branch" drop-down menu, on the summary of alerts, to check whether an alert is fixed in a particular branch. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1"%} @@ -105,7 +146,7 @@ To dismiss or delete alerts: ![Deleting alerts](/assets/images/help/repository/code-scanning-delete-alerts.png) - Optionally, you can use the filters to display a subset of alerts and then delete all matching alerts at once. For example, if you have removed a query from {% data variables.product.prodname_codeql %} analysis, you can use the "Rule" filter to list just the alerts for that query and then select and delete all of those alerts. + Optionally, you can use{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.2" %} the free text search or{% endif %} the filters to display a subset of alerts and then delete all matching alerts at once. For example, if you have removed a query from {% data variables.product.prodname_codeql %} analysis, you can use the "Rule" filter to list just the alerts for that query and then select and delete all of those alerts. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1"%} ![Filter alerts by rule](/assets/images/help/repository/code-scanning-filter-by-rule.png) diff --git a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md index c352049717..09f4af869f 100644 --- a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md +++ b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container.md @@ -10,8 +10,15 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - CodeQL + - Actions + - Repositories + - Containers + - Java --- diff --git a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md index ef66c08a26..37959ec4ff 100644 --- a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md +++ b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md @@ -14,8 +14,12 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - Actions + - Repositories --- diff --git a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md index 9c7c8908c9..0074f86637 100644 --- a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md +++ b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md @@ -11,8 +11,13 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - Pull requests + - Alerts + - Repositories --- diff --git a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md index e8896cfbd9..3d700d8930 100644 --- a/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md +++ b/content/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md @@ -11,8 +11,18 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - CodeQL + - Actions + - Troubleshooting + - Repositories + - Pull requests + - C/C++ + - C# + - Java --- diff --git a/content/code-security/secure-coding/index.md b/content/code-security/secure-coding/index.md index 9950164827..20771af9ec 100644 --- a/content/code-security/secure-coding/index.md +++ b/content/code-security/secure-coding/index.md @@ -11,7 +11,9 @@ versions: enterprise-server: '>=3.0' github-ae: '*' topics: - - Security + - Advanced Security + - Code scanning + - CodeQL children: - /automatically-scanning-your-code-for-vulnerabilities-and-errors - /integrating-with-code-scanning diff --git a/content/code-security/secure-coding/integrating-with-code-scanning/about-integration-with-code-scanning.md b/content/code-security/secure-coding/integrating-with-code-scanning/about-integration-with-code-scanning.md index 5e2e8d287c..47f95c6a79 100644 --- a/content/code-security/secure-coding/integrating-with-code-scanning/about-integration-with-code-scanning.md +++ b/content/code-security/secure-coding/integrating-with-code-scanning/about-integration-with-code-scanning.md @@ -10,8 +10,12 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: overview topics: - - Security + - Advanced Security + - Code scanning + - Webhooks + - Integration --- diff --git a/content/code-security/secure-coding/integrating-with-code-scanning/index.md b/content/code-security/secure-coding/integrating-with-code-scanning/index.md index 364bb25944..fbb1065f22 100644 --- a/content/code-security/secure-coding/integrating-with-code-scanning/index.md +++ b/content/code-security/secure-coding/integrating-with-code-scanning/index.md @@ -11,7 +11,9 @@ versions: enterprise-server: '>=3.0' github-ae: '*' topics: - - Security + - Advanced Security + - Code scanning + - Integration children: - /about-integration-with-code-scanning - /uploading-a-sarif-file-to-github diff --git a/content/code-security/secure-coding/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/content/code-security/secure-coding/integrating-with-code-scanning/sarif-support-for-code-scanning.md index 2d36b12501..0c4a5ef2f0 100644 --- a/content/code-security/secure-coding/integrating-with-code-scanning/sarif-support-for-code-scanning.md +++ b/content/code-security/secure-coding/integrating-with-code-scanning/sarif-support-for-code-scanning.md @@ -12,8 +12,12 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: reference topics: - - Security + - Advanced Security + - Code scanning + - Integration + - SARIF --- diff --git a/content/code-security/secure-coding/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md b/content/code-security/secure-coding/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md index be2dd2b57b..31f592307d 100644 --- a/content/code-security/secure-coding/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md +++ b/content/code-security/secure-coding/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md @@ -12,8 +12,15 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - Integration + - Actions + - Repositories + - CI + - SARIF --- diff --git a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system.md b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system.md index 17fff63d94..b8001a51df 100644 --- a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system.md +++ b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system.md @@ -8,7 +8,14 @@ versions: enterprise-server: '>=3.0' github-ae: '*' topics: - - Security + - Advanced Security + - Code scanning + - CodeQL + - Repositories + - Pull requests + - Integration + - CI + - SARIF redirect_from: - /code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system --- diff --git a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md index 60026b0064..025808b169 100644 --- a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md +++ b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-runner-in-your-ci-system.md @@ -13,8 +13,18 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - CodeQL + - Integration + - CI + - Repositories + - Pull requests + - C/C++ + - C# + - Java --- diff --git a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/index.md b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/index.md index 1efbc2ef8c..5fe2e55854 100644 --- a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/index.md +++ b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/index.md @@ -9,8 +9,13 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - Integration + - CI + - CodeQL children: - /about-codeql-code-scanning-in-your-ci-system - /running-codeql-cli-in-your-ci-system diff --git a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-cli-in-your-ci-system.md b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-cli-in-your-ci-system.md index 3ca4502685..e36f736b8e 100644 --- a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-cli-in-your-ci-system.md +++ b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-cli-in-your-ci-system.md @@ -7,9 +7,17 @@ miniTocMaxHeadingLevel: 4 versions: free-pro-team: '*' enterprise-server: '>=3.1' - github-ae: next + github-ae: 'next' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - CodeQL + - Repositories + - Pull requests + - Integration + - CI + - SARIF redirect_from: - /code-security/secure-coding/running-codeql-cli-in-your-ci-system --- diff --git a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md index d58df42cb3..e177799902 100644 --- a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md +++ b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md @@ -12,8 +12,16 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - CodeQL + - Repositories + - Pull requests + - Integration + - CI + - SARIF --- @@ -158,7 +166,7 @@ This example is similar to the previous example, however this time the repositor $ . /srv/checkout/example-repo-2/codeql-runner/codeql-env.sh ``` -1. Build the code. On macOS, you need to prefix the build command with the environment variable `$CODEQL_RUNNER`. For more information, see "[Troubleshooting {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/troubleshooting-codeql-runner-in-your-ci-system#no-code-found-during-the-build)#no-code-found-during-the-build)." +1. Build the code. On macOS, you need to prefix the build command with the environment variable `$CODEQL_RUNNER`. For more information, see "[Troubleshooting {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/troubleshooting-codeql-runner-in-your-ci-system#no-code-found-during-the-build)." {% data reusables.code-scanning.codeql-runner-analyze-example %} diff --git a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/troubleshooting-codeql-runner-in-your-ci-system.md b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/troubleshooting-codeql-runner-in-your-ci-system.md index b3491880f9..288f962302 100644 --- a/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/troubleshooting-codeql-runner-in-your-ci-system.md +++ b/content/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/troubleshooting-codeql-runner-in-your-ci-system.md @@ -12,8 +12,14 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - CodeQL + - Troubleshooting + - Integration + - CI --- diff --git a/content/code-security/security-advisories/about-coordinated-disclosure-of-security-vulnerabilities.md b/content/code-security/security-advisories/about-coordinated-disclosure-of-security-vulnerabilities.md index 4338399524..e3d8411ea8 100644 --- a/content/code-security/security-advisories/about-coordinated-disclosure-of-security-vulnerabilities.md +++ b/content/code-security/security-advisories/about-coordinated-disclosure-of-security-vulnerabilities.md @@ -4,6 +4,10 @@ intro: 'Vulnerability disclosure is a coordinated effort between security report miniTocMaxHeadingLevel: 4 versions: free-pro-team: '*' +type: overview +topics: + - Security advisories + - Vulnerabilities --- ### About disclosing vulnerabilities in the industry diff --git a/content/code-security/security-advisories/about-github-security-advisories.md b/content/code-security/security-advisories/about-github-security-advisories.md index 70db6331c7..c214bf09e9 100644 --- a/content/code-security/security-advisories/about-github-security-advisories.md +++ b/content/code-security/security-advisories/about-github-security-advisories.md @@ -7,8 +7,11 @@ redirect_from: - /github/managing-security-vulnerabilities/about-github-security-advisories versions: free-pro-team: '*' +type: overview topics: - - Security + - Security advisories + - Vulnerabilities + - CVEs --- {% data reusables.repositories.security-advisory-admin-permissions %} diff --git a/content/code-security/security-advisories/adding-a-collaborator-to-a-security-advisory.md b/content/code-security/security-advisories/adding-a-collaborator-to-a-security-advisory.md index 07fc24a299..7f844c3ef4 100644 --- a/content/code-security/security-advisories/adding-a-collaborator-to-a-security-advisory.md +++ b/content/code-security/security-advisories/adding-a-collaborator-to-a-security-advisory.md @@ -7,8 +7,11 @@ redirect_from: - /github/managing-security-vulnerabilities/adding-a-collaborator-to-a-security-advisory versions: free-pro-team: '*' +type: how_to topics: - - Security + - Security advisories + - Vulnerabilities + - Collaboration --- People with admin permissions to a security advisory can add collaborators to the security advisory. diff --git a/content/code-security/security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability.md b/content/code-security/security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability.md index 73635560ea..19f4e558a3 100644 --- a/content/code-security/security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability.md +++ b/content/code-security/security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability.md @@ -6,8 +6,12 @@ redirect_from: - /github/managing-security-vulnerabilities/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability versions: free-pro-team: '*' +type: how_to topics: - - Security + - Security advisories + - Vulnerabilities + - Collaboration + - Forks --- ### Prerequisites diff --git a/content/code-security/security-advisories/creating-a-security-advisory.md b/content/code-security/security-advisories/creating-a-security-advisory.md index dab420dc4a..1a0e0bf4aa 100644 --- a/content/code-security/security-advisories/creating-a-security-advisory.md +++ b/content/code-security/security-advisories/creating-a-security-advisory.md @@ -7,8 +7,10 @@ redirect_from: - /github/managing-security-vulnerabilities/creating-a-security-advisory versions: free-pro-team: '*' +type: how_to topics: - - Security + - Security advisories + - Vulnerabilities --- Anyone with admin permissions to a repository can create a security advisory. diff --git a/content/code-security/security-advisories/editing-a-security-advisory.md b/content/code-security/security-advisories/editing-a-security-advisory.md index 8664ab31dc..12dab63f8d 100644 --- a/content/code-security/security-advisories/editing-a-security-advisory.md +++ b/content/code-security/security-advisories/editing-a-security-advisory.md @@ -5,8 +5,10 @@ redirect_from: - /github/managing-security-vulnerabilities/editing-a-security-advisory versions: free-pro-team: '*' +type: how_to topics: - - Security + - Security advisories + - Vulnerabilities --- People with admin permissions to a security advisory can edit the security advisory. diff --git a/content/code-security/security-advisories/index.md b/content/code-security/security-advisories/index.md index 08d85d2fb3..ba5b199dde 100644 --- a/content/code-security/security-advisories/index.md +++ b/content/code-security/security-advisories/index.md @@ -8,7 +8,10 @@ redirect_from: versions: free-pro-team: '*' topics: - - Security + - Security advisories + - Vulnerabilities + - Repositories + - CVEs children: - /about-coordinated-disclosure-of-security-vulnerabilities - /about-github-security-advisories diff --git a/content/code-security/security-advisories/permission-levels-for-security-advisories.md b/content/code-security/security-advisories/permission-levels-for-security-advisories.md index a63400c572..56390ba86a 100644 --- a/content/code-security/security-advisories/permission-levels-for-security-advisories.md +++ b/content/code-security/security-advisories/permission-levels-for-security-advisories.md @@ -7,8 +7,11 @@ redirect_from: - /github/managing-security-vulnerabilities/permission-levels-for-security-advisories versions: free-pro-team: '*' +type: reference topics: - - Security + - Security advisories + - Vulnerabilities + - Permissions --- ### Permissions overview diff --git a/content/code-security/security-advisories/publishing-a-security-advisory.md b/content/code-security/security-advisories/publishing-a-security-advisory.md index e009c50cf2..a8d2fb149e 100644 --- a/content/code-security/security-advisories/publishing-a-security-advisory.md +++ b/content/code-security/security-advisories/publishing-a-security-advisory.md @@ -7,8 +7,12 @@ redirect_from: - /github/managing-security-vulnerabilities/publishing-a-security-advisory versions: free-pro-team: '*' +type: how_to topics: - - Security + - Security advisories + - Vulnerabilities + - CVEs + - Repositories --- diff --git a/content/code-security/security-advisories/removing-a-collaborator-from-a-security-advisory.md b/content/code-security/security-advisories/removing-a-collaborator-from-a-security-advisory.md index e1586b3754..5692dbd270 100644 --- a/content/code-security/security-advisories/removing-a-collaborator-from-a-security-advisory.md +++ b/content/code-security/security-advisories/removing-a-collaborator-from-a-security-advisory.md @@ -5,8 +5,11 @@ redirect_from: - /github/managing-security-vulnerabilities/removing-a-collaborator-from-a-security-advisory versions: free-pro-team: '*' +type: how_to topics: - - Security + - Security advisories + - Vulnerabilities + - Collaboration --- People with admin permissions to a security advisory can remove collaborators from the security advisory. diff --git a/content/code-security/security-advisories/withdrawing-a-security-advisory.md b/content/code-security/security-advisories/withdrawing-a-security-advisory.md index 79dbae768e..12270c2484 100644 --- a/content/code-security/security-advisories/withdrawing-a-security-advisory.md +++ b/content/code-security/security-advisories/withdrawing-a-security-advisory.md @@ -5,8 +5,10 @@ redirect_from: - /github/managing-security-vulnerabilities/withdrawing-a-security-advisory versions: free-pro-team: '*' +type: how_to topics: - - Security + - Security advisories + - Vulnerabilities --- If you publish a security advisory in error, you can withdraw the security advisory by contacting {% data variables.contact.contact_support %}. diff --git a/content/code-security/security-overview/exploring-security-alerts.md b/content/code-security/security-overview/exploring-security-alerts.md index eb3f57a17f..4934707319 100644 --- a/content/code-security/security-overview/exploring-security-alerts.md +++ b/content/code-security/security-overview/exploring-security-alerts.md @@ -5,6 +5,13 @@ product: '{% data reusables.gated-features.security-center %}' versions: free-pro-team: '*' github-ae: 'next' +type: how_to +topics: + - Security overview + - Advanced Security + - Alerts + - Organizations + - Teams --- {% data reusables.security-center.beta %} diff --git a/content/code-security/security-overview/index.md b/content/code-security/security-overview/index.md index da3b8892a0..121d861380 100644 --- a/content/code-security/security-overview/index.md +++ b/content/code-security/security-overview/index.md @@ -5,7 +5,10 @@ intro: 'View, sort, and filter the security alerts from across your organization product: '{% data reusables.gated-features.security-center %}' versions: free-pro-team: '*' - github-ae: next + github-ae: 'next' +topics: + - Security overview + - Advanced Security children: - /exploring-security-alerts --- diff --git a/content/code-security/supply-chain-security/index.md b/content/code-security/supply-chain-security/index.md index 06dd68e360..26f02658df 100644 --- a/content/code-security/supply-chain-security/index.md +++ b/content/code-security/supply-chain-security/index.md @@ -9,7 +9,9 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' topics: - - Security + - Dependabot + - Dependencies + - Repositories children: - /understanding-your-software-supply-chain - /keeping-your-dependencies-updated-automatically diff --git a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates.md b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates.md index 8d01da1eae..8967866401 100644 --- a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates.md +++ b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates.md @@ -9,8 +9,13 @@ redirect_from: - /code-security/supply-chain-security/about-dependabot-version-updates versions: free-pro-team: '*' +type: overview topics: + - Dependabot + - Version updates - Repositories + - Dependencies + - Pull requests --- ### About {% data variables.product.prodname_dependabot_version_updates %} diff --git a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates.md b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates.md index e8caa1a624..525ea937dd 100644 --- a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates.md +++ b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates.md @@ -8,8 +8,13 @@ redirect_from: miniTocMaxHeadingLevel: 4 versions: free-pro-team: '*' +type: reference topics: + - Dependabot + - Version updates - Repositories + - Dependencies + - Pull requests --- ### About the *dependabot.yml* file @@ -944,3 +949,17 @@ registries: token: ${{secrets.MY_GITHUB_PERSONAL_TOKEN}} ``` {% endraw %} + +#### `terraform-registry` + +The `terraform-registry` type supports a token. + +{% raw %} +```yaml +registries: + terraform-example: + type: terraform-registry + url: https://terraform.example.com + token: ${{secrets.MY_TERRAFORM_API_TOKEN}} +``` +{% endraw %} diff --git a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates.md b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates.md index 3e7a411b73..31aa2d374c 100644 --- a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates.md +++ b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates.md @@ -7,8 +7,15 @@ redirect_from: - /code-security/supply-chain-security/customizing-dependency-updates versions: free-pro-team: '*' +type: how_to topics: + - Dependabot + - Version updates + - Security updates - Repositories + - Dependencies + - Pull requests + - Vulnerabilities --- ### About customizing dependency updates diff --git a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-version-updates.md b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-version-updates.md index db653a02a7..9ede734d6f 100644 --- a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-version-updates.md +++ b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-version-updates.md @@ -7,8 +7,13 @@ redirect_from: - /code-security/supply-chain-security/enabling-and-disabling-version-updates versions: free-pro-team: '*' +type: how_to topics: + - Dependabot + - Version updates - Repositories + - Dependencies + - Pull requests --- diff --git a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/index.md b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/index.md index 946d617301..0d9fda6298 100644 --- a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/index.md +++ b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/index.md @@ -7,6 +7,10 @@ versions: free-pro-team: '*' topics: - Repositories + - Dependabot + - Version updates + - Dependencies + - Pull requests children: - /about-dependabot-version-updates - /upgrading-from-dependabotcom-to-github-native-dependabot diff --git a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md index 1582a893f2..370462752a 100644 --- a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md +++ b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot.md @@ -7,8 +7,12 @@ redirect_from: - /code-security/supply-chain-security/keeping-your-actions-up-to-date-with-dependabot versions: free-pro-team: '*' +type: how_to topics: - Repositories + - Dependabot + - Version updates + - Actions --- ### About {% data variables.product.prodname_dependabot_version_updates %} for actions diff --git a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/listing-dependencies-configured-for-version-updates.md b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/listing-dependencies-configured-for-version-updates.md index 7e51fb81da..d36e451296 100644 --- a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/listing-dependencies-configured-for-version-updates.md +++ b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/listing-dependencies-configured-for-version-updates.md @@ -6,8 +6,12 @@ redirect_from: - /code-security/supply-chain-security/listing-dependencies-configured-for-version-updates versions: free-pro-team: '*' +type: how_to topics: - Repositories + - Dependabot + - Version updates + - Dependencies --- ### Viewing dependencies monitored by {% data variables.product.prodname_dependabot %} diff --git a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot.md b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot.md index a91e7a3de6..b9e9cdaf5b 100644 --- a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot.md +++ b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot.md @@ -6,6 +6,13 @@ redirect_from: - /code-security/supply-chain-security/managing-encrypted-secrets-for-dependabot versions: free-pro-team: '*' +type: how_to +topics: + - Dependabot + - Version updates + - Secret store + - Repositories + - Dependencies --- ### About encrypted secrets for {% data variables.product.prodname_dependabot %} diff --git a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates.md b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates.md index b84c596853..e4de9c94be 100644 --- a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates.md +++ b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates.md @@ -6,8 +6,14 @@ redirect_from: - /code-security/supply-chain-security/managing-pull-requests-for-dependency-updates versions: free-pro-team: '*' +type: how_to topics: - Repositories + - Version updates + - Security updates + - Pull requests + - Dependencies + - Vulnerabilities --- ### About {% data variables.product.prodname_dependabot %} pull requests diff --git a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/upgrading-from-dependabotcom-to-github-native-dependabot.md b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/upgrading-from-dependabotcom-to-github-native-dependabot.md index d27aa13db1..476f4ff94c 100644 --- a/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/upgrading-from-dependabotcom-to-github-native-dependabot.md +++ b/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/upgrading-from-dependabotcom-to-github-native-dependabot.md @@ -3,8 +3,12 @@ title: Upgrading from Dependabot.com to GitHub-native Dependabot intro: You can upgrade to GitHub-native Dependabot by merging a pull request that will allow your dependencies to continue being updated. versions: free-pro-team: '*' +type: how_to topics: - Repositories + - Dependabot + - Version updates + - Dependencies redirect_from: - /code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot --- diff --git a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md index 0947e29647..28ea3e52fc 100644 --- a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md +++ b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies.md @@ -9,8 +9,13 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=3.0' +type: overview topics: - - Security + - Dependabot + - Alerts + - Vulnerabilities + - Repositories + - Dependencies --- diff --git a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md index 248d7bb1de..3192e829c7 100644 --- a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md +++ b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates.md @@ -8,8 +8,14 @@ redirect_from: - /code-security/supply-chain-security/about-dependabot-security-updates versions: free-pro-team: '*' +type: overview topics: - - Security + - Dependabot + - Security updates + - Vulnerabilities + - Repositories + - Dependencies + - Pull requests --- diff --git a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-managing-vulnerable-dependencies.md b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-managing-vulnerable-dependencies.md index 2a96479ef9..bebdc22998 100644 --- a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-managing-vulnerable-dependencies.md +++ b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-managing-vulnerable-dependencies.md @@ -6,8 +6,13 @@ redirect_from: - /code-security/supply-chain-security/about-managing-vulnerable-dependencies versions: free-pro-team: '*' +type: overview topics: - - Security + - Dependabot + - Vulnerabilities + - Repositories + - Dependencies + - Pull requests --- diff --git a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md index d5471b8dba..fac43820d6 100644 --- a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md +++ b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database.md @@ -7,8 +7,13 @@ redirect_from: - /code-security/supply-chain-security/browsing-security-vulnerabilities-in-the-github-advisory-database versions: free-pro-team: '*' +type: how_to topics: - - Security + - Security advisories + - Alerts + - Dependabot + - Vulnerabilities + - CVEs --- diff --git a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md index 0d764859de..919f28f31b 100644 --- a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md +++ b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md @@ -11,8 +11,14 @@ redirect_from: - /code-security/supply-chain-security/configuring-dependabot-security-updates versions: free-pro-team: '*' +type: how_to topics: - - Security + - Dependabot + - Security updates + - Alerts + - Dependencies + - Pull requests + - Repositories --- diff --git a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md index f1a8d81b33..805dafad46 100644 --- a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md +++ b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies.md @@ -8,8 +8,14 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=3.0' +type: how_to topics: - - Security + - Dependabot + - Alerts + - Notifications + - Vulnerabilities + - Dependencies + - Repositories --- diff --git a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md index c11b0e35db..d1ebfc41d2 100644 --- a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md +++ b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/index.md @@ -10,6 +10,14 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=3.0' +topics: + - Repositories + - Dependabot + - Version updates + - Dependencies + - Pull requests + - Vulnerabilities + - Alerts children: - /about-managing-vulnerable-dependencies - /browsing-security-vulnerabilities-in-the-github-advisory-database diff --git a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-dependabot-errors.md b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-dependabot-errors.md index 1e80a7fc5b..2a2dc7b0ee 100644 --- a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-dependabot-errors.md +++ b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-dependabot-errors.md @@ -8,8 +8,16 @@ redirect_from: - /code-security/supply-chain-security/troubleshooting-dependabot-errors versions: free-pro-team: '*' +type: how_to topics: - - Security + - Dependabot + - Security updates + - Version updates + - Repositories + - Pull requests + - Troubleshooting + - Errors + - Dependencies --- ### About {% data variables.product.prodname_dependabot %} errors diff --git a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md index 5f9369368b..b73bc87ce1 100644 --- a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md +++ b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies.md @@ -8,8 +8,19 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=3.0' +type: how_to topics: - - Security + - Dependabot + - Alerts + - Troubleshooting + - Errors + - Security updates + - Dependencies + - Vulnerabilities + - Dependency graph + - Alerts + - CVEs + - Repositories --- The results of dependency detection reported by {% data variables.product.product_name %} may be different from the results returned by other tools. There are good reasons for this and it's helpful to understand how {% data variables.product.prodname_dotcom %} determines dependencies for your project. diff --git a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md index 68507ae33e..e4c339979e 100644 --- a/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md +++ b/content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository.md @@ -10,8 +10,14 @@ shortTitle: Viewing and updating vulnerable dependencies versions: free-pro-team: '*' enterprise-server: '>=3.0' +type: how_to topics: - - Security + - Dependabot + - Security updates + - Alerts + - Dependencies + - Pull requests + - Repositories --- Your repository's {% data variables.product.prodname_dependabot %} alerts tab lists all open and closed {% data variables.product.prodname_dependabot_alerts %}{% if currentVersion == "free-pro-team@latest" %} and corresponding {% data variables.product.prodname_dependabot_security_updates %}{% endif %}. You can sort the list of alerts using the drop-down menu, and you can click into specific alerts for more details. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md index f3d8594362..4ad228ec86 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md @@ -3,7 +3,12 @@ title: About dependency review intro: 'Dependency review lets you catch vulnerable dependencies before you introduce them to your environment, and provides information on license, dependents, and age of dependencies.' versions: free-pro-team: '*' +type: overview topics: + - Advanced Security + - Dependency review + - Vulnerabilities + - Dependencies - Pull requests redirect_from: - /code-security/supply-chain-security/about-dependency-review diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md index 23ead0bca8..2db33ec284 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md @@ -7,7 +7,10 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=3.0' +type: overview topics: + - Dependency graph + - Dependencies - Repositories --- diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md index 5068cac8be..43100e062e 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md @@ -12,7 +12,10 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=3.0' +type: how_to topics: + - Dependency graph + - Dependencies - Repositories --- diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/index.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/index.md index e1ee0a8325..9e1bca0732 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/index.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/index.md @@ -3,6 +3,10 @@ title: Understanding your software supply chain versions: free-pro-team: '*' enterprise-server: '>=3.0' +topics: + - Dependency graph + - Dependencies + - Repositories children: - /about-the-dependency-graph - /exploring-the-dependencies-of-a-repository diff --git a/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md b/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md index 70bec916fc..d6a393c4fc 100644 --- a/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md +++ b/content/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account.md @@ -51,8 +51,10 @@ When you create a new codespace, {% data variables.product.prodname_dotcom %} cl * _install_ * _bootstrap.sh_ * _bootstrap_ +* _script/bootstrap_ * _setup.sh_ * _setup_ +* _script/setup_ If none of these files are found, then any files or folders in `dotfiles` starting with `.` are symlinked to the codespace's `~` or `$HOME` directory. diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md index 8eaaef8458..95710b4ff1 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md @@ -1,6 +1,6 @@ --- title: Creating a default community health file -intro: 'You can create default community health files, such as CONTRIBUTING and CODE_OF_CONDUCT. Default files will be used for any public repository owned by the account that does not contain its own file of that type.' +intro: 'You can create default community health files, such as CONTRIBUTING and CODE_OF_CONDUCT. Default files will be used for any repository owned by the account that does not contain its own file of that type.' redirect_from: - /articles/creating-a-default-community-health-file-for-your-organization - /github/building-a-strong-community/creating-a-default-community-health-file-for-your-organization @@ -16,12 +16,12 @@ topics: You can add default community health files to the root of a public repository called `.github` that is owned by an organization{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. -{% data variables.product.product_name %} will use and display default files for any public repository owned by the account that does not have its own file of that type in any of the following places: +{% data variables.product.product_name %} will use and display default files for any repository owned by the account that does not have its own file of that type in any of the following places: - the root of the repository - the `.github` folder - the `docs` folder -For example, anyone who creates an issue or pull request in a public repository that does not have its own CONTRIBUTING file will see a link to the default CONTRIBUTING file. If a repository has any files in its own `.github/ISSUE_TEMPLATE` folder{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}, including issue templates or a *config.yml* file,{% endif %} none of the contents of the default `.github/ISSUE_TEMPLATE` folder will be used. +For example, anyone who creates an issue or pull request in a repository that does not have its own CONTRIBUTING file will see a link to the default CONTRIBUTING file. If a repository has any files in its own `.github/ISSUE_TEMPLATE` folder{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %}, including issue templates or a *config.yml* file,{% endif %} none of the contents of the default `.github/ISSUE_TEMPLATE` folder will be used. Default files are not included in clones, packages, or downloads of individual repositories because they are stored only in the `.github` repository. diff --git a/content/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository.md b/content/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository.md index b42755cf22..aaf3de1a8f 100644 --- a/content/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository.md +++ b/content/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository.md @@ -12,7 +12,13 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: + - Dependabot + - Alerts + - Advanced Security + - Dependency graph + - Secret scanning - Repositories --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md b/content/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md index be9ea3449d..cd8ea1906a 100644 --- a/content/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md +++ b/content/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md @@ -3,8 +3,13 @@ title: Reviewing dependency changes in a pull request intro: 'If a pull request contains changes to dependencies, you can view a summary of what has changed and whether there are known vulnerabilities in any of the dependencies.' versions: free-pro-team: '*' +type: how_to topics: - Pull requests + - Dependency review + - Advanced Security + - Vulnerabilities + - Dependencies redirect_from: - /github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request - /github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request diff --git a/content/github/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md index c05df1885b..2fb1200184 100644 --- a/content/github/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md +++ b/content/github/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md @@ -141,7 +141,7 @@ You can disable some of the badges for {% data variables.product.prodname_dotcom ### List of qualifying repositories for Mars 2020 Helicopter Contributor badge -If you authored any commit(s) present in the commit history for the listed tag of one or more of the repositories below, you'll receive the Mars 2020 Helicopter Contributor badge on your profile. The authored commit must be with a verified email address, associated with your account at the time {% data variables.product.prodname_dotcom %} determined the eligible contributions, in order to be attributed to you. Future changes to verified emails will not have an effect on the badge. We built the list based on information received from NASA's Jet Propulsion Laboratory. +If you authored any commit(s) present in the commit history for the listed tag of one or more of the repositories below, you'll receive the Mars 2020 Helicopter Contributor badge on your profile. The authored commit must be with a verified email address, associated with your account at the time {% data variables.product.prodname_dotcom %} determined the eligible contributions, in order to be attributed to you. You can be the original author or [one of the co-authors](/github/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors) of the commit. Future changes to verified emails will not have an effect on the badge. We built the list based on information received from NASA's Jet Propulsion Laboratory. | {% data variables.product.prodname_dotcom %} Repository | Version | Tag | |---|---|---| @@ -212,7 +212,7 @@ If you authored any commit(s) present in the commit history for the listed tag o | [HdrHistogram/HdrHistogram](https://github.com/HdrHistogram/HdrHistogram) | 2.1.9 | [HdrHistogram-2.1.9](https://github.com/HdrHistogram/HdrHistogram/releases/tag/HdrHistogram-2.1.9) | | [locationtech/spatial4j](https://github.com/locationtech/spatial4j) | 0.7 | [spatial4j-0.7](https://github.com/locationtech/spatial4j/releases/tag/spatial4j-0.7) | | [locationtech/jts](https://github.com/locationtech/jts) | 1.15.0 | [jts-1.15.0](https://github.com/locationtech/jts/releases/tag/jts-1.15.0) | -| [apache/log4j](https://github.com/apache/log4j) | 2.11 | [v1_2_11](https://github.com/apache/log4j/releases/tag/v1_2_11) | +| [apache/logging-log4j2](https://github.com/apache/logging-log4j2) | 2.11 | [log4j-2.11.0](https://github.com/apache/logging-log4j2/releases/tag/log4j-2.11.0) | ### Further reading diff --git a/content/rest/reference/code-scanning.md b/content/rest/reference/code-scanning.md index 56f7a494cc..11833f581a 100644 --- a/content/rest/reference/code-scanning.md +++ b/content/rest/reference/code-scanning.md @@ -7,8 +7,11 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +type: reference topics: - API + - Code scanning + - REST --- {% data reusables.code-scanning.beta %} diff --git a/content/rest/reference/repos.md b/content/rest/reference/repos.md index 550c0eec06..b9b984d3c1 100644 --- a/content/rest/reference/repos.md +++ b/content/rest/reference/repos.md @@ -369,4 +369,4 @@ Name | Type | Description ``hub.mode``|`string` | **Required**. Either `subscribe` or `unsubscribe`. ``hub.topic``|`string` |**Required**. The URI of the GitHub repository to subscribe to. The path must be in the format of `/{owner}/{repo}/events/{event}`. ``hub.callback``|`string` | The URI to receive the updates to the topic. -``hub.secret``|`string` | A shared secret key that generates a SHA1 HMAC of the outgoing body content. You can verify a push came from GitHub by comparing the raw request body with the contents of the `X-Hub-Signature` header. You can see [the PubSubHubbub documentation](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify) for more details. +``hub.secret``|`string` | A shared secret key that generates a hash signature of the outgoing body content. You can verify a push came from GitHub by comparing the raw request body with the contents of the {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}`X-Hub-Signature` or `X-Hub-Signature-256` headers{% elsif currentVersion ver_lt "enterprise-server@2.23" %}`X-Hub-Signature` header{% elsif currentVersion == "github-ae@latest" %}`X-Hub-Signature-256` header{% endif %}. You can see [the PubSubHubbub documentation](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify) for more details. diff --git a/data/allowed-topics.js b/data/allowed-topics.js index 7c2baa2e45..d0cafc9144 100644 --- a/data/allowed-topics.js +++ b/data/allowed-topics.js @@ -12,131 +12,148 @@ module.exports = [ '2FA', + 'Access management', + 'Accounts', 'Action development', 'Actions', 'Administrator', 'Advanced Security', + 'Alerts', 'Amazon ECS', + 'Analytics', 'Android', 'Ant', - 'Analytics', 'API', 'Auditing', 'Authentication', 'Azure App Service', 'Azure Pipelines', 'Backups', + 'Billing', + 'C/C++', + 'C#', 'Cancellation', 'CD', 'CI', 'CircleCI', + 'CLI', 'Clustering', + 'Code scanning', + 'CodeQL', + 'Codespaces', + 'Collaboration', + 'Community', 'Contacting sponsors', 'Containers', - 'Code scanning', - 'Codespaces', + 'CVEs', + 'Dependabot', + 'Dependencies', + 'Dependency graph', + 'Dependency review', + 'Desktop', 'Developer', + 'Device verification', + 'Discounts', 'Discussions', 'Docker', 'Downgrades', + 'Early access', 'Education', - 'Events', + 'Enterprise', 'Errors', + 'Events', + 'Forks', 'Fundamentals', 'Git', + 'GitHub Apps', 'GitHub Connect', + 'GitHub search', + 'GitHub', 'GitLab', 'Google Kubernetes Engine', 'Gradle', 'GraphQL', + 'Health', 'High availability', + 'Identity', 'Infrastructure', + 'Integration', 'iOS', + 'Issues', 'Java', 'JavaScript', 'Jenkins', + 'Jobs', + 'Legal', + 'LFS', 'Licensing', 'Logging', + 'Maintenance', 'Marketplace', 'Maven', 'Migration', + 'Mobile', 'Monitoring', 'Networking', 'Node', 'Nonprofits', + 'Notifications', + 'OAuth Apps', 'Open Source', 'Organizations', 'Packages', 'Packaging', - 'Performance', - 'Powershell', - 'Pre-receive hooks', - 'Privacy', - 'Project management', - 'Publishing', - 'Python', - 'Ruby', - 'Secret scanning', - 'Security', - 'Sponsors', - 'Sponsors payments', - 'Sponsors profile', - 'Storage', - 'Support', - 'Swift', - 'Travis CI', - 'Upgrades', - 'User account', - 'Webhooks', - 'Workflows', - 'Access management', - 'Accounts', - 'Billing', - 'CLI', - 'Codespaces', - 'Community', - 'Desktop', - 'Device verification', - 'Discounts', - 'Early access', - 'Enterprise', - 'GitHub', - 'GitHub Apps', - 'GitHub search', - 'Identity', - 'Issues', - 'Jobs', - 'Legal', - 'LFS', - 'Maintenance', - 'Marketplace', - 'Mobile', - 'Notifications', - 'OAuth Apps', 'Pages', + 'Performance', 'Permissions', 'Policies', 'Policy', + 'Powershell', + 'Pre-receive hooks', + 'Privacy', 'Profile', 'Profiles', + 'Project management', 'Projects', + 'Publishing', 'Pull requests', + 'Python', 'Receipts', 'Repositories', + 'REST', + 'Ruby', + 'SARIF', + 'Secret scanning', + 'Secret store', + 'Security advisories', + 'Security overview', + 'Security policies', + 'Security updates', 'Security', - 'Spending limits', - 'Support', 'Set up', + 'Spending limits', + 'Sponsors payments', + 'Sponsors profile', + 'Sponsors', 'SSH', 'SSO', + 'Storage', + 'Support', + 'Swift', 'Teams', + 'Travis CI', 'Trials', 'Troubleshooting', 'Upgrades', + 'User account', 'Usernames', + 'Version updates', 'Visual Studio Code', - 'Xamarin', - 'Xamarin.iOS', + 'Vulnerabilities', + 'Webhooks', + 'Workflows', 'Xamarin.Android', + 'Xamarin.iOS', + 'Xamarin', 'Xcode' ] diff --git a/data/reusables/enterprise_migrations/locking-repositories.md b/data/reusables/enterprise_migrations/locking-repositories.md index f44ff52c94..ea0ecd6bcf 100644 --- a/data/reusables/enterprise_migrations/locking-repositories.md +++ b/data/reusables/enterprise_migrations/locking-repositories.md @@ -1,6 +1,6 @@ {% tip %} -**Note:** Locking a repository prevents users from pushing to the repository or modifying a repository's resources, like issues, labels, milestones, wikis, and comments. New teams and collaborators can't be associated with a locked repository. +**Note:** Locking a repository prevents all read or write access to the repository. You cannot associate new teams or collaborators with a locked repository. -If you're performing a trial run, you don't need to lock repositories. Otherwise, it's highly recommended. For more information, see "[About Migrations](/enterprise/admin/migrations/about-migrations#types-of-migrations)." +If you're performing a trial run, you do not need to lock the repository. When you migrate data from a repository that's in use, {% data variables.product.company_short %} strongly recommends locking the repository. For more information, see "[About Migrations](/enterprise/admin/migrations/about-migrations#types-of-migrations)." {% endtip %} diff --git a/data/reusables/webhooks/secret.md b/data/reusables/webhooks/secret.md index 95f3a341ca..a92e5fca87 100644 --- a/data/reusables/webhooks/secret.md +++ b/data/reusables/webhooks/secret.md @@ -1 +1 @@ -Setting a webhook secret allows you to ensure that `POST` requests sent to the payload URL are from {% data variables.product.product_name %}. When you set a secret, you'll receive the {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}`X-Hub-Signature` and `X-Hub-Signature-256` headers{% elsif currentVersion ver_lt "enterprise-server@2.23" %}`X-Hub-Signature` header{% elsif currentVersion == "github-ae@latest" %}`X-Hub-Signature-256` header{% endif %} in the webhook `POST` request. For more information on how to use a secret with a signature header to secure your webhook payloads, see "[Securing your webhooks](/webhooks/securing/)." +Setting a webhook secret allows you to ensure that `POST` requests sent to the payload URL are from {% data variables.product.product_name %}. When you set a secret, you'll receive the {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}`X-Hub-Signature` and `X-Hub-Signature-256` headers{% elsif currentVersion ver_lt "enterprise-server@2.23" %}`X-Hub-Signature` header{% elsif currentVersion == "github-ae@latest" %}`X-Hub-Signature-256` header{% endif %} in the webhook `POST` request. For more information on how to use a secret with a signature header to secure your webhook payloads, see "[Securing your webhooks](/webhooks/securing/)." diff --git a/lib/release-notes-utils.js b/lib/release-notes-utils.js index b62397e688..e5883b51ec 100644 --- a/lib/release-notes-utils.js +++ b/lib/release-notes-utils.js @@ -12,6 +12,7 @@ function sortPatchKeys (release, version, options = {}) { return { version: `${version}.${keyWithDots}`, patchVersion: keyWithDots, + downloadVersion: `${version}.${keyWithDots.replace(/\.rc\d*$/, '')}`, release: version, // TODO this naming :/ we are not currently using this value, but we may want to. ...release[key] } diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 900e2bc08f..446644941c 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -50198,6 +50198,185 @@ } ] }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The owner of the repository. Determined from the repository full_name of the content_reference event.

" + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The name of the repository. Determined from the repository full_name of the content_reference event.

" + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

The id of the content_reference event.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
" + } + ], + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#create-a-content-attachment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "

Required. The title of the attachment

", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + "body": { + "description": "

Required. The body of the attachment

", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", + "html": "

To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.corsair-preview+json
" + } + ], + "category": "apps", + "subcategory": "installations" + }, + "slug": "create-a-content-attachment", + "category": "apps", + "categoryLabel": "Apps", + "subcategory": "installations", + "subcategoryLabel": "Installations", + "notes": [], + "descriptionHTML": "

Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

\n

The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

\n

You must use an installation access token to access this endpoint.

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

Required. The title of the attachment

", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + { + "description": "

Required. The body of the attachment

", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", @@ -94693,184 +94872,5 @@ ], "bodyParameters": [], "descriptionHTML": "

Get a random sentence from the Zen of GitHub

" - }, - { - "verb": "post", - "requestPath": "/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "serverUrl": "https://api.github.com", - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

The owner of the repository. Determined from the repository full_name of the content_reference event.

" - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

The name of the repository. Determined from the repository full_name of the content_reference event.

" - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "

The id of the content_reference event.

" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n https://api.github.com/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  https://api.github.com/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", - "html": "
await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
" - } - ], - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/apps#create-a-content-attachment" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "

Required. The title of the attachment

", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - "body": { - "description": "

Required. The body of the attachment

", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", - "html": "

To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.corsair-preview+json
" - } - ], - "category": "apps", - "subcategory": "installations" - }, - "slug": "create-a-content-attachment", - "category": "apps", - "categoryLabel": "Apps", - "subcategory": "installations", - "subcategoryLabel": "Installations", - "notes": [], - "descriptionHTML": "

Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

\n

The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

\n

You must use an installation access token to access this endpoint.

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

Required. The title of the attachment

", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - { - "description": "

Required. The body of the attachment

", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] } ] \ No newline at end of file diff --git a/lib/rest/static/decorated/ghes-2.18.json b/lib/rest/static/decorated/ghes-2.18.json index fbd01943d0..891ad862e6 100644 --- a/lib/rest/static/decorated/ghes-2.18.json +++ b/lib/rest/static/decorated/ghes-2.18.json @@ -31642,6 +31642,185 @@ } ] }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The owner of the repository. Determined from the repository full_name of the content_reference event.

" + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The name of the repository. Determined from the repository full_name of the content_reference event.

" + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

The id of the content_reference event.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
" + } + ], + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.18/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/apps#create-a-content-attachment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "

Required. The title of the attachment

", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + "body": { + "description": "

Required. The body of the attachment

", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", + "html": "

To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.corsair-preview+json
" + } + ], + "category": "apps", + "subcategory": "installations" + }, + "slug": "create-a-content-attachment", + "category": "apps", + "categoryLabel": "Apps", + "subcategory": "installations", + "subcategoryLabel": "Installations", + "notes": [], + "descriptionHTML": "

Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

\n

The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

\n

You must use an installation access token to access this endpoint.

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

Required. The title of the attachment

", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + { + "description": "

Required. The body of the attachment

", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", @@ -65625,184 +65804,5 @@ ], "bodyParameters": [], "descriptionHTML": "

Get a random sentence from the Zen of GitHub

" - }, - { - "verb": "post", - "requestPath": "/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "serverUrl": "http(s)://{hostname}/api/v3", - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

The owner of the repository. Determined from the repository full_name of the content_reference event.

" - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

The name of the repository. Determined from the repository full_name of the content_reference event.

" - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "

The id of the content_reference event.

" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", - "html": "
await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
" - } - ], - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.18/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/apps#create-a-content-attachment" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "

Required. The title of the attachment

", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - "body": { - "description": "

Required. The body of the attachment

", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", - "html": "

To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.corsair-preview+json
" - } - ], - "category": "apps", - "subcategory": "installations" - }, - "slug": "create-a-content-attachment", - "category": "apps", - "categoryLabel": "Apps", - "subcategory": "installations", - "subcategoryLabel": "Installations", - "notes": [], - "descriptionHTML": "

Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

\n

The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

\n

You must use an installation access token to access this endpoint.

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

Required. The title of the attachment

", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - { - "description": "

Required. The body of the attachment

", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] } ] \ No newline at end of file diff --git a/lib/rest/static/decorated/ghes-2.19.json b/lib/rest/static/decorated/ghes-2.19.json index a0cfea7cc5..a796837325 100644 --- a/lib/rest/static/decorated/ghes-2.19.json +++ b/lib/rest/static/decorated/ghes-2.19.json @@ -32239,6 +32239,185 @@ } ] }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The owner of the repository. Determined from the repository full_name of the content_reference event.

" + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The name of the repository. Determined from the repository full_name of the content_reference event.

" + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

The id of the content_reference event.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
" + } + ], + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.19/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/apps#create-a-content-attachment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "

Required. The title of the attachment

", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + "body": { + "description": "

Required. The body of the attachment

", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", + "html": "

To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.corsair-preview+json
" + } + ], + "category": "apps", + "subcategory": "installations" + }, + "slug": "create-a-content-attachment", + "category": "apps", + "categoryLabel": "Apps", + "subcategory": "installations", + "subcategoryLabel": "Installations", + "notes": [], + "descriptionHTML": "

Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

\n

The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

\n

You must use an installation access token to access this endpoint.

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

Required. The title of the attachment

", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + { + "description": "

Required. The body of the attachment

", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", @@ -66245,184 +66424,5 @@ ], "bodyParameters": [], "descriptionHTML": "

Get a random sentence from the Zen of GitHub

" - }, - { - "verb": "post", - "requestPath": "/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "serverUrl": "http(s)://{hostname}/api/v3", - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

The owner of the repository. Determined from the repository full_name of the content_reference event.

" - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

The name of the repository. Determined from the repository full_name of the content_reference event.

" - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "

The id of the content_reference event.

" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", - "html": "
await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
" - } - ], - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.19/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/apps#create-a-content-attachment" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "

Required. The title of the attachment

", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - "body": { - "description": "

Required. The body of the attachment

", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", - "html": "

To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.corsair-preview+json
" - } - ], - "category": "apps", - "subcategory": "installations" - }, - "slug": "create-a-content-attachment", - "category": "apps", - "categoryLabel": "Apps", - "subcategory": "installations", - "subcategoryLabel": "Installations", - "notes": [], - "descriptionHTML": "

Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

\n

The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

\n

You must use an installation access token to access this endpoint.

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

Required. The title of the attachment

", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - { - "description": "

Required. The body of the attachment

", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] } ] \ No newline at end of file diff --git a/lib/rest/static/decorated/ghes-2.20.json b/lib/rest/static/decorated/ghes-2.20.json index a66c832c50..3006535474 100644 --- a/lib/rest/static/decorated/ghes-2.20.json +++ b/lib/rest/static/decorated/ghes-2.20.json @@ -32713,6 +32713,185 @@ } ] }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The owner of the repository. Determined from the repository full_name of the content_reference event.

" + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The name of the repository. Determined from the repository full_name of the content_reference event.

" + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

The id of the content_reference event.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
" + } + ], + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.20/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.20/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.20/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/apps#create-a-content-attachment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "

Required. The title of the attachment

", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + "body": { + "description": "

Required. The body of the attachment

", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", + "html": "

To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.corsair-preview+json
" + } + ], + "category": "apps", + "subcategory": "installations" + }, + "slug": "create-a-content-attachment", + "category": "apps", + "categoryLabel": "Apps", + "subcategory": "installations", + "subcategoryLabel": "Installations", + "notes": [], + "descriptionHTML": "

Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

\n

The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

\n

You must use an installation access token to access this endpoint.

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

Required. The title of the attachment

", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + { + "description": "

Required. The body of the attachment

", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", @@ -66807,184 +66986,5 @@ ], "bodyParameters": [], "descriptionHTML": "

Get a random sentence from the Zen of GitHub

" - }, - { - "verb": "post", - "requestPath": "/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "serverUrl": "http(s)://{hostname}/api/v3", - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

The owner of the repository. Determined from the repository full_name of the content_reference event.

" - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

The name of the repository. Determined from the repository full_name of the content_reference event.

" - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "

The id of the content_reference event.

" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", - "html": "
await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
" - } - ], - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.20/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.20/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.20/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/apps#create-a-content-attachment" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "

Required. The title of the attachment

", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - "body": { - "description": "

Required. The body of the attachment

", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", - "html": "

To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.corsair-preview+json
" - } - ], - "category": "apps", - "subcategory": "installations" - }, - "slug": "create-a-content-attachment", - "category": "apps", - "categoryLabel": "Apps", - "subcategory": "installations", - "subcategoryLabel": "Installations", - "notes": [], - "descriptionHTML": "

Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

\n

The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

\n

You must use an installation access token to access this endpoint.

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

Required. The title of the attachment

", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - { - "description": "

Required. The body of the attachment

", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] } ] \ No newline at end of file diff --git a/lib/rest/static/decorated/ghes-2.21.json b/lib/rest/static/decorated/ghes-2.21.json index 3563b97abf..ac8fb1d627 100644 --- a/lib/rest/static/decorated/ghes-2.21.json +++ b/lib/rest/static/decorated/ghes-2.21.json @@ -36277,6 +36277,185 @@ } ] }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The owner of the repository. Determined from the repository full_name of the content_reference event.

" + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The name of the repository. Determined from the repository full_name of the content_reference event.

" + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

The id of the content_reference event.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
" + } + ], + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.21/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.21/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.21/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/apps#create-a-content-attachment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "

Required. The title of the attachment

", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + "body": { + "description": "

Required. The body of the attachment

", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", + "html": "

To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.corsair-preview+json
" + } + ], + "category": "apps", + "subcategory": "installations" + }, + "slug": "create-a-content-attachment", + "category": "apps", + "categoryLabel": "Apps", + "subcategory": "installations", + "subcategoryLabel": "Installations", + "notes": [], + "descriptionHTML": "

Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

\n

The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

\n

You must use an installation access token to access this endpoint.

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

Required. The title of the attachment

", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + { + "description": "

Required. The body of the attachment

", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", @@ -71042,184 +71221,5 @@ ], "bodyParameters": [], "descriptionHTML": "

Get a random sentence from the Zen of GitHub

" - }, - { - "verb": "post", - "requestPath": "/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "serverUrl": "http(s)://{hostname}/api/v3", - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

The owner of the repository. Determined from the repository full_name of the content_reference event.

" - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

The name of the repository. Determined from the repository full_name of the content_reference event.

" - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "

The id of the content_reference event.

" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", - "html": "
await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
" - } - ], - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.21/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.21/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.21/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/apps#create-a-content-attachment" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "

Required. The title of the attachment

", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - "body": { - "description": "

Required. The body of the attachment

", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", - "html": "

To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.corsair-preview+json
" - } - ], - "category": "apps", - "subcategory": "installations" - }, - "slug": "create-a-content-attachment", - "category": "apps", - "categoryLabel": "Apps", - "subcategory": "installations", - "subcategoryLabel": "Installations", - "notes": [], - "descriptionHTML": "

Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

\n

The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

\n

You must use an installation access token to access this endpoint.

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

Required. The title of the attachment

", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - { - "description": "

Required. The body of the attachment

", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] } ] \ No newline at end of file diff --git a/lib/rest/static/decorated/ghes-2.22.json b/lib/rest/static/decorated/ghes-2.22.json index 0ec65296dd..6df593b651 100644 --- a/lib/rest/static/decorated/ghes-2.22.json +++ b/lib/rest/static/decorated/ghes-2.22.json @@ -44064,6 +44064,185 @@ } ] }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The owner of the repository. Determined from the repository full_name of the content_reference event.

" + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The name of the repository. Determined from the repository full_name of the content_reference event.

" + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

The id of the content_reference event.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
" + } + ], + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.22/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/apps#create-a-content-attachment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "

Required. The title of the attachment

", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + "body": { + "description": "

Required. The body of the attachment

", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", + "html": "

To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.corsair-preview+json
" + } + ], + "category": "apps", + "subcategory": "installations" + }, + "slug": "create-a-content-attachment", + "category": "apps", + "categoryLabel": "Apps", + "subcategory": "installations", + "subcategoryLabel": "Installations", + "notes": [], + "descriptionHTML": "

Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

\n

The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

\n

You must use an installation access token to access this endpoint.

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

Required. The title of the attachment

", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + { + "description": "

Required. The body of the attachment

", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", @@ -78682,184 +78861,5 @@ ], "bodyParameters": [], "descriptionHTML": "

Get a random sentence from the Zen of GitHub

" - }, - { - "verb": "post", - "requestPath": "/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "serverUrl": "http(s)://{hostname}/api/v3", - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

The owner of the repository. Determined from the repository full_name of the content_reference event.

" - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

The name of the repository. Determined from the repository full_name of the content_reference event.

" - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "

The id of the content_reference event.

" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", - "html": "
await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
" - } - ], - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.22/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/apps#create-a-content-attachment" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "

Required. The title of the attachment

", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - "body": { - "description": "

Required. The body of the attachment

", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", - "html": "

To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.corsair-preview+json
" - } - ], - "category": "apps", - "subcategory": "installations" - }, - "slug": "create-a-content-attachment", - "category": "apps", - "categoryLabel": "Apps", - "subcategory": "installations", - "subcategoryLabel": "Installations", - "notes": [], - "descriptionHTML": "

Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

\n

The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

\n

You must use an installation access token to access this endpoint.

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

Required. The title of the attachment

", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - { - "description": "

Required. The body of the attachment

", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] } ] \ No newline at end of file diff --git a/lib/rest/static/decorated/ghes-3.0.json b/lib/rest/static/decorated/ghes-3.0.json index 861902e0c5..c2cabe1af9 100644 --- a/lib/rest/static/decorated/ghes-3.0.json +++ b/lib/rest/static/decorated/ghes-3.0.json @@ -48521,6 +48521,185 @@ } ] }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The owner of the repository. Determined from the repository full_name of the content_reference event.

" + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The name of the repository. Determined from the repository full_name of the content_reference event.

" + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

The id of the content_reference event.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
" + } + ], + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@3.0/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#create-a-content-attachment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "

Required. The title of the attachment

", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + "body": { + "description": "

Required. The body of the attachment

", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", + "html": "

To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.corsair-preview+json
" + } + ], + "category": "apps", + "subcategory": "installations" + }, + "slug": "create-a-content-attachment", + "category": "apps", + "categoryLabel": "Apps", + "subcategory": "installations", + "subcategoryLabel": "Installations", + "notes": [], + "descriptionHTML": "

Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

\n

The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

\n

You must use an installation access token to access this endpoint.

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

Required. The title of the attachment

", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + { + "description": "

Required. The body of the attachment

", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", @@ -83412,184 +83591,5 @@ ], "bodyParameters": [], "descriptionHTML": "

Get a random sentence from the Zen of GitHub

" - }, - { - "verb": "post", - "requestPath": "/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "serverUrl": "http(s)://{hostname}/api/v3", - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

The owner of the repository. Determined from the repository full_name of the content_reference event.

" - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

The name of the repository. Determined from the repository full_name of the content_reference event.

" - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "

The id of the content_reference event.

" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/api/v3/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", - "html": "
await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
" - } - ], - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@3.0/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#create-a-content-attachment" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "

Required. The title of the attachment

", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - "body": { - "description": "

Required. The body of the attachment

", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", - "html": "

To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.corsair-preview+json
" - } - ], - "category": "apps", - "subcategory": "installations" - }, - "slug": "create-a-content-attachment", - "category": "apps", - "categoryLabel": "Apps", - "subcategory": "installations", - "subcategoryLabel": "Installations", - "notes": [], - "descriptionHTML": "

Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

\n

The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

\n

You must use an installation access token to access this endpoint.

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

Required. The title of the attachment

", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - { - "description": "

Required. The body of the attachment

", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] } ] \ No newline at end of file diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json index 5d0b6ef924..e2514f8310 100644 --- a/lib/rest/static/decorated/ghes-3.1.json +++ b/lib/rest/static/decorated/ghes-3.1.json @@ -49210,6 +49210,185 @@ } ] }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + "serverUrl": "http(s)://{hostname}", + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The owner of the repository. Determined from the repository full_name of the content_reference event.

" + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The name of the repository. Determined from the repository full_name of the content_reference event.

" + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

The id of the content_reference event.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/repos/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/repos/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
" + } + ], + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@3.1/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@3.1/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.1/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#create-a-content-attachment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "

Required. The title of the attachment

", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + "body": { + "description": "

Required. The body of the attachment

", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", + "html": "

To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.corsair-preview+json
" + } + ], + "category": "apps", + "subcategory": "installations" + }, + "slug": "create-a-content-attachment", + "category": "apps", + "categoryLabel": "Apps", + "subcategory": "installations", + "subcategoryLabel": "Installations", + "notes": [], + "descriptionHTML": "

Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

\n

The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

\n

You must use an installation access token to access this endpoint.

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

Required. The title of the attachment

", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + { + "description": "

Required. The body of the attachment

", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", @@ -84304,184 +84483,5 @@ ], "bodyParameters": [], "descriptionHTML": "

Get a random sentence from the Zen of GitHub

" - }, - { - "verb": "post", - "requestPath": "/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "serverUrl": "http(s)://{hostname}", - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

The owner of the repository. Determined from the repository full_name of the content_reference event.

" - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

The name of the repository. Determined from the repository full_name of the content_reference event.

" - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "

The id of the content_reference event.

" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://{hostname}/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://{hostname}/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", - "html": "
await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
" - } - ], - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@3.1/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@3.1/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.1/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#create-a-content-attachment" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "

Required. The title of the attachment

", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - "body": { - "description": "

Required. The body of the attachment

", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", - "html": "

To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.corsair-preview+json
" - } - ], - "category": "apps", - "subcategory": "installations" - }, - "slug": "create-a-content-attachment", - "category": "apps", - "categoryLabel": "Apps", - "subcategory": "installations", - "subcategoryLabel": "Installations", - "notes": [], - "descriptionHTML": "

Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

\n

The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

\n

You must use an installation access token to access this endpoint.

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

Required. The title of the attachment

", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - { - "description": "

Required. The body of the attachment

", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] } ] \ No newline at end of file diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 5d09a18675..64e2d491de 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -41707,6 +41707,185 @@ } ] }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + "serverUrl": "http(s)://api.{hostname}", + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The owner of the repository. Determined from the repository full_name of the content_reference event.

" + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The name of the repository. Determined from the repository full_name of the content_reference event.

" + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

The id of the content_reference event.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://api.{hostname}/repos/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
" + } + ], + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/github-ae@latest/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/apps#create-a-content-attachment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "

Required. The title of the attachment

", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + "body": { + "description": "

Required. The body of the attachment

", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", + "html": "

To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.corsair-preview+json
" + } + ], + "category": "apps", + "subcategory": "installations" + }, + "slug": "create-a-content-attachment", + "category": "apps", + "categoryLabel": "Apps", + "subcategory": "installations", + "subcategoryLabel": "Installations", + "notes": [], + "descriptionHTML": "

Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

\n

The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

\n

You must use an installation access token to access this endpoint.

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

Required. The title of the attachment

", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024, + "name": "title", + "in": "body", + "rawType": "string", + "rawDescription": "The title of the attachment", + "childParamsGroups": [] + }, + { + "description": "

Required. The body of the attachment

", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144, + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The body of the attachment", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
{\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/contents/{path}", @@ -75534,184 +75713,5 @@ ], "bodyParameters": [], "descriptionHTML": "

Get a random sentence from the Zen of GitHub

" - }, - { - "verb": "post", - "requestPath": "/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "serverUrl": "http(s)://api.{hostname}", - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

The owner of the repository. Determined from the repository full_name of the content_reference event.

" - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

The name of the repository. Determined from the repository full_name of the content_reference event.

" - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "

The id of the content_reference event.

" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n http(s)://api.{hostname}/octocat/hello-world/content_references/42/attachments \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.corsair-preview+json\" \\\n  http(s)://api.{hostname}/octocat/hello-world/content_references/42/attachments \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n owner: 'octocat',\n repo: 'hello-world',\n content_reference_id: 42,\n title: 'title',\n body: 'body',\n mediaType: {\n previews: [\n 'corsair'\n ]\n }\n})", - "html": "
await octokit.request('POST /{owner}/{repo}/content_references/{content_reference_id}/attachments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  content_reference_id: 42,\n  title: 'title',\n  body: 'body',\n  mediaType: {\n    previews: [\n      'corsair'\n    ]\n  }\n})\n
" - } - ], - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/github-ae@latest/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/apps#create-a-content-attachment" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "

Required. The title of the attachment

", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - "body": { - "description": "

Required. The body of the attachment

", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```", - "html": "

To access the Content Attachments API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.corsair-preview+json
" - } - ], - "category": "apps", - "subcategory": "installations" - }, - "slug": "create-a-content-attachment", - "category": "apps", - "categoryLabel": "Apps", - "subcategory": "installations", - "subcategoryLabel": "Installations", - "notes": [], - "descriptionHTML": "

Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

\n

The app must create a content attachment within six hours of the content reference URL being posted. See \"Using content attachments\" for details about content attachments.

\n

You must use an installation access token to access this endpoint.

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

Required. The title of the attachment

", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024, - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The title of the attachment", - "childParamsGroups": [] - }, - { - "description": "

Required. The body of the attachment

", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The body of the attachment", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
{\n  \"id\": 101,\n  \"title\": \"[A-1234] Error found in core/models.py file'\",\n  \"body\": \"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] } ] \ No newline at end of file diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index a1b897f243..053a4b7493 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -185332,6 +185332,313 @@ } } }, + "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": { + "post": { + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#create-a-content-attachment" + }, + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ContentReferenceAttachment", + "description": "Content Reference attachments allow you to provide context around URLs posted in comments", + "type": "object", + "properties": { + "id": { + "description": "The ID of the attachment", + "example": 21, + "type": "integer" + }, + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + }, + "node_id": { + "description": "The node_id of the content attachment", + "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", + "type": "string" + } + }, + "required": [ + "id", + "title", + "body" + ] + }, + "examples": { + "default": { + "value": { + "id": 101, + "title": "[A-1234] Error found in core/models.py file'", + "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + } + } + }, "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", @@ -392433,313 +392740,6 @@ "category": "meta" } } - }, - "/{owner}/{repo}/content_references/{content_reference_id}/attachments": { - "post": { - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/apps#create-a-content-attachment" - }, - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ContentReferenceAttachment", - "description": "Content Reference attachments allow you to provide context around URLs posted in comments", - "type": "object", - "properties": { - "id": { - "description": "The ID of the attachment", - "example": 21, - "type": "integer" - }, - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - }, - "node_id": { - "description": "The node_id of the content attachment", - "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", - "type": "string" - } - }, - "required": [ - "id", - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "id": 101, - "title": "[A-1234] Error found in core/models.py file'", - "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" - } - ], - "category": "apps", - "subcategory": "installations" - } - } } } } \ No newline at end of file diff --git a/lib/rest/static/dereferenced/ghes-2.18.deref.json b/lib/rest/static/dereferenced/ghes-2.18.deref.json index 619469fe3d..8296bfb812 100644 --- a/lib/rest/static/dereferenced/ghes-2.18.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.18.deref.json @@ -117293,6 +117293,313 @@ } } }, + "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": { + "post": { + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.18/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/apps#create-a-content-attachment" + }, + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ContentReferenceAttachment", + "description": "Content Reference attachments allow you to provide context around URLs posted in comments", + "type": "object", + "properties": { + "id": { + "description": "The ID of the attachment", + "example": 21, + "type": "integer" + }, + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + }, + "node_id": { + "description": "The node_id of the content attachment", + "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", + "type": "string" + } + }, + "required": [ + "id", + "title", + "body" + ] + }, + "examples": { + "default": { + "value": { + "id": 101, + "title": "[A-1234] Error found in core/models.py file'", + "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + } + } + }, "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", @@ -296922,313 +297229,6 @@ "category": "meta" } } - }, - "/{owner}/{repo}/content_references/{content_reference_id}/attachments": { - "post": { - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.18/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.18/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.18/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/apps#create-a-content-attachment" - }, - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ContentReferenceAttachment", - "description": "Content Reference attachments allow you to provide context around URLs posted in comments", - "type": "object", - "properties": { - "id": { - "description": "The ID of the attachment", - "example": 21, - "type": "integer" - }, - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - }, - "node_id": { - "description": "The node_id of the content attachment", - "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", - "type": "string" - } - }, - "required": [ - "id", - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "id": 101, - "title": "[A-1234] Error found in core/models.py file'", - "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" - } - ], - "category": "apps", - "subcategory": "installations" - } - } } } } \ No newline at end of file diff --git a/lib/rest/static/dereferenced/ghes-2.19.deref.json b/lib/rest/static/dereferenced/ghes-2.19.deref.json index 3810620046..3ccc1e8aad 100644 --- a/lib/rest/static/dereferenced/ghes-2.19.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.19.deref.json @@ -120335,6 +120335,313 @@ } } }, + "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": { + "post": { + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.19/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/apps#create-a-content-attachment" + }, + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ContentReferenceAttachment", + "description": "Content Reference attachments allow you to provide context around URLs posted in comments", + "type": "object", + "properties": { + "id": { + "description": "The ID of the attachment", + "example": 21, + "type": "integer" + }, + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + }, + "node_id": { + "description": "The node_id of the content attachment", + "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", + "type": "string" + } + }, + "required": [ + "id", + "title", + "body" + ] + }, + "examples": { + "default": { + "value": { + "id": 101, + "title": "[A-1234] Error found in core/models.py file'", + "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + } + } + }, "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", @@ -300288,313 +300595,6 @@ "category": "meta" } } - }, - "/{owner}/{repo}/content_references/{content_reference_id}/attachments": { - "post": { - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.19/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.19/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.19/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/apps#create-a-content-attachment" - }, - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ContentReferenceAttachment", - "description": "Content Reference attachments allow you to provide context around URLs posted in comments", - "type": "object", - "properties": { - "id": { - "description": "The ID of the attachment", - "example": 21, - "type": "integer" - }, - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - }, - "node_id": { - "description": "The node_id of the content attachment", - "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", - "type": "string" - } - }, - "required": [ - "id", - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "id": 101, - "title": "[A-1234] Error found in core/models.py file'", - "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" - } - ], - "category": "apps", - "subcategory": "installations" - } - } } } } \ No newline at end of file diff --git a/lib/rest/static/dereferenced/ghes-2.20.deref.json b/lib/rest/static/dereferenced/ghes-2.20.deref.json index 770b9f402c..8cd03d7601 100644 --- a/lib/rest/static/dereferenced/ghes-2.20.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.20.deref.json @@ -122556,6 +122556,313 @@ } } }, + "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": { + "post": { + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.20/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.20/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.20/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/apps#create-a-content-attachment" + }, + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ContentReferenceAttachment", + "description": "Content Reference attachments allow you to provide context around URLs posted in comments", + "type": "object", + "properties": { + "id": { + "description": "The ID of the attachment", + "example": 21, + "type": "integer" + }, + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + }, + "node_id": { + "description": "The node_id of the content attachment", + "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", + "type": "string" + } + }, + "required": [ + "id", + "title", + "body" + ] + }, + "examples": { + "default": { + "value": { + "id": 101, + "title": "[A-1234] Error found in core/models.py file'", + "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + } + } + }, "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", @@ -303594,313 +303901,6 @@ "category": "meta" } } - }, - "/{owner}/{repo}/content_references/{content_reference_id}/attachments": { - "post": { - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.20/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.20/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.20/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/apps#create-a-content-attachment" - }, - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ContentReferenceAttachment", - "description": "Content Reference attachments allow you to provide context around URLs posted in comments", - "type": "object", - "properties": { - "id": { - "description": "The ID of the attachment", - "example": 21, - "type": "integer" - }, - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - }, - "node_id": { - "description": "The node_id of the content attachment", - "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", - "type": "string" - } - }, - "required": [ - "id", - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "id": 101, - "title": "[A-1234] Error found in core/models.py file'", - "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" - } - ], - "category": "apps", - "subcategory": "installations" - } - } } } } \ No newline at end of file diff --git a/lib/rest/static/dereferenced/ghes-2.21.deref.json b/lib/rest/static/dereferenced/ghes-2.21.deref.json index 84527ae4e6..025848fbc9 100644 --- a/lib/rest/static/dereferenced/ghes-2.21.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.21.deref.json @@ -134168,6 +134168,313 @@ } } }, + "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": { + "post": { + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.21/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.21/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.21/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/apps#create-a-content-attachment" + }, + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ContentReferenceAttachment", + "description": "Content Reference attachments allow you to provide context around URLs posted in comments", + "type": "object", + "properties": { + "id": { + "description": "The ID of the attachment", + "example": 21, + "type": "integer" + }, + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + }, + "node_id": { + "description": "The node_id of the content attachment", + "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", + "type": "string" + } + }, + "required": [ + "id", + "title", + "body" + ] + }, + "examples": { + "default": { + "value": { + "id": 101, + "title": "[A-1234] Error found in core/models.py file'", + "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + } + } + }, "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", @@ -313642,313 +313949,6 @@ "category": "meta" } } - }, - "/{owner}/{repo}/content_references/{content_reference_id}/attachments": { - "post": { - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.21/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.21/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.21/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/apps#create-a-content-attachment" - }, - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ContentReferenceAttachment", - "description": "Content Reference attachments allow you to provide context around URLs posted in comments", - "type": "object", - "properties": { - "id": { - "description": "The ID of the attachment", - "example": 21, - "type": "integer" - }, - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - }, - "node_id": { - "description": "The node_id of the content attachment", - "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", - "type": "string" - } - }, - "required": [ - "id", - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "id": 101, - "title": "[A-1234] Error found in core/models.py file'", - "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" - } - ], - "category": "apps", - "subcategory": "installations" - } - } } } } \ No newline at end of file diff --git a/lib/rest/static/dereferenced/ghes-2.22.deref.json b/lib/rest/static/dereferenced/ghes-2.22.deref.json index cec548f694..aa6b8e7c8f 100644 --- a/lib/rest/static/dereferenced/ghes-2.22.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.22.deref.json @@ -165071,6 +165071,313 @@ } } }, + "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": { + "post": { + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.22/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/apps#create-a-content-attachment" + }, + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ContentReferenceAttachment", + "description": "Content Reference attachments allow you to provide context around URLs posted in comments", + "type": "object", + "properties": { + "id": { + "description": "The ID of the attachment", + "example": 21, + "type": "integer" + }, + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + }, + "node_id": { + "description": "The node_id of the content attachment", + "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", + "type": "string" + } + }, + "required": [ + "id", + "title", + "body" + ] + }, + "examples": { + "default": { + "value": { + "id": 101, + "title": "[A-1234] Error found in core/models.py file'", + "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + } + } + }, "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", @@ -345131,313 +345438,6 @@ "category": "meta" } } - }, - "/{owner}/{repo}/content_references/{content_reference_id}/attachments": { - "post": { - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@2.22/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@2.22/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@2.22/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/apps#create-a-content-attachment" - }, - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ContentReferenceAttachment", - "description": "Content Reference attachments allow you to provide context around URLs posted in comments", - "type": "object", - "properties": { - "id": { - "description": "The ID of the attachment", - "example": 21, - "type": "integer" - }, - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - }, - "node_id": { - "description": "The node_id of the content attachment", - "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", - "type": "string" - } - }, - "required": [ - "id", - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "id": 101, - "title": "[A-1234] Error found in core/models.py file'", - "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" - } - ], - "category": "apps", - "subcategory": "installations" - } - } } } } \ No newline at end of file diff --git a/lib/rest/static/dereferenced/ghes-3.0.deref.json b/lib/rest/static/dereferenced/ghes-3.0.deref.json index 214b73f6ce..e9706e24f4 100644 --- a/lib/rest/static/dereferenced/ghes-3.0.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.0.deref.json @@ -170466,6 +170466,313 @@ } } }, + "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": { + "post": { + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@3.0/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#create-a-content-attachment" + }, + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ContentReferenceAttachment", + "description": "Content Reference attachments allow you to provide context around URLs posted in comments", + "type": "object", + "properties": { + "id": { + "description": "The ID of the attachment", + "example": 21, + "type": "integer" + }, + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + }, + "node_id": { + "description": "The node_id of the content attachment", + "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", + "type": "string" + } + }, + "required": [ + "id", + "title", + "body" + ] + }, + "examples": { + "default": { + "value": { + "id": 101, + "title": "[A-1234] Error found in core/models.py file'", + "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + } + } + }, "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", @@ -350852,313 +351159,6 @@ "category": "meta" } } - }, - "/{owner}/{repo}/content_references/{content_reference_id}/attachments": { - "post": { - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@3.0/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#create-a-content-attachment" - }, - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ContentReferenceAttachment", - "description": "Content Reference attachments allow you to provide context around URLs posted in comments", - "type": "object", - "properties": { - "id": { - "description": "The ID of the attachment", - "example": 21, - "type": "integer" - }, - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - }, - "node_id": { - "description": "The node_id of the content attachment", - "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", - "type": "string" - } - }, - "required": [ - "id", - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "id": 101, - "title": "[A-1234] Error found in core/models.py file'", - "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" - } - ], - "category": "apps", - "subcategory": "installations" - } - } } } } \ No newline at end of file diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json index 1a98e1cf46..5ac9f83b12 100644 --- a/lib/rest/static/dereferenced/ghes-3.1.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json @@ -173350,6 +173350,313 @@ } } }, + "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": { + "post": { + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@3.1/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@3.1/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.1/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#create-a-content-attachment" + }, + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ContentReferenceAttachment", + "description": "Content Reference attachments allow you to provide context around URLs posted in comments", + "type": "object", + "properties": { + "id": { + "description": "The ID of the attachment", + "example": 21, + "type": "integer" + }, + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + }, + "node_id": { + "description": "The node_id of the content attachment", + "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", + "type": "string" + } + }, + "required": [ + "id", + "title", + "body" + ] + }, + "examples": { + "default": { + "value": { + "id": 101, + "title": "[A-1234] Error found in core/models.py file'", + "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + } + } + }, "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", @@ -355243,313 +355550,6 @@ "category": "meta" } } - }, - "/{owner}/{repo}/content_references/{content_reference_id}/attachments": { - "post": { - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@3.1/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@3.1/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.1/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#create-a-content-attachment" - }, - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ContentReferenceAttachment", - "description": "Content Reference attachments allow you to provide context around URLs posted in comments", - "type": "object", - "properties": { - "id": { - "description": "The ID of the attachment", - "example": 21, - "type": "integer" - }, - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - }, - "node_id": { - "description": "The node_id of the content attachment", - "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", - "type": "string" - } - }, - "required": [ - "id", - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "id": 101, - "title": "[A-1234] Error found in core/models.py file'", - "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" - } - ], - "category": "apps", - "subcategory": "installations" - } - } } } } \ No newline at end of file diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 648467a8bf..3d6bdd4ae4 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -141894,6 +141894,313 @@ } } }, + "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": { + "post": { + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/github-ae@latest/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/apps#create-a-content-attachment" + }, + "parameters": [ + { + "name": "owner", + "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "content_reference_id", + "description": "The `id` of the `content_reference` event.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + } + }, + "required": [ + "title", + "body" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "ContentReferenceAttachment", + "description": "Content Reference attachments allow you to provide context around URLs posted in comments", + "type": "object", + "properties": { + "id": { + "description": "The ID of the attachment", + "example": 21, + "type": "integer" + }, + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + }, + "node_id": { + "description": "The node_id of the content attachment", + "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", + "type": "string" + } + }, + "required": [ + "id", + "title", + "body" + ] + }, + "examples": { + "default": { + "value": { + "id": 101, + "title": "[A-1234] Error found in core/models.py file'", + "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview header missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + } + } + }, "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", @@ -311664,313 +311971,6 @@ "category": "meta" } } - }, - "/{owner}/{repo}/content_references/{content_reference_id}/attachments": { - "post": { - "summary": "Create a content attachment", - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/github-ae@latest/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/create-content-attachment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/apps#create-a-content-attachment" - }, - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - } - }, - "required": [ - "title", - "body" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "ContentReferenceAttachment", - "description": "Content Reference attachments allow you to provide context around URLs posted in comments", - "type": "object", - "properties": { - "id": { - "description": "The ID of the attachment", - "example": 21, - "type": "integer" - }, - "title": { - "description": "The title of the attachment", - "example": "Title of the attachment", - "type": "string", - "maxLength": 1024 - }, - "body": { - "description": "The body of the attachment", - "example": "Body of the attachment", - "type": "string", - "maxLength": 262144 - }, - "node_id": { - "description": "The node_id of the content attachment", - "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", - "type": "string" - } - }, - "required": [ - "id", - "title", - "body" - ] - }, - "examples": { - "default": { - "value": { - "id": 101, - "title": "[A-1234] Error found in core/models.py file'", - "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "415": { - "description": "Preview header missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "corsair", - "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" - } - ], - "category": "apps", - "subcategory": "installations" - } - } } } } \ No newline at end of file diff --git a/translations/de-DE/content/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system.md b/translations/de-DE/content/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system.md index 3a04b180a9..c403a1da2c 100644 --- a/translations/de-DE/content/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system.md +++ b/translations/de-DE/content/code-security/secure-coding/about-codeql-code-scanning-in-your-ci-system.md @@ -7,8 +7,15 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: overview topics: - - Security + - Advanced Security + - Code scanning + - CodeQL + - Repositories + - Pull requests + - Integration + - CI --- {% data reusables.code-scanning.beta %} diff --git a/translations/de-DE/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates.md b/translations/de-DE/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates.md index 3e7a411b73..31aa2d374c 100644 --- a/translations/de-DE/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates.md +++ b/translations/de-DE/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates.md @@ -7,8 +7,15 @@ redirect_from: - /code-security/supply-chain-security/customizing-dependency-updates versions: free-pro-team: '*' +type: how_to topics: + - Dependabot + - Version updates + - Security updates - Repositories + - Dependencies + - Pull requests + - Vulnerabilities --- ### About customizing dependency updates diff --git a/translations/de-DE/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates.md b/translations/de-DE/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates.md index b84c596853..e4de9c94be 100644 --- a/translations/de-DE/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates.md +++ b/translations/de-DE/content/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates.md @@ -6,8 +6,14 @@ redirect_from: - /code-security/supply-chain-security/managing-pull-requests-for-dependency-updates versions: free-pro-team: '*' +type: how_to topics: - Repositories + - Version updates + - Security updates + - Pull requests + - Dependencies + - Vulnerabilities --- ### About {% data variables.product.prodname_dependabot %} pull requests diff --git a/translations/ko-KR/content/code-security/secure-coding/running-codeql-runner-in-your-ci-system.md b/translations/ko-KR/content/code-security/secure-coding/running-codeql-runner-in-your-ci-system.md index 495d68c51c..9f1642dcfe 100644 --- a/translations/ko-KR/content/code-security/secure-coding/running-codeql-runner-in-your-ci-system.md +++ b/translations/ko-KR/content/code-security/secure-coding/running-codeql-runner-in-your-ci-system.md @@ -11,8 +11,15 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +type: how_to topics: - - Security + - Advanced Security + - Code scanning + - CodeQL + - Repositories + - Pull requests + - Integration + - CI --- diff --git a/translations/ko-KR/content/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot.md b/translations/ko-KR/content/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot.md index 7c186aac17..8efa13d02b 100644 --- a/translations/ko-KR/content/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot.md +++ b/translations/ko-KR/content/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot.md @@ -3,8 +3,14 @@ title: Upgrading from Dependabot.com to GitHub-native Dependabot intro: You can upgrade to GitHub-native Dependabot by merging a pull request that will allow your dependencies to continue being updated. versions: free-pro-team: '*' +type: how_to topics: - Repositories + - Dependabot + - Upgrading + - Version updates + - Dependencies + - Migration --- {% warning %}