|
After Width: | Height: | Size: 45 KiB |
BIN
assets/images/enterprise/3.4/repository/code-scanning-alert.png
Normal file
|
After Width: | Height: | Size: 68 KiB |
|
After Width: | Height: | Size: 38 KiB |
|
After Width: | Height: | Size: 54 KiB |
|
After Width: | Height: | Size: 54 KiB |
|
After Width: | Height: | Size: 44 KiB |
|
After Width: | Height: | Size: 184 KiB |
|
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 134 KiB |
|
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 187 KiB |
|
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 118 KiB |
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 171 KiB |
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 176 KiB |
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 125 KiB |
BIN
assets/images/help/repository/mermaid-file-diagram.png
Normal file
|
After Width: | Height: | Size: 23 KiB |
BIN
assets/images/help/writing/fenced-geojson-rendered-map.png
Normal file
|
After Width: | Height: | Size: 355 KiB |
BIN
assets/images/help/writing/fenced-stl-rendered-object.png
Normal file
|
After Width: | Height: | Size: 110 KiB |
BIN
assets/images/help/writing/fenced-topojson-rendered-map.png
Normal file
|
After Width: | Height: | Size: 274 KiB |
@@ -7,6 +7,7 @@ const restRepoDisplayPages = [
|
||||
'branches',
|
||||
'collaborators',
|
||||
'commits',
|
||||
'deploy_keys',
|
||||
'deployments',
|
||||
'pages',
|
||||
'releases',
|
||||
@@ -19,6 +20,7 @@ const restRepoCategoryExceptionsTitles = {
|
||||
branches: 'Branches',
|
||||
collaborators: 'Collaborators',
|
||||
commits: 'Commits',
|
||||
deploy_keys: 'Deploy Keys',
|
||||
deployments: 'Deployments',
|
||||
pages: 'GitHub Pages',
|
||||
releases: 'Releases',
|
||||
|
||||
@@ -68,7 +68,8 @@ export const RestReferencePage = ({
|
||||
if (
|
||||
hash &&
|
||||
(pathname.endsWith('/rest/reference/repos') ||
|
||||
pathname.endsWith('/rest/reference/enterprise-admin'))
|
||||
pathname.endsWith('/rest/reference/enterprise-admin') ||
|
||||
pathname.endsWith('/rest/reference/deployments'))
|
||||
) {
|
||||
setLoadClientsideRedirectExceptions(true)
|
||||
}
|
||||
@@ -160,9 +161,6 @@ export const RestReferencePage = ({
|
||||
{page.introPlainText}
|
||||
</Lead>
|
||||
)}
|
||||
<div key={`restCategory-introContent`}>
|
||||
<div dangerouslySetInnerHTML={{ __html: introContent }} />
|
||||
</div>
|
||||
<div className="my-3 d-flex">
|
||||
<div className="pr-3 mt-1">
|
||||
<Circle className="color-fg-on-emphasis color-bg-emphasis">
|
||||
@@ -185,6 +183,9 @@ export const RestReferencePage = ({
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
<div key={`restCategory-introContent`}>
|
||||
<div dangerouslySetInnerHTML={{ __html: introContent }} />
|
||||
</div>
|
||||
<MarkdownContent>
|
||||
{subcategories.map((subcategory, index) => (
|
||||
<div key={`restCategory-${index}`}>
|
||||
|
||||
@@ -134,7 +134,7 @@ Email notifications from {% data variables.product.product_location %} contain t
|
||||
| `To` field | This field connects directly to the thread.{% ifversion not ghae %} If you reply to the email, you'll add a new comment to the conversation.{% endif %} |
|
||||
| `Cc` address | {% data variables.product.product_name %} will `Cc` you if you're subscribed to a conversation. The second `Cc` email address matches the notification reason. The suffix for these notification reasons is {% data variables.notifications.cc_address %}. The possible notification reasons are: <ul><li>`assign`: You were assigned to an issue or pull request.</li><li>`author`: You created an issue or pull request.</li><li>`ci_activity`: A {% data variables.product.prodname_actions %} workflow run that you triggered was completed.</li><li>`comment`: You commented on an issue or pull request.</li><li>`manual`: There was an update to an issue or pull request you manually subscribed to.</li><li>`mention`: You were mentioned on an issue or pull request.</li><li>`push`: Someone committed to a pull request you're subscribed to.</li><li>`review_requested`: You or a team you're a member of was requested to review a pull request.</li>{% ifversion fpt or ghes or ghae-issue-4864 or ghec %}<li>`security_alert`: {% data variables.product.prodname_dotcom %} detected a vulnerability in a repository you receive alerts for.</li>{% endif %}<li>`state_change`: An issue or pull request you're subscribed to was either closed or opened.</li><li>`subscribed`: There was an update in a repository you're watching.</li><li>`team_mention`: A team you belong to was mentioned on an issue or pull request.</li><li>`your_activity`: You opened, commented on, or closed an issue or pull request.</li></ul> |
|
||||
| `mailing list` field | This field identifies the name of the repository and its owner. The format of this address is always `<repository name>.<repository owner>.{% data variables.command_line.backticks %}`. |{% ifversion fpt or ghes or ghae-issue-4864 or ghec %}
|
||||
| `X-GitHub-Severity` field | {% data reusables.repositories.security-alerts-x-github-severity %} The possible severity levels are:<ul><li>`low`</li><li>`moderate`</li><li>`high`</li><li>`critical`</li></ul>For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." |{% endif %}
|
||||
| `X-GitHub-Severity` field | {% data reusables.repositories.security-alerts-x-github-severity %} The possible severity levels are:<ul><li>`low`</li><li>`moderate`</li><li>`high`</li><li>`critical`</li></ul>For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." |{% endif %}
|
||||
|
||||
## Choosing your notification settings
|
||||
|
||||
|
||||
@@ -173,7 +173,7 @@ If you use {% data variables.product.prodname_dependabot %} to keep your depende
|
||||
- `reason:security_alert` to show notifications for {% data variables.product.prodname_dependabot_alerts %} and security update pull requests.
|
||||
- `author:app/dependabot` to show notifications generated by {% data variables.product.prodname_dependabot %}. This includes {% data variables.product.prodname_dependabot_alerts %}, security update pull requests, and version update pull requests.
|
||||
|
||||
For more information about {% data variables.product.prodname_dependabot %}, see "[About managing vulnerable dependencies](/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies)."
|
||||
For more information about {% data variables.product.prodname_dependabot %}, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)."
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghes < 3.3 or ghae-issue-4864 %}
|
||||
@@ -182,7 +182,7 @@ If you use {% data variables.product.prodname_dependabot %} to tell you about vu
|
||||
- `is:repository_vulnerability_alert`
|
||||
- `reason:security_alert`
|
||||
|
||||
For more information about {% data variables.product.prodname_dependabot %}, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
|
||||
For more information about {% data variables.product.prodname_dependabot %}, see "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
|
||||
{% endif %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -49,5 +49,5 @@ For an overview of repository-level security, see "[Securing your repository](/c
|
||||
## Further reading
|
||||
|
||||
- "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)"
|
||||
- "[Managing vulnerabilities in your project's dependencies](/github/managing-security-vulnerabilities/managing-vulnerabilities-in-your-projects-dependencies)"
|
||||
- "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)"
|
||||
- "[Keeping your dependencies updated automatically](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically)"
|
||||
|
||||
@@ -45,7 +45,7 @@ The repository owner has full control of the repository. In addition to the acti
|
||||
| Customize the repository's social media preview | "[Customizing your repository's social media preview](/github/administering-a-repository/customizing-your-repositorys-social-media-preview)" |
|
||||
| Create a template from the repository | "[Creating a template repository](/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)" |{% ifversion fpt or ghes or ghae-issue-4864 or ghec %}
|
||||
| Control access to {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies | "[Managing security and analysis settings for your repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)" |{% endif %}{% ifversion fpt or ghec %}
|
||||
| Dismiss {% data variables.product.prodname_dependabot_alerts %} in the repository | "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" |
|
||||
| Dismiss {% data variables.product.prodname_dependabot_alerts %} in the repository | "[Viewing {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" |
|
||||
| Manage data use for a private repository | "[Managing data use settings for your private repository](/get-started/privacy-on-github/managing-data-use-settings-for-your-private-repository)"|{% endif %}
|
||||
| Define code owners for the repository | "[About code owners](/github/creating-cloning-and-archiving-repositories/about-code-owners)" |
|
||||
| Archive the repository | "[Archiving repositories](/repositories/archiving-a-github-repository/archiving-repositories)" |{% ifversion fpt or ghec %}
|
||||
|
||||
@@ -290,7 +290,7 @@ GitHub helps you avoid using third-party software that contains known vulnerabil
|
||||
|
||||
| Dependency Management Tool | Description |
|
||||
|----|----|
|
||||
| Dependabot Alerts | You can track your repository's dependencies and receive Dependabot alerts when your enterprise detects vulnerable dependencies. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies)." |
|
||||
| Dependabot Alerts | You can track your repository's dependencies and receive Dependabot alerts when your enterprise detects vulnerable dependencies. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies)." |
|
||||
| Dependency Graph | The dependency graph is a summary of the manifest and lock files stored in a repository. It shows you the ecosystems and packages your codebase depends on (its dependencies) and the repositories and packages that depend on your project (its dependents). For more information, see "[About the dependency graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph)." |{% ifversion ghes > 3.1 or ghec %}
|
||||
| Dependency Review | 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. For more information, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)" or "[Reviewing Dependency Changes in a Pull Request](/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request)." | {% endif %} {% ifversion ghec or ghes > 3.2 %}
|
||||
| Dependabot Security Updates | Dependabot can fix vulnerable dependencies for you by raising pull requests with security updates. For more information, see "[About Dependabot security updates](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates)." |
|
||||
|
||||
@@ -49,7 +49,7 @@ You can also choose to manually sync vulnerability data at any time. For more in
|
||||
|
||||
When {% data variables.product.product_location %} receives information about a vulnerability, it identifies repositories in {% data variables.product.product_location %} that use the affected version of the dependency and generates {% data variables.product.prodname_dependabot_alerts %}. You can choose whether or not to notify users automatically about new {% data variables.product.prodname_dependabot_alerts %}.
|
||||
|
||||
For repositories with {% data variables.product.prodname_dependabot_alerts %} enabled, scanning is triggered on any push to the default branch that contains a manifest file or lock file. Additionally, when a new vulnerability record is added to {% data variables.product.product_location %}, {% data variables.product.product_name %} scans all existing repositories on {% data variables.product.product_location %} and generates alerts for any repository that is vulnerable. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
|
||||
For repositories with {% data variables.product.prodname_dependabot_alerts %} enabled, scanning is triggered on any push to the default branch that contains a manifest file or lock file. Additionally, when a new vulnerability record is added to {% data variables.product.product_location %}, {% data variables.product.product_name %} scans all existing repositories on {% data variables.product.product_location %} and generates alerts for any repository that is vulnerable. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
|
||||
|
||||
{% ifversion ghes > 3.2 %}
|
||||
### About {% data variables.product.prodname_dependabot_updates %}
|
||||
@@ -67,7 +67,7 @@ After you enable {% data variables.product.prodname_dependabot_alerts %}, you ca
|
||||
With {% data variables.product.prodname_dependabot_updates %}, {% data variables.product.company_short %} automatically creates pull requests to update dependencies in two ways.
|
||||
|
||||
- **{% data variables.product.prodname_dependabot_version_updates %}**: Users add a {% data variables.product.prodname_dependabot %} configuration file to the repository to enable {% data variables.product.prodname_dependabot %} to create pull requests when a new version of a tracked dependency is released. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates)."
|
||||
- **{% data variables.product.prodname_dependabot_security_updates %}**: Users toggle a repository setting to enable {% data variables.product.prodname_dependabot %} to create pull requests when {% data variables.product.prodname_dotcom %} detects a vulnerability in one of the dependencies of the dependency graph for the repository. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies)" and "[About {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates)."
|
||||
- **{% data variables.product.prodname_dependabot_security_updates %}**: Users toggle a repository setting to enable {% data variables.product.prodname_dependabot %} to create pull requests when {% data variables.product.prodname_dotcom %} detects a vulnerability in one of the dependencies of the dependency graph for the repository. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies)" and "[About {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates)."
|
||||
{% endif %}
|
||||
|
||||
## Enabling {% data variables.product.prodname_dependabot_alerts %}
|
||||
|
||||
@@ -27,7 +27,15 @@ By default, {% data variables.product.prodname_code_scanning %} analyzes your co
|
||||
|
||||
Each alert highlights a problem with the code and the name of the tool that identified it. You can see the line of code that triggered the alert, as well as properties of the alert, such as the alert severity{% ifversion fpt or ghes > 3.1 or ghae or ghec %}, security severity,{% endif %} and the nature of the problem. Alerts also tell you when the issue was first introduced. For alerts identified by {% data variables.product.prodname_codeql %} analysis, you will also see information on how to fix the problem.
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||
{% data reusables.code-scanning.alert-default-branch %}
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||

|
||||
{% else %}
|
||||

|
||||
{% endif %}
|
||||
|
||||
If you set up {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %}, you can also find data-flow problems in your code. Data-flow analysis finds potential security issues in code, such as: using data insecurely, passing dangerous arguments to functions, and leaking sensitive information.
|
||||
|
||||
|
||||
@@ -46,9 +46,16 @@ By default, the code scanning alerts page is filtered to show alerts for the def
|
||||
{% else %}
|
||||

|
||||
{% endif %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||
{% data reusables.code-scanning.alert-default-branch %}
|
||||
{% endif %}
|
||||
1. Optionally, if the alert highlights a problem with data flow, click **Show paths** to display the path from the data source to the sink where it's used.
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||

|
||||
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.
|
||||
{% else %}
|
||||

|
||||
{% endif %}
|
||||
2. 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.
|
||||

|
||||
|
||||
For more information, see "[About {% data variables.product.prodname_code_scanning %} alerts](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)."
|
||||
@@ -80,6 +87,10 @@ The benefit of using keyword filters is that only values with results are shown
|
||||
|
||||
If you enter multiple filters, the view will show alerts matching _all_ these filters. For example, `is:closed severity:high branch:main` will only display closed high-severity alerts that are present on the `main` branch. The exception is filters relating to refs (`ref`, `branch` and `pr`): `is:open branch:main branch:next` will show you open alerts from both the `main` branch and the `next` branch.
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||
{% data reusables.code-scanning.filter-non-default-branches %}
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghes > 3.3 or ghec %}
|
||||
|
||||
You can prefix the `tag` filter with `-` to exclude results with that tag. For example, `-tag:style` only shows alerts that do not have the `style` tag{% if codeql-ml-queries %} and `-tag:experimental` will omit all experimental alerts. For more information, see "[About {% data variables.product.prodname_code_scanning %} alerts](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts#about-experimental-alerts)."{% else %}.{% endif %}
|
||||
@@ -96,10 +107,12 @@ You can use the "Only alerts in application code" filter or `autofilter:true` ke
|
||||
|
||||
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)
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||

|
||||
{% else %}
|
||||

|
||||
{% endif %}
|
||||
|
||||
| Supported search | Syntax example | Results |
|
||||
| ---- | ---- | ---- |
|
||||
@@ -113,7 +126,7 @@ You can search the list of alerts. This is useful if there is a large number of
|
||||
|
||||
**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.
|
||||
- The AND search will return results where the search terms are found _anywhere_, in any order in the alert name or details.
|
||||
|
||||
{% endtip %}
|
||||
|
||||
@@ -143,7 +156,7 @@ If you have write permission for a repository, you can view fixed alerts by view
|
||||
|
||||
You can use{% ifversion fpt or ghes > 3.1 or ghae or ghec %} 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.
|
||||
Alerts may be fixed in one branch but not in another. You can use the "Branch" filter, on the summary of alerts, to check whether an alert is fixed in a particular branch.
|
||||
|
||||
{% ifversion fpt or ghes > 3.1 or ghae or ghec %}
|
||||

|
||||
@@ -151,6 +164,9 @@ Alerts may be fixed in one branch but not in another. You can use the "Branch" d
|
||||

|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||
{% data reusables.code-scanning.filter-non-default-branches %}
|
||||
{% endif %}
|
||||
## Dismissing or deleting alerts
|
||||
|
||||
There are two ways of closing an alert. You can fix the problem in the code, or you can dismiss the alert. Alternatively, if you have admin permissions for the repository, you can delete alerts. Deleting alerts is useful in situations where you have set up a {% data variables.product.prodname_code_scanning %} tool and then decided to remove it, or where you have configured {% data variables.product.prodname_codeql %} analysis with a larger set of queries than you want to continue using, and you've then removed some queries from the tool. In both cases, deleting alerts allows you to clean up your {% data variables.product.prodname_code_scanning %} results. You can delete alerts from the summary list within the **Security** tab.
|
||||
|
||||
@@ -39,7 +39,11 @@ You can use more than one issue to track the same {% data variables.product.prod
|
||||
|
||||
- A "tracked in" section will also show in the corresponding alert page.
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||

|
||||
{% else %}
|
||||

|
||||
{% endif %}
|
||||
|
||||
- On the tracking issue, {% data variables.product.prodname_dotcom %} displays a security badge icon in the task list and on the hovercard.
|
||||
|
||||
@@ -65,7 +69,11 @@ The status of the tracked alert won't change if you change the checkbox state of
|
||||
1. Optionally, to find the alert to track, you can use the free-text search or the drop-down menus to filter and locate the alert. For more information, see "[Managing code scanning alerts for your repository](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#filtering-code-scanning-alerts)."
|
||||
{% endif %}
|
||||
1. Towards the top of the page, on the right side, click **Create issue**.
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||

|
||||
{% else %}
|
||||

|
||||
{% endif %}
|
||||
{% data variables.product.prodname_dotcom %} automatically creates an issue to track the alert and adds the alert as a task list item.
|
||||
{% data variables.product.prodname_dotcom %} prepopulates the issue:
|
||||
- The title contains the name of the {% data variables.product.prodname_code_scanning %} alert.
|
||||
|
||||
@@ -74,10 +74,17 @@ If you have write permission for the repository, some annotations contain links
|
||||
|
||||
To see more information about an alert, users with write permission can click the **Show more details** link shown in the annotation. This allows you to see all of the context and metadata provided by the tool in an alert view. In the example below, you can see tags showing the severity, type, and relevant common weakness enumerations (CWEs) for the problem. The view also shows which commit introduced the problem.
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||
{% data reusables.code-scanning.alert-default-branch %}
|
||||
{% endif %}
|
||||
|
||||
In the detailed view for an alert, some {% data variables.product.prodname_code_scanning %} tools, like {% data variables.product.prodname_codeql %} analysis, also include a description of the problem and a **Show more** link for guidance on how to fix your code.
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %}
|
||||

|
||||
|
||||
{% else %}
|
||||

|
||||
{% endif %}
|
||||
## Fixing an alert on your pull request
|
||||
|
||||
Anyone with push access to a pull request can fix a {% data variables.product.prodname_code_scanning %} alert that's identified on that pull request. If you commit changes to the pull request this triggers a new run of the pull request checks. If your changes fix the problem, the alert is closed and the annotation removed.
|
||||
|
||||
@@ -1,11 +1,13 @@
|
||||
---
|
||||
title: About alerts for vulnerable dependencies
|
||||
title: About Dependabot alerts
|
||||
intro: '{% data variables.product.product_name %} sends {% data variables.product.prodname_dependabot_alerts %} when we detect vulnerabilities affecting your repository.'
|
||||
redirect_from:
|
||||
- /articles/about-security-alerts-for-vulnerable-dependencies
|
||||
- /github/managing-security-vulnerabilities/about-security-alerts-for-vulnerable-dependencies
|
||||
- /github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies
|
||||
- /code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -81,7 +83,7 @@ For repositories where {% data variables.product.prodname_dependabot_security_up
|
||||
|
||||
## Access to {% data variables.product.prodname_dependabot_alerts %}
|
||||
|
||||
You can see all of the alerts that affect a particular project{% ifversion fpt or ghec %} on the repository's Security tab or{% endif %} in the repository's dependency graph. For more information, see "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)."
|
||||
You can see all of the alerts that affect a particular project{% ifversion fpt or ghec %} on the repository's Security tab or{% endif %} in the repository's dependency graph. For more information, see "[Viewing {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)."
|
||||
|
||||
By default, we notify people with admin permissions in the affected repositories about new {% data variables.product.prodname_dependabot_alerts %}. {% ifversion fpt or ghec %}{% data variables.product.product_name %} never publicly discloses identified vulnerabilities for any repository. You can also make {% data variables.product.prodname_dependabot_alerts %} visible to additional people or teams working repositories that you own or have admin permissions for. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."
|
||||
{% endif %}
|
||||
@@ -95,5 +97,5 @@ You can also see all the {% data variables.product.prodname_dependabot_alerts %}
|
||||
## Further reading
|
||||
|
||||
- "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)"
|
||||
- "[Viewing and updating vulnerable dependencies in your repository](/articles/viewing-and-updating-vulnerable-dependencies-in-your-repository)"{% endif %}
|
||||
- "[Viewing {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/articles/viewing-and-updating-vulnerable-dependencies-in-your-repository)"{% endif %}
|
||||
{% ifversion fpt or ghec %}- "[Privacy on {% data variables.product.prodname_dotcom %}](/get-started/privacy-on-github)"{% endif %}
|
||||
@@ -6,6 +6,7 @@ miniTocMaxHeadingLevel: 3
|
||||
redirect_from:
|
||||
- /github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database
|
||||
- /code-security/supply-chain-security/browsing-security-vulnerabilities-in-the-github-advisory-database
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
@@ -35,7 +36,7 @@ The {% data variables.product.prodname_advisory_database %} contains a list of k
|
||||
|
||||
We carefully review each advisory for validity. Each {% data variables.product.company_short %}-reviewed advisory has a full description, and contains both ecosystem and package information.
|
||||
|
||||
If you enable {% data variables.product.prodname_dependabot_alerts %} for your repositories, you are automatically notified when a new {% data variables.product.company_short %}-reviewed advisory affects packages you depend on. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)."
|
||||
If you enable {% data variables.product.prodname_dependabot_alerts %} for your repositories, you are automatically notified when a new {% data variables.product.company_short %}-reviewed advisory affects packages you depend on. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)."
|
||||
|
||||
### About unreviewed advisories
|
||||
|
||||
@@ -107,7 +108,7 @@ You can search the database, and use qualifiers to narrow your search. For examp
|
||||
|
||||
## Viewing your vulnerable repositories
|
||||
|
||||
For any {% data variables.product.company_short %}-reviewed advisory in the {% data variables.product.prodname_advisory_database %}, you can see which of your repositories are affected by that security vulnerability. To see a vulnerable repository, you must have access to {% data variables.product.prodname_dependabot_alerts %} for that repository. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#access-to-dependabot-alerts)."
|
||||
For any {% data variables.product.company_short %}-reviewed advisory in the {% data variables.product.prodname_advisory_database %}, you can see which of your repositories are affected by that security vulnerability. To see a vulnerable repository, you must have access to {% data variables.product.prodname_dependabot_alerts %} for that repository. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#access-to-dependabot-alerts)."
|
||||
|
||||
1. Navigate to https://github.com/advisories.
|
||||
2. Click an advisory.
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: Configuring notifications for vulnerable dependencies
|
||||
shortTitle: Configuring notifications
|
||||
title: Configuring notifications for Dependabot alerts
|
||||
shortTitle: Configure notifications
|
||||
intro: 'Optimize how you receive notifications about {% data variables.product.prodname_dependabot_alerts %}.'
|
||||
redirect_from:
|
||||
- /github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies
|
||||
- /code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -58,7 +59,7 @@ You can configure notification settings for yourself or your organization from t
|
||||
|
||||
## How to reduce the noise from notifications for vulnerable dependencies
|
||||
|
||||
If you are concerned about receiving too many notifications for {% data variables.product.prodname_dependabot_alerts %}, we recommend you opt into the weekly email digest, or turn off notifications while keeping {% data variables.product.prodname_dependabot_alerts %} enabled. You can still navigate to see your {% data variables.product.prodname_dependabot_alerts %} in your repository's Security tab. For more information, see "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)."
|
||||
If you are concerned about receiving too many notifications for {% data variables.product.prodname_dependabot_alerts %}, we recommend you opt into the weekly email digest, or turn off notifications while keeping {% data variables.product.prodname_dependabot_alerts %} enabled. You can still navigate to see your {% data variables.product.prodname_dependabot_alerts %} in your repository's Security tab. For more information, see "[Viewing {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)."
|
||||
|
||||
## Further reading
|
||||
|
||||
@@ -3,6 +3,7 @@ title: Editing security advisories in the GitHub Advisory Database
|
||||
intro: 'You can submit improvements to any advisory published in the {% data variables.product.prodname_advisory_database %}.'
|
||||
redirect_from:
|
||||
- /code-security/security-advisories/editing-security-advisories-in-the-github-advisory-database
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/editing-security-advisories-in-the-github-advisory-database
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
24
content/code-security/dependabot/dependabot-alerts/index.md
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title: Identifying vulnerabilities in your project's dependencies with Dependabot alerts
|
||||
shortTitle: Dependabot alerts
|
||||
intro: '{% data variables.product.prodname_dependabot %} generates {% data variables.product.prodname_dependabot_alerts %} when known vulnerabilites are detected in dependencies that your project uses.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: issue-4864
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Dependabot
|
||||
- Alerts
|
||||
- Vulnerabilities
|
||||
- Repositories
|
||||
- Dependencies
|
||||
children:
|
||||
- /browsing-security-vulnerabilities-in-the-github-advisory-database
|
||||
- /editing-security-advisories-in-the-github-advisory-database
|
||||
- /about-dependabot-alerts
|
||||
- /viewing-and-updating-dependabot-alerts
|
||||
- /configuring-notifications-for-dependabot-alerts
|
||||
---
|
||||
|
||||
@@ -1,12 +1,13 @@
|
||||
---
|
||||
title: Viewing and updating vulnerable dependencies in your repository
|
||||
title: Viewing and updating Dependabot alerts
|
||||
intro: 'If {% data variables.product.product_name %} discovers vulnerable dependencies in your project, you can view them on the Dependabot alerts tab of your repository. Then, you can update your project to resolve or dismiss the vulnerability.'
|
||||
redirect_from:
|
||||
- /articles/viewing-and-updating-vulnerable-dependencies-in-your-repository
|
||||
- /github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository
|
||||
- /code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository
|
||||
permissions: Repository administrators and organization owners can view and update dependencies.
|
||||
shortTitle: View vulnerable dependencies
|
||||
shortTitle: View Dependabot alerts
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -25,7 +26,7 @@ topics:
|
||||
{% data reusables.dependabot.beta-security-and-version-updates %}
|
||||
{% data reusables.dependabot.enterprise-enable-dependabot %}
|
||||
|
||||
Your repository's {% data variables.product.prodname_dependabot_alerts %} tab lists all open and closed {% data variables.product.prodname_dependabot_alerts %}{% ifversion fpt or ghec or ghes > 3.2 %} and corresponding {% data variables.product.prodname_dependabot_security_updates %}{% endif %}. You can{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5638 %} filter alerts by package, ecosystem, or manifest. You can also{% endif %} sort the list of alerts, 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)."
|
||||
Your repository's {% data variables.product.prodname_dependabot_alerts %} tab lists all open and closed {% data variables.product.prodname_dependabot_alerts %}{% ifversion fpt or ghec or ghes > 3.2 %} and corresponding {% data variables.product.prodname_dependabot_security_updates %}{% endif %}. You can{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5638 %} filter alerts by package, ecosystem, or manifest. You can also{% endif %} sort the list of alerts, and you can click into specific alerts for more details. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)."
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.2 %}
|
||||
You can enable automatic security updates for any repository that uses {% data variables.product.prodname_dependabot_alerts %} and the dependency graph. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates)."
|
||||
@@ -112,7 +113,7 @@ Each {% data variables.product.prodname_dependabot %} alert has a unique numeric
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)"{% ifversion fpt or ghec or ghes > 3.2 %}
|
||||
- "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)"{% ifversion fpt or ghec or ghes > 3.2 %}
|
||||
- "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates)"{% endif %}
|
||||
- "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)"
|
||||
- "[Troubleshooting the detection of vulnerable dependencies](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies)"{% ifversion fpt or ghec or ghes > 3.2 %}
|
||||
@@ -6,6 +6,7 @@ redirect_from:
|
||||
- /github/managing-security-vulnerabilities/about-github-dependabot-security-updates
|
||||
- /github/managing-security-vulnerabilities/about-dependabot-security-updates
|
||||
- /code-security/supply-chain-security/about-dependabot-security-updates
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
@@ -27,7 +28,7 @@ topics:
|
||||
|
||||
## About {% data variables.product.prodname_dependabot_security_updates %}
|
||||
|
||||
{% data variables.product.prodname_dependabot_security_updates %} make it easier for you to fix vulnerable dependencies in your repository. If you enable this feature, when a {% data variables.product.prodname_dependabot %} alert is raised for a vulnerable dependency in the dependency graph of your repository, {% data variables.product.prodname_dependabot %} automatically tries to fix it. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)" and "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)."
|
||||
{% data variables.product.prodname_dependabot_security_updates %} make it easier for you to fix vulnerable dependencies in your repository. If you enable this feature, when a {% data variables.product.prodname_dependabot %} alert is raised for a vulnerable dependency in the dependency graph of your repository, {% data variables.product.prodname_dependabot %} automatically tries to fix it. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)" and "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)."
|
||||
|
||||
{% data variables.product.prodname_dotcom %} may send {% data variables.product.prodname_dependabot_alerts %} to repositories affected by a vulnerability disclosed by a recently published {% data variables.product.prodname_dotcom %} security advisory. {% data reusables.security-advisory.link-browsing-advisory-db %}
|
||||
|
||||
@@ -9,6 +9,7 @@ redirect_from:
|
||||
- /github/managing-security-vulnerabilities/configuring-github-dependabot-security-updates
|
||||
- /github/managing-security-vulnerabilities/configuring-dependabot-security-updates
|
||||
- /code-security/supply-chain-security/configuring-dependabot-security-updates
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
@@ -74,6 +75,6 @@ You can also enable or disable {% data variables.product.prodname_dependabot_sec
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)"{% ifversion fpt or ghec %}
|
||||
- "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)"{% ifversion fpt or ghec %}
|
||||
- "[Managing data use settings for your private repository](/get-started/privacy-on-github/managing-data-use-settings-for-your-private-repository)"{% endif %}
|
||||
- "[Supported package ecosystems](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)"
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
title: Automatically updating dependencies with known vulnerabilities with Dependabot security updates
|
||||
intro: '{% data variables.product.prodname_dependabot %} can help you fix vulnerable dependencies by automatically raising pull requests to update dependencies to secure versions.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '>3.2'
|
||||
topics:
|
||||
- Repositories
|
||||
- Dependabot
|
||||
- Security updates
|
||||
- Dependencies
|
||||
- Pull requests
|
||||
shortTitle: Dependabot security updates
|
||||
children:
|
||||
- /about-dependabot-security-updates
|
||||
- /configuring-dependabot-security-updates
|
||||
---
|
||||
|
||||
@@ -8,6 +8,7 @@ redirect_from:
|
||||
- /github/administering-a-repository/about-dependabot-version-updates
|
||||
- /code-security/supply-chain-security/about-dependabot-version-updates
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/upgrading-from-dependabotcom-to-github-native-dependabot
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
@@ -31,7 +32,7 @@ shortTitle: Dependabot version updates
|
||||
|
||||
You enable {% data variables.product.prodname_dependabot_version_updates %} by checking a configuration file into your repository. The configuration file specifies the location of the manifest, or of other package definition files, stored in your repository. {% data variables.product.prodname_dependabot %} uses this information to check for outdated packages and applications. {% data variables.product.prodname_dependabot %} determines if there is a new version of a dependency by looking at the semantic versioning ([semver](https://semver.org/)) of the dependency to decide whether it should update to that version. For certain package managers, {% data variables.product.prodname_dependabot_version_updates %} also supports vendoring. Vendored (or cached) dependencies are dependencies that are checked in to a specific directory in a repository rather than referenced in a manifest. Vendored dependencies are available at build time even if package servers are unavailable. {% data variables.product.prodname_dependabot_version_updates %} can be configured to check vendored dependencies for new versions and update them if necessary.
|
||||
|
||||
When {% data variables.product.prodname_dependabot %} identifies an outdated dependency, it raises a pull request to update the manifest to the latest version of the dependency. For vendored dependencies, {% data variables.product.prodname_dependabot %} raises a pull request to replace the outdated dependency with the new version directly. You check that your tests pass, review the changelog and release notes included in the pull request summary, and then merge it. For more information, see "[Enabling and disabling {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates)."
|
||||
When {% data variables.product.prodname_dependabot %} identifies an outdated dependency, it raises a pull request to update the manifest to the latest version of the dependency. For vendored dependencies, {% data variables.product.prodname_dependabot %} raises a pull request to replace the outdated dependency with the new version directly. You check that your tests pass, review the changelog and release notes included in the pull request summary, and then merge it. For more information, see "[Configuring {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates)."
|
||||
|
||||
If you enable _security updates_, {% data variables.product.prodname_dependabot %} also raises pull requests to update vulnerable dependencies. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)."
|
||||
|
||||
@@ -50,7 +51,7 @@ If you've enabled security updates, you'll sometimes see extra pull requests for
|
||||
## Supported repositories and ecosystems
|
||||
<!-- If you make changes to this feature, update /getting-started-with-github/github-language-support to reflect any changes to supported repositories or ecosystems. -->
|
||||
|
||||
You can configure version updates for repositories that contain a dependency manifest or lock file for one of the supported package managers. For some package managers, you can also configure vendoring for dependencies. For more information, see "[Configuration options for dependency updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#vendor)."
|
||||
You can configure version updates for repositories that contain a dependency manifest or lock file for one of the supported package managers. For some package managers, you can also configure vendoring for dependencies. For more information, see "[Configuration options for the dependabot.yml file](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#vendor)."
|
||||
{% note %}
|
||||
|
||||
{% data reusables.dependabot.private-dependencies-note %}
|
||||
@@ -1,10 +1,12 @@
|
||||
---
|
||||
title: Configuration options for dependency updates
|
||||
title: Configuration options for the dependabot.yml file
|
||||
intro: 'Detailed information for all the options you can use to customize how {% data variables.product.prodname_dependabot %} maintains your repositories.'
|
||||
permissions: 'People with write permissions to a repository can configure {% data variables.product.prodname_dependabot %} for the repository.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
redirect_from:
|
||||
- /github/administering-a-repository/configuration-options-for-dependency-updates
|
||||
- /code-security/supply-chain-security/configuration-options-for-dependency-updates
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates
|
||||
miniTocMaxHeadingLevel: 3
|
||||
versions:
|
||||
fpt: '*'
|
||||
@@ -17,7 +19,7 @@ topics:
|
||||
- Repositories
|
||||
- Dependencies
|
||||
- Pull requests
|
||||
shortTitle: Configuration options
|
||||
shortTitle: Configure dependabot.yml
|
||||
---
|
||||
|
||||
{% data reusables.dependabot.beta-security-and-version-updates %}
|
||||
@@ -27,7 +29,7 @@ shortTitle: Configuration options
|
||||
|
||||
The {% data variables.product.prodname_dependabot %} configuration file, *dependabot.yml*, uses YAML syntax. If you're new to YAML and want to learn more, see "[Learn YAML in five minutes](https://www.codeproject.com/Articles/1214409/Learn-YAML-in-five-minutes)."
|
||||
|
||||
You must store this file in the `.github` directory of your repository. When you add or update the *dependabot.yml* file, this triggers an immediate check for version updates. For more information and an example, see "[Enabling and disabling {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates#enabling-dependabot-version-updates)."
|
||||
You must store this file in the `.github` directory of your repository. When you add or update the *dependabot.yml* file, this triggers an immediate check for version updates. For more information and an example, see "[Configuring {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates#enabling-dependabot-version-updates)."
|
||||
|
||||
Any options that also affect security updates are used the next time a security alert triggers a pull request for a security update. For more information, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates)."
|
||||
|
||||
@@ -1,11 +1,12 @@
|
||||
---
|
||||
title: Enabling and disabling Dependabot version updates
|
||||
title: Configuring Dependabot version updates
|
||||
intro: 'You can configure your repository so that {% data variables.product.prodname_dependabot %} automatically updates the packages you use.'
|
||||
permissions: 'People with write permissions to a repository can enable or disable {% data variables.product.prodname_dependabot_version_updates %} for the repository.'
|
||||
redirect_from:
|
||||
- /github/administering-a-repository/enabling-and-disabling-version-updates
|
||||
- /code-security/supply-chain-security/enabling-and-disabling-version-updates
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-version-updates
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
@@ -17,7 +18,7 @@ topics:
|
||||
- Repositories
|
||||
- Dependencies
|
||||
- Pull requests
|
||||
shortTitle: Enable and disable updates
|
||||
shortTitle: Configure version updates
|
||||
---
|
||||
<!--Marketing-LINK: From /features/security/software-supply-chain page "About version updates for dependencies".-->
|
||||
{% data reusables.dependabot.beta-security-and-version-updates %}
|
||||
@@ -33,7 +34,7 @@ You enable {% data variables.product.prodname_dependabot_version_updates %} by c
|
||||
|
||||
## Enabling {% data variables.product.prodname_dependabot_version_updates %}
|
||||
|
||||
{% data reusables.dependabot.create-dependabot-yml %} For information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates)."
|
||||
{% data reusables.dependabot.create-dependabot-yml %} For information, see "[Configuration options for the dependabot.yml file](/github/administering-a-repository/configuration-options-for-dependency-updates)."
|
||||
1. Add a `version`.
|
||||
1. Optionally, if you have dependencies in a private registry, add a `registries` section containing authentication details.
|
||||
1. Add an `updates` section, with an entry for each package manager you want {% data variables.product.prodname_dependabot %} to monitor.
|
||||
@@ -137,4 +138,4 @@ updates:
|
||||
update-types: ["version-update:semver-patch"]
|
||||
```
|
||||
|
||||
For more information about checking for existing ignore preferences, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates#ignore)."
|
||||
For more information about checking for existing ignore preferences, see "[Configuration options for the dependabot.yml file](/github/administering-a-repository/configuration-options-for-dependency-updates#ignore)."
|
||||
@@ -5,6 +5,7 @@ permissions: 'People with write permissions to a repository can configure {% dat
|
||||
redirect_from:
|
||||
- /github/administering-a-repository/customizing-dependency-updates
|
||||
- /code-security/supply-chain-security/customizing-dependency-updates
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
@@ -34,7 +35,7 @@ After you've enabled version updates, you can customize how {% data variables.pr
|
||||
- Change the maximum number of open pull requests for version updates from the default of 5: `open-pull-requests-limit`
|
||||
- Open pull requests for version updates to target a specific branch, instead of the default branch: `target-branch`
|
||||
|
||||
For more information about the configuration options, see "[Configuration options for dependency updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates)."
|
||||
For more information about the configuration options, see "[Configuration options for the dependabot.yml file](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates)."
|
||||
|
||||
When you update the *dependabot.yml* file in your repository, {% data variables.product.prodname_dependabot %} runs an immediate check with the new configuration. Within minutes you will see an updated list of dependencies on the **{% data variables.product.prodname_dependabot %}** tab, this may take longer if the repository has many dependencies. You may also see new pull requests for version updates. For more information, see "[Listing dependencies configured for version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/listing-dependencies-configured-for-version-updates)."
|
||||
|
||||
@@ -140,4 +141,4 @@ updates:
|
||||
|
||||
## More examples
|
||||
|
||||
For more examples, see "[Configuration options for dependency updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates)."
|
||||
For more examples, see "[Configuration options for the dependabot.yml file](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates)."
|
||||
@@ -0,0 +1,26 @@
|
||||
---
|
||||
title: Keeping your dependencies updated automatically with Dependabot version updates
|
||||
intro: 'You can use {% data variables.product.prodname_dependabot %} to automatically keep the dependencies and packages used in your repository updated to the latest version, even when they don’t have any known vulnerabilities.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
redirect_from:
|
||||
- /github/administering-a-repository/keeping-your-dependencies-updated-automatically
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '>3.2'
|
||||
topics:
|
||||
- Repositories
|
||||
- Dependabot
|
||||
- Version updates
|
||||
- Dependencies
|
||||
- Pull requests
|
||||
children:
|
||||
- /about-dependabot-version-updates
|
||||
- /configuring-dependabot-version-updates
|
||||
- /listing-dependencies-configured-for-version-updates
|
||||
- /customizing-dependency-updates
|
||||
- /configuration-options-for-the-dependabot.yml-file
|
||||
shortTitle: Dependabot version updates
|
||||
---
|
||||
|
||||
@@ -4,6 +4,7 @@ intro: 'You can view the dependencies that {% data variables.product.prodname_de
|
||||
redirect_from:
|
||||
- /github/administering-a-repository/listing-dependencies-configured-for-version-updates
|
||||
- /code-security/supply-chain-security/listing-dependencies-configured-for-version-updates
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/listing-dependencies-configured-for-version-updates
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
@@ -22,7 +23,7 @@ shortTitle: List configured dependencies
|
||||
|
||||
## Viewing dependencies monitored by {% data variables.product.prodname_dependabot %}
|
||||
|
||||
After you've enabled version updates, you can confirm that your configuration is correct using the **{% data variables.product.prodname_dependabot %}** tab in the dependency graph for the repository. For more information, see "[Enabling and disabling {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates)."
|
||||
After you've enabled version updates, you can confirm that your configuration is correct using the **{% data variables.product.prodname_dependabot %}** tab in the dependency graph for the repository. For more information, see "[Configuring {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates)."
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.accessing-repository-graphs %}
|
||||
23
content/code-security/dependabot/index.md
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
title: Keeping your supply chain secure with Dependabot
|
||||
shortTitle: Dependabot
|
||||
intro: 'Monitor vulnerabilities in dependencies used in your project{% ifversion fpt or ghec or ghes > 3.2 %} and keep your dependencies up-to-date{% endif %} with {% data variables.product.prodname_dependabot %}.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: issue-4864
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Dependabot
|
||||
- Alerts
|
||||
- Vulnerabilities
|
||||
- Repositories
|
||||
- Dependencies
|
||||
children:
|
||||
- /dependabot-alerts
|
||||
- /dependabot-security-updates
|
||||
- /dependabot-version-updates
|
||||
- /working-with-dependabot
|
||||
---
|
||||
|
||||
@@ -17,6 +17,8 @@ topics:
|
||||
- Dependencies
|
||||
- Pull requests
|
||||
shortTitle: Use Dependabot with Actions
|
||||
redirect_from:
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions
|
||||
---
|
||||
|
||||
{% data reusables.dependabot.beta-security-and-version-updates %}
|
||||
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title: Working with Dependabot
|
||||
shortTitle: Work with Dependabot
|
||||
intro: 'Guidance and recommendations for working with {% data variables.product.prodname_dependabot %}, such as managing pull requests raised by {% data variables.product.prodname_dependabot %}, using {% data variables.product.prodname_actions %} with {% data variables.product.prodname_dependabot %}, and troubleshooting {% data variables.product.prodname_dependabot %} errors.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '>3.2'
|
||||
topics:
|
||||
- Repositories
|
||||
- Dependabot
|
||||
- Version updates
|
||||
- Security updates
|
||||
- Dependencies
|
||||
- Pull requests
|
||||
children:
|
||||
- /managing-pull-requests-for-dependency-updates
|
||||
- /automating-dependabot-with-github-actions
|
||||
- /keeping-your-actions-up-to-date-with-dependabot
|
||||
- /managing-encrypted-secrets-for-dependabot
|
||||
- /troubleshooting-the-detection-of-vulnerable-dependencies
|
||||
- /troubleshooting-dependabot-errors
|
||||
---
|
||||
|
||||
@@ -5,6 +5,7 @@ redirect_from:
|
||||
- /github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot
|
||||
- /github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot
|
||||
- /code-security/supply-chain-security/keeping-your-actions-up-to-date-with-dependabot
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
@@ -36,7 +37,7 @@ Actions are often updated with bug fixes and new features to make automated proc
|
||||
1. Set a `schedule.interval` to specify how often to check for new versions.
|
||||
{% data reusables.dependabot.check-in-dependabot-yml %} If you have edited an existing file, save your changes.
|
||||
|
||||
You can also enable {% data variables.product.prodname_dependabot_version_updates %} on forks. For more information, see "[Enabling and disabling {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates#enabling-version-updates-on-forks)."
|
||||
You can also enable {% data variables.product.prodname_dependabot_version_updates %} on forks. For more information, see "[Configuring {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates#enabling-version-updates-on-forks)."
|
||||
|
||||
### Example *dependabot.yml* file for {% data variables.product.prodname_actions %}
|
||||
|
||||
@@ -57,7 +58,7 @@ updates:
|
||||
|
||||
## Configuring {% data variables.product.prodname_dependabot_version_updates %} for actions
|
||||
|
||||
When enabling {% data variables.product.prodname_dependabot_version_updates %} for actions, you must specify values for `package-ecosystem`, `directory`, and `schedule.interval`. There are many more optional properties that you can set to further customize your version updates. For more information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates)."
|
||||
When enabling {% data variables.product.prodname_dependabot_version_updates %} for actions, you must specify values for `package-ecosystem`, `directory`, and `schedule.interval`. There are many more optional properties that you can set to further customize your version updates. For more information, see "[Configuration options for the dependabot.yml file](/github/administering-a-repository/configuration-options-for-dependency-updates)."
|
||||
|
||||
## Further reading
|
||||
|
||||
@@ -4,6 +4,7 @@ intro: 'You can store sensitive information, like passwords and access tokens, a
|
||||
redirect_from:
|
||||
- /github/administering-a-repository/managing-encrypted-secrets-for-dependabot
|
||||
- /code-security/supply-chain-security/managing-encrypted-secrets-for-dependabot
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
@@ -33,7 +34,7 @@ password: ${{secrets.MY_ARTIFACTORY_PASSWORD}}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
For more information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates#configuration-options-for-private-registries)."
|
||||
For more information, see "[Configuration options for the dependabot.yml file](/github/administering-a-repository/configuration-options-for-dependency-updates#configuration-options-for-private-registries)."
|
||||
|
||||
### Naming your secrets
|
||||
|
||||
@@ -4,6 +4,7 @@ intro: 'You manage pull requests raised by {% data variables.product.prodname_de
|
||||
redirect_from:
|
||||
- /github/administering-a-repository/managing-pull-requests-for-dependency-updates
|
||||
- /code-security/supply-chain-security/managing-pull-requests-for-dependency-updates
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
@@ -41,7 +42,7 @@ If you have many dependencies to manage, you may want to customize the configura
|
||||
|
||||
## Changing the rebase strategy for {% data variables.product.prodname_dependabot %} pull requests
|
||||
|
||||
By default, {% data variables.product.prodname_dependabot %} automatically rebases pull requests to resolve any conflicts. If you'd prefer to handle merge conflicts manually, you can disable this using the `rebase-strategy` option. For details, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates#rebase-strategy)."
|
||||
By default, {% data variables.product.prodname_dependabot %} automatically rebases pull requests to resolve any conflicts. If you'd prefer to handle merge conflicts manually, you can disable this using the `rebase-strategy` option. For details, see "[Configuration options for the dependabot.yml file](/github/administering-a-repository/configuration-options-for-dependency-updates#rebase-strategy)."
|
||||
|
||||
## Managing {% data variables.product.prodname_dependabot %} pull requests with comment commands
|
||||
|
||||
@@ -62,4 +63,4 @@ You can use any of the following commands on a {% data variables.product.prodnam
|
||||
|
||||
{% data variables.product.prodname_dependabot %} will react with a "thumbs up" emoji to acknowledge the command, and may respond with a comment on the pull request. While {% data variables.product.prodname_dependabot %} usually responds quickly, some commands may take several minutes to complete if {% data variables.product.prodname_dependabot %} is busy processing other updates or commands.
|
||||
|
||||
If you run any of the commands for ignoring dependencies or versions, {% data variables.product.prodname_dependabot %} stores the preferences for the repository centrally. While this is a quick solution, for repositories with more than one contributor it is better to explicitly define the dependencies and versions to ignore in the configuration file. This makes it easy for all contributors to see why a particular dependency isn't being updated automatically. For more information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates#ignore)."
|
||||
If you run any of the commands for ignoring dependencies or versions, {% data variables.product.prodname_dependabot %} stores the preferences for the repository centrally. While this is a quick solution, for repositories with more than one contributor it is better to explicitly define the dependencies and versions to ignore in the configuration file. This makes it easy for all contributors to see why a particular dependency isn't being updated automatically. For more information, see "[Configuration options for the dependabot.yml file](/github/administering-a-repository/configuration-options-for-dependency-updates#ignore)."
|
||||
@@ -6,6 +6,7 @@ redirect_from:
|
||||
- /github/managing-security-vulnerabilities/troubleshooting-github-dependabot-errors
|
||||
- /github/managing-security-vulnerabilities/troubleshooting-dependabot-errors
|
||||
- /code-security/supply-chain-security/troubleshooting-dependabot-errors
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-dependabot-errors
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
@@ -76,7 +77,7 @@ Pull requests for security updates act to upgrade a vulnerable dependency to the
|
||||
|
||||
Every application that has dependencies has a dependency graph, that is, a directed acyclic graph of every package version that the application directly or indirectly depends on. Every time a dependency is updated, this graph must resolve otherwise the application won't build. When an ecosystem has a deep and complex dependency graph, for example, npm and RubyGems, it is often impossible to upgrade a single dependency without upgrading the whole ecosystem.
|
||||
|
||||
The best way to avoid this problem is to stay up to date with the most recently released versions, for example, by enabling version updates. This increases the likelihood that a vulnerability in one dependency can be resolved by a simple upgrade that doesn't break the dependency graph. For more information, see "[Enabling and disabling {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates)."
|
||||
The best way to avoid this problem is to stay up to date with the most recently released versions, for example, by enabling version updates. This increases the likelihood that a vulnerability in one dependency can be resolved by a simple upgrade that doesn't break the dependency graph. For more information, see "[Configuring {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates)."
|
||||
|
||||
### {% data variables.product.prodname_dependabot %} cannot update to the required version as there is already an open pull request for the latest version
|
||||
|
||||
@@ -90,13 +91,13 @@ There are two options: you can review the open pull request and merge it as soon
|
||||
|
||||
This error is difficult to address. If a version update times out, you could specify the most important dependencies to update using the `allow` parameter or, alternatively, use the `ignore` parameter to exclude some dependencies from updates. Updating your configuration might allow {% data variables.product.prodname_dependabot %} to review the version update and generate the pull request in the time available.
|
||||
|
||||
If a security update times out, you can reduce the chances of this happening by keeping the dependencies updated, for example, by enabling version updates. For more information, see "[Enabling and disabling {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates)."
|
||||
If a security update times out, you can reduce the chances of this happening by keeping the dependencies updated, for example, by enabling version updates. For more information, see "[Configuring {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates)."
|
||||
|
||||
### {% data variables.product.prodname_dependabot %} cannot open any more pull requests
|
||||
|
||||
There's a limit on the number of open pull requests {% data variables.product.prodname_dependabot %} will generate. When this limit is reached, no new pull requests are opened and this error is reported. The best way to resolve this error is to review and merge some of the open pull requests.
|
||||
|
||||
There are separate limits for security and version update pull requests, so that open version update pull requests cannot block the creation of a security update pull request. The limit for security update pull requests is 10. By default, the limit for version updates is 5 but you can change this using the `open-pull-requests-limit` parameter in the configuration file. For more information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates#open-pull-requests-limit)."
|
||||
There are separate limits for security and version update pull requests, so that open version update pull requests cannot block the creation of a security update pull request. The limit for security update pull requests is 10. By default, the limit for version updates is 5 but you can change this using the `open-pull-requests-limit` parameter in the configuration file. For more information, see "[Configuration options for the dependabot.yml file](/github/administering-a-repository/configuration-options-for-dependency-updates#open-pull-requests-limit)."
|
||||
|
||||
The best way to resolve this error is to merge or close some of the existing pull requests and trigger a new pull request manually. For more information, see "[Triggering a {% data variables.product.prodname_dependabot %} pull request manually](#triggering-a-dependabot-pull-request-manually)."
|
||||
|
||||
@@ -125,3 +126,8 @@ If you unblock {% data variables.product.prodname_dependabot %}, you can manuall
|
||||
|
||||
- **Security updates**—display the {% data variables.product.prodname_dependabot %} alert that shows the error you have fixed and click **Create {% data variables.product.prodname_dependabot %} security update**.
|
||||
- **Version updates**—on the **Insights** tab for the repository click **Dependency graph**, and then click the **Dependabot** tab. Click **Last checked *TIME* ago** to see the log file that {% data variables.product.prodname_dependabot %} generated during the last check for version updates. Click **Check for updates**.
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[Troubleshooting the dependency graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/troubleshooting-the-dependency-graph)"
|
||||
- "[Troubleshooting the detection of vulnerable dependencies](/code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies)"
|
||||
@@ -1,10 +1,11 @@
|
||||
---
|
||||
title: Troubleshooting the detection of vulnerable dependencies
|
||||
intro: 'If the dependency information reported by {% data variables.product.product_name %} is not what you expected, there are a number of points to consider, and various things you can check.'
|
||||
shortTitle: Troubleshoot detection
|
||||
shortTitle: Troubleshoot vulnerability detection
|
||||
redirect_from:
|
||||
- /github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies
|
||||
- /code-security/supply-chain-security/troubleshooting-the-detection-of-vulnerable-dependencies
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -19,26 +20,31 @@ topics:
|
||||
- Security updates
|
||||
- Dependencies
|
||||
- Vulnerabilities
|
||||
- Dependency graph
|
||||
- Alerts
|
||||
- CVEs
|
||||
- Repositories
|
||||
---
|
||||
|
||||
{% data reusables.dependabot.beta-security-and-version-updates %}
|
||||
|
||||
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.
|
||||
{% data reusables.dependabot.result-discrepancy %}
|
||||
|
||||
## Why do some dependencies seem to be missing?
|
||||
|
||||
{% data variables.product.prodname_dotcom %} generates and displays dependency data differently than other tools. Consequently, if you've been using another tool to identify dependencies you will almost certainly see different results. Consider the following:
|
||||
|
||||
* {% data variables.product.prodname_advisory_database %} is one of the data sources that {% data variables.product.prodname_dotcom %} uses to identify vulnerable dependencies. It's a free, curated database of vulnerability information for common package ecosystems on {% data variables.product.prodname_dotcom %}. It includes both data reported directly to {% data variables.product.prodname_dotcom %} from {% data variables.product.prodname_security_advisories %}, as well as official feeds and community sources. This data is reviewed and curated by {% data variables.product.prodname_dotcom %} to ensure that false or unactionable information is not shared with the development community. {% data reusables.security-advisory.link-browsing-advisory-db %}
|
||||
* The dependency graph parses all known package manifest files in a user’s repository. For example, for npm it will parse the _package-lock.json_ file. It constructs a graph of all of the repository’s dependencies and public dependents. This happens when you enable the dependency graph and when anyone pushes to the default branch, and it includes commits that makes changes to a supported manifest format. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."
|
||||
* {% data variables.product.prodname_dependabot %} scans any push, to the default branch, that contains a manifest file. When a new vulnerability record is added, it scans all existing repositories and generates an alert for each vulnerable repository. {% data variables.product.prodname_dependabot_alerts %} are aggregated at the repository level, rather than creating one alert per vulnerability. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)."
|
||||
* The dependency graph parses all known package manifest files in a user’s repository. For example, for npm it will parse the _package-lock.json_ file. It constructs a graph of all of the repository’s dependencies and public dependents. This happens when you enable the dependency graph and when anyone pushes to the default branch, and it includes commits that makes changes to a supported manifest format. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)" and "[Troubleshooting the dependency graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/troubleshooting-the-dependency-graph)."
|
||||
* {% data variables.product.prodname_dependabot %} scans any push, to the default branch, that contains a manifest file. When a new vulnerability record is added, it scans all existing repositories and generates an alert for each vulnerable repository. {% data variables.product.prodname_dependabot_alerts %} are aggregated at the repository level, rather than creating one alert per vulnerability. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)."
|
||||
* {% ifversion fpt or ghec or ghes > 3.2 %}{% data variables.product.prodname_dependabot_security_updates %} are triggered when you receive an alert about a vulnerable dependency in your repository. Where possible, {% data variables.product.prodname_dependabot %} creates a pull request in your repository to upgrade the vulnerable dependency to the minimum possible secure version needed to avoid the vulnerability. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)" and "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)."
|
||||
|
||||
{% endif %}{% data variables.product.prodname_dependabot %} doesn't scan repositories for vulnerable dependencies on a schedule, but rather when something changes. For example, a scan is triggered when a new dependency is added ({% data variables.product.prodname_dotcom %} checks for this on every push), or when a new vulnerability is added to the advisory database{% ifversion ghes or ghae-issue-4864 %} and synchronized to {% data variables.product.product_location %}{% endif %}. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#detection-of-vulnerable-dependencies)."
|
||||
{% endif %}{% data variables.product.prodname_dependabot %} doesn't scan repositories for vulnerable dependencies on a schedule, but rather when something changes. For example, a scan is triggered when a new dependency is added ({% data variables.product.prodname_dotcom %} checks for this on every push), or when a new vulnerability is added to the advisory database{% ifversion ghes or ghae-issue-4864 %} and synchronized to {% data variables.product.product_location %}{% endif %}. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#detection-of-vulnerable-dependencies)."
|
||||
|
||||
## Do {% data variables.product.prodname_dependabot_alerts %} only relate to vulnerable dependencies in manifests and lockfiles?
|
||||
|
||||
{% data variables.product.prodname_dependabot_alerts %} advise you about dependencies you should update, including transitive dependencies, where the version can be determined from a manifest or a lockfile. {% ifversion fpt or ghec or ghes > 3.2 %}{% data variables.product.prodname_dependabot_security_updates %} only suggest a change where {% data variables.product.prodname_dependabot %} can directly "fix" the dependency, that is, when these are:
|
||||
* Direct dependencies explicitly declared in a manifest or lockfile
|
||||
* Transitive dependencies declared in a lockfile{% endif %}
|
||||
|
||||
**Check**: Is the uncaught vulnerability for a component that's not specified in the repository's manifest or lockfile?
|
||||
|
||||
## Why don't I get vulnerability alerts for some ecosystems?
|
||||
|
||||
@@ -48,44 +54,6 @@ It's worth noting that {% data variables.product.prodname_dotcom %} Security Adv
|
||||
|
||||
**Check**: Does the uncaught vulnerability apply to an unsupported ecosystem?
|
||||
|
||||
## Does the dependency graph only find dependencies in manifests and lockfiles?
|
||||
|
||||
The dependency graph includes information on dependencies that are explicitly declared in your environment. That is, dependencies that are specified in a manifest or a lockfile. The dependency graph generally also includes transitive dependencies, even when they aren't specified in a lockfile, by looking at the dependencies of the dependencies in a manifest file.
|
||||
|
||||
{% data variables.product.prodname_dependabot_alerts %} advise you about dependencies you should update, including transitive dependencies, where the version can be determined from a manifest or a lockfile. {% ifversion fpt or ghec or ghes > 3.2 %}{% data variables.product.prodname_dependabot_security_updates %} only suggest a change where {% data variables.product.prodname_dependabot %} can directly "fix" the dependency, that is, when these are:
|
||||
* Direct dependencies explicitly declared in a manifest or lockfile
|
||||
* Transitive dependencies declared in a lockfile{% endif %}
|
||||
|
||||
The dependency graph doesn't include "loose" dependencies. "Loose" dependencies are individual files that are copied from another source and checked into the repository directly or within an archive (such as a ZIP or JAR file), rather than being referenced by in a package manager’s manifest or lockfile.
|
||||
|
||||
**Check**: Is the uncaught vulnerability for a component that's not specified in the repository's manifest or lockfile?
|
||||
|
||||
## Does the dependency graph detect dependencies specified using variables?
|
||||
|
||||
The dependency graph analyzes manifests as they’re pushed to {% data variables.product.prodname_dotcom %}. The dependency graph doesn't, therefore, have access to the build environment of the project, so it can't resolve variables used within manifests. If you use variables within a manifest to specify the name, or more commonly the version of a dependency, then that dependency will not be included in the dependency graph.
|
||||
|
||||
**Check**: Is the missing dependency declared in the manifest by using a variable for its name or version?
|
||||
|
||||
## Are there limits which affect the dependency graph data?
|
||||
|
||||
Yes, the dependency graph has two categories of limits:
|
||||
|
||||
1. **Processing limits**
|
||||
|
||||
These affect the dependency graph displayed within {% data variables.product.prodname_dotcom %} and also prevent {% data variables.product.prodname_dependabot_alerts %} being created.
|
||||
|
||||
Manifests over 0.5 MB in size are only processed for enterprise accounts. For other accounts, manifests over 0.5 MB are ignored and will not create {% data variables.product.prodname_dependabot_alerts %}.
|
||||
|
||||
By default, {% data variables.product.prodname_dotcom %} will not process more than 20 manifests per repository. {% data variables.product.prodname_dependabot_alerts %} are not created for manifests beyond this limit. If you need to increase the limit, contact {% data variables.contact.contact_support %}.
|
||||
|
||||
2. **Visualization limits**
|
||||
|
||||
These affect what's displayed in the dependency graph within {% data variables.product.prodname_dotcom %}. However, they don't affect the {% data variables.product.prodname_dependabot_alerts %} that are created.
|
||||
|
||||
The Dependencies view of the dependency graph for a repository only displays 100 manifests. Typically this is adequate as it is significantly higher than the processing limit described above. In situations where the processing limit is over 100, {% data variables.product.prodname_dependabot_alerts %} are still created for any manifests that are not shown within {% data variables.product.prodname_dotcom %}.
|
||||
|
||||
**Check**: Is the missing dependency in a manifest file that's over 0.5 MB, or in a repository with a large number of manifests?
|
||||
|
||||
## Does {% data variables.product.prodname_dependabot %} generate alerts for vulnerabilities that have been known for many years?
|
||||
|
||||
The {% data variables.product.prodname_advisory_database %} was launched in November 2019, and initially back-filled to include vulnerability information for the supported ecosystems, starting from 2017. When adding CVEs to the database, we prioritize curating newer CVEs, and CVEs affecting newer versions of software.
|
||||
@@ -118,7 +86,8 @@ The {% data variables.product.prodname_dependabot_alerts %} count in {% data var
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)"
|
||||
- "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)"
|
||||
- "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)"{% ifversion fpt or ghec or ghes > 3.2 %}
|
||||
- "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)"
|
||||
- "[Viewing {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)"
|
||||
- "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)"
|
||||
- "[Troubleshooting the dependency graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/troubleshooting-the-dependency-graph)"{% ifversion fpt or ghec or ghes > 3.2 %}
|
||||
- "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)"{% endif %}
|
||||
@@ -37,7 +37,7 @@ Privately discuss and fix security vulnerabilities in your repository's code. Yo
|
||||
|
||||
### {% data variables.product.prodname_dependabot_alerts %} and security updates
|
||||
|
||||
View alerts about dependencies that are known to contain security vulnerabilities, and choose whether to have pull requests generated automatically to update these dependencies. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)"
|
||||
View alerts about dependencies that are known to contain security vulnerabilities, and choose whether to have pull requests generated automatically to update these dependencies. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)"
|
||||
and "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)."
|
||||
{% endif %}
|
||||
|
||||
@@ -46,7 +46,7 @@ and "[About {% data variables.product.prodname_dependabot_security_updates %}](/
|
||||
|
||||
{% data reusables.dependabot.dependabot-alerts-beta %}
|
||||
|
||||
View alerts about dependencies that are known to contain security vulnerabilities, and manage these alerts. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
|
||||
View alerts about dependencies that are known to contain security vulnerabilities, and manage these alerts. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.2 %}
|
||||
|
||||
@@ -48,7 +48,7 @@ You can create a default security policy that will display in any of your organi
|
||||
{% data reusables.dependabot.dependabot-alerts-beta %}
|
||||
{% data reusables.dependabot.dependabot-alerts-dependency-graph-enterprise %}
|
||||
|
||||
For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)," "[Exploring the dependencies of a repository](/code-security/supply-chain-security/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)," and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)."
|
||||
For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)," "[Exploring the dependencies of a repository](/code-security/supply-chain-security/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)," and "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)."
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghes > 3.1 or ghae-issue-4864 or ghec %}
|
||||
@@ -79,7 +79,7 @@ For more information, see "[About {% data variables.product.prodname_dependabot_
|
||||
|
||||
You can enable {% data variables.product.prodname_dependabot %} to automatically raise pull requests to keep your dependencies up-to-date. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/code-security/supply-chain-security/about-dependabot-version-updates)."
|
||||
|
||||
To enable {% data variables.product.prodname_dependabot_version_updates %}, you must create a *dependabot.yml* configuration file. For more information, see "[Enabling and disabling {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates)."
|
||||
To enable {% data variables.product.prodname_dependabot_version_updates %}, you must create a *dependabot.yml* configuration file. For more information, see "[Configuring {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -135,7 +135,7 @@ For more information, see "[Managing security and analysis settings for your org
|
||||
## Next steps
|
||||
{% ifversion fpt or ghes > 3.1 or ghec %}You can view, filter, and sort security alerts for repositories owned by your organization in the security overview. For more information, see "[About the security overview](/code-security/security-overview/about-the-security-overview)."{% endif %}
|
||||
|
||||
You can view and manage alerts from security features to address dependencies and vulnerabilities in your code. For more information, see {% ifversion fpt or ghes or ghec %} "[Viewing and updating vulnerable dependencies in your repository](/code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository),"{% endif %} {% ifversion fpt or ghec or ghes > 3.2 %}"[Managing pull requests for dependency updates](/code-security/supply-chain-security/managing-pull-requests-for-dependency-updates)," {% endif %}"[Managing {% data variables.product.prodname_code_scanning %} for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)," and "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)."
|
||||
You can view and manage alerts from security features to address dependencies and vulnerabilities in your code. For more information, see {% ifversion fpt or ghes or ghec %} "[Viewing {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository),"{% endif %} {% ifversion fpt or ghec or ghes > 3.2 %}"[Managing pull requests for dependency updates](/code-security/supply-chain-security/managing-pull-requests-for-dependency-updates)," {% endif %}"[Managing {% data variables.product.prodname_code_scanning %} for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)," and "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)."
|
||||
|
||||
{% ifversion fpt or ghec %}If you have a security vulnerability, you can create a security advisory to privately discuss and fix the vulnerability. For more information, see "[About {% data variables.product.prodname_security_advisories %}](/code-security/security-advisories/about-github-security-advisories)" and "[Creating a security advisory](/code-security/security-advisories/creating-a-security-advisory)."
|
||||
{% endif %}
|
||||
|
||||
@@ -75,7 +75,7 @@ For more information, see "[Exploring the dependencies of a repository](/code-se
|
||||
{% data reusables.dependabot.dependabot-alerts-beta %}
|
||||
{% data reusables.dependabot.dependabot-alerts-dependency-graph-enterprise %}
|
||||
|
||||
For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies){% ifversion fpt or ghec %}" and "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account){% endif %}."
|
||||
For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies){% ifversion fpt or ghec %}" and "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account){% endif %}."
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -111,7 +111,7 @@ For more information, see "[About {% data variables.product.prodname_dependabot_
|
||||
|
||||
You can enable {% data variables.product.prodname_dependabot %} to automatically raise pull requests to keep your dependencies up-to-date. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/code-security/supply-chain-security/about-dependabot-version-updates)."
|
||||
|
||||
To enable {% data variables.product.prodname_dependabot_version_updates %}, you must create a *dependabot.yml* configuration file. For more information, see "[Enabling and disabling {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates)."
|
||||
To enable {% data variables.product.prodname_dependabot_version_updates %}, you must create a *dependabot.yml* configuration file. For more information, see "[Configuring {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -132,7 +132,7 @@ You can set up {% data variables.product.prodname_code_scanning %} to automatica
|
||||
{% endif %}
|
||||
|
||||
## Next steps
|
||||
You can view and manage alerts from security features to address dependencies and vulnerabilities in your code. For more information, see {% ifversion fpt or ghes or ghec %} "[Viewing and updating vulnerable dependencies in your repository](/code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository),"{% endif %} {% ifversion fpt or ghec or ghes > 3.2 %}"[Managing pull requests for dependency updates](/code-security/supply-chain-security/managing-pull-requests-for-dependency-updates)," {% endif %}"[Managing {% data variables.product.prodname_code_scanning %} for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)," and "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)."
|
||||
You can view and manage alerts from security features to address dependencies and vulnerabilities in your code. For more information, see {% ifversion fpt or ghes or ghec %} "[Viewing {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository),"{% endif %} {% ifversion fpt or ghec or ghes > 3.2 %}"[Managing pull requests for dependency updates](/code-security/supply-chain-security/managing-pull-requests-for-dependency-updates)," {% endif %}"[Managing {% data variables.product.prodname_code_scanning %} for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)," and "[Managing alerts from {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/managing-alerts-from-secret-scanning)."
|
||||
|
||||
{% ifversion fpt or ghec %}If you have a security vulnerability, you can create a security advisory to privately discuss and fix the vulnerability. For more information, see "[About {% data variables.product.prodname_security_advisories %}](/code-security/security-advisories/about-github-security-advisories)" and "[Creating a security advisory](/code-security/security-advisories/creating-a-security-advisory)."
|
||||
{% endif %}
|
||||
|
||||
@@ -75,7 +75,6 @@ includeGuides:
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-managing-vulnerable-dependencies
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/editing-security-advisories-in-the-github-advisory-database
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates
|
||||
|
||||
@@ -54,6 +54,7 @@ children:
|
||||
- /code-scanning
|
||||
- /repository-security-advisories
|
||||
- /supply-chain-security
|
||||
- /dependabot
|
||||
- /security-overview
|
||||
- /guides
|
||||
---
|
||||
|
||||
@@ -28,7 +28,7 @@ shortTitle: About security overview
|
||||
|
||||
You can use the security overview for a high-level view of the security status of your organization or to identify problematic repositories that require intervention. You can view aggregate or repository-specific security information in the security overview. You can also use the security overview to see which security features are enabled for your repositories and to configure any available security features that are not currently in use.
|
||||
|
||||
The security overview indicates whether {% ifversion fpt or ghes > 3.1 or ghec %}security{% endif %}{% ifversion ghae %}{% data variables.product.prodname_GH_advanced_security %}{% endif %} features are enabled for repositories owned by your organization and consolidates alerts for each feature.{% ifversion fpt or ghes > 3.1 or ghec %} Security features include {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}, as well as {% data variables.product.prodname_dependabot_alerts %}.{% endif %} For more information about {% data variables.product.prodname_GH_advanced_security %} features, see "[About {% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security)."{% ifversion fpt or ghes > 3.1 or ghec %} For more information about {% data variables.product.prodname_dependabot_alerts %}, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)."{% endif %}
|
||||
The security overview indicates whether {% ifversion fpt or ghes > 3.1 or ghec %}security{% endif %}{% ifversion ghae %}{% data variables.product.prodname_GH_advanced_security %}{% endif %} features are enabled for repositories owned by your organization and consolidates alerts for each feature.{% ifversion fpt or ghes > 3.1 or ghec %} Security features include {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}, as well as {% data variables.product.prodname_dependabot_alerts %}.{% endif %} For more information about {% data variables.product.prodname_GH_advanced_security %} features, see "[About {% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security)."{% ifversion fpt or ghes > 3.1 or ghec %} For more information about {% data variables.product.prodname_dependabot_alerts %}, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)."{% endif %}
|
||||
|
||||
For more information about securing your code at the repository and organization levels, see "[Securing your repository](/code-security/getting-started/securing-your-repository)" and "[Securing your organization](/code-security/getting-started/securing-your-organization)."
|
||||
|
||||
@@ -54,7 +54,7 @@ For each repository in the security overview, you will see icons for each type o
|
||||
| -------- | -------- |
|
||||
| {% octicon "code-square" aria-label="Code scanning alerts" %} | {% data variables.product.prodname_code_scanning_capc %} alerts. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning)." |
|
||||
| {% octicon "key" aria-label="Secret scanning alerts" %} | {% data variables.product.prodname_secret_scanning_caps %} alerts. For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)." |
|
||||
| {% octicon "hubot" aria-label="Dependabot alerts" %} | {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." |
|
||||
| {% octicon "hubot" aria-label="Dependabot alerts" %} | {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." |
|
||||
| {% octicon "check" aria-label="Check" %} | The security feature is enabled, but does not raise alerts in this repository. |
|
||||
| {% octicon "x" aria-label="x" %} | The security feature is not supported in this repository. |
|
||||
|
||||
|
||||
@@ -16,8 +16,6 @@ topics:
|
||||
- Repositories
|
||||
children:
|
||||
- /understanding-your-software-supply-chain
|
||||
- /keeping-your-dependencies-updated-automatically
|
||||
- /managing-vulnerabilities-in-your-projects-dependencies
|
||||
- /end-to-end-supply-chain
|
||||
---
|
||||
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
---
|
||||
title: Keeping your dependencies updated automatically
|
||||
intro: '{% data variables.product.prodname_dependabot %} can maintain your repository''s dependencies automatically.'
|
||||
redirect_from:
|
||||
- /github/administering-a-repository/keeping-your-dependencies-updated-automatically
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '>3.2'
|
||||
topics:
|
||||
- Repositories
|
||||
- Dependabot
|
||||
- Version updates
|
||||
- Dependencies
|
||||
- Pull requests
|
||||
children:
|
||||
- /about-dependabot-version-updates
|
||||
- /enabling-and-disabling-dependabot-version-updates
|
||||
- /listing-dependencies-configured-for-version-updates
|
||||
- /managing-pull-requests-for-dependency-updates
|
||||
- /automating-dependabot-with-github-actions
|
||||
- /managing-encrypted-secrets-for-dependabot
|
||||
- /customizing-dependency-updates
|
||||
- /configuration-options-for-dependency-updates
|
||||
- /keeping-your-actions-up-to-date-with-dependabot
|
||||
shortTitle: Auto-update dependencies
|
||||
---
|
||||
|
||||
{% data reusables.dependabot.beta-security-and-version-updates %}
|
||||
@@ -1,46 +0,0 @@
|
||||
---
|
||||
title: About managing vulnerable dependencies
|
||||
intro: '{% data variables.product.product_name %} helps you to avoid using third-party software that contains known vulnerabilities.'
|
||||
redirect_from:
|
||||
- /github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies
|
||||
- /code-security/supply-chain-security/about-managing-vulnerable-dependencies
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '>=3.2'
|
||||
ghae: issue-4864
|
||||
ghec: '*'
|
||||
type: overview
|
||||
topics:
|
||||
- Dependabot
|
||||
- Dependency graph
|
||||
- Dependency review
|
||||
- Vulnerabilities
|
||||
- Repositories
|
||||
- Dependencies
|
||||
- Pull requests
|
||||
shortTitle: Vulnerable dependencies
|
||||
---
|
||||
<!--Marketing-LINK: From /features/security/software-supply-chain page "Managing vulnerabilities in your project’s dependencies ".-->
|
||||
|
||||
{% data variables.product.product_name %} provides the following tools for removing and avoiding vulnerable dependencies.
|
||||
|
||||
## Dependency graph
|
||||
The dependency graph is a summary of the manifest and lock files stored in a repository. It shows you the ecosystems and packages your codebase depends on (its dependencies) and the repositories and packages that depend on your project (its dependents). The information in the dependency graph is used by dependency review and {% data variables.product.prodname_dependabot %}.
|
||||
For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."
|
||||
|
||||
## Dependency review
|
||||
|
||||
{% data reusables.dependency-review.beta %}
|
||||
|
||||
By checking the dependency reviews on pull requests you can avoid introducing vulnerabilities from dependencies into your codebase. If the pull requests adds a vulnerable dependency, or changes a dependency to a vulnerable version, this is highlighted in the dependency review. You can change the dependency to a patched version before merging the pull request. For more information, see "[About dependency review](/code-security/supply-chain-security/about-dependency-review)."
|
||||
|
||||
## {% data variables.product.prodname_dependabot_alerts %}
|
||||
{% data variables.product.product_name %} can create {% data variables.product.prodname_dependabot_alerts %} when it detects vulnerable dependencies in your repository. The alert is displayed on the Security tab for the repository. The alert includes a link to the affected file in the project, and information about a fixed version. {% data variables.product.product_name %} also notifies the maintainers of the repository, according to their notification preferences. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)."
|
||||
|
||||
{% ifversion fpt or ghec or ghes > 3.2 %}
|
||||
## {% data variables.product.prodname_dependabot_security_updates %}
|
||||
When {% data variables.product.product_name %} generates a {% data variables.product.prodname_dependabot %} alert for a vulnerable dependency in your repository, {% data variables.product.prodname_dependabot %} can automatically try to fix it for you. {% data variables.product.prodname_dependabot_security_updates %} are automatically generated pull requests that update a vulnerable dependency to a fixed version. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)."
|
||||
|
||||
## {% data variables.product.prodname_dependabot_version_updates %}
|
||||
Enabling {% data variables.product.prodname_dependabot_version_updates %} takes the effort out of maintaining your dependencies. With {% data variables.product.prodname_dependabot_version_updates %}, whenever {% data variables.product.prodname_dotcom %} identifies an outdated dependency, it raises a pull request to update the manifest to the latest version of the dependency. By contrast, {% data variables.product.prodname_dependabot_security_updates %} only raises pull requests to fix vulnerable dependencies. For more information, see "[About Dependabot version updates](/github/administering-a-repository/about-dependabot-version-updates)."
|
||||
{% endif %}
|
||||
@@ -1,36 +0,0 @@
|
||||
---
|
||||
title: Managing vulnerabilities in your project's dependencies
|
||||
intro: 'You can track your repository''s dependencies and receive {% data variables.product.prodname_dependabot_alerts %} when {% data variables.product.product_name %} detects vulnerable dependencies.'
|
||||
redirect_from:
|
||||
- /articles/updating-your-project-s-dependencies
|
||||
- /articles/updating-your-projects-dependencies
|
||||
- /articles/managing-security-vulnerabilities-in-your-projects-dependencies
|
||||
- /articles/managing-vulnerabilities-in-your-projects-dependencies
|
||||
- /github/managing-security-vulnerabilities/managing-vulnerabilities-in-your-projects-dependencies
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: issue-4864
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Repositories
|
||||
- Dependabot
|
||||
- Version updates
|
||||
- Dependencies
|
||||
- Pull requests
|
||||
- Vulnerabilities
|
||||
- Alerts
|
||||
children:
|
||||
- /about-managing-vulnerable-dependencies
|
||||
- /browsing-security-vulnerabilities-in-the-github-advisory-database
|
||||
- /editing-security-advisories-in-the-github-advisory-database
|
||||
- /about-alerts-for-vulnerable-dependencies
|
||||
- /configuring-notifications-for-vulnerable-dependencies
|
||||
- /about-dependabot-security-updates
|
||||
- /configuring-dependabot-security-updates
|
||||
- /viewing-and-updating-vulnerable-dependencies-in-your-repository
|
||||
- /troubleshooting-the-detection-of-vulnerable-dependencies
|
||||
- /troubleshooting-dependabot-errors
|
||||
shortTitle: Fix vulnerable dependencies
|
||||
---
|
||||
|
||||
@@ -41,7 +41,7 @@ Sometimes you might just want to update the version of one dependency in a manif
|
||||
|
||||
By checking the dependency reviews in a pull request, and changing any dependencies that are flagged as vulnerable, you can avoid vulnerabilities being added to your project. For more information about how dependency review works, see "[Reviewing dependency changes in a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request)."
|
||||
|
||||
{% data variables.product.prodname_dependabot_alerts %} will find vulnerabilities that are already in your dependencies, but it's much better to avoid introducing potential problems than to fix problems at a later date. For more information about {% data variables.product.prodname_dependabot_alerts %}, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)."
|
||||
{% data variables.product.prodname_dependabot_alerts %} will find vulnerabilities that are already in your dependencies, but it's much better to avoid introducing potential problems than to fix problems at a later date. For more information about {% data variables.product.prodname_dependabot_alerts %}, see "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)."
|
||||
|
||||
Dependency review supports the same languages and package management ecosystems as the dependency graph. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)."
|
||||
|
||||
@@ -49,4 +49,4 @@ Dependency review supports the same languages and package management ecosystems
|
||||
## Enabling dependency review
|
||||
|
||||
The dependency review feature becomes available when you enable the dependency graph. {% ifversion ghec %}For more information, see "[Enabling the dependency graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph#enabling-the-dependency-graph)."{% endif %}{% ifversion ghes or ghae %}For more information, see "[Enabling the dependency graph for your enterprise](/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise)."{% endif %}
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
||||
@@ -55,7 +55,7 @@ You can use the dependency graph to:
|
||||
|
||||
- Explore the repositories your code depends on{% ifversion fpt or ghec %}, and those that depend on it{% endif %}. For more information, see "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)." {% ifversion fpt or ghec %}
|
||||
- View a summary of the dependencies used in your organization's repositories in a single dashboard. For more information, see "[Viewing insights for your organization](/articles/viewing-insights-for-your-organization#viewing-organization-dependency-insights)."{% endif %}
|
||||
- View and update vulnerable dependencies for your repository. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)."{% ifversion fpt or ghes > 3.1 or ghec %}
|
||||
- View and update vulnerable dependencies for your repository. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)."{% ifversion fpt or ghes > 3.1 or ghec %}
|
||||
- See information about vulnerable dependencies in pull requests. For more information, see "[Reviewing dependency changes in a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request)."{% endif %}
|
||||
|
||||
## Enabling the dependency graph
|
||||
@@ -111,5 +111,5 @@ The recommended formats explicitly define which versions are used for all direct
|
||||
- "[Dependency graph](https://en.wikipedia.org/wiki/Dependency_graph)" on Wikipedia
|
||||
- "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)"{% ifversion fpt or ghec %}
|
||||
- "[Viewing insights for your organization](/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization)"{% endif %}
|
||||
- "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)"
|
||||
- "[Viewing {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)"
|
||||
- "[Troubleshooting the detection of vulnerable dependencies](/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies)"
|
||||
|
||||
@@ -117,7 +117,7 @@ If a manifest or lock file is not processed, its dependencies are omitted from t
|
||||
## Further reading
|
||||
|
||||
- "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)"
|
||||
- "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)"{% ifversion fpt or ghec %}
|
||||
- "[Viewing {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)"{% ifversion fpt or ghec %}
|
||||
- "[Viewing insights for your organization](/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization)"
|
||||
- "[Understanding how {% data variables.product.prodname_dotcom %} uses and protects your data](/get-started/privacy-on-github)"
|
||||
{% endif %}
|
||||
|
||||
@@ -9,10 +9,11 @@ topics:
|
||||
- Dependency graph
|
||||
- Dependencies
|
||||
- Repositories
|
||||
shortTitle: Understand your supply chain
|
||||
children:
|
||||
- /about-the-dependency-graph
|
||||
- /exploring-the-dependencies-of-a-repository
|
||||
- /about-dependency-review
|
||||
shortTitle: Understand your supply chain
|
||||
- /exploring-the-dependencies-of-a-repository
|
||||
- /troubleshooting-the-dependency-graph
|
||||
---
|
||||
|
||||
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
title: Troubleshooting the dependency graph
|
||||
intro: 'If the dependency information reported by the dependency graph is not what you expected, there are a number of points to consider, and various things you can check.'
|
||||
shortTitle: Troubleshoot dependency graph
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: issue-4864
|
||||
ghec: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Troubleshooting
|
||||
- Errors
|
||||
- Dependencies
|
||||
- Vulnerabilities
|
||||
- Dependency graph
|
||||
- CVEs
|
||||
- Repositories
|
||||
---
|
||||
|
||||
{% data reusables.dependabot.result-discrepancy %}
|
||||
|
||||
## Does the dependency graph only find dependencies in manifests and lockfiles?
|
||||
|
||||
The dependency graph includes information on dependencies that are explicitly declared in your environment. That is, dependencies that are specified in a manifest or a lockfile. The dependency graph generally also includes transitive dependencies, even when they aren't specified in a lockfile, by looking at the dependencies of the dependencies in a manifest file.
|
||||
|
||||
The dependency graph doesn't include "loose" dependencies. "Loose" dependencies are individual files that are copied from another source and checked into the repository directly or within an archive (such as a ZIP or JAR file), rather than being referenced by in a package manager’s manifest or lockfile.
|
||||
|
||||
**Check**: Is the missing dependency for a component that's not specified in the repository's manifest or lockfile?
|
||||
|
||||
## Does the dependency graph detect dependencies specified using variables?
|
||||
|
||||
The dependency graph analyzes manifests as they’re pushed to {% data variables.product.prodname_dotcom %}. The dependency graph doesn't, therefore, have access to the build environment of the project, so it can't resolve variables used within manifests. If you use variables within a manifest to specify the name, or more commonly the version of a dependency, then that dependency will not be included in the dependency graph.
|
||||
|
||||
**Check**: Is the missing dependency declared in the manifest by using a variable for its name or version?
|
||||
|
||||
## Are there limits which affect the dependency graph data?
|
||||
|
||||
Yes, the dependency graph has two categories of limits:
|
||||
|
||||
1. **Processing limits**
|
||||
|
||||
These affect the dependency graph displayed within {% data variables.product.prodname_dotcom %} and also prevent {% data variables.product.prodname_dependabot_alerts %} being created.
|
||||
|
||||
Manifests over 0.5 MB in size are only processed for enterprise accounts. For other accounts, manifests over 0.5 MB are ignored and will not create {% data variables.product.prodname_dependabot_alerts %}.
|
||||
|
||||
By default, {% data variables.product.prodname_dotcom %} will not process more than 20 manifests per repository. {% data variables.product.prodname_dependabot_alerts %} are not created for manifests beyond this limit. If you need to increase the limit, contact {% data variables.contact.contact_support %}.
|
||||
|
||||
2. **Visualization limits**
|
||||
|
||||
These affect what's displayed in the dependency graph within {% data variables.product.prodname_dotcom %}. However, they don't affect the {% data variables.product.prodname_dependabot_alerts %} that are created.
|
||||
|
||||
The Dependencies view of the dependency graph for a repository only displays 100 manifests. Typically this is adequate as it is significantly higher than the processing limit described above. In situations where the processing limit is over 100, {% data variables.product.prodname_dependabot_alerts %} are still created for any manifests that are not shown within {% data variables.product.prodname_dotcom %}.
|
||||
|
||||
**Check**: Is the missing dependency in a manifest file that's over 0.5 MB, or in a repository with a large number of manifests?
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[About the dependency graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph)"
|
||||
- "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)"
|
||||
- "[Troubleshooting the detection of vulnerable dependencies](/code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies)"{% ifversion fpt or ghec or ghes > 3.2 %}
|
||||
- "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors)"{% endif %}
|
||||
@@ -89,7 +89,7 @@ Permission | Description
|
||||
[`starring`](/rest/reference/permissions-required-for-github-apps/#permission-on-starring) | Grants access to the [Starring API](/rest/reference/activity#starring). Can be one of: `none`, `read`, or `write`.
|
||||
[`statuses`](/rest/reference/permissions-required-for-github-apps/#permission-on-statuses) | Grants access to the [Statuses API](/rest/reference/commits#commit-statuses). Can be one of: `none`, `read`, or `write`.
|
||||
[`team_discussions`](/rest/reference/permissions-required-for-github-apps/#permission-on-team-discussions) | Grants access to the [Team Discussions API](/rest/reference/teams#discussions) and the [Team Discussion Comments API](/rest/reference/teams#discussion-comments). Can be one of: `none`, `read`, or `write`.{% ifversion fpt or ghes or ghae-issue-4864 or ghec %}
|
||||
`vulnerability_alerts`| Grants access to receive security alerts for vulnerable dependencies in a repository. See "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)" to learn more. Can be one of: `none` or `read`.{% endif %}
|
||||
`vulnerability_alerts`| Grants access to receive {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies in a repository. See "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)" to learn more. Can be one of: `none` or `read`.{% endif %}
|
||||
`watching` | Grants access to list and change repositories a user is subscribed to. Can be one of: `none`, `read`, or `write`.
|
||||
|
||||
## {% data variables.product.prodname_github_app %} webhook events
|
||||
|
||||
@@ -1244,7 +1244,7 @@ Key | Type | Description
|
||||
|
||||
Activity related to a security advisory that has been reviewed by {% data variables.product.company_short %}. A {% data variables.product.company_short %}-reviewed security advisory provides information about security-related vulnerabilities in software on {% data variables.product.prodname_dotcom %}.
|
||||
|
||||
The security advisory dataset also powers the GitHub {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)."
|
||||
The security advisory dataset also powers the GitHub {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)."
|
||||
|
||||
### Availability
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ We'll announce substantial new features that use metadata or aggregate data on t
|
||||
|
||||
## How data improves security recommendations
|
||||
|
||||
As an example of how your data might be used, we can detect and alert you to a security vulnerability in your public repository's dependencies. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
|
||||
As an example of how your data might be used, we can detect and alert you to a security vulnerability in your public repository's dependencies. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
|
||||
|
||||
To detect potential security vulnerabilities, {% data variables.product.product_name %} scans the contents of your dependency manifest file to draw a list of your project's dependencies.
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ shortTitle: Manage data use for private repo
|
||||
|
||||
## About data use for your private repository
|
||||
|
||||
When you enable data use for your private repository, you'll be able to access the dependency graph, where you can track your repository's dependencies and receive {% data variables.product.prodname_dependabot_alerts %} when {% data variables.product.product_name %} detects vulnerable dependencies. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)."
|
||||
When you enable data use for your private repository, you'll be able to access the dependency graph, where you can track your repository's dependencies and receive {% data variables.product.prodname_dependabot_alerts %} when {% data variables.product.product_name %} detects vulnerable dependencies. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)."
|
||||
|
||||
## Enabling or disabling data use features
|
||||
|
||||
@@ -32,5 +32,5 @@ When you enable data use for your private repository, you'll be able to access t
|
||||
## Further reading
|
||||
|
||||
- "[About {% data variables.product.prodname_dotcom %}'s use of your data](/articles/about-github-s-use-of-your-data)"
|
||||
- "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)"
|
||||
- "[Viewing {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)"
|
||||
- "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)"
|
||||
|
||||
@@ -18,7 +18,7 @@ shortTitle: Enterprise Server trial
|
||||
|
||||
You can request a 45-day trial to evaluate {% data variables.product.prodname_ghe_server %}. Your trial will be installed as a virtual appliance, with options for on-premises or cloud deployment. For a list of supported visualization platforms, see "[Setting up a GitHub Enterprise Server instance](/enterprise-server@latest/admin/installation/setting-up-a-github-enterprise-server-instance)."
|
||||
|
||||
{% ifversion ghes %}{% data variables.product.prodname_dependabot %}{% else %}Security{% endif %} alerts and {% data variables.product.prodname_github_connect %} are not currently available in trials of {% data variables.product.prodname_ghe_server %}. For a demonstration of these features, contact {% data variables.contact.contact_enterprise_sales %}. For more information about these features, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)" and "[Connecting your enterprise account to {% data variables.product.prodname_ghe_cloud %}](/enterprise-server@latest/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)."
|
||||
{% ifversion ghes %}{% data variables.product.prodname_dependabot %}{% else %}Security{% endif %} alerts and {% data variables.product.prodname_github_connect %} are not currently available in trials of {% data variables.product.prodname_ghe_server %}. For a demonstration of these features, contact {% data variables.contact.contact_enterprise_sales %}. For more information about these features, see "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)" and "[Connecting your enterprise account to {% data variables.product.prodname_ghe_cloud %}](/enterprise-server@latest/admin/configuration/managing-connections-between-your-enterprise-accounts/connecting-your-enterprise-account-to-github-enterprise-cloud)."
|
||||
|
||||
Trials are also available for {% data variables.product.prodname_ghe_cloud %}. For more information, see "[Setting up a trial of {% data variables.product.prodname_ghe_cloud %}](/articles/setting-up-a-trial-of-github-enterprise-cloud)."
|
||||
|
||||
|
||||
@@ -69,10 +69,9 @@ We use [Linguist](https://github.com/github/linguist) to perform language detect
|
||||
{% if mermaid %}
|
||||
## Creating diagrams
|
||||
|
||||
You can use Mermaid syntax to add diagrams. For more information, see "[Creating diagrams](/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams)."
|
||||
You can also use code blocks to create diagrams in Markdown. GitHub supports Mermaid, geoJSON, topoJSON, and ASCII STL syntax. For more information, see "[Creating diagrams](/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Further reading
|
||||
|
||||
- [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/)
|
||||
|
||||
@@ -6,7 +6,13 @@ versions:
|
||||
shortTitle: Create diagrams
|
||||
---
|
||||
|
||||
You can use Mermaid syntax to create diagrams. Mermaid is a Markdown-inspired tool that renders text into diagrams. For example, Mermaid can render flow charts, sequence diagrams, pie charts and more. For more information, see the [Mermaid documentation](https://mermaid-js.github.io/mermaid/#/).
|
||||
## About creating diagrams
|
||||
|
||||
You can create diagrams in Markdown using three different syntaxes: mermaid, geoJSON and topoJSON, and ASCII STL.
|
||||
|
||||
## Creating Mermaid diagrams
|
||||
|
||||
Mermaid is a Markdown-inspired tool that renders text into diagrams. For example, Mermaid can render flow charts, sequence diagrams, pie charts and more. For more information, see the [Mermaid documentation](https://mermaid-js.github.io/mermaid/#/).
|
||||
|
||||
To create a Mermaid diagram, add Mermaid syntax inside a fenced code block with the `mermaid` language identifier. For more information about creating code blocks, see "[Creating and highlighting code blocks](/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks)."
|
||||
|
||||
@@ -31,3 +37,122 @@ graph TD;
|
||||
**Note:** You may observe errors if you run a third-party Mermaid plugin when using Mermaid syntax on {% data variables.product.company_short %}.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
## Creating geoJSON and topoJSON maps
|
||||
|
||||
You can use geo/topoJSON syntax to create interactive maps. To create a map, add geoJSON or topoJSON inside a fenced code block with the `geojson` or `topojson` syntax identifier. For more information, see "[Creating and highlighting code blocks](/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks)."
|
||||
|
||||
### Using geoJSON
|
||||
|
||||
For example, you can create a simple map:
|
||||
|
||||
<pre>
|
||||
```geojson
|
||||
{
|
||||
"type": "Polygon",
|
||||
"coordinates": [
|
||||
[
|
||||
[-90,30],
|
||||
[-90,35],
|
||||
[-90,35],
|
||||
[-85,35],
|
||||
[-85,30]
|
||||
]
|
||||
]
|
||||
}
|
||||
```
|
||||
</pre>
|
||||
|
||||

|
||||
|
||||
### Using topoJSON
|
||||
|
||||
For example, you can create a simple topoJSON map:
|
||||
|
||||
<pre>
|
||||
```topojson
|
||||
{
|
||||
"type": "Topology",
|
||||
"transform": {
|
||||
"scale": [0.0005000500050005, 0.00010001000100010001],
|
||||
"translate": [100, 0]
|
||||
},
|
||||
"objects": {
|
||||
"example": {
|
||||
"type": "GeometryCollection",
|
||||
"geometries": [
|
||||
{
|
||||
"type": "Point",
|
||||
"properties": {"prop0": "value0"},
|
||||
"coordinates": [4000, 5000]
|
||||
},
|
||||
{
|
||||
"type": "LineString",
|
||||
"properties": {"prop0": "value0", "prop1": 0},
|
||||
"arcs": [0]
|
||||
},
|
||||
{
|
||||
"type": "Polygon",
|
||||
"properties": {"prop0": "value0",
|
||||
"prop1": {"this": "that"}
|
||||
},
|
||||
"arcs": [[1]]
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"arcs": [[[4000, 0], [1999, 9999], [2000, -9999], [2000, 9999]],[[0, 0], [0, 9999], [2000, 0], [0, -9999], [-2000, 0]]]
|
||||
}
|
||||
```
|
||||
</pre>
|
||||
|
||||

|
||||
|
||||
For more information on working with `.geojson` and `.topojson` files, see "[Working with non-code files](/repositories/working-with-files/using-files/working-with-non-code-files#mapping-geojson-files-on-github)."
|
||||
|
||||
|
||||
## Creating STL 3D models
|
||||
|
||||
You can use ASCII STL syntax directly in markdown to create interactive 3D models. To display a model, add ASCII STL syntax inside a fenced code block with the `stl` syntax identifier. For more information, see "[Creating and highlighting code blocks](/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks)."
|
||||
|
||||
For example, you can create a simple 3D model:
|
||||
|
||||
<pre>
|
||||
```stl
|
||||
solid cube_corner
|
||||
facet normal 0.0 -1.0 0.0
|
||||
outer loop
|
||||
vertex 0.0 0.0 0.0
|
||||
vertex 1.0 0.0 0.0
|
||||
vertex 0.0 0.0 1.0
|
||||
endloop
|
||||
endfacet
|
||||
facet normal 0.0 0.0 -1.0
|
||||
outer loop
|
||||
vertex 0.0 0.0 0.0
|
||||
vertex 0.0 1.0 0.0
|
||||
vertex 1.0 0.0 0.0
|
||||
endloop
|
||||
endfacet
|
||||
facet normal -1.0 0.0 0.0
|
||||
outer loop
|
||||
vertex 0.0 0.0 0.0
|
||||
vertex 0.0 0.0 1.0
|
||||
vertex 0.0 1.0 0.0
|
||||
endloop
|
||||
endfacet
|
||||
facet normal 0.577 0.577 0.577
|
||||
outer loop
|
||||
vertex 1.0 0.0 0.0
|
||||
vertex 0.0 1.0 0.0
|
||||
vertex 0.0 0.0 1.0
|
||||
endloop
|
||||
endfacet
|
||||
endsolid
|
||||
```
|
||||
</pre>
|
||||
|
||||

|
||||
|
||||
For more information on working with `.stl` files, see "[Working with non-code files](/repositories/working-with-files/using-files/working-with-non-code-files#3d-file-viewer)."
|
||||
|
||||
|
||||
@@ -123,7 +123,7 @@ You can enable or disable features for all repositories.
|
||||
|
||||
By default, {% data variables.product.prodname_dependabot %} can't update dependencies that are located in private repositories or private package registries. However, if a dependency is in a private {% data variables.product.prodname_dotcom %} repository within the same organization as the project that uses that dependency, you can allow {% data variables.product.prodname_dependabot %} to update the version successfully by giving it access to the host repository.
|
||||
|
||||
If your code depends on packages in a private registry, you can allow {% data variables.product.prodname_dependabot %} to update the versions of these dependencies by configuring this at the repository level. You do this by adding authentication details to the _dependabot.yml_ file for the repository. For more information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates#configuration-options-for-private-registries)."
|
||||
If your code depends on packages in a private registry, you can allow {% data variables.product.prodname_dependabot %} to update the versions of these dependencies by configuring this at the repository level. You do this by adding authentication details to the _dependabot.yml_ file for the repository. For more information, see "[Configuration options for the dependabot.yml file](/github/administering-a-repository/configuration-options-for-dependency-updates#configuration-options-for-private-registries)."
|
||||
|
||||
To allow {% data variables.product.prodname_dependabot %} to access a private {% data variables.product.prodname_dotcom %} repository:
|
||||
|
||||
@@ -163,6 +163,5 @@ You can manage access to {% data variables.product.prodname_GH_advanced_security
|
||||
|
||||
- "[Securing your repository](/code-security/getting-started/securing-your-repository)"{% ifversion not fpt %}
|
||||
- "[About secret scanning](/github/administering-a-repository/about-secret-scanning)"{% endif %}{% ifversion not ghae %}
|
||||
- "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)"
|
||||
- "[Managing vulnerabilities in your project's dependencies](/github/managing-security-vulnerabilities/managing-vulnerabilities-in-your-projects-dependencies)"{% endif %}{% ifversion fpt or ghec or ghes > 3.2 %}
|
||||
- "[Keeping your dependencies updated automatically](/github/administering-a-repository/keeping-your-dependencies-updated-automatically)"{% endif %}
|
||||
- "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)"{% endif %}{% ifversion fpt or ghec or ghes > 3.2 %}
|
||||
- "[Keeping your dependencies updated automatically](/github/administering-a-repository/keeping-your-dependencies-updated-automatically)"{% endif %}
|
||||
@@ -42,7 +42,7 @@ To search for specific events, use the `action` qualifier in your query. Actions
|
||||
| [`billing`](#billing-category-actions) | Contains all activities related to your organization's billing.
|
||||
| [`business`](#business-category-actions) | Contains activities related to business settings for an enterprise. |
|
||||
| [`codespaces`](#codespaces-category-actions) | Contains all activities related to your organization's codespaces. |{% endif %}{% ifversion fpt or ghec or ghes > 3.2 %}
|
||||
| [`dependabot_alerts`](#dependabot_alerts-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_alerts %} in existing repositories. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
|
||||
| [`dependabot_alerts`](#dependabot_alerts-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_alerts %} in existing repositories. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
|
||||
| [`dependabot_alerts_new_repos`](#dependabot_alerts_new_repos-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_alerts %} in new repositories created in the organization.
|
||||
| [`dependabot_security_updates`](#dependabot_security_updates-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_security_updates %} in existing repositories. For more information, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)."
|
||||
| [`dependabot_security_updates_new_repos`](#dependabot_security_updates_new_repos-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_security_updates %} for new repositories created in the organization.{% endif %}{% ifversion fpt or ghec %}
|
||||
@@ -680,7 +680,7 @@ For more information, see "[Managing the publication of {% data variables.produc
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| `create` | Triggered when {% data variables.product.product_name %} creates a {% data variables.product.prodname_dependabot %} alert for a repository that uses a vulnerable dependency. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
|
||||
| `create` | Triggered when {% data variables.product.product_name %} creates a {% data variables.product.prodname_dependabot %} alert for a repository that uses a vulnerable dependency. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
|
||||
| `dismiss` | Triggered when an organization owner or person with admin access to the repository dismisses a {% data variables.product.prodname_dependabot %} alert about a vulnerable dependency.
|
||||
| `resolve` | Triggered when someone with write access to a repository pushes changes to update and resolve a vulnerability in a project dependency.
|
||||
|
||||
|
||||
@@ -75,5 +75,5 @@ Almost all software relies on code developed and maintained by other developers,
|
||||
|
||||
The dependency graph provides a great way to visualize and explore the dependencies for a repository. For more information, see "[About the dependency graph](/code-security/supply-chain-security/about-the-dependency-graph)" and "[Exploring the dependencies of a repository](/code-security/supply-chain-security/exploring-the-dependencies-of-a-repository)."
|
||||
|
||||
You can also set up your repository so that {% data variables.product.company_short %} alerts you automatically whenever a security vulnerability is found in one of your dependencies. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
|
||||
You can also set up your repository so that {% data variables.product.company_short %} alerts you automatically whenever a security vulnerability is found in one of your dependencies. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
|
||||
{% endif %}
|
||||
|
||||
@@ -130,6 +130,12 @@ By default, the embedded renderer is 420 pixels wide by 620 pixels high, but you
|
||||
|
||||
{% endtip %}
|
||||
|
||||
{% if mermaid %}
|
||||
### Rendering in Markdown
|
||||
|
||||
You can embed ASCII STL syntax directly in Markdown. For more information, see "[Creating diagrams](/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams#creating-stl-3d-models)."
|
||||
{% endif %}
|
||||
|
||||
## Rendering CSV and TSV data
|
||||
|
||||
GitHub supports rendering tabular data in the form of *.csv* (comma-separated) and .*tsv* (tab-separated) files.
|
||||
@@ -240,7 +246,7 @@ When you click the paper icon on the right, you'll also see the changes made to
|
||||
|
||||

|
||||
|
||||
### Geometry Types
|
||||
### Geometry types
|
||||
|
||||
Maps on {% data variables.product.product_name %} use [Leaflet.js](http://leafletjs.com) and support all the geometry types outlined in [the geoJSON spec](http://www.geojson.org/geojson-spec.html) (Point, LineString, Polygon, MultiPoint, MultiLineString, MultiPolygon, and GeometryCollection). TopoJSON files should be type "Topology" and adhere to the [topoJSON spec](https://github.com/mbostock/topojson/wiki/Specification).
|
||||
|
||||
@@ -281,6 +287,12 @@ By default, the embedded map 420px x 620px, but you can customize the output by
|
||||
|
||||
{% endtip %}
|
||||
|
||||
{% if mermaid %}
|
||||
### Mapping in Markdown
|
||||
|
||||
You can embed geoJSON and topoJSON directly in Markdown. For more information, see "[Creating diagrams](/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams#creating-geojson-and-topojson-maps)."
|
||||
{% endif %}
|
||||
|
||||
### Clustering
|
||||
|
||||
If your map contains a large number of markers (roughly over 750), GitHub will automatically cluster nearby markers at higher zoom levels. Simply click the cluster or zoom in to see individual markers.
|
||||
@@ -299,7 +311,7 @@ Additionally, if your `.geojson` file is especially large (over 10 MB), it is no
|
||||
|
||||
It may still be possible to render the data by converting the `.geojson` file to [TopoJSON](https://github.com/mbostock/topojson), a compression format that, in some cases, can reduce filesize by up to 80%. Of course, you can always break the file into smaller chunks (such as by state or by year), and store the data as multiple files within the repository.
|
||||
|
||||
### Additional Resources
|
||||
### Further reading
|
||||
|
||||
* [Leaflet.js geojson documentation](http://leafletjs.com/examples/geojson.html)
|
||||
* [MapBox marker-styling documentation](http://www.mapbox.com/developers/simplestyle/)
|
||||
@@ -327,3 +339,45 @@ $ jupyter nbconvert --to html <em>NOTEBOOK-NAME.ipynb</em>
|
||||
|
||||
- [Jupyter Notebook's GitHub repository](https://github.com/jupyter/jupyter_notebook)
|
||||
- [Gallery of Jupyter Notebooks](https://github.com/jupyter/jupyter/wiki/A-gallery-of-interesting-Jupyter-Notebooks)
|
||||
|
||||
{% if mermaid %}
|
||||
## Displaying mermaid files on {% data variables.product.prodname_dotcom %}
|
||||
|
||||
{% data variables.product.product_name %} supports rendering Mermaid files within repositories. Commit the file as you would normally using a `.mermaid` or `.mmd` extension. Then, navigate to the path of the Mermaid file on {% data variables.product.prodname_dotcom %}.
|
||||
|
||||
For example, if you add a `.mmd` file with the following content to your repository:
|
||||
|
||||
```
|
||||
graph TD
|
||||
A[Friend's Birthday] -->|Get money| B(Go shopping)
|
||||
B --> C{Let me think}
|
||||
C -->|One| D["Cool <br> Laptop"]
|
||||
C -->|Two| E[iPhone]
|
||||
C -->|Three| F[fa:fa-car Car]
|
||||
```
|
||||
|
||||
When you view the file in the repository, it is rendered as a flow chart.
|
||||

|
||||
|
||||
### Troubleshooting
|
||||
|
||||
If your chart does not render at all, verify that it contains valid Mermaid Markdown syntax by checking your chart with the [Mermaid live editor](https://mermaid.live/edit).
|
||||
|
||||
If the chart displays, but does not appear as you'd expect, you can create a new [feedback discussion](https://github.com/github/feedback/discussions/categories/general-feedback), and add the `mermaid` tag.
|
||||
|
||||
#### Known issues
|
||||
|
||||
* Sequence diagram charts frequently render with additional padding below the chart, with more padding added as the chart size increases. This is a known issue with the mMermaid library.
|
||||
* Actor nodes with popover menus do not work as expected within sequence diagram charts. This is due to a discrepancy in how JavaScript events are added to a chart when the Mermaid library's API is used to render a chart.
|
||||
* Not all charts are a11y compliant. This may affect users who rely on a screen reader.
|
||||
|
||||
### Mermaid in Markdown
|
||||
|
||||
You can embed Mermaid syntax directly in Markdown. For more information, see "[Creating diagrams](/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams#creating-mermaid-diagrams)."
|
||||
|
||||
### Further reading
|
||||
|
||||
* [Mermaid.js documentation](https://mermaid-js.github.io/mermaid/#/)
|
||||
* [Mermaid.js live editor](https://mermaid.live/edit)
|
||||
{% endif %}
|
||||
|
||||
|
||||
17
content/rest/reference/deploy_keys.md
Normal file
@@ -0,0 +1,17 @@
|
||||
---
|
||||
title: Deploy Keys
|
||||
intro: 'The Deploy Keys API allows to create an SSH key that is stored on your server and grants access to a GitHub repository.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- API
|
||||
miniTocMaxHeadingLevel: 3
|
||||
---
|
||||
|
||||
<!--
|
||||
Operations are automatically generated below. Markdown for subcategories is located in data/reusables/rest-reference/keys
|
||||
-->
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Deployments
|
||||
intro: 'The deployments API allows you to create and delete deploy keys, deployments, and deployment environments.'
|
||||
intro: 'The deployments API allows you to create and delete deployments and deployment environments.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -22,6 +22,7 @@ children:
|
||||
- /collaborators
|
||||
- /commits
|
||||
- /dependabot
|
||||
- /deploy_keys
|
||||
- /deployments
|
||||
- /emojis
|
||||
- /enterprise-admin
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Issue 5812 and 6172
|
||||
# Mermaid syntax support
|
||||
# Issues 5812 and 6172, also 6411
|
||||
# Mermaid syntax support, also ASCII STL and geoJSON/topoJSON syntax support
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '>=3.5'
|
||||
ghes: '>=3.6'
|
||||
ghae: 'issue-6172'
|
||||
|
||||
@@ -18,24 +18,24 @@ dependabot_alerts:
|
||||
title: 'Get notifications for vulnerable dependencies'
|
||||
description: 'Set up Dependabot to alert you to new vulnerabilities in your dependencies.'
|
||||
guides:
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies
|
||||
- /code-security/dependabot/dependabot-alerts/about-dependabot-alerts
|
||||
- '{% ifversion fpt or ghec or ghes > 3.2 %}/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository{% endif %}'
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-dependabot-errors
|
||||
- /code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts
|
||||
- /code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts
|
||||
- /code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates
|
||||
- /code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies
|
||||
- /code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors
|
||||
|
||||
# Feature available on dotcom and GHES 3.3+, so articles available on GHAE and earlier GHES hidden to hide the learning track
|
||||
dependabot_security_updates:
|
||||
title: 'Get pull requests to update your vulnerable dependencies'
|
||||
description: 'Set up Dependabot to create pull requests when new vulnerabilities are reported.'
|
||||
guides:
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates
|
||||
- /code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates
|
||||
- /code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates
|
||||
- '{% ifversion fpt or ghec or ghes > 3.2 %}/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies{% endif %}'
|
||||
- '{% ifversion fpt or ghec or ghes > 3.2 %}/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository{% endif %}'
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates
|
||||
- /code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates
|
||||
- '{% ifversion fpt or ghec or ghes > 3.2 %}/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies{% endif %}'
|
||||
|
||||
# Feature available only on dotcom and GHES 3.3+
|
||||
@@ -43,16 +43,16 @@ dependency_version_updates:
|
||||
title: 'Keep your dependencies up-to-date'
|
||||
description: 'Use Dependabot to check for new releases and create pull requests to update your dependencies.'
|
||||
guides:
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/listing-dependencies-configured-for-version-updates
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot
|
||||
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates
|
||||
- /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-dependabot-errors
|
||||
- /code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates
|
||||
- /code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates
|
||||
- /code-security/dependabot/dependabot-version-updates/customizing-dependency-updates
|
||||
- /code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
|
||||
- /code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
|
||||
- /code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions
|
||||
- /code-security/dependabot/dependabot-version-updates/listing-dependencies-configured-for-version-updates
|
||||
- /code-security/dependabot/working-with-dependabot/managing-encrypted-secrets-for-dependabot
|
||||
- /code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates
|
||||
- /code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors
|
||||
|
||||
# Feature available in GHEC, GHES 3.0 up, and GHAE. Feature limited on FPT so hidden there.
|
||||
secret_scanning:
|
||||
|
||||
1
data/reusables/code-scanning/alert-default-branch.md
Normal file
@@ -0,0 +1 @@
|
||||
The status and details on the alert page only reflect the state of the alert on the default branch of the repository, even if the alert exists in other branches. You can see the status of the alert on non-default branches in the **Affected branches** section on the right-hand side of the alert page. If an alert doesn't exist in the default branch, the status of the alert will display as "in pull request" or "in branch" and will be colored grey.
|
||||
@@ -0,0 +1 @@
|
||||
Please note that if you have filtered for alerts on a non-default branch, but the same alerts exist on the default branch, the alert page for any given alert will still only reflect the alert's status on the default branch, even if that status conflicts with the status on a non-default branch. For example, an alert that appears in the "Open" list in the summary of alerts for `branch-x` could show a status of "Fixed" on the alert page, if the alert is already fixed on the default branch. You can view the status of the alert for the branch you filtered on in the **Affected branches** section on the right side of the alert page.
|
||||
@@ -1 +1 @@
|
||||
When running security or version updates, some ecosystems must be able to resolve all dependencies from their source to verify that updates have been successful. If your manifest or lock files contain any private dependencies, {% data variables.product.prodname_dependabot %} must be able to access the location at which those dependencies are hosted. Organization owners can grant {% data variables.product.prodname_dependabot %} access to private repositories containing dependencies for a project within the same organization. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-dependencies)." You can configure access to private registries in a repository's _dependabot.yml_ configuration file. For more information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates#configuration-options-for-private-registries)."
|
||||
When running security or version updates, some ecosystems must be able to resolve all dependencies from their source to verify that updates have been successful. If your manifest or lock files contain any private dependencies, {% data variables.product.prodname_dependabot %} must be able to access the location at which those dependencies are hosted. Organization owners can grant {% data variables.product.prodname_dependabot %} access to private repositories containing dependencies for a project within the same organization. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-dependencies)." You can configure access to private registries in a repository's _dependabot.yml_ configuration file. For more information, see "[Configuration options for the dependabot.yml file](/github/administering-a-repository/configuration-options-for-dependency-updates#configuration-options-for-private-registries)."
|
||||
|
||||
1
data/reusables/dependabot/result-discrepancy.md
Normal file
@@ -0,0 +1 @@
|
||||
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.
|
||||
@@ -1,3 +1,3 @@
|
||||
{% data variables.product.prodname_dotcom %} will review each published security advisory, add it to the {% data variables.product.prodname_advisory_database %}, and may use the security advisory to send {% data variables.product.prodname_dependabot_alerts %} to affected repositories. If the security advisory comes from a fork, we'll only send an alert if the fork owns a package, published under a unique name, on a public package registry. This process can take up to 72 hours and {% data variables.product.prodname_dotcom %} may contact you for more information.
|
||||
|
||||
For more information about {% data variables.product.prodname_dependabot_alerts %}, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)" and "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-dependabot-security-updates)." For more information about {% data variables.product.prodname_advisory_database %}, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database)."
|
||||
For more information about {% data variables.product.prodname_dependabot_alerts %}, see "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)" and "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-dependabot-security-updates)." For more information about {% data variables.product.prodname_advisory_database %}, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database)."
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
{% ifversion not ghae %}
|
||||
If your repository has a supported dependency manifest{% ifversion fpt or ghec %} (and if you've set up the dependency graph if it's a private repository){% endif %}, whenever {% data variables.product.product_name %} detects a vulnerable dependency in your repository, you will receive a weekly digest email. You can also configure your security alerts as web notifications, individual email notifications, daily email digests, or alerts in the {% data variables.product.product_name %} interface. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
|
||||
If your repository has a supported dependency manifest{% ifversion fpt or ghec %} (and if you've set up the dependency graph if it's a private repository){% endif %}, whenever {% data variables.product.product_name %} detects a vulnerable dependency in your repository, you will receive a weekly digest email. You can also configure your security alerts as web notifications, individual email notifications, daily email digests, or alerts in the {% data variables.product.product_name %} interface. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
|
||||
{% endif %}
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
## Deploy keys
|
||||
|
||||
{% data reusables.repositories.deploy-keys %}
|
||||
|
||||
Deploy keys can either be setup using the following API endpoints, or by using GitHub. To learn how to set deploy keys up in GitHub, see "[Managing deploy keys](/developers/overview/managing-deploy-keys)."
|
||||
@@ -1 +1 @@
|
||||
Activity related to security vulnerability alerts in a repository. {% data reusables.webhooks.action_type_desc %} For more information, see the "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)".
|
||||
Activity related to security vulnerability alerts in a repository. {% data reusables.webhooks.action_type_desc %} For more information, see the "[About {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)".
|
||||
|
||||
@@ -25,10 +25,16 @@
|
||||
"/rest/reference/repos#list-repository-invitations": "/rest/reference/collaborators#list-repository-invitations",
|
||||
"/rest/reference/repos#update-a-repository-invitation": "/rest/reference/collaborators#update-a-repository-invitation",
|
||||
"/rest/reference/repos#delete-a-repository-invitation": "/rest/reference/collaborators#delete-a-repository-invitation",
|
||||
"/rest/reference/repos#list-deploy-keys": "/rest/reference/deployments#list-deploy-keys",
|
||||
"/rest/reference/repos#create-a-deploy-key": "/rest/reference/deployments#create-a-deploy-key",
|
||||
"/rest/reference/repos#get-a-deploy-key": "/rest/reference/deployments#get-a-deploy-key",
|
||||
"/rest/reference/repos#delete-a-deploy-key": "/rest/reference/deployments#delete-a-deploy-key",
|
||||
"/rest/reference/repos#list-deploy-keys": "/rest/reference/deploy_keys#list-deploy-keys",
|
||||
"/rest/reference/repos#create-a-deploy-key": "/rest/reference/deploy_keys#create-a-deploy-key",
|
||||
"/rest/reference/repos#get-a-deploy-key": "/rest/reference/deploy_keys#get-a-deploy-key",
|
||||
"/rest/reference/repos#delete-a-deploy-key": "/rest/reference/deploy_keys#delete-a-deploy-key",
|
||||
"/rest/reference/repos#deploy-keys": "/rest/reference/deploy_keys",
|
||||
"/rest/reference/deployments#list-deploy-keys": "/rest/reference/deploy_keys#list-deploy-keys",
|
||||
"/rest/reference/deployments#create-a-deploy-key": "/rest/reference/deploy_keys#create-a-deploy-key",
|
||||
"/rest/reference/deployments#get-a-deploy-key": "/rest/reference/deploy_keys#get-a-deploy-key",
|
||||
"/rest/reference/deployments#delete-a-deploy-key": "/rest/reference/deploy_keys#delete-a-deploy-key",
|
||||
"/rest/reference/deployments#deploy-keys": "/rest/reference/deploy_keys",
|
||||
"/rest/reference/repos#get-a-github-pages-site": "/rest/reference/pages#get-a-github-pages-site",
|
||||
"/rest/reference/repos#create-a-github-pages-site": "/rest/reference/pages#create-a-github-pages-site",
|
||||
"/rest/reference/repos#update-information-about-a-github-pages-site": "/rest/reference/pages#update-information-about-a-github-pages-site",
|
||||
|
||||
@@ -1133,6 +1133,28 @@
|
||||
"requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}"
|
||||
}
|
||||
],
|
||||
"deploy_keys": [
|
||||
{
|
||||
"slug": "list-deploy-keys",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "create-a-deploy-key",
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "get-a-deploy-key",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
},
|
||||
{
|
||||
"slug": "delete-a-deploy-key",
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
}
|
||||
],
|
||||
"deployments": [
|
||||
{
|
||||
"slug": "list-deployments",
|
||||
@@ -1188,26 +1210,6 @@
|
||||
"slug": "delete-an-environment",
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/environments/{environment_name}"
|
||||
},
|
||||
{
|
||||
"slug": "list-deploy-keys",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "create-a-deploy-key",
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "get-a-deploy-key",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
},
|
||||
{
|
||||
"slug": "delete-a-deploy-key",
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
}
|
||||
],
|
||||
"emojis": [
|
||||
@@ -3968,6 +3970,28 @@
|
||||
"requestPath": "/repos/{owner}/{repo}/statuses/{sha}"
|
||||
}
|
||||
],
|
||||
"deploy_keys": [
|
||||
{
|
||||
"slug": "list-deploy-keys",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "create-a-deploy-key",
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "get-a-deploy-key",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
},
|
||||
{
|
||||
"slug": "delete-a-deploy-key",
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
}
|
||||
],
|
||||
"deployments": [
|
||||
{
|
||||
"slug": "list-deployments",
|
||||
@@ -4003,26 +4027,6 @@
|
||||
"slug": "get-a-deployment-status",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}"
|
||||
},
|
||||
{
|
||||
"slug": "list-deploy-keys",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "create-a-deploy-key",
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "get-a-deploy-key",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
},
|
||||
{
|
||||
"slug": "delete-a-deploy-key",
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
}
|
||||
],
|
||||
"emojis": [
|
||||
@@ -6471,6 +6475,28 @@
|
||||
"requestPath": "/repos/{owner}/{repo}/statuses/{sha}"
|
||||
}
|
||||
],
|
||||
"deploy_keys": [
|
||||
{
|
||||
"slug": "list-deploy-keys",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "create-a-deploy-key",
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "get-a-deploy-key",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
},
|
||||
{
|
||||
"slug": "delete-a-deploy-key",
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
}
|
||||
],
|
||||
"deployments": [
|
||||
{
|
||||
"slug": "list-deployments",
|
||||
@@ -6526,26 +6552,6 @@
|
||||
"slug": "delete-an-environment",
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/environments/{environment_name}"
|
||||
},
|
||||
{
|
||||
"slug": "list-deploy-keys",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "create-a-deploy-key",
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "get-a-deploy-key",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
},
|
||||
{
|
||||
"slug": "delete-a-deploy-key",
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
}
|
||||
],
|
||||
"emojis": [
|
||||
@@ -9049,6 +9055,28 @@
|
||||
"requestPath": "/repos/{owner}/{repo}/statuses/{sha}"
|
||||
}
|
||||
],
|
||||
"deploy_keys": [
|
||||
{
|
||||
"slug": "list-deploy-keys",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "create-a-deploy-key",
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "get-a-deploy-key",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
},
|
||||
{
|
||||
"slug": "delete-a-deploy-key",
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
}
|
||||
],
|
||||
"deployments": [
|
||||
{
|
||||
"slug": "list-deployments",
|
||||
@@ -9104,26 +9132,6 @@
|
||||
"slug": "delete-an-environment",
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/environments/{environment_name}"
|
||||
},
|
||||
{
|
||||
"slug": "list-deploy-keys",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "create-a-deploy-key",
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "get-a-deploy-key",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
},
|
||||
{
|
||||
"slug": "delete-a-deploy-key",
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
}
|
||||
],
|
||||
"emojis": [
|
||||
@@ -11791,6 +11799,28 @@
|
||||
"requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}"
|
||||
}
|
||||
],
|
||||
"deploy_keys": [
|
||||
{
|
||||
"slug": "list-deploy-keys",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "create-a-deploy-key",
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "get-a-deploy-key",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
},
|
||||
{
|
||||
"slug": "delete-a-deploy-key",
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
}
|
||||
],
|
||||
"deployments": [
|
||||
{
|
||||
"slug": "list-deployments",
|
||||
@@ -11846,26 +11876,6 @@
|
||||
"slug": "delete-an-environment",
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/environments/{environment_name}"
|
||||
},
|
||||
{
|
||||
"slug": "list-deploy-keys",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "create-a-deploy-key",
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "get-a-deploy-key",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
},
|
||||
{
|
||||
"slug": "delete-a-deploy-key",
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
}
|
||||
],
|
||||
"emojis": [
|
||||
@@ -14320,6 +14330,28 @@
|
||||
"requestPath": "/repos/{owner}/{repo}/statuses/{sha}"
|
||||
}
|
||||
],
|
||||
"deploy_keys": [
|
||||
{
|
||||
"slug": "list-deploy-keys",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "create-a-deploy-key",
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "get-a-deploy-key",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
},
|
||||
{
|
||||
"slug": "delete-a-deploy-key",
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
}
|
||||
],
|
||||
"deployments": [
|
||||
{
|
||||
"slug": "list-deployments",
|
||||
@@ -14355,26 +14387,6 @@
|
||||
"slug": "get-a-deployment-status",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}"
|
||||
},
|
||||
{
|
||||
"slug": "list-deploy-keys",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "create-a-deploy-key",
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "get-a-deploy-key",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
},
|
||||
{
|
||||
"slug": "delete-a-deploy-key",
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}"
|
||||
}
|
||||
],
|
||||
"emojis": [
|
||||
|
||||
@@ -37428,6 +37428,350 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"deploy_keys": {
|
||||
"deploy_keys": [
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "Results per page (max 100)",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 30
|
||||
},
|
||||
"descriptionHTML": "<p>Results per page (max 100)</p>"
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
"description": "Page number of the results to fetch.",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 1
|
||||
},
|
||||
"descriptionHTML": "<p>Page number of the results to fetch.</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "List deploy keys",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "list-deploy-keys",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "[\n {\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n }\n]"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('POST /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world',\n key: 'key'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Create a deploy key",
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"title": {
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"key": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"read_only": {
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"key"
|
||||
]
|
||||
},
|
||||
"example": {
|
||||
"title": "octocat@octomac",
|
||||
"key": "ssh-rsa AAA...",
|
||||
"read_only": true
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "create-a-deploy-key",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>You can create a read-only deploy key.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"httpStatusMessage": "Created",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
"description": "<p>Validation failed</p>"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Get a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "get-a-deploy-key",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Delete a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "delete-a-deploy-key",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"httpStatusMessage": "No Content",
|
||||
"description": "<p>Response</p>"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"deployments": {
|
||||
"deployments": [
|
||||
{
|
||||
@@ -38548,348 +38892,6 @@
|
||||
]
|
||||
}
|
||||
],
|
||||
"keys": [
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "Results per page (max 100)",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 30
|
||||
},
|
||||
"descriptionHTML": "<p>Results per page (max 100)</p>"
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
"description": "Page number of the results to fetch.",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 1
|
||||
},
|
||||
"descriptionHTML": "<p>Page number of the results to fetch.</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "List deploy keys",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "list-deploy-keys",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "[\n {\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n }\n]"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('POST /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world',\n key: 'key'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Create a deploy key",
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"title": {
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"key": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"read_only": {
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"key"
|
||||
]
|
||||
},
|
||||
"example": {
|
||||
"title": "octocat@octomac",
|
||||
"key": "ssh-rsa AAA...",
|
||||
"read_only": true
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "create-a-deploy-key",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>You can create a read-only deploy key.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"httpStatusMessage": "Created",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
"description": "<p>Validation failed</p>"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Get a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "get-a-deploy-key",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Delete a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "delete-a-deploy-key",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"httpStatusMessage": "No Content",
|
||||
"description": "<p>Response</p>"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"statuses": [
|
||||
{
|
||||
"verb": "get",
|
||||
|
||||
@@ -29302,6 +29302,350 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"deploy_keys": {
|
||||
"deploy_keys": [
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "Results per page (max 100)",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 30
|
||||
},
|
||||
"descriptionHTML": "<p>Results per page (max 100)</p>"
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
"description": "Page number of the results to fetch.",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 1
|
||||
},
|
||||
"descriptionHTML": "<p>Page number of the results to fetch.</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "List deploy keys",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "list-deploy-keys",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "[\n {\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n }\n]"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('POST /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world',\n key: 'key'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Create a deploy key",
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"title": {
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"key": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"read_only": {
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"key"
|
||||
]
|
||||
},
|
||||
"example": {
|
||||
"title": "octocat@octomac",
|
||||
"key": "ssh-rsa AAA...",
|
||||
"read_only": true
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "create-a-deploy-key",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>You can create a read-only deploy key.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"httpStatusMessage": "Created",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
"description": "<p>Validation failed</p>"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Get a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "get-a-deploy-key",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Delete a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "delete-a-deploy-key",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"httpStatusMessage": "No Content",
|
||||
"description": "<p>Response</p>"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"deployments": {
|
||||
"deployments": [
|
||||
{
|
||||
@@ -29895,348 +30239,6 @@
|
||||
"subcategory": "deployments"
|
||||
}
|
||||
],
|
||||
"keys": [
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "Results per page (max 100)",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 30
|
||||
},
|
||||
"descriptionHTML": "<p>Results per page (max 100)</p>"
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
"description": "Page number of the results to fetch.",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 1
|
||||
},
|
||||
"descriptionHTML": "<p>Page number of the results to fetch.</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "List deploy keys",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "list-deploy-keys",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "[\n {\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n }\n]"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('POST /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world',\n key: 'key'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Create a deploy key",
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"title": {
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"key": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"read_only": {
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"key"
|
||||
]
|
||||
},
|
||||
"example": {
|
||||
"title": "octocat@octomac",
|
||||
"key": "ssh-rsa AAA...",
|
||||
"read_only": true
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "create-a-deploy-key",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>You can create a read-only deploy key.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"httpStatusMessage": "Created",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
"description": "<p>Validation failed</p>"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Get a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "get-a-deploy-key",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Delete a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "delete-a-deploy-key",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"httpStatusMessage": "No Content",
|
||||
"description": "<p>Response</p>"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"statuses": [
|
||||
{
|
||||
"verb": "get",
|
||||
|
||||
@@ -30176,6 +30176,350 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"deploy_keys": {
|
||||
"deploy_keys": [
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "Results per page (max 100)",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 30
|
||||
},
|
||||
"descriptionHTML": "<p>Results per page (max 100)</p>"
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
"description": "Page number of the results to fetch.",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 1
|
||||
},
|
||||
"descriptionHTML": "<p>Page number of the results to fetch.</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "List deploy keys",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "list-deploy-keys",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "[\n {\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n }\n]"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('POST /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world',\n key: 'key'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Create a deploy key",
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"title": {
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"key": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"read_only": {
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"key"
|
||||
]
|
||||
},
|
||||
"example": {
|
||||
"title": "octocat@octomac",
|
||||
"key": "ssh-rsa AAA...",
|
||||
"read_only": true
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "create-a-deploy-key",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>You can create a read-only deploy key.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"httpStatusMessage": "Created",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
"description": "<p>Validation failed</p>"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Get a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "get-a-deploy-key",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Delete a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "delete-a-deploy-key",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"httpStatusMessage": "No Content",
|
||||
"description": "<p>Response</p>"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"deployments": {
|
||||
"deployments": [
|
||||
{
|
||||
@@ -31318,348 +31662,6 @@
|
||||
]
|
||||
}
|
||||
],
|
||||
"keys": [
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "Results per page (max 100)",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 30
|
||||
},
|
||||
"descriptionHTML": "<p>Results per page (max 100)</p>"
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
"description": "Page number of the results to fetch.",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 1
|
||||
},
|
||||
"descriptionHTML": "<p>Page number of the results to fetch.</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "List deploy keys",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "list-deploy-keys",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "[\n {\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n }\n]"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('POST /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world',\n key: 'key'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Create a deploy key",
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"title": {
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"key": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"read_only": {
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"key"
|
||||
]
|
||||
},
|
||||
"example": {
|
||||
"title": "octocat@octomac",
|
||||
"key": "ssh-rsa AAA...",
|
||||
"read_only": true
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "create-a-deploy-key",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>You can create a read-only deploy key.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"httpStatusMessage": "Created",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
"description": "<p>Validation failed</p>"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Get a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "get-a-deploy-key",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Delete a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "delete-a-deploy-key",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"httpStatusMessage": "No Content",
|
||||
"description": "<p>Response</p>"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"statuses": [
|
||||
{
|
||||
"verb": "get",
|
||||
|
||||
@@ -30277,6 +30277,350 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"deploy_keys": {
|
||||
"deploy_keys": [
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "Results per page (max 100)",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 30
|
||||
},
|
||||
"descriptionHTML": "<p>Results per page (max 100)</p>"
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
"description": "Page number of the results to fetch.",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 1
|
||||
},
|
||||
"descriptionHTML": "<p>Page number of the results to fetch.</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "List deploy keys",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "list-deploy-keys",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "[\n {\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n }\n]"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('POST /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world',\n key: 'key'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Create a deploy key",
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"title": {
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"key": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"read_only": {
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"key"
|
||||
]
|
||||
},
|
||||
"example": {
|
||||
"title": "octocat@octomac",
|
||||
"key": "ssh-rsa AAA...",
|
||||
"read_only": true
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "create-a-deploy-key",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>You can create a read-only deploy key.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"httpStatusMessage": "Created",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
"description": "<p>Validation failed</p>"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Get a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "get-a-deploy-key",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Delete a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "delete-a-deploy-key",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"httpStatusMessage": "No Content",
|
||||
"description": "<p>Response</p>"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"deployments": {
|
||||
"deployments": [
|
||||
{
|
||||
@@ -31397,348 +31741,6 @@
|
||||
]
|
||||
}
|
||||
],
|
||||
"keys": [
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "Results per page (max 100)",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 30
|
||||
},
|
||||
"descriptionHTML": "<p>Results per page (max 100)</p>"
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
"description": "Page number of the results to fetch.",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 1
|
||||
},
|
||||
"descriptionHTML": "<p>Page number of the results to fetch.</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "List deploy keys",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "list-deploy-keys",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "[\n {\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n }\n]"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('POST /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world',\n key: 'key'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Create a deploy key",
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"title": {
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"key": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"read_only": {
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"key"
|
||||
]
|
||||
},
|
||||
"example": {
|
||||
"title": "octocat@octomac",
|
||||
"key": "ssh-rsa AAA...",
|
||||
"read_only": true
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "create-a-deploy-key",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>You can create a read-only deploy key.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"httpStatusMessage": "Created",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
"description": "<p>Validation failed</p>"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Get a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "get-a-deploy-key",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Delete a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "delete-a-deploy-key",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"httpStatusMessage": "No Content",
|
||||
"description": "<p>Response</p>"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"statuses": [
|
||||
{
|
||||
"verb": "get",
|
||||
|
||||
@@ -32841,6 +32841,350 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"deploy_keys": {
|
||||
"deploy_keys": [
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "Results per page (max 100)",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 30
|
||||
},
|
||||
"descriptionHTML": "<p>Results per page (max 100)</p>"
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
"description": "Page number of the results to fetch.",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 1
|
||||
},
|
||||
"descriptionHTML": "<p>Page number of the results to fetch.</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "List deploy keys",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "list-deploy-keys",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "[\n {\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n }\n]"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('POST /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world',\n key: 'key'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Create a deploy key",
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"title": {
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"key": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"read_only": {
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"key"
|
||||
]
|
||||
},
|
||||
"example": {
|
||||
"title": "octocat@octomac",
|
||||
"key": "ssh-rsa AAA...",
|
||||
"read_only": true
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "create-a-deploy-key",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>You can create a read-only deploy key.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"httpStatusMessage": "Created",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
"description": "<p>Validation failed</p>"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Get a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "get-a-deploy-key",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Delete a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "delete-a-deploy-key",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"httpStatusMessage": "No Content",
|
||||
"description": "<p>Response</p>"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"deployments": {
|
||||
"deployments": [
|
||||
{
|
||||
@@ -33961,348 +34305,6 @@
|
||||
]
|
||||
}
|
||||
],
|
||||
"keys": [
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "Results per page (max 100)",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 30
|
||||
},
|
||||
"descriptionHTML": "<p>Results per page (max 100)</p>"
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
"description": "Page number of the results to fetch.",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 1
|
||||
},
|
||||
"descriptionHTML": "<p>Page number of the results to fetch.</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "List deploy keys",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "list-deploy-keys",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "[\n {\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n }\n]"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('POST /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world',\n key: 'key'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Create a deploy key",
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"title": {
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"key": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"read_only": {
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"key"
|
||||
]
|
||||
},
|
||||
"example": {
|
||||
"title": "octocat@octomac",
|
||||
"key": "ssh-rsa AAA...",
|
||||
"read_only": true
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "create-a-deploy-key",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>You can create a read-only deploy key.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"httpStatusMessage": "Created",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
"description": "<p>Validation failed</p>"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Get a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "get-a-deploy-key",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Delete a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "delete-a-deploy-key",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"httpStatusMessage": "No Content",
|
||||
"description": "<p>Response</p>"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"statuses": [
|
||||
{
|
||||
"verb": "get",
|
||||
|
||||
@@ -26912,6 +26912,350 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"deploy_keys": {
|
||||
"deploy_keys": [
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "Results per page (max 100)",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 30
|
||||
},
|
||||
"descriptionHTML": "<p>Results per page (max 100)</p>"
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
"description": "Page number of the results to fetch.",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 1
|
||||
},
|
||||
"descriptionHTML": "<p>Page number of the results to fetch.</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/keys"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "List deploy keys",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "list-deploy-keys",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "[\n {\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n }\n]"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('POST /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world',\n key: 'key'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Create a deploy key",
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"title": {
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"key": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"read_only": {
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"key"
|
||||
]
|
||||
},
|
||||
"example": {
|
||||
"title": "octocat@octomac",
|
||||
"key": "ssh-rsa AAA...",
|
||||
"read_only": true
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "create-a-deploy-key",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>You can create a read-only deploy key.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"httpStatusMessage": "Created",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
"description": "<p>Validation failed</p>"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Get a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "get-a-deploy-key",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Delete a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "delete-a-deploy-key",
|
||||
"category": "deploy_keys",
|
||||
"subcategory": "deploy_keys",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"httpStatusMessage": "No Content",
|
||||
"description": "<p>Response</p>"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"deployments": {
|
||||
"deployments": [
|
||||
{
|
||||
@@ -27483,348 +27827,6 @@
|
||||
"subcategory": "deployments"
|
||||
}
|
||||
],
|
||||
"keys": [
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "Results per page (max 100)",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 30
|
||||
},
|
||||
"descriptionHTML": "<p>Results per page (max 100)</p>"
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
"description": "Page number of the results to fetch.",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 1
|
||||
},
|
||||
"descriptionHTML": "<p>Page number of the results to fetch.</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/keys"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "List deploy keys",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "list-deploy-keys",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "[\n {\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n }\n]"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/keys \\\n -d '{\"key\":\"key\"}'"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('POST /repos/{owner}/{repo}/keys', {\n owner: 'octocat',\n repo: 'hello-world',\n key: 'key'\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Create a deploy key",
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"title": {
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"key": {
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"read_only": {
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"key"
|
||||
]
|
||||
},
|
||||
"example": {
|
||||
"title": "octocat@octomac",
|
||||
"key": "ssh-rsa AAA...",
|
||||
"read_only": true
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "create-a-deploy-key",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>You can create a read-only deploy key.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"httpStatusMessage": "Created",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
"description": "<p>Validation failed</p>"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p>A name for the key.</p>",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A name for the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. The contents of the key.</p>",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The contents of the key.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('GET /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Get a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "get-a-deploy-key",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"descriptionHTML": "",
|
||||
"bodyParameters": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "<p>Response</p>",
|
||||
"payload": "{\n \"id\": 1,\n \"key\": \"ssh-rsa AAA...\",\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/keys/1\",\n \"title\": \"octocat@octomac\",\n \"verified\": true,\n \"created_at\": \"2014-12-10T15:53:42Z\",\n \"read_only\": true\n}"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
"requestPath": "/repos/{owner}/{repo}/keys/{key_id}",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "key_id",
|
||||
"description": "key_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>key_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/keys/42"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/keys/{key_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 42\n})"
|
||||
}
|
||||
],
|
||||
"summary": "Delete a deploy key",
|
||||
"x-github": {
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "keys"
|
||||
},
|
||||
"slug": "delete-a-deploy-key",
|
||||
"category": "deployments",
|
||||
"subcategory": "keys",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"httpStatusMessage": "No Content",
|
||||
"description": "<p>Response</p>"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"statuses": [
|
||||
{
|
||||
"verb": "get",
|
||||
|
||||
@@ -140,10 +140,15 @@ async function updateRedirectOverrides() {
|
||||
|
||||
const redirects = {}
|
||||
console.log('\n➡️ Updating REST API redirect exception list.\n')
|
||||
for (const value of Object.values(overrides)) {
|
||||
for (const [key, value] of Object.entries(overrides)) {
|
||||
const oldUrl = value.originalUrl
|
||||
const anchor = oldUrl.replace('/rest/reference', '').split('#')[1]
|
||||
redirects[oldUrl] = `/rest/reference/${value.category}#${anchor}`
|
||||
if (key.includes('#')) {
|
||||
// We are updating a subcategory into a category
|
||||
redirects[oldUrl] = `/rest/reference/${value.category}`
|
||||
} else {
|
||||
redirects[oldUrl] = `/rest/reference/${value.category}#${anchor}`
|
||||
}
|
||||
}
|
||||
await writeFile(
|
||||
'lib/redirects/static/client-side-rest-api-redirects.json',
|
||||
|
||||