Update OpenAPI Description (#58833)
Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com>
This commit is contained in:
docs-bot
@@ -2736,6 +2736,15 @@
|
||||
"title": "Organization dismissal requests for Dependabot",
|
||||
"displayTitle": "Organization permissions for \"Organization dismissal requests for Dependabot\"",
|
||||
"permissions": [
|
||||
{
|
||||
"category": "dependabot",
|
||||
"slug": "list-dismissal-requests-for-dependabot-alerts-for-an-organization",
|
||||
"subcategory": "alert-dismissal-requests",
|
||||
"verb": "get",
|
||||
"requestPath": "/orgs/{org}/dismissal-requests/dependabot",
|
||||
"additional-permissions": false,
|
||||
"access": "read"
|
||||
},
|
||||
{
|
||||
"category": "dependabot",
|
||||
"slug": "review-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
|
||||
|
||||
@@ -2286,6 +2286,12 @@
|
||||
"verb": "delete",
|
||||
"requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}"
|
||||
},
|
||||
{
|
||||
"slug": "list-dismissal-requests-for-dependabot-alerts-for-an-organization",
|
||||
"subcategory": "alert-dismissal-requests",
|
||||
"verb": "get",
|
||||
"requestPath": "/orgs/{org}/dismissal-requests/dependabot"
|
||||
},
|
||||
{
|
||||
"slug": "list-dependabot-alerts-for-a-repository",
|
||||
"subcategory": "alerts",
|
||||
|
||||
@@ -3817,6 +3817,17 @@
|
||||
"title": "Organization dismissal requests for Dependabot",
|
||||
"displayTitle": "Organization permissions for \"Organization dismissal requests for Dependabot\"",
|
||||
"permissions": [
|
||||
{
|
||||
"category": "dependabot",
|
||||
"slug": "list-dismissal-requests-for-dependabot-alerts-for-an-organization",
|
||||
"subcategory": "alert-dismissal-requests",
|
||||
"verb": "get",
|
||||
"requestPath": "/orgs/{org}/dismissal-requests/dependabot",
|
||||
"access": "read",
|
||||
"user-to-server": true,
|
||||
"server-to-server": true,
|
||||
"additional-permissions": false
|
||||
},
|
||||
{
|
||||
"category": "dependabot",
|
||||
"slug": "review-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
|
||||
|
||||
@@ -2270,6 +2270,12 @@
|
||||
"verb": "delete",
|
||||
"requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}"
|
||||
},
|
||||
{
|
||||
"slug": "list-dismissal-requests-for-dependabot-alerts-for-an-organization",
|
||||
"subcategory": "alert-dismissal-requests",
|
||||
"verb": "get",
|
||||
"requestPath": "/orgs/{org}/dismissal-requests/dependabot"
|
||||
},
|
||||
{
|
||||
"slug": "list-dependabot-alerts-for-a-repository",
|
||||
"subcategory": "alerts",
|
||||
|
||||
@@ -2518,6 +2518,12 @@
|
||||
"verb": "delete",
|
||||
"requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}"
|
||||
},
|
||||
{
|
||||
"slug": "list-dismissal-requests-for-dependabot-alerts-for-an-organization",
|
||||
"subcategory": "alert-dismissal-requests",
|
||||
"verb": "get",
|
||||
"requestPath": "/orgs/{org}/dismissal-requests/dependabot"
|
||||
},
|
||||
{
|
||||
"slug": "list-dependabot-alerts-for-a-repository",
|
||||
"subcategory": "alerts",
|
||||
|
||||
@@ -1479,6 +1479,15 @@
|
||||
"title": "Organization dismissal requests for Dependabot",
|
||||
"displayTitle": "Organization permissions for \"Organization dismissal requests for Dependabot\"",
|
||||
"permissions": [
|
||||
{
|
||||
"category": "dependabot",
|
||||
"slug": "list-dismissal-requests-for-dependabot-alerts-for-an-organization",
|
||||
"subcategory": "alert-dismissal-requests",
|
||||
"verb": "get",
|
||||
"requestPath": "/orgs/{org}/dismissal-requests/dependabot",
|
||||
"additional-permissions": false,
|
||||
"access": "read"
|
||||
},
|
||||
{
|
||||
"category": "dependabot",
|
||||
"slug": "review-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
|
||||
|
||||
@@ -1650,6 +1650,12 @@
|
||||
"verb": "delete",
|
||||
"requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}"
|
||||
},
|
||||
{
|
||||
"slug": "list-dismissal-requests-for-dependabot-alerts-for-an-organization",
|
||||
"subcategory": "alert-dismissal-requests",
|
||||
"verb": "get",
|
||||
"requestPath": "/orgs/{org}/dismissal-requests/dependabot"
|
||||
},
|
||||
{
|
||||
"slug": "list-dependabot-alerts-for-a-repository",
|
||||
"subcategory": "alerts",
|
||||
|
||||
@@ -2171,6 +2171,17 @@
|
||||
"title": "Organization dismissal requests for Dependabot",
|
||||
"displayTitle": "Organization permissions for \"Organization dismissal requests for Dependabot\"",
|
||||
"permissions": [
|
||||
{
|
||||
"category": "dependabot",
|
||||
"slug": "list-dismissal-requests-for-dependabot-alerts-for-an-organization",
|
||||
"subcategory": "alert-dismissal-requests",
|
||||
"verb": "get",
|
||||
"requestPath": "/orgs/{org}/dismissal-requests/dependabot",
|
||||
"access": "read",
|
||||
"user-to-server": true,
|
||||
"server-to-server": true,
|
||||
"additional-permissions": false
|
||||
},
|
||||
{
|
||||
"category": "dependabot",
|
||||
"slug": "review-a-dismissal-request-for-a-dependabot-alert-for-a-repository",
|
||||
|
||||
@@ -1790,6 +1790,12 @@
|
||||
"verb": "delete",
|
||||
"requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}"
|
||||
},
|
||||
{
|
||||
"slug": "list-dismissal-requests-for-dependabot-alerts-for-an-organization",
|
||||
"subcategory": "alert-dismissal-requests",
|
||||
"verb": "get",
|
||||
"requestPath": "/orgs/{org}/dismissal-requests/dependabot"
|
||||
},
|
||||
{
|
||||
"slug": "list-dependabot-alerts-for-a-repository",
|
||||
"subcategory": "alerts",
|
||||
|
||||
@@ -1838,6 +1838,12 @@
|
||||
"verb": "delete",
|
||||
"requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}"
|
||||
},
|
||||
{
|
||||
"slug": "list-dismissal-requests-for-dependabot-alerts-for-an-organization",
|
||||
"subcategory": "alert-dismissal-requests",
|
||||
"verb": "get",
|
||||
"requestPath": "/orgs/{org}/dismissal-requests/dependabot"
|
||||
},
|
||||
{
|
||||
"slug": "list-dependabot-alerts-for-a-repository",
|
||||
"subcategory": "alerts",
|
||||
|
||||
@@ -60,5 +60,5 @@
|
||||
"2022-11-28"
|
||||
]
|
||||
},
|
||||
"sha": "36293de54d74df13b35b662263d6c010c83de3e6"
|
||||
"sha": "b1e772fd7deb79fdcde54863353275d990299269"
|
||||
}
|
||||
@@ -45150,7 +45150,7 @@
|
||||
"type": "object",
|
||||
"name": "inputs",
|
||||
"in": "body",
|
||||
"description": "<p>Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when <code>inputs</code> are omitted.</p>"
|
||||
"description": "<p>Input keys and values configured in the workflow file. The maximum number of properties is 25. Any default properties configured in the workflow file will be used when <code>inputs</code> are omitted.</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>.</p>\n<p>You must configure your GitHub Actions workflow to run when the <a href=\"/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch\"><code>workflow_dispatch</code> webhook</a> event occurs. The <code>inputs</code> are configured in the workflow file. For more information about how to configure the <code>workflow_dispatch</code> event in the workflow file, see \"<a href=\"/actions/reference/events-that-trigger-workflows#workflow_dispatch\">Events that trigger workflows</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
|
||||
@@ -55155,7 +55155,7 @@
|
||||
"type": "object",
|
||||
"name": "inputs",
|
||||
"in": "body",
|
||||
"description": "<p>Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when <code>inputs</code> are omitted.</p>"
|
||||
"description": "<p>Input keys and values configured in the workflow file. The maximum number of properties is 25. Any default properties configured in the workflow file will be used when <code>inputs</code> are omitted.</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>.</p>\n<p>You must configure your GitHub Actions workflow to run when the <a href=\"/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch\"><code>workflow_dispatch</code> webhook</a> event occurs. The <code>inputs</code> are configured in the workflow file. For more information about how to configure the <code>workflow_dispatch</code> event in the workflow file, see \"<a href=\"/actions/reference/events-that-trigger-workflows#workflow_dispatch\">Events that trigger workflows</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
|
||||
@@ -335582,6 +335582,441 @@
|
||||
},
|
||||
"dependabot": {
|
||||
"alert-dismissal-requests": [
|
||||
{
|
||||
"serverUrl": "https://api.github.com",
|
||||
"verb": "get",
|
||||
"requestPath": "/orgs/{org}/dismissal-requests/dependabot",
|
||||
"title": "List dismissal requests for Dependabot alerts for an organization",
|
||||
"category": "dependabot",
|
||||
"subcategory": "alert-dismissal-requests",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "org",
|
||||
"description": "<p>The organization name. The name is not case sensitive.</p>",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "repository_name",
|
||||
"description": "<p>The name of the repository to filter on.</p>",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "reviewer",
|
||||
"description": "<p>Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.</p>",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "requester",
|
||||
"description": "<p>Filter bypass requests by the handle of the GitHub user who requested the bypass.</p>",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "time_period",
|
||||
"description": "<p>The time period to filter by.</p>\n<p>For example, <code>day</code> will filter for rule suites that occurred in the past 24 hours, and <code>week</code> will filter for rule suites that occurred in the past 7 days (168 hours).</p>",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"hour",
|
||||
"day",
|
||||
"week",
|
||||
"month"
|
||||
],
|
||||
"default": "day"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "request_status",
|
||||
"description": "<p>The status of the dismissal request to filter on. When specified, only requests with this status will be returned.</p>",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"completed",
|
||||
"cancelled",
|
||||
"approved",
|
||||
"expired",
|
||||
"denied",
|
||||
"open",
|
||||
"all"
|
||||
],
|
||||
"default": "all"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "<p>The number of results per page (max 100). For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 30
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
"description": "<p>The page number of the results to fetch. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 1
|
||||
}
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists dismissal requests for Dependabot alerts in an organization.</p>\n<p>Delegated alert dismissal must be enabled on repositories in the org and the user must be an org admin, security manager,\nor have the appropriate permission to access this endpoint.\nPersonal access tokens (classic) need the <code>security_events</code> scope to use this endpoint.</p>",
|
||||
"codeExamples": [
|
||||
{
|
||||
"key": "default",
|
||||
"request": {
|
||||
"description": "Example",
|
||||
"acceptHeader": "application/vnd.github.v3+json",
|
||||
"parameters": {
|
||||
"org": "ORG"
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"statusCode": "200",
|
||||
"contentType": "application/json",
|
||||
"description": "<p>A list of alert dismissal requests.</p>",
|
||||
"example": [
|
||||
{
|
||||
"id": 21,
|
||||
"number": 42,
|
||||
"repository": {
|
||||
"id": 1,
|
||||
"name": "smile",
|
||||
"full_name": "octo-org/smile"
|
||||
},
|
||||
"organization": {
|
||||
"id": 1,
|
||||
"name": "octo-org"
|
||||
},
|
||||
"requester": {
|
||||
"actor_id": 12,
|
||||
"actor_name": "monalisa"
|
||||
},
|
||||
"request_type": "dependabot_alert_dismissal",
|
||||
"data": [
|
||||
{
|
||||
"reason": "no_bandwidth",
|
||||
"alert_number": "1",
|
||||
"alert_title": "lodash - GHSA-1234-abcd-5678"
|
||||
}
|
||||
],
|
||||
"resource_identifier": "1",
|
||||
"status": "denied",
|
||||
"requester_comment": "No bandwidth to fix this right now",
|
||||
"expires_at": "2024-07-08T08:43:03Z",
|
||||
"created_at": "2024-07-01T08:43:03Z",
|
||||
"responses": [
|
||||
{
|
||||
"id": 42,
|
||||
"reviewer": {
|
||||
"actor_id": 4,
|
||||
"actor_name": "octocat"
|
||||
},
|
||||
"status": "denied",
|
||||
"created_at": "2024-07-02T08:43:04Z"
|
||||
}
|
||||
],
|
||||
"url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/dependabot/1",
|
||||
"html_url": "https://github.com/octo-org/smile/security/dependabot/1"
|
||||
},
|
||||
{
|
||||
"id": 12,
|
||||
"number": 24,
|
||||
"repository": {
|
||||
"id": 1,
|
||||
"name": "smile",
|
||||
"full_name": "octo-org/smile"
|
||||
},
|
||||
"organization": {
|
||||
"id": 1,
|
||||
"name": "octo-org"
|
||||
},
|
||||
"requester": {
|
||||
"actor_id": 12,
|
||||
"actor_name": "monalisa"
|
||||
},
|
||||
"request_type": "dependabot_alert_dismissal",
|
||||
"data": [
|
||||
{
|
||||
"reason": "tolerable_risk",
|
||||
"alert_number": "2",
|
||||
"alert_title": "axios - GHSA-5678-efgh-9012"
|
||||
}
|
||||
],
|
||||
"resource_identifier": "2",
|
||||
"status": "approved",
|
||||
"requester_comment": "Risk is acceptable for this internal tool",
|
||||
"expires_at": "2024-07-08T07:43:03Z",
|
||||
"created_at": "2024-07-01T07:43:03Z",
|
||||
"responses": [
|
||||
{
|
||||
"id": 43,
|
||||
"reviewer": {
|
||||
"actor_id": 4,
|
||||
"actor_name": "octocat"
|
||||
},
|
||||
"status": "approved",
|
||||
"created_at": "2024-07-02T08:43:04Z"
|
||||
}
|
||||
],
|
||||
"url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/dependabot/2",
|
||||
"html_url": "https://github.com/octo-org/smile/security/dependabot/2"
|
||||
}
|
||||
],
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"title": "Dependabot alert dismissal request",
|
||||
"description": "Alert dismissal request made by a user asking to dismiss a Dependabot alert.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"format": "int64",
|
||||
"description": "The unique identifier of the dismissal request."
|
||||
},
|
||||
"number": {
|
||||
"type": "integer",
|
||||
"format": "int64",
|
||||
"description": "The number uniquely identifying the dismissal request within its repository."
|
||||
},
|
||||
"repository": {
|
||||
"type": "object",
|
||||
"description": "The repository the dismissal request is for.",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"format": "int64",
|
||||
"description": "The ID of the repository the dismissal request is for."
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The name of the repository the dismissal request is for."
|
||||
},
|
||||
"full_name": {
|
||||
"type": "string",
|
||||
"description": "The full name of the repository the dismissal request is for."
|
||||
}
|
||||
}
|
||||
},
|
||||
"organization": {
|
||||
"type": "object",
|
||||
"description": "The organization associated with the repository the dismissal request is for.",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"format": "int64",
|
||||
"description": "The ID of the organization."
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The name of the organization."
|
||||
}
|
||||
}
|
||||
},
|
||||
"requester": {
|
||||
"type": "object",
|
||||
"description": "The user who requested the dismissal request.",
|
||||
"properties": {
|
||||
"actor_id": {
|
||||
"type": "integer",
|
||||
"format": "int64",
|
||||
"description": "The ID of the GitHub user who requested the dismissal request."
|
||||
},
|
||||
"actor_name": {
|
||||
"type": "string",
|
||||
"description": "The name of the GitHub user who requested the dismissal request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"request_type": {
|
||||
"type": "string",
|
||||
"description": "The type of request."
|
||||
},
|
||||
"data": {
|
||||
"type": [
|
||||
"array",
|
||||
"null"
|
||||
],
|
||||
"description": "Data describing the dismissal request metadata.",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"reason": {
|
||||
"type": "string",
|
||||
"description": "The reason for the dismissal request."
|
||||
},
|
||||
"alert_number": {
|
||||
"type": "string",
|
||||
"description": "The alert number."
|
||||
},
|
||||
"alert_title": {
|
||||
"type": "string",
|
||||
"description": "The title of the alert."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"resource_identifier": {
|
||||
"type": "string",
|
||||
"description": "The unique identifier for the request type of the dismissal request.",
|
||||
"examples": [
|
||||
"123"
|
||||
]
|
||||
},
|
||||
"status": {
|
||||
"type": "string",
|
||||
"description": "The status of the dismissal request.",
|
||||
"enum": [
|
||||
"pending",
|
||||
"denied",
|
||||
"approved",
|
||||
"expired"
|
||||
]
|
||||
},
|
||||
"requester_comment": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
],
|
||||
"description": "The comment the requester provided when creating the dismissal request."
|
||||
},
|
||||
"expires_at": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"description": "The date and time the dismissal request will expire."
|
||||
},
|
||||
"created_at": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"description": "The date and time the dismissal request was created."
|
||||
},
|
||||
"responses": {
|
||||
"type": [
|
||||
"array",
|
||||
"null"
|
||||
],
|
||||
"description": "The responses to the dismissal request.",
|
||||
"items": {
|
||||
"title": "Dismissal request response",
|
||||
"description": "A response made by a requester to dismiss the request.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"format": "int64",
|
||||
"description": "The ID of the response to the dismissal request."
|
||||
},
|
||||
"reviewer": {
|
||||
"type": "object",
|
||||
"description": "The user who reviewed the dismissal request.",
|
||||
"properties": {
|
||||
"actor_id": {
|
||||
"type": "integer",
|
||||
"format": "int64",
|
||||
"description": "The ID of the GitHub user who reviewed the dismissal request."
|
||||
},
|
||||
"actor_name": {
|
||||
"type": "string",
|
||||
"description": "The name of the GitHub user who reviewed the dismissal request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"message": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
],
|
||||
"description": "The response comment of the reviewer."
|
||||
},
|
||||
"status": {
|
||||
"type": "string",
|
||||
"description": "The response status to the dismissal request until dismissed.",
|
||||
"enum": [
|
||||
"approved",
|
||||
"denied",
|
||||
"dismissed"
|
||||
]
|
||||
},
|
||||
"created_at": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"description": "The date and time the response to the dismissal request was created."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"type": "string",
|
||||
"format": "uri",
|
||||
"examples": [
|
||||
"https://api.github.com/repos/octo-org/smile/dismissal-requests/dependabot/1"
|
||||
]
|
||||
},
|
||||
"html_url": {
|
||||
"type": "string",
|
||||
"description": "The URL to view the dismissal request in a browser.",
|
||||
"format": "uri",
|
||||
"examples": [
|
||||
"https://github.com/octo-org/smile/security/dependabot/1"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>A list of alert dismissal requests.</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "403",
|
||||
"description": "<p>Forbidden</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "500",
|
||||
"description": "<p>Internal Error</p>"
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"progAccess": {
|
||||
"userToServerRest": true,
|
||||
"serverToServer": true,
|
||||
"fineGrainedPat": true,
|
||||
"permissions": [
|
||||
{
|
||||
"\"Organization dismissal requests for Dependabot\" organization permissions": "read"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"serverUrl": "https://api.github.com",
|
||||
"verb": "get",
|
||||
|
||||
@@ -369337,6 +369337,441 @@
|
||||
},
|
||||
"dependabot": {
|
||||
"alert-dismissal-requests": [
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
"verb": "get",
|
||||
"requestPath": "/orgs/{org}/dismissal-requests/dependabot",
|
||||
"title": "List dismissal requests for Dependabot alerts for an organization",
|
||||
"category": "dependabot",
|
||||
"subcategory": "alert-dismissal-requests",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "org",
|
||||
"description": "<p>The organization name. The name is not case sensitive.</p>",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "repository_name",
|
||||
"description": "<p>The name of the repository to filter on.</p>",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "reviewer",
|
||||
"description": "<p>Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.</p>",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "requester",
|
||||
"description": "<p>Filter bypass requests by the handle of the GitHub user who requested the bypass.</p>",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "time_period",
|
||||
"description": "<p>The time period to filter by.</p>\n<p>For example, <code>day</code> will filter for rule suites that occurred in the past 24 hours, and <code>week</code> will filter for rule suites that occurred in the past 7 days (168 hours).</p>",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"hour",
|
||||
"day",
|
||||
"week",
|
||||
"month"
|
||||
],
|
||||
"default": "day"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "request_status",
|
||||
"description": "<p>The status of the dismissal request to filter on. When specified, only requests with this status will be returned.</p>",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"completed",
|
||||
"cancelled",
|
||||
"approved",
|
||||
"expired",
|
||||
"denied",
|
||||
"open",
|
||||
"all"
|
||||
],
|
||||
"default": "all"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "<p>The number of results per page (max 100). For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.19/rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 30
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
"description": "<p>The page number of the results to fetch. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.19/rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 1
|
||||
}
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists dismissal requests for Dependabot alerts in an organization.</p>\n<p>Delegated alert dismissal must be enabled on repositories in the org and the user must be an org admin, security manager,\nor have the appropriate permission to access this endpoint.\nPersonal access tokens (classic) need the <code>security_events</code> scope to use this endpoint.</p>",
|
||||
"codeExamples": [
|
||||
{
|
||||
"key": "default",
|
||||
"request": {
|
||||
"description": "Example",
|
||||
"acceptHeader": "application/vnd.github.v3+json",
|
||||
"parameters": {
|
||||
"org": "ORG"
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"statusCode": "200",
|
||||
"contentType": "application/json",
|
||||
"description": "<p>A list of alert dismissal requests.</p>",
|
||||
"example": [
|
||||
{
|
||||
"id": 21,
|
||||
"number": 42,
|
||||
"repository": {
|
||||
"id": 1,
|
||||
"name": "smile",
|
||||
"full_name": "octo-org/smile"
|
||||
},
|
||||
"organization": {
|
||||
"id": 1,
|
||||
"name": "octo-org"
|
||||
},
|
||||
"requester": {
|
||||
"actor_id": 12,
|
||||
"actor_name": "monalisa"
|
||||
},
|
||||
"request_type": "dependabot_alert_dismissal",
|
||||
"data": [
|
||||
{
|
||||
"reason": "no_bandwidth",
|
||||
"alert_number": "1",
|
||||
"alert_title": "lodash - GHSA-1234-abcd-5678"
|
||||
}
|
||||
],
|
||||
"resource_identifier": "1",
|
||||
"status": "denied",
|
||||
"requester_comment": "No bandwidth to fix this right now",
|
||||
"expires_at": "2024-07-08T08:43:03Z",
|
||||
"created_at": "2024-07-01T08:43:03Z",
|
||||
"responses": [
|
||||
{
|
||||
"id": 42,
|
||||
"reviewer": {
|
||||
"actor_id": 4,
|
||||
"actor_name": "octocat"
|
||||
},
|
||||
"status": "denied",
|
||||
"created_at": "2024-07-02T08:43:04Z"
|
||||
}
|
||||
],
|
||||
"url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/dependabot/1",
|
||||
"html_url": "https://github.com/octo-org/smile/security/dependabot/1"
|
||||
},
|
||||
{
|
||||
"id": 12,
|
||||
"number": 24,
|
||||
"repository": {
|
||||
"id": 1,
|
||||
"name": "smile",
|
||||
"full_name": "octo-org/smile"
|
||||
},
|
||||
"organization": {
|
||||
"id": 1,
|
||||
"name": "octo-org"
|
||||
},
|
||||
"requester": {
|
||||
"actor_id": 12,
|
||||
"actor_name": "monalisa"
|
||||
},
|
||||
"request_type": "dependabot_alert_dismissal",
|
||||
"data": [
|
||||
{
|
||||
"reason": "tolerable_risk",
|
||||
"alert_number": "2",
|
||||
"alert_title": "axios - GHSA-5678-efgh-9012"
|
||||
}
|
||||
],
|
||||
"resource_identifier": "2",
|
||||
"status": "approved",
|
||||
"requester_comment": "Risk is acceptable for this internal tool",
|
||||
"expires_at": "2024-07-08T07:43:03Z",
|
||||
"created_at": "2024-07-01T07:43:03Z",
|
||||
"responses": [
|
||||
{
|
||||
"id": 43,
|
||||
"reviewer": {
|
||||
"actor_id": 4,
|
||||
"actor_name": "octocat"
|
||||
},
|
||||
"status": "approved",
|
||||
"created_at": "2024-07-02T08:43:04Z"
|
||||
}
|
||||
],
|
||||
"url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/dependabot/2",
|
||||
"html_url": "https://github.com/octo-org/smile/security/dependabot/2"
|
||||
}
|
||||
],
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"title": "Dependabot alert dismissal request",
|
||||
"description": "Alert dismissal request made by a user asking to dismiss a Dependabot alert.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"format": "int64",
|
||||
"description": "The unique identifier of the dismissal request."
|
||||
},
|
||||
"number": {
|
||||
"type": "integer",
|
||||
"format": "int64",
|
||||
"description": "The number uniquely identifying the dismissal request within its repository."
|
||||
},
|
||||
"repository": {
|
||||
"type": "object",
|
||||
"description": "The repository the dismissal request is for.",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"format": "int64",
|
||||
"description": "The ID of the repository the dismissal request is for."
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The name of the repository the dismissal request is for."
|
||||
},
|
||||
"full_name": {
|
||||
"type": "string",
|
||||
"description": "The full name of the repository the dismissal request is for."
|
||||
}
|
||||
}
|
||||
},
|
||||
"organization": {
|
||||
"type": "object",
|
||||
"description": "The organization associated with the repository the dismissal request is for.",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"format": "int64",
|
||||
"description": "The ID of the organization."
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The name of the organization."
|
||||
}
|
||||
}
|
||||
},
|
||||
"requester": {
|
||||
"type": "object",
|
||||
"description": "The user who requested the dismissal request.",
|
||||
"properties": {
|
||||
"actor_id": {
|
||||
"type": "integer",
|
||||
"format": "int64",
|
||||
"description": "The ID of the GitHub user who requested the dismissal request."
|
||||
},
|
||||
"actor_name": {
|
||||
"type": "string",
|
||||
"description": "The name of the GitHub user who requested the dismissal request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"request_type": {
|
||||
"type": "string",
|
||||
"description": "The type of request."
|
||||
},
|
||||
"data": {
|
||||
"type": [
|
||||
"array",
|
||||
"null"
|
||||
],
|
||||
"description": "Data describing the dismissal request metadata.",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"reason": {
|
||||
"type": "string",
|
||||
"description": "The reason for the dismissal request."
|
||||
},
|
||||
"alert_number": {
|
||||
"type": "string",
|
||||
"description": "The alert number."
|
||||
},
|
||||
"alert_title": {
|
||||
"type": "string",
|
||||
"description": "The title of the alert."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"resource_identifier": {
|
||||
"type": "string",
|
||||
"description": "The unique identifier for the request type of the dismissal request.",
|
||||
"examples": [
|
||||
"123"
|
||||
]
|
||||
},
|
||||
"status": {
|
||||
"type": "string",
|
||||
"description": "The status of the dismissal request.",
|
||||
"enum": [
|
||||
"pending",
|
||||
"denied",
|
||||
"approved",
|
||||
"expired"
|
||||
]
|
||||
},
|
||||
"requester_comment": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
],
|
||||
"description": "The comment the requester provided when creating the dismissal request."
|
||||
},
|
||||
"expires_at": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"description": "The date and time the dismissal request will expire."
|
||||
},
|
||||
"created_at": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"description": "The date and time the dismissal request was created."
|
||||
},
|
||||
"responses": {
|
||||
"type": [
|
||||
"array",
|
||||
"null"
|
||||
],
|
||||
"description": "The responses to the dismissal request.",
|
||||
"items": {
|
||||
"title": "Dismissal request response",
|
||||
"description": "A response made by a requester to dismiss the request.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"format": "int64",
|
||||
"description": "The ID of the response to the dismissal request."
|
||||
},
|
||||
"reviewer": {
|
||||
"type": "object",
|
||||
"description": "The user who reviewed the dismissal request.",
|
||||
"properties": {
|
||||
"actor_id": {
|
||||
"type": "integer",
|
||||
"format": "int64",
|
||||
"description": "The ID of the GitHub user who reviewed the dismissal request."
|
||||
},
|
||||
"actor_name": {
|
||||
"type": "string",
|
||||
"description": "The name of the GitHub user who reviewed the dismissal request."
|
||||
}
|
||||
}
|
||||
},
|
||||
"message": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
],
|
||||
"description": "The response comment of the reviewer."
|
||||
},
|
||||
"status": {
|
||||
"type": "string",
|
||||
"description": "The response status to the dismissal request until dismissed.",
|
||||
"enum": [
|
||||
"approved",
|
||||
"denied",
|
||||
"dismissed"
|
||||
]
|
||||
},
|
||||
"created_at": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"description": "The date and time the response to the dismissal request was created."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"type": "string",
|
||||
"format": "uri",
|
||||
"examples": [
|
||||
"https://api.github.com/repos/octo-org/smile/dismissal-requests/dependabot/1"
|
||||
]
|
||||
},
|
||||
"html_url": {
|
||||
"type": "string",
|
||||
"description": "The URL to view the dismissal request in a browser.",
|
||||
"format": "uri",
|
||||
"examples": [
|
||||
"https://github.com/octo-org/smile/security/dependabot/1"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>A list of alert dismissal requests.</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "403",
|
||||
"description": "<p>Forbidden</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "500",
|
||||
"description": "<p>Internal Error</p>"
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"progAccess": {
|
||||
"userToServerRest": true,
|
||||
"serverToServer": true,
|
||||
"fineGrainedPat": true,
|
||||
"permissions": [
|
||||
{
|
||||
"\"Organization dismissal requests for Dependabot\" organization permissions": "read"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
"verb": "get",
|
||||
|
||||
@@ -50,5 +50,5 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"sha": "36293de54d74df13b35b662263d6c010c83de3e6"
|
||||
"sha": "b1e772fd7deb79fdcde54863353275d990299269"
|
||||
}
|
||||
@@ -1,3 +1,3 @@
|
||||
{
|
||||
"sha": "36293de54d74df13b35b662263d6c010c83de3e6"
|
||||
"sha": "b1e772fd7deb79fdcde54863353275d990299269"
|
||||
}
|
||||
Reference in New Issue
Block a user