diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index f5cf56c3ca..0520b12e43 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -702699,7 +702699,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -702821,6 +702822,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -702854,7 +702882,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -702895,6 +702923,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -704977,7 +705025,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -705099,6 +705148,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -705132,7 +705208,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -705173,6 +705249,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -707255,7 +707351,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -707377,6 +707474,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -707410,7 +707534,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -707451,6 +707575,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -709533,7 +709677,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -709655,6 +709800,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -709688,7 +709860,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -709729,6 +709901,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -711852,7 +712044,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -711974,6 +712167,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -712007,7 +712227,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -712048,6 +712268,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -714171,7 +714411,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -714293,6 +714534,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -714326,7 +714594,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -714367,6 +714635,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -716449,7 +716737,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -716571,6 +716860,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -716604,7 +716920,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -716645,6 +716961,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -718727,7 +719063,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -718849,6 +719186,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -718882,7 +719246,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -718923,6 +719287,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -721005,7 +721389,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -721127,6 +721512,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -721160,7 +721572,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -721201,6 +721613,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -723324,7 +723756,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -723446,6 +723879,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -723479,7 +723939,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -723520,6 +723980,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -870691,13 +871171,13 @@ } } }, - "dismissal-request-secret-scanning-cancelled": { + "dismissal-request-code-scanning-created": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal request was canceled.", - "operationId": "dismissal-request-secret-scanning/cancelled", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "description": "A code scanning alert dismissal request was created.", + "operationId": "dismissal-request-code-scanning/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" }, "parameters": [ { @@ -870762,13 +871242,13 @@ "content": { "application/json": { "schema": { - "title": "Exemption request cancellation event", + "title": "Exemption request created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "cancelled" + "created" ] }, "enterprise": { @@ -872508,7 +872988,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -872630,6 +873111,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -872663,7 +873171,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -872704,6 +873212,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -872960,7 +873488,7 @@ "x-github": { "githubCloudOnly": true, "category": "webhooks", - "subcategory": "dismissal_request_secret_scanning", + "subcategory": "dismissal_request_code_scanning", "supported-webhook-types": [ "repository", "organization", @@ -872969,13 +873497,13 @@ } } }, - "dismissal-request-secret-scanning-completed": { + "dismissal-request-code-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal request was completed.", - "operationId": "dismissal-request-secret-scanning/completed", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "description": "A code scanning alert dismissal response was submitted.", + "operationId": "dismissal-request-code-scanning/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" }, "parameters": [ { @@ -873040,13 +873568,13 @@ "content": { "application/json": { "schema": { - "title": "Exemption request completed event", + "title": "Exemption response submitted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "completed" + "response_submitted" ] }, "enterprise": { @@ -874786,7 +875314,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -874908,6 +875437,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -874941,7 +875497,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -874982,6 +875538,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -875052,6 +875628,46 @@ } } }, + "exemption_response": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -875224,6 +875840,7 @@ "required": [ "action", "exemption_request", + "exemption_response", "sender" ] } @@ -875238,7 +875855,7 @@ "x-github": { "githubCloudOnly": true, "category": "webhooks", - "subcategory": "dismissal_request_secret_scanning", + "subcategory": "dismissal_request_code_scanning", "supported-webhook-types": [ "repository", "organization", @@ -875247,11 +875864,4663 @@ } } }, - "dismissal-request-secret-scanning-created": { + "dismissal-request-secret-scanning-cancelled": { "post": { "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal request was created.", - "operationId": "dismissal-request-secret-scanning/created", + "description": "A secret scanning alert dismissal request was canceled.", + "operationId": "dismissal-request-secret-scanning/cancelled", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Exemption request cancellation event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "cancelled" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": [ + "integer", + "null" + ], + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "locations": { + "type": "array", + "description": "The location data of the secret that was detected", + "items": { + "type": "object", + "properties": { + "commit": { + "type": "string", + "description": "The commit SHA where the secret was detected" + }, + "branch": { + "type": "string", + "description": "The branch where the secret was detected" + }, + "path": { + "type": "string", + "description": "The path of the file where the secret was detected" + } + } + } + } + } + } + } + } + }, + { + "title": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning_closure" + ] + }, + "data": { + "type": "array", + "description": "The data related to the secret scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "alert_number": { + "type": "string", + "description": "The number of the alert that was detected" + } + } + } + } + } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the exemption request." + }, + "metadata": { + "type": [ + "object", + "null" + ], + "description": "Metadata about the exemption request.", + "anyOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + }, + { + "title": "Secret scanning alert dismissal request metadata", + "description": "Metadata for a secret scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the secret alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + } + } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the exemption request.", + "items": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/monalisa/smile/exemptions/1" + ] + } + } + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "dismissal_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "dismissal-request-secret-scanning-completed": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", + "description": "A secret scanning alert dismissal request was completed.", + "operationId": "dismissal-request-secret-scanning/completed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Exemption request completed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "completed" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": [ + "integer", + "null" + ], + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "locations": { + "type": "array", + "description": "The location data of the secret that was detected", + "items": { + "type": "object", + "properties": { + "commit": { + "type": "string", + "description": "The commit SHA where the secret was detected" + }, + "branch": { + "type": "string", + "description": "The branch where the secret was detected" + }, + "path": { + "type": "string", + "description": "The path of the file where the secret was detected" + } + } + } + } + } + } + } + } + }, + { + "title": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning_closure" + ] + }, + "data": { + "type": "array", + "description": "The data related to the secret scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "alert_number": { + "type": "string", + "description": "The number of the alert that was detected" + } + } + } + } + } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the exemption request." + }, + "metadata": { + "type": [ + "object", + "null" + ], + "description": "Metadata about the exemption request.", + "anyOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + }, + { + "title": "Secret scanning alert dismissal request metadata", + "description": "Metadata for a secret scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the secret alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + } + } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the exemption request.", + "items": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/monalisa/smile/exemptions/1" + ] + } + } + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "dismissal_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "dismissal-request-secret-scanning-created": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", + "description": "A secret scanning alert dismissal request was created.", + "operationId": "dismissal-request-secret-scanning/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, @@ -877064,7 +882333,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -877186,6 +882456,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -877219,7 +882516,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -877260,6 +882557,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -879342,7 +884659,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -879464,6 +884782,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -879497,7 +884842,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -879538,6 +884883,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -881661,7 +887026,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -881783,6 +887149,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -881816,7 +887209,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -881857,6 +887250,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 26d36ece07..8c6d68e1b4 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -113676,6 +113676,7 @@ webhooks: - push_ruleset_bypass - secret_scanning - secret_scanning_closure + - code_scanning_alert_dismissal exemption_request_data: oneOf: - title: Push ruleset bypass exemption request data @@ -113769,6 +113770,25 @@ webhooks: alert_number: type: string description: The number of the alert that was detected + - title: Code scanning alert dismissal request data + description: Code scanning alerts that have dismissal requests. + type: object + properties: + type: + type: string + description: The type of request + enum: + - code_scanning_alert_dismissal + data: + type: array + description: The data related to the code scanning alerts + that have dismissal requests. + items: + type: object + properties: + alert_number: + type: string + description: The number of the alert to be dismissed resource_identifier: type: string description: The unique identifier for the request type of the @@ -113794,7 +113814,7 @@ webhooks: - object - 'null' description: Metadata about the exemption request. - oneOf: + anyOf: - title: Secret Scanning Push Protection Exemption Request Metadata description: Metadata for a secret scanning push protection exemption request. @@ -113826,6 +113846,21 @@ webhooks: - false_positive - tests - revoked + - title: Code scanning alert dismissal request metadata + description: Metadata for a code scanning alert dismissal + request. + type: object + properties: + alert_title: + type: string + description: The title of the code scanning alert + reason: + type: string + description: The reason for the dismissal request + enum: + - false positive + - won't fix + - used in tests expires_at: type: string format: date-time @@ -129822,6 +129857,138 @@ webhooks: - repository - organization - app + dismissal-request-code-scanning-created: + post: + summary: |- + This event occurs when there is activity related to a user's request to dismiss a code scanning alert. + + To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. + + > [!NOTE] + > Delegated alert dismissal for code scanning is currently in public preview and subject to change. + description: A code scanning alert dismissal request was created. + operationId: dismissal-request-code-scanning/created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: *733 + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: dismissal_request_code_scanning + supported-webhook-types: + - repository + - organization + - app + dismissal-request-code-scanning-response-submitted: + post: + summary: |- + This event occurs when there is activity related to a user's request to dismiss a code scanning alert. + + To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. + + > [!NOTE] + > Delegated alert dismissal for code scanning is currently in public preview and subject to change. + description: A code scanning alert dismissal response was submitted. + operationId: dismissal-request-code-scanning/response-submitted + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: *735 + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: dismissal_request_code_scanning + supported-webhook-types: + - repository + - organization + - app dismissal-request-secret-scanning-cancelled: post: summary: |- diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index f5cf56c3ca..0520b12e43 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -702699,7 +702699,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -702821,6 +702822,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -702854,7 +702882,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -702895,6 +702923,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -704977,7 +705025,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -705099,6 +705148,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -705132,7 +705208,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -705173,6 +705249,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -707255,7 +707351,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -707377,6 +707474,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -707410,7 +707534,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -707451,6 +707575,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -709533,7 +709677,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -709655,6 +709800,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -709688,7 +709860,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -709729,6 +709901,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -711852,7 +712044,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -711974,6 +712167,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -712007,7 +712227,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -712048,6 +712268,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -714171,7 +714411,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -714293,6 +714534,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -714326,7 +714594,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -714367,6 +714635,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -716449,7 +716737,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -716571,6 +716860,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -716604,7 +716920,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -716645,6 +716961,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -718727,7 +719063,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -718849,6 +719186,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -718882,7 +719246,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -718923,6 +719287,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -721005,7 +721389,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -721127,6 +721512,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -721160,7 +721572,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -721201,6 +721613,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -723324,7 +723756,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -723446,6 +723879,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -723479,7 +723939,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -723520,6 +723980,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -870691,13 +871171,13 @@ } } }, - "dismissal-request-secret-scanning-cancelled": { + "dismissal-request-code-scanning-created": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal request was canceled.", - "operationId": "dismissal-request-secret-scanning/cancelled", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "description": "A code scanning alert dismissal request was created.", + "operationId": "dismissal-request-code-scanning/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" }, "parameters": [ { @@ -870762,13 +871242,13 @@ "content": { "application/json": { "schema": { - "title": "Exemption request cancellation event", + "title": "Exemption request created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "cancelled" + "created" ] }, "enterprise": { @@ -872508,7 +872988,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -872630,6 +873111,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -872663,7 +873171,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -872704,6 +873212,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -872960,7 +873488,7 @@ "x-github": { "githubCloudOnly": true, "category": "webhooks", - "subcategory": "dismissal_request_secret_scanning", + "subcategory": "dismissal_request_code_scanning", "supported-webhook-types": [ "repository", "organization", @@ -872969,13 +873497,13 @@ } } }, - "dismissal-request-secret-scanning-completed": { + "dismissal-request-code-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal request was completed.", - "operationId": "dismissal-request-secret-scanning/completed", + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "description": "A code scanning alert dismissal response was submitted.", + "operationId": "dismissal-request-code-scanning/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" }, "parameters": [ { @@ -873040,13 +873568,13 @@ "content": { "application/json": { "schema": { - "title": "Exemption request completed event", + "title": "Exemption response submitted event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "completed" + "response_submitted" ] }, "enterprise": { @@ -874786,7 +875314,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -874908,6 +875437,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -874941,7 +875497,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -874982,6 +875538,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -875052,6 +875628,46 @@ } } }, + "exemption_response": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + }, "sender": { "title": "Simple User", "description": "A GitHub user.", @@ -875224,6 +875840,7 @@ "required": [ "action", "exemption_request", + "exemption_response", "sender" ] } @@ -875238,7 +875855,7 @@ "x-github": { "githubCloudOnly": true, "category": "webhooks", - "subcategory": "dismissal_request_secret_scanning", + "subcategory": "dismissal_request_code_scanning", "supported-webhook-types": [ "repository", "organization", @@ -875247,11 +875864,4663 @@ } } }, - "dismissal-request-secret-scanning-created": { + "dismissal-request-secret-scanning-cancelled": { "post": { "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", - "description": "A secret scanning alert dismissal request was created.", - "operationId": "dismissal-request-secret-scanning/created", + "description": "A secret scanning alert dismissal request was canceled.", + "operationId": "dismissal-request-secret-scanning/cancelled", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Exemption request cancellation event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "cancelled" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": [ + "integer", + "null" + ], + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "locations": { + "type": "array", + "description": "The location data of the secret that was detected", + "items": { + "type": "object", + "properties": { + "commit": { + "type": "string", + "description": "The commit SHA where the secret was detected" + }, + "branch": { + "type": "string", + "description": "The branch where the secret was detected" + }, + "path": { + "type": "string", + "description": "The path of the file where the secret was detected" + } + } + } + } + } + } + } + } + }, + { + "title": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning_closure" + ] + }, + "data": { + "type": "array", + "description": "The data related to the secret scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "alert_number": { + "type": "string", + "description": "The number of the alert that was detected" + } + } + } + } + } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the exemption request." + }, + "metadata": { + "type": [ + "object", + "null" + ], + "description": "Metadata about the exemption request.", + "anyOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + }, + { + "title": "Secret scanning alert dismissal request metadata", + "description": "Metadata for a secret scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the secret alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + } + } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the exemption request.", + "items": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/monalisa/smile/exemptions/1" + ] + } + } + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "dismissal_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "dismissal-request-secret-scanning-completed": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", + "description": "A secret scanning alert dismissal request was completed.", + "operationId": "dismissal-request-secret-scanning/completed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Exemption request completed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "completed" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": [ + "string", + "null" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/octo-business" + ] + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "examples": [ + "Octo Business" + ] + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "examples": [ + "octo-business" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2019-01-26T19:14:43Z" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" + ] + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "exemption_request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": [ + "integer", + "null" + ], + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning", + "secret_scanning_closure", + "code_scanning_alert_dismissal" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "locations": { + "type": "array", + "description": "The location data of the secret that was detected", + "items": { + "type": "object", + "properties": { + "commit": { + "type": "string", + "description": "The commit SHA where the secret was detected" + }, + "branch": { + "type": "string", + "description": "The branch where the secret was detected" + }, + "path": { + "type": "string", + "description": "The path of the file where the secret was detected" + } + } + } + } + } + } + } + } + }, + { + "title": "Secret scanning alert dismissal request data", + "description": "Secret scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning_closure" + ] + }, + "data": { + "type": "array", + "description": "The data related to the secret scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "alert_number": { + "type": "string", + "description": "The number of the alert that was detected" + } + } + } + } + } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the exemption request." + }, + "metadata": { + "type": [ + "object", + "null" + ], + "description": "Metadata about the exemption request.", + "anyOf": [ + { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + }, + { + "title": "Secret scanning alert dismissal request metadata", + "description": "Metadata for a secret scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the secret alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "fixed_later", + "false_positive", + "tests", + "revoked" + ] + } + } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the exemption request.", + "items": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/monalisa/smile/exemptions/1" + ] + } + } + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "dismissal_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "dismissal-request-secret-scanning-created": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", + "description": "A secret scanning alert dismissal request was created.", + "operationId": "dismissal-request-secret-scanning/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, @@ -877064,7 +882333,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -877186,6 +882456,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -877219,7 +882516,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -877260,6 +882557,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -879342,7 +884659,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -879464,6 +884782,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -879497,7 +884842,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -879538,6 +884883,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -881661,7 +887026,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -881783,6 +887149,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -881816,7 +887209,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -881857,6 +887250,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index 26d36ece07..8c6d68e1b4 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -113676,6 +113676,7 @@ webhooks: - push_ruleset_bypass - secret_scanning - secret_scanning_closure + - code_scanning_alert_dismissal exemption_request_data: oneOf: - title: Push ruleset bypass exemption request data @@ -113769,6 +113770,25 @@ webhooks: alert_number: type: string description: The number of the alert that was detected + - title: Code scanning alert dismissal request data + description: Code scanning alerts that have dismissal requests. + type: object + properties: + type: + type: string + description: The type of request + enum: + - code_scanning_alert_dismissal + data: + type: array + description: The data related to the code scanning alerts + that have dismissal requests. + items: + type: object + properties: + alert_number: + type: string + description: The number of the alert to be dismissed resource_identifier: type: string description: The unique identifier for the request type of the @@ -113794,7 +113814,7 @@ webhooks: - object - 'null' description: Metadata about the exemption request. - oneOf: + anyOf: - title: Secret Scanning Push Protection Exemption Request Metadata description: Metadata for a secret scanning push protection exemption request. @@ -113826,6 +113846,21 @@ webhooks: - false_positive - tests - revoked + - title: Code scanning alert dismissal request metadata + description: Metadata for a code scanning alert dismissal + request. + type: object + properties: + alert_title: + type: string + description: The title of the code scanning alert + reason: + type: string + description: The reason for the dismissal request + enum: + - false positive + - won't fix + - used in tests expires_at: type: string format: date-time @@ -129822,6 +129857,138 @@ webhooks: - repository - organization - app + dismissal-request-code-scanning-created: + post: + summary: |- + This event occurs when there is activity related to a user's request to dismiss a code scanning alert. + + To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. + + > [!NOTE] + > Delegated alert dismissal for code scanning is currently in public preview and subject to change. + description: A code scanning alert dismissal request was created. + operationId: dismissal-request-code-scanning/created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: *733 + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: dismissal_request_code_scanning + supported-webhook-types: + - repository + - organization + - app + dismissal-request-code-scanning-response-submitted: + post: + summary: |- + This event occurs when there is activity related to a user's request to dismiss a code scanning alert. + + To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. + + > [!NOTE] + > Delegated alert dismissal for code scanning is currently in public preview and subject to change. + description: A code scanning alert dismissal response was submitted. + operationId: dismissal-request-code-scanning/response-submitted + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: *735 + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: dismissal_request_code_scanning + supported-webhook-types: + - repository + - organization + - app dismissal-request-secret-scanning-cancelled: post: summary: |- diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index 0b8fd61cf5..afab8d766b 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -87194,6 +87194,192 @@ } } }, + "dismissal-request-code-scanning-created": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "description": "A code scanning alert dismissal request was created.", + "operationId": "dismissal-request-code-scanning/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-exemption-request-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "dismissal_request_code_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "dismissal-request-code-scanning-response-submitted": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "description": "A code scanning alert dismissal response was submitted.", + "operationId": "dismissal-request-code-scanning/response-submitted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "dismissal_request_code_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "dismissal-request-secret-scanning-cancelled": { "post": { "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", @@ -147796,6 +147982,33 @@ } } }, + "dismissal-request-code-scanning": { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } + }, "exemption-request-secret-scanning-metadata": { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -147837,6 +148050,26 @@ } } }, + "dismissal-request-code-scanning-metadata": { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } + }, "exemption-response": { "title": "Exemption response", "description": "A response to an exemption request by a delegated bypasser.", @@ -147911,7 +148144,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -147924,6 +148158,9 @@ }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning" + }, + { + "$ref": "#/components/schemas/dismissal-request-code-scanning" } ] }, @@ -147957,12 +148194,15 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning-metadata" + }, + { + "$ref": "#/components/schemas/dismissal-request-code-scanning-metadata" } ] }, diff --git a/descriptions-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index d4f3b2d47f..14fc16ec8c 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -63165,6 +63165,140 @@ webhooks: - repository - organization - app + dismissal-request-code-scanning-created: + post: + summary: |- + This event occurs when there is activity related to a user's request to dismiss a code scanning alert. + + To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. + + > [!NOTE] + > Delegated alert dismissal for code scanning is currently in public preview and subject to change. + description: A code scanning alert dismissal request was created. + operationId: dismissal-request-code-scanning/created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: dismissal_request_code_scanning + supported-webhook-types: + - repository + - organization + - app + dismissal-request-code-scanning-response-submitted: + post: + summary: |- + This event occurs when there is activity related to a user's request to dismiss a code scanning alert. + + To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. + + > [!NOTE] + > Delegated alert dismissal for code scanning is currently in public preview and subject to change. + description: A code scanning alert dismissal response was submitted. + operationId: dismissal-request-code-scanning/response-submitted + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: dismissal_request_code_scanning + supported-webhook-types: + - repository + - organization + - app dismissal-request-secret-scanning-cancelled: post: summary: |- @@ -107165,6 +107299,26 @@ components: alert_number: type: string description: The number of the alert that was detected + dismissal-request-code-scanning: + title: Code scanning alert dismissal request data + description: Code scanning alerts that have dismissal requests. + type: object + properties: + type: + type: string + description: The type of request + enum: + - code_scanning_alert_dismissal + data: + type: array + description: The data related to the code scanning alerts that have dismissal + requests. + items: + type: object + properties: + alert_number: + type: string + description: The number of the alert to be dismissed exemption-request-secret-scanning-metadata: title: Secret Scanning Push Protection Exemption Request Metadata description: Metadata for a secret scanning push protection exemption request. @@ -107196,6 +107350,21 @@ components: - false_positive - tests - revoked + dismissal-request-code-scanning-metadata: + title: Code scanning alert dismissal request metadata + description: Metadata for a code scanning alert dismissal request. + type: object + properties: + alert_title: + type: string + description: The title of the code scanning alert + reason: + type: string + description: The reason for the dismissal request + enum: + - false positive + - won't fix + - used in tests exemption-response: title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -107257,11 +107426,13 @@ components: - push_ruleset_bypass - secret_scanning - secret_scanning_closure + - code_scanning_alert_dismissal exemption_request_data: oneOf: - "$ref": "#/components/schemas/exemption-request-push-ruleset-bypass" - "$ref": "#/components/schemas/exemption-request-secret-scanning" - "$ref": "#/components/schemas/dismissal-request-secret-scanning" + - "$ref": "#/components/schemas/dismissal-request-code-scanning" resource_identifier: type: string description: The unique identifier for the request type of the exemption @@ -107287,9 +107458,10 @@ components: - object - 'null' description: Metadata about the exemption request. - oneOf: + anyOf: - "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" - "$ref": "#/components/schemas/dismissal-request-secret-scanning-metadata" + - "$ref": "#/components/schemas/dismissal-request-code-scanning-metadata" expires_at: type: string format: date-time diff --git a/descriptions-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index 0b8fd61cf5..afab8d766b 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -87194,6 +87194,192 @@ } } }, + "dismissal-request-code-scanning-created": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "description": "A code scanning alert dismissal request was created.", + "operationId": "dismissal-request-code-scanning/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-exemption-request-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "dismissal_request_code_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "dismissal-request-code-scanning-response-submitted": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"code scanning alerts\" repository permission.\n\n> [!NOTE]\n> Delegated alert dismissal for code scanning is currently in public preview and subject to change.", + "description": "A code scanning alert dismissal response was submitted.", + "operationId": "dismissal-request-code-scanning/response-submitted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "dismissal_request_code_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "dismissal-request-secret-scanning-cancelled": { "post": { "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", @@ -147796,6 +147982,33 @@ } } }, + "dismissal-request-code-scanning": { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } + }, "exemption-request-secret-scanning-metadata": { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -147837,6 +148050,26 @@ } } }, + "dismissal-request-code-scanning-metadata": { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } + }, "exemption-response": { "title": "Exemption response", "description": "A response to an exemption request by a delegated bypasser.", @@ -147911,7 +148144,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -147924,6 +148158,9 @@ }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning" + }, + { + "$ref": "#/components/schemas/dismissal-request-code-scanning" } ] }, @@ -147957,12 +148194,15 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning-metadata" + }, + { + "$ref": "#/components/schemas/dismissal-request-code-scanning-metadata" } ] }, diff --git a/descriptions-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index d4f3b2d47f..14fc16ec8c 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -63165,6 +63165,140 @@ webhooks: - repository - organization - app + dismissal-request-code-scanning-created: + post: + summary: |- + This event occurs when there is activity related to a user's request to dismiss a code scanning alert. + + To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. + + > [!NOTE] + > Delegated alert dismissal for code scanning is currently in public preview and subject to change. + description: A code scanning alert dismissal request was created. + operationId: dismissal-request-code-scanning/created + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: dismissal_request_code_scanning + supported-webhook-types: + - repository + - organization + - app + dismissal-request-code-scanning-response-submitted: + post: + summary: |- + This event occurs when there is activity related to a user's request to dismiss a code scanning alert. + + To subscribe to this event, a GitHub App must have at least read-level access for the "code scanning alerts" repository permission. + + > [!NOTE] + > Delegated alert dismissal for code scanning is currently in public preview and subject to change. + description: A code scanning alert dismissal response was submitted. + operationId: dismissal-request-code-scanning/response-submitted + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: dismissal_request_code_scanning + supported-webhook-types: + - repository + - organization + - app dismissal-request-secret-scanning-cancelled: post: summary: |- @@ -107165,6 +107299,26 @@ components: alert_number: type: string description: The number of the alert that was detected + dismissal-request-code-scanning: + title: Code scanning alert dismissal request data + description: Code scanning alerts that have dismissal requests. + type: object + properties: + type: + type: string + description: The type of request + enum: + - code_scanning_alert_dismissal + data: + type: array + description: The data related to the code scanning alerts that have dismissal + requests. + items: + type: object + properties: + alert_number: + type: string + description: The number of the alert to be dismissed exemption-request-secret-scanning-metadata: title: Secret Scanning Push Protection Exemption Request Metadata description: Metadata for a secret scanning push protection exemption request. @@ -107196,6 +107350,21 @@ components: - false_positive - tests - revoked + dismissal-request-code-scanning-metadata: + title: Code scanning alert dismissal request metadata + description: Metadata for a code scanning alert dismissal request. + type: object + properties: + alert_title: + type: string + description: The title of the code scanning alert + reason: + type: string + description: The reason for the dismissal request + enum: + - false positive + - won't fix + - used in tests exemption-response: title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -107257,11 +107426,13 @@ components: - push_ruleset_bypass - secret_scanning - secret_scanning_closure + - code_scanning_alert_dismissal exemption_request_data: oneOf: - "$ref": "#/components/schemas/exemption-request-push-ruleset-bypass" - "$ref": "#/components/schemas/exemption-request-secret-scanning" - "$ref": "#/components/schemas/dismissal-request-secret-scanning" + - "$ref": "#/components/schemas/dismissal-request-code-scanning" resource_identifier: type: string description: The unique identifier for the request type of the exemption @@ -107287,9 +107458,10 @@ components: - object - 'null' description: Metadata about the exemption request. - oneOf: + anyOf: - "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" - "$ref": "#/components/schemas/dismissal-request-secret-scanning-metadata" + - "$ref": "#/components/schemas/dismissal-request-code-scanning-metadata" expires_at: type: string format: date-time diff --git a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json index f8aa967cea..059ec9211c 100644 --- a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.json @@ -569605,7 +569605,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -569727,6 +569728,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -569760,7 +569788,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -569801,6 +569829,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -571883,7 +571931,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -572005,6 +572054,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -572038,7 +572114,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -572079,6 +572155,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -574161,7 +574257,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -574283,6 +574380,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -574316,7 +574440,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -574357,6 +574481,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -576439,7 +576583,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -576561,6 +576706,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -576594,7 +576766,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -576635,6 +576807,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -578758,7 +578950,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -578880,6 +579073,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -578913,7 +579133,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -578954,6 +579174,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, diff --git a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml index 55ce1237b4..9fc3483876 100644 --- a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml +++ b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.2022-11-28.deref.yaml @@ -94691,6 +94691,7 @@ webhooks: - push_ruleset_bypass - secret_scanning - secret_scanning_closure + - code_scanning_alert_dismissal exemption_request_data: oneOf: - title: Push ruleset bypass exemption request data @@ -94784,6 +94785,25 @@ webhooks: alert_number: type: string description: The number of the alert that was detected + - title: Code scanning alert dismissal request data + description: Code scanning alerts that have dismissal requests. + type: object + properties: + type: + type: string + description: The type of request + enum: + - code_scanning_alert_dismissal + data: + type: array + description: The data related to the code scanning alerts + that have dismissal requests. + items: + type: object + properties: + alert_number: + type: string + description: The number of the alert to be dismissed resource_identifier: type: string description: The unique identifier for the request type of the @@ -94809,7 +94829,7 @@ webhooks: - object - 'null' description: Metadata about the exemption request. - oneOf: + anyOf: - title: Secret Scanning Push Protection Exemption Request Metadata description: Metadata for a secret scanning push protection exemption request. @@ -94841,6 +94861,21 @@ webhooks: - false_positive - tests - revoked + - title: Code scanning alert dismissal request metadata + description: Metadata for a code scanning alert dismissal + request. + type: object + properties: + alert_title: + type: string + description: The title of the code scanning alert + reason: + type: string + description: The reason for the dismissal request + enum: + - false positive + - won't fix + - used in tests expires_at: type: string format: date-time diff --git a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.deref.json b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.deref.json index f8aa967cea..059ec9211c 100644 --- a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.deref.json +++ b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.deref.json @@ -569605,7 +569605,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -569727,6 +569728,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -569760,7 +569788,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -569801,6 +569829,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -571883,7 +571931,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -572005,6 +572054,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -572038,7 +572114,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -572079,6 +572155,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -574161,7 +574257,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -574283,6 +574380,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -574316,7 +574440,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -574357,6 +574481,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -576439,7 +576583,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -576561,6 +576706,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -576594,7 +576766,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -576635,6 +576807,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -578758,7 +578950,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -578880,6 +579073,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -578913,7 +579133,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -578954,6 +579174,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, diff --git a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.deref.yaml b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.deref.yaml index 55ce1237b4..9fc3483876 100644 --- a/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.deref.yaml +++ b/descriptions-next/ghes-3.14/dereferenced/ghes-3.14.deref.yaml @@ -94691,6 +94691,7 @@ webhooks: - push_ruleset_bypass - secret_scanning - secret_scanning_closure + - code_scanning_alert_dismissal exemption_request_data: oneOf: - title: Push ruleset bypass exemption request data @@ -94784,6 +94785,25 @@ webhooks: alert_number: type: string description: The number of the alert that was detected + - title: Code scanning alert dismissal request data + description: Code scanning alerts that have dismissal requests. + type: object + properties: + type: + type: string + description: The type of request + enum: + - code_scanning_alert_dismissal + data: + type: array + description: The data related to the code scanning alerts + that have dismissal requests. + items: + type: object + properties: + alert_number: + type: string + description: The number of the alert to be dismissed resource_identifier: type: string description: The unique identifier for the request type of the @@ -94809,7 +94829,7 @@ webhooks: - object - 'null' description: Metadata about the exemption request. - oneOf: + anyOf: - title: Secret Scanning Push Protection Exemption Request Metadata description: Metadata for a secret scanning push protection exemption request. @@ -94841,6 +94861,21 @@ webhooks: - false_positive - tests - revoked + - title: Code scanning alert dismissal request metadata + description: Metadata for a code scanning alert dismissal + request. + type: object + properties: + alert_title: + type: string + description: The title of the code scanning alert + reason: + type: string + description: The reason for the dismissal request + enum: + - false positive + - won't fix + - used in tests expires_at: type: string format: date-time diff --git a/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.json b/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.json index 2d83e56893..c952b509ec 100644 --- a/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.json +++ b/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.json @@ -128061,6 +128061,33 @@ } } }, + "dismissal-request-code-scanning": { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } + }, "exemption-request-secret-scanning-metadata": { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -128102,6 +128129,26 @@ } } }, + "dismissal-request-code-scanning-metadata": { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } + }, "exemption-response": { "title": "Exemption response", "description": "A response to an exemption request by a delegated bypasser.", @@ -128176,7 +128223,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -128189,6 +128237,9 @@ }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning" + }, + { + "$ref": "#/components/schemas/dismissal-request-code-scanning" } ] }, @@ -128222,12 +128273,15 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning-metadata" + }, + { + "$ref": "#/components/schemas/dismissal-request-code-scanning-metadata" } ] }, diff --git a/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.yaml b/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.yaml index 6ad310b973..ad21d05df8 100644 --- a/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.yaml +++ b/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.yaml @@ -92019,6 +92019,26 @@ components: alert_number: type: string description: The number of the alert that was detected + dismissal-request-code-scanning: + title: Code scanning alert dismissal request data + description: Code scanning alerts that have dismissal requests. + type: object + properties: + type: + type: string + description: The type of request + enum: + - code_scanning_alert_dismissal + data: + type: array + description: The data related to the code scanning alerts that have dismissal + requests. + items: + type: object + properties: + alert_number: + type: string + description: The number of the alert to be dismissed exemption-request-secret-scanning-metadata: title: Secret Scanning Push Protection Exemption Request Metadata description: Metadata for a secret scanning push protection exemption request. @@ -92050,6 +92070,21 @@ components: - false_positive - tests - revoked + dismissal-request-code-scanning-metadata: + title: Code scanning alert dismissal request metadata + description: Metadata for a code scanning alert dismissal request. + type: object + properties: + alert_title: + type: string + description: The title of the code scanning alert + reason: + type: string + description: The reason for the dismissal request + enum: + - false positive + - won't fix + - used in tests exemption-response: title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -92111,11 +92146,13 @@ components: - push_ruleset_bypass - secret_scanning - secret_scanning_closure + - code_scanning_alert_dismissal exemption_request_data: oneOf: - "$ref": "#/components/schemas/exemption-request-push-ruleset-bypass" - "$ref": "#/components/schemas/exemption-request-secret-scanning" - "$ref": "#/components/schemas/dismissal-request-secret-scanning" + - "$ref": "#/components/schemas/dismissal-request-code-scanning" resource_identifier: type: string description: The unique identifier for the request type of the exemption @@ -92141,9 +92178,10 @@ components: - object - 'null' description: Metadata about the exemption request. - oneOf: + anyOf: - "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" - "$ref": "#/components/schemas/dismissal-request-secret-scanning-metadata" + - "$ref": "#/components/schemas/dismissal-request-code-scanning-metadata" expires_at: type: string format: date-time diff --git a/descriptions-next/ghes-3.14/ghes-3.14.json b/descriptions-next/ghes-3.14/ghes-3.14.json index 2d83e56893..c952b509ec 100644 --- a/descriptions-next/ghes-3.14/ghes-3.14.json +++ b/descriptions-next/ghes-3.14/ghes-3.14.json @@ -128061,6 +128061,33 @@ } } }, + "dismissal-request-code-scanning": { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } + }, "exemption-request-secret-scanning-metadata": { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -128102,6 +128129,26 @@ } } }, + "dismissal-request-code-scanning-metadata": { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } + }, "exemption-response": { "title": "Exemption response", "description": "A response to an exemption request by a delegated bypasser.", @@ -128176,7 +128223,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -128189,6 +128237,9 @@ }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning" + }, + { + "$ref": "#/components/schemas/dismissal-request-code-scanning" } ] }, @@ -128222,12 +128273,15 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning-metadata" + }, + { + "$ref": "#/components/schemas/dismissal-request-code-scanning-metadata" } ] }, diff --git a/descriptions-next/ghes-3.14/ghes-3.14.yaml b/descriptions-next/ghes-3.14/ghes-3.14.yaml index 6ad310b973..ad21d05df8 100644 --- a/descriptions-next/ghes-3.14/ghes-3.14.yaml +++ b/descriptions-next/ghes-3.14/ghes-3.14.yaml @@ -92019,6 +92019,26 @@ components: alert_number: type: string description: The number of the alert that was detected + dismissal-request-code-scanning: + title: Code scanning alert dismissal request data + description: Code scanning alerts that have dismissal requests. + type: object + properties: + type: + type: string + description: The type of request + enum: + - code_scanning_alert_dismissal + data: + type: array + description: The data related to the code scanning alerts that have dismissal + requests. + items: + type: object + properties: + alert_number: + type: string + description: The number of the alert to be dismissed exemption-request-secret-scanning-metadata: title: Secret Scanning Push Protection Exemption Request Metadata description: Metadata for a secret scanning push protection exemption request. @@ -92050,6 +92070,21 @@ components: - false_positive - tests - revoked + dismissal-request-code-scanning-metadata: + title: Code scanning alert dismissal request metadata + description: Metadata for a code scanning alert dismissal request. + type: object + properties: + alert_title: + type: string + description: The title of the code scanning alert + reason: + type: string + description: The reason for the dismissal request + enum: + - false positive + - won't fix + - used in tests exemption-response: title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -92111,11 +92146,13 @@ components: - push_ruleset_bypass - secret_scanning - secret_scanning_closure + - code_scanning_alert_dismissal exemption_request_data: oneOf: - "$ref": "#/components/schemas/exemption-request-push-ruleset-bypass" - "$ref": "#/components/schemas/exemption-request-secret-scanning" - "$ref": "#/components/schemas/dismissal-request-secret-scanning" + - "$ref": "#/components/schemas/dismissal-request-code-scanning" resource_identifier: type: string description: The unique identifier for the request type of the exemption @@ -92141,9 +92178,10 @@ components: - object - 'null' description: Metadata about the exemption request. - oneOf: + anyOf: - "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" - "$ref": "#/components/schemas/dismissal-request-secret-scanning-metadata" + - "$ref": "#/components/schemas/dismissal-request-code-scanning-metadata" expires_at: type: string format: date-time diff --git a/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.2022-11-28.deref.json b/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.2022-11-28.deref.json index 20d4cdbe4c..0ceae3695f 100644 --- a/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.2022-11-28.deref.json @@ -574736,7 +574736,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -574858,6 +574859,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -574891,7 +574919,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -574932,6 +574960,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -577014,7 +577062,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -577136,6 +577185,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -577169,7 +577245,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -577210,6 +577286,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -579292,7 +579388,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -579414,6 +579511,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -579447,7 +579571,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -579488,6 +579612,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -581570,7 +581714,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -581692,6 +581837,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -581725,7 +581897,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -581766,6 +581938,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -583889,7 +584081,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -584011,6 +584204,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -584044,7 +584264,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -584085,6 +584305,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, diff --git a/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.2022-11-28.deref.yaml b/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.2022-11-28.deref.yaml index 66b67a7baf..bbba710fbd 100644 --- a/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.2022-11-28.deref.yaml +++ b/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.2022-11-28.deref.yaml @@ -95142,6 +95142,7 @@ webhooks: - push_ruleset_bypass - secret_scanning - secret_scanning_closure + - code_scanning_alert_dismissal exemption_request_data: oneOf: - title: Push ruleset bypass exemption request data @@ -95235,6 +95236,25 @@ webhooks: alert_number: type: string description: The number of the alert that was detected + - title: Code scanning alert dismissal request data + description: Code scanning alerts that have dismissal requests. + type: object + properties: + type: + type: string + description: The type of request + enum: + - code_scanning_alert_dismissal + data: + type: array + description: The data related to the code scanning alerts + that have dismissal requests. + items: + type: object + properties: + alert_number: + type: string + description: The number of the alert to be dismissed resource_identifier: type: string description: The unique identifier for the request type of the @@ -95260,7 +95280,7 @@ webhooks: - object - 'null' description: Metadata about the exemption request. - oneOf: + anyOf: - title: Secret Scanning Push Protection Exemption Request Metadata description: Metadata for a secret scanning push protection exemption request. @@ -95292,6 +95312,21 @@ webhooks: - false_positive - tests - revoked + - title: Code scanning alert dismissal request metadata + description: Metadata for a code scanning alert dismissal + request. + type: object + properties: + alert_title: + type: string + description: The title of the code scanning alert + reason: + type: string + description: The reason for the dismissal request + enum: + - false positive + - won't fix + - used in tests expires_at: type: string format: date-time diff --git a/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.deref.json b/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.deref.json index 20d4cdbe4c..0ceae3695f 100644 --- a/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.deref.json +++ b/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.deref.json @@ -574736,7 +574736,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -574858,6 +574859,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -574891,7 +574919,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -574932,6 +574960,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -577014,7 +577062,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -577136,6 +577185,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -577169,7 +577245,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -577210,6 +577286,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -579292,7 +579388,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -579414,6 +579511,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -579447,7 +579571,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -579488,6 +579612,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -581570,7 +581714,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -581692,6 +581837,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -581725,7 +581897,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -581766,6 +581938,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, @@ -583889,7 +584081,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -584011,6 +584204,33 @@ } } } + }, + { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } } ] }, @@ -584044,7 +584264,7 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -584085,6 +584305,26 @@ ] } } + }, + { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } } ] }, diff --git a/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.deref.yaml b/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.deref.yaml index 66b67a7baf..bbba710fbd 100644 --- a/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.deref.yaml +++ b/descriptions-next/ghes-3.15/dereferenced/ghes-3.15.deref.yaml @@ -95142,6 +95142,7 @@ webhooks: - push_ruleset_bypass - secret_scanning - secret_scanning_closure + - code_scanning_alert_dismissal exemption_request_data: oneOf: - title: Push ruleset bypass exemption request data @@ -95235,6 +95236,25 @@ webhooks: alert_number: type: string description: The number of the alert that was detected + - title: Code scanning alert dismissal request data + description: Code scanning alerts that have dismissal requests. + type: object + properties: + type: + type: string + description: The type of request + enum: + - code_scanning_alert_dismissal + data: + type: array + description: The data related to the code scanning alerts + that have dismissal requests. + items: + type: object + properties: + alert_number: + type: string + description: The number of the alert to be dismissed resource_identifier: type: string description: The unique identifier for the request type of the @@ -95260,7 +95280,7 @@ webhooks: - object - 'null' description: Metadata about the exemption request. - oneOf: + anyOf: - title: Secret Scanning Push Protection Exemption Request Metadata description: Metadata for a secret scanning push protection exemption request. @@ -95292,6 +95312,21 @@ webhooks: - false_positive - tests - revoked + - title: Code scanning alert dismissal request metadata + description: Metadata for a code scanning alert dismissal + request. + type: object + properties: + alert_title: + type: string + description: The title of the code scanning alert + reason: + type: string + description: The reason for the dismissal request + enum: + - false positive + - won't fix + - used in tests expires_at: type: string format: date-time diff --git a/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.json b/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.json index f231566479..9910339dd7 100644 --- a/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.json +++ b/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.json @@ -128396,6 +128396,33 @@ } } }, + "dismissal-request-code-scanning": { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } + }, "exemption-request-secret-scanning-metadata": { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -128437,6 +128464,26 @@ } } }, + "dismissal-request-code-scanning-metadata": { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } + }, "exemption-response": { "title": "Exemption response", "description": "A response to an exemption request by a delegated bypasser.", @@ -128511,7 +128558,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -128524,6 +128572,9 @@ }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning" + }, + { + "$ref": "#/components/schemas/dismissal-request-code-scanning" } ] }, @@ -128557,12 +128608,15 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning-metadata" + }, + { + "$ref": "#/components/schemas/dismissal-request-code-scanning-metadata" } ] }, diff --git a/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.yaml b/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.yaml index 7af1241db8..5b79e3391a 100644 --- a/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.yaml +++ b/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.yaml @@ -92397,6 +92397,26 @@ components: alert_number: type: string description: The number of the alert that was detected + dismissal-request-code-scanning: + title: Code scanning alert dismissal request data + description: Code scanning alerts that have dismissal requests. + type: object + properties: + type: + type: string + description: The type of request + enum: + - code_scanning_alert_dismissal + data: + type: array + description: The data related to the code scanning alerts that have dismissal + requests. + items: + type: object + properties: + alert_number: + type: string + description: The number of the alert to be dismissed exemption-request-secret-scanning-metadata: title: Secret Scanning Push Protection Exemption Request Metadata description: Metadata for a secret scanning push protection exemption request. @@ -92428,6 +92448,21 @@ components: - false_positive - tests - revoked + dismissal-request-code-scanning-metadata: + title: Code scanning alert dismissal request metadata + description: Metadata for a code scanning alert dismissal request. + type: object + properties: + alert_title: + type: string + description: The title of the code scanning alert + reason: + type: string + description: The reason for the dismissal request + enum: + - false positive + - won't fix + - used in tests exemption-response: title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -92489,11 +92524,13 @@ components: - push_ruleset_bypass - secret_scanning - secret_scanning_closure + - code_scanning_alert_dismissal exemption_request_data: oneOf: - "$ref": "#/components/schemas/exemption-request-push-ruleset-bypass" - "$ref": "#/components/schemas/exemption-request-secret-scanning" - "$ref": "#/components/schemas/dismissal-request-secret-scanning" + - "$ref": "#/components/schemas/dismissal-request-code-scanning" resource_identifier: type: string description: The unique identifier for the request type of the exemption @@ -92519,9 +92556,10 @@ components: - object - 'null' description: Metadata about the exemption request. - oneOf: + anyOf: - "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" - "$ref": "#/components/schemas/dismissal-request-secret-scanning-metadata" + - "$ref": "#/components/schemas/dismissal-request-code-scanning-metadata" expires_at: type: string format: date-time diff --git a/descriptions-next/ghes-3.15/ghes-3.15.json b/descriptions-next/ghes-3.15/ghes-3.15.json index f231566479..9910339dd7 100644 --- a/descriptions-next/ghes-3.15/ghes-3.15.json +++ b/descriptions-next/ghes-3.15/ghes-3.15.json @@ -128396,6 +128396,33 @@ } } }, + "dismissal-request-code-scanning": { + "title": "Code scanning alert dismissal request data", + "description": "Code scanning alerts that have dismissal requests.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "code_scanning_alert_dismissal" + ] + }, + "data": { + "type": "array", + "description": "The data related to the code scanning alerts that have dismissal requests.", + "items": { + "type": "object", + "properties": { + "alert_number": { + "type": "string", + "description": "The number of the alert to be dismissed" + } + } + } + } + } + }, "exemption-request-secret-scanning-metadata": { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -128437,6 +128464,26 @@ } } }, + "dismissal-request-code-scanning-metadata": { + "title": "Code scanning alert dismissal request metadata", + "description": "Metadata for a code scanning alert dismissal request.", + "type": "object", + "properties": { + "alert_title": { + "type": "string", + "description": "The title of the code scanning alert" + }, + "reason": { + "type": "string", + "description": "The reason for the dismissal request", + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + } + } + }, "exemption-response": { "title": "Exemption response", "description": "A response to an exemption request by a delegated bypasser.", @@ -128511,7 +128558,8 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure" + "secret_scanning_closure", + "code_scanning_alert_dismissal" ] }, "exemption_request_data": { @@ -128524,6 +128572,9 @@ }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning" + }, + { + "$ref": "#/components/schemas/dismissal-request-code-scanning" } ] }, @@ -128557,12 +128608,15 @@ "null" ], "description": "Metadata about the exemption request.", - "oneOf": [ + "anyOf": [ { "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning-metadata" + }, + { + "$ref": "#/components/schemas/dismissal-request-code-scanning-metadata" } ] }, diff --git a/descriptions-next/ghes-3.15/ghes-3.15.yaml b/descriptions-next/ghes-3.15/ghes-3.15.yaml index 7af1241db8..5b79e3391a 100644 --- a/descriptions-next/ghes-3.15/ghes-3.15.yaml +++ b/descriptions-next/ghes-3.15/ghes-3.15.yaml @@ -92397,6 +92397,26 @@ components: alert_number: type: string description: The number of the alert that was detected + dismissal-request-code-scanning: + title: Code scanning alert dismissal request data + description: Code scanning alerts that have dismissal requests. + type: object + properties: + type: + type: string + description: The type of request + enum: + - code_scanning_alert_dismissal + data: + type: array + description: The data related to the code scanning alerts that have dismissal + requests. + items: + type: object + properties: + alert_number: + type: string + description: The number of the alert to be dismissed exemption-request-secret-scanning-metadata: title: Secret Scanning Push Protection Exemption Request Metadata description: Metadata for a secret scanning push protection exemption request. @@ -92428,6 +92448,21 @@ components: - false_positive - tests - revoked + dismissal-request-code-scanning-metadata: + title: Code scanning alert dismissal request metadata + description: Metadata for a code scanning alert dismissal request. + type: object + properties: + alert_title: + type: string + description: The title of the code scanning alert + reason: + type: string + description: The reason for the dismissal request + enum: + - false positive + - won't fix + - used in tests exemption-response: title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -92489,11 +92524,13 @@ components: - push_ruleset_bypass - secret_scanning - secret_scanning_closure + - code_scanning_alert_dismissal exemption_request_data: oneOf: - "$ref": "#/components/schemas/exemption-request-push-ruleset-bypass" - "$ref": "#/components/schemas/exemption-request-secret-scanning" - "$ref": "#/components/schemas/dismissal-request-secret-scanning" + - "$ref": "#/components/schemas/dismissal-request-code-scanning" resource_identifier: type: string description: The unique identifier for the request type of the exemption @@ -92519,9 +92556,10 @@ components: - object - 'null' description: Metadata about the exemption request. - oneOf: + anyOf: - "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" - "$ref": "#/components/schemas/dismissal-request-secret-scanning-metadata" + - "$ref": "#/components/schemas/dismissal-request-code-sca{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}