jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-05 12:07:35 -05:00
Code Issues Projects Releases Wiki Activity

Merge pull request #27244 from github/repo-sync

Browse Source 
Repo sync
This commit is contained in:
docs-bot
2023-08-02 16:30:16 -07:00
committed by GitHub
parent 96af74e14c b760a894ce
commit 944e4881a4
16 changed files with 270 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json
View File

@@ -6353,6 +6353,15 @@
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}",
"additional-permissions": [],
"access": "write"
},
{
"category": "security-advisories",
"slug": "request-a-cve-for-a-repository-security-advisory",
"subcategory": "repository-advisories",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve",
"additional-permissions": [],
"access": "write"
}
]
},

6
src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json
View File

@@ -4099,6 +4099,12 @@
"subcategory": "repository-advisories",
"verb": "patch",
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}"
},
{
"slug": "request-a-cve-for-a-repository-security-advisory",
"subcategory": "repository-advisories",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve"
}
],
"teams": [

11
src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json
View File

@@ -7776,6 +7776,17 @@
"user-to-server": true,
"server-to-server": true,
"additional-permissions": []
},
{
"category": "security-advisories",
"slug": "request-a-cve-for-a-repository-security-advisory",
"subcategory": "repository-advisories",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": []
}
]
},

6
src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json
View File

@@ -3711,6 +3711,12 @@
"subcategory": "repository-advisories",
"verb": "patch",
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}"
},
{
"slug": "request-a-cve-for-a-repository-security-advisory",
"subcategory": "repository-advisories",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve"
}
],
"teams": [

6
src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json
View File

@@ -4165,6 +4165,12 @@
"subcategory": "repository-advisories",
"verb": "patch",
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}"
},
{
"slug": "request-a-cve-for-a-repository-security-advisory",
"subcategory": "repository-advisories",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve"
}
],
"teams": [

9
src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json
View File

@@ -6934,6 +6934,15 @@
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}",
"additional-permissions": [],
"access": "write"
},
{
"category": "security-advisories",
"slug": "request-a-cve-for-a-repository-security-advisory",
"subcategory": "repository-advisories",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve",
"additional-permissions": [],
"access": "write"
}
]
},

6
src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json
View File

@@ -4387,6 +4387,12 @@
"subcategory": "repository-advisories",
"verb": "patch",
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}"
},
{
"slug": "request-a-cve-for-a-repository-security-advisory",
"subcategory": "repository-advisories",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve"
}
],
"teams": [

11
src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json
View File

@@ -8492,6 +8492,17 @@
"user-to-server": true,
"server-to-server": true,
"additional-permissions": []
},
{
"category": "security-advisories",
"slug": "request-a-cve-for-a-repository-security-advisory",
"subcategory": "repository-advisories",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": []
}
]
},

6
src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json
View File

@@ -3999,6 +3999,12 @@
"subcategory": "repository-advisories",
"verb": "patch",
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}"
},
{
"slug": "request-a-cve-for-a-repository-security-advisory",
"subcategory": "repository-advisories",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve"
}
],
"teams": [

6
src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json
View File

@@ -4453,6 +4453,12 @@
"subcategory": "repository-advisories",
"verb": "patch",
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}"
},
{
"slug": "request-a-cve-for-a-repository-security-advisory",
"subcategory": "repository-advisories",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve"
}
],
"teams": [

2
src/github-apps/lib/config.json
View File

@@ -60,5 +60,5 @@
"2022-11-28"
]
},
"sha": "902841d79e04ac06ca03c8499a6fe4d32cd39370"
"sha": "af631f687d9e4aedb65f9351d66a955b63f56f15"
}

86
src/rest/data/fpt-2022-11-28/schema.json
View File

@@ -513970,6 +513970,92 @@
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
]
},
{
"serverUrl": "https://api.github.com",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve",
"title": "Request a CVE for a repository security advisory",
"category": "security-advisories",
"subcategory": "repository-advisories",
"parameters": [
{
"name": "owner",
"description": "<p>The account owner of the repository. The name is not case sensitive.</p>",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"description": "<p>The name of the repository without the <code>.git</code> extension. The name is not case sensitive.</p>",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ghsa_id",
"description": "<p>The GHSA (GitHub Security Advisory) identifier of the advisory.</p>",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"bodyParameters": [],
"enabledForGitHubApps": true,
"codeExamples": [
{
"key": "default",
"request": {
"description": "Example",
"acceptHeader": "application/vnd.github.v3+json",
"parameters": {
"owner": "OWNER",
"repo": "REPO",
"ghsa_id": "GHSA_ID"
}
},
"response": {
"statusCode": "202",
"contentType": "application/json",
"description": "<p>Accepted</p>",
"example": null,
"schema": {
"type": "object"
}
}
}
],
"previews": [],
"descriptionHTML": "<p>If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see \"<a href=\"https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional\">Requesting a CVE identification number</a>.\"</p>\n<p>You may request a CVE for public repositories, but cannot do so for private repositories.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope or <code>repository_advisories:write</code> permission to use this endpoint.</p>\n<p>In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
"description": "<p>Accepted</p>"
},
{
"httpStatusCode": "400",
"description": "<p>Bad Request</p>"
},
{
"httpStatusCode": "403",
"description": "<p>Forbidden</p>"
},
{
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
},
{
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
]
}
]
},

90
src/rest/data/ghec-2022-11-28/schema.json
View File

@@ -248900,7 +248900,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the <code>read:audit_log</code> scope.</p>",
"descriptionHTML": "<p>Gets the audit log for an enterprise. To use this endpoint, you must\nbe an enterprise admin, and you must use an access token with the <code>read:audit_log</code>\nscope.</p>\n<p>This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#exceeding-the-rate-limit\">Resources in the REST API</a>\" and \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Best practices for integrators</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -363698,7 +363698,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the audit log for an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization\">Reviewing the audit log for your organization</a>.\"</p>\n<p>To use this endpoint, you must be an organization owner, and you must use an access token with the <code>read:audit_log</code> scope. GitHub Apps must have the <code>organization_administration</code> read permission to use this endpoint.</p>\n<p>By default, the response includes up to 30 events from the past three months. Use the <code>phrase</code> parameter to filter results and retrieve older events. For example, use the <code>phrase</code> parameter with the <code>created</code> qualifier to filter events based on when the events occurred. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log\">Reviewing the audit log for your organization</a>.\"</p>\n<p>Use pagination to retrieve fewer or more than 30 events. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#pagination\">Resources in the REST API</a>.\"</p>",
"descriptionHTML": "<p>Gets the audit log for an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization\">Reviewing the audit log for your organization</a>.\"</p>\n<p>To use this endpoint, you must be an organization owner, and you must use an access token with the <code>read:audit_log</code> scope. GitHub Apps must have the <code>organization_administration</code> read permission to use this endpoint.</p>\n<p>By default, the response includes up to 30 events from the past three months. Use the <code>phrase</code> parameter to filter results and retrieve older events. For example, use the <code>phrase</code> parameter with the <code>created</code> qualifier to filter events based on when the events occurred. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log\">Reviewing the audit log for your organization</a>.\"</p>\n<p>Use pagination to retrieve fewer or more than 30 events. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#pagination\">Resources in the REST API</a>.\"</p>\n<p>This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#exceeding-the-rate-limit\">Resources in the REST API</a>\" and \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators#dealing-with-rate-limits\">Best practices for integrators</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -533503,6 +533503,92 @@
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
]
},
{
"serverUrl": "https://api.github.com",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve",
"title": "Request a CVE for a repository security advisory",
"category": "security-advisories",
"subcategory": "repository-advisories",
"parameters": [
{
"name": "owner",
"description": "<p>The account owner of the repository. The name is not case sensitive.</p>",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"description": "<p>The name of the repository without the <code>.git</code> extension. The name is not case sensitive.</p>",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ghsa_id",
"description": "<p>The GHSA (GitHub Security Advisory) identifier of the advisory.</p>",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"bodyParameters": [],
"enabledForGitHubApps": true,
"codeExamples": [
{
"key": "default",
"request": {
"description": "Example",
"acceptHeader": "application/vnd.github.v3+json",
"parameters": {
"owner": "OWNER",
"repo": "REPO",
"ghsa_id": "GHSA_ID"
}
},
"response": {
"statusCode": "202",
"contentType": "application/json",
"description": "<p>Accepted</p>",
"example": null,
"schema": {
"type": "object"
}
}
}
],
"previews": [],
"descriptionHTML": "<p>If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional\">Requesting a CVE identification number</a>.\"</p>\n<p>You may request a CVE for public repositories, but cannot do so for private repositories.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope or <code>repository_advisories:write</code> permission to use this endpoint.</p>\n<p>In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
"description": "<p>Accepted</p>"
},
{
"httpStatusCode": "400",
"description": "<p>Bad Request</p>"
},
{
"httpStatusCode": "403",
"description": "<p>Forbidden</p>"
},
{
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
},
{
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
]
}
]
},

19
src/rest/data/ghes-3.9-2022-11-28/schema.json
View File

@@ -202586,7 +202586,7 @@
"serverUrl": "http(s)://HOSTNAME",
"verb": "get",
"requestPath": "/manage/v1/config/nodes",
"title": "Get all GHES node metadata for all nodes",
"title": "Get GHES node metadata for all nodes",
"category": "enterprise-admin",
"subcategory": "manage-ghes",
"parameters": [
@@ -202668,6 +202668,9 @@
"uuid": {
"type": "string"
},
"replica": {
"type": "boolean"
},
"cluster_roles": {
"type": "array",
"items": {
@@ -202700,7 +202703,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Get all node metadata for existing nodes in the current cluster. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/admin/enterprise-management/configuring-clustering/about-clustering\">About clustering</a>.\"</p>",
"descriptionHTML": "<p>Get node metadata for all configured nodes in the current cluster. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/admin/enterprise-management/configuring-clustering/about-clustering\">About clustering</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -202709,6 +202712,10 @@
{
"httpStatusCode": "401",
"description": "<p>Unauthorized</p>"
},
{
"httpStatusCode": "500",
"description": "<p>Internal error</p>"
}
]
},
@@ -202878,6 +202885,10 @@
{
"httpStatusCode": "401",
"description": "<p>Unauthorized</p>"
},
{
"httpStatusCode": "500",
"description": "<p>Internal error</p>"
}
]
},
@@ -202985,6 +202996,10 @@
{
"httpStatusCode": "401",
"description": "<p>Unauthorized</p>"
},
{
"httpStatusCode": "500",
"description": "<p>Internal error</p>"
}
]
}

2
src/rest/lib/config.json
View File

@@ -33,5 +33,5 @@
]
}
},
"sha": "902841d79e04ac06ca03c8499a6fe4d32cd39370"
"sha": "af631f687d9e4aedb65f9351d66a955b63f56f15"
}

2
src/webhooks/lib/config.json
View File

@@ -1,3 +1,3 @@
{
"sha": "902841d79e04ac06ca03c8499a6fe4d32cd39370"
"sha": "af631f687d9e4aedb65f9351d66a955b63f56f15"
}