diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 9c0c223fb6..ab7db02577 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -59447,7 +59447,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.\n> You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/).", + "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.", "tags": [ "search" ], @@ -102178,12 +102178,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index 4cf2929dde..8e6d2e782c 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -43168,7 +43168,6 @@ paths: description: |- > [!WARNING] > **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025. - > You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/). tags: - search operationId: search/issues-and-pull-requests @@ -74578,11 +74577,11 @@ components: type: object properties: id: - description: The ID of the runner. + description: The id of the runner. type: integer example: 5 runner_group_id: - description: The ID of the runner group. + description: The id of the runner group. type: integer example: 1 name: diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 9c0c223fb6..ab7db02577 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -59447,7 +59447,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.\n> You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/).", + "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.", "tags": [ "search" ], @@ -102178,12 +102178,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 4cf2929dde..8e6d2e782c 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -43168,7 +43168,6 @@ paths: description: |- > [!WARNING] > **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025. - > You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/). tags: - search operationId: search/issues-and-pull-requests @@ -74578,11 +74577,11 @@ components: type: object properties: id: - description: The ID of the runner. + description: The id of the runner. type: integer example: 5 runner_group_id: - description: The ID of the runner group. + description: The id of the runner group. type: integer example: 1 name: diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index f1f0421034..feec5b9ef1 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -57482,12 +57482,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -57892,12 +57892,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -58254,12 +58254,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -60124,12 +60124,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -166102,12 +166102,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -166482,12 +166482,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -168379,12 +168379,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -444591,7 +444591,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.\n> You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/).", + "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.", "tags": [ "search" ], diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index d8a92b554a..98b3be5e55 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -18268,11 +18268,11 @@ paths: type: object properties: id: - description: The ID of the runner. + description: The id of the runner. type: integer example: 5 runner_group_id: - description: The ID of the runner group. + description: The id of the runner group. type: integer example: 1 name: @@ -87378,7 +87378,6 @@ paths: description: |- > [!WARNING] > **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025. - > You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/). tags: - search operationId: search/issues-and-pull-requests diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index f1f0421034..feec5b9ef1 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -57482,12 +57482,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -57892,12 +57892,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -58254,12 +58254,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -60124,12 +60124,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -166102,12 +166102,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -166482,12 +166482,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -168379,12 +168379,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -444591,7 +444591,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.\n> You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/).", + "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.", "tags": [ "search" ], diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index d8a92b554a..98b3be5e55 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -18268,11 +18268,11 @@ paths: type: object properties: id: - description: The ID of the runner. + description: The id of the runner. type: integer example: 5 runner_group_id: - description: The ID of the runner group. + description: The id of the runner group. type: integer example: 1 name: @@ -87378,7 +87378,6 @@ paths: description: |- > [!WARNING] > **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025. - > You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/). tags: - search operationId: search/issues-and-pull-requests diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index 09c2e8934a..8a01eeefd3 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -20529,12 +20529,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -20939,12 +20939,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -21301,12 +21301,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -23171,12 +23171,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -83785,12 +83785,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -84195,12 +84195,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -84557,12 +84557,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -86427,12 +86427,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -199505,12 +199505,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -199885,12 +199885,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -201782,12 +201782,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -490560,7 +490560,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.\n> You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/).", + "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.", "tags": [ "search" ], @@ -597248,8 +597248,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -597371,33 +597370,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -597425,7 +597397,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -597466,26 +597438,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -599192,8 +599144,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -599315,33 +599266,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -599369,7 +599293,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -599410,26 +599334,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -601136,8 +601040,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -601259,33 +601162,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -601313,7 +601189,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -601354,26 +601230,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -603080,8 +602936,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -603203,33 +603058,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -603257,7 +603085,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -603298,26 +603126,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -605063,8 +604871,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -605186,33 +604993,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -605240,7 +605020,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -605281,26 +605061,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -607046,8 +606806,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -607169,33 +606928,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -607223,7 +606955,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -607264,26 +606996,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -608990,8 +608702,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -609113,33 +608824,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -609167,7 +608851,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -609208,26 +608892,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -610934,8 +610598,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -611057,33 +610720,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -611111,7 +610747,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -611152,26 +610788,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -612878,8 +612494,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -613001,33 +612616,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -613055,7 +612643,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -613096,26 +612684,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -614861,8 +614429,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -614984,33 +614551,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -615038,7 +614578,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -615079,26 +614619,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -737984,13 +737504,13 @@ } } }, - "dismissal-request-code-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 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", + "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", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -738055,13 +737575,13 @@ "content": { "application/json": { "schema": { - "title": "Exemption request created event", + "title": "Exemption request cancellation event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "cancelled" ] }, "enterprise": { @@ -739475,8 +738995,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -739598,33 +739117,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -739652,7 +739144,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -739693,26 +739185,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -739919,7 +739391,7 @@ "x-github": { "githubCloudOnly": true, "category": "webhooks", - "subcategory": "dismissal_request_code_scanning", + "subcategory": "dismissal_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -739928,13 +739400,13 @@ } } }, - "dismissal-request-code-scanning-response-submitted": { + "dismissal-request-secret-scanning-completed": { "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", + "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_code_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -739999,13 +739471,13 @@ "content": { "application/json": { "schema": { - "title": "Exemption response submitted event", + "title": "Exemption request completed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "response_submitted" + "completed" ] }, "enterprise": { @@ -741419,8 +740891,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -741542,33 +741013,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -741596,7 +741040,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -741637,26 +741081,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -741721,44 +741145,6 @@ } } }, - "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", - "description": "The comment the reviewer provided when responding to the exemption request.", - "nullable": true - }, - "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.", @@ -741887,7 +741273,6 @@ "required": [ "action", "exemption_request", - "exemption_response", "sender" ] } @@ -741902,7 +741287,7 @@ "x-github": { "githubCloudOnly": true, "category": "webhooks", - "subcategory": "dismissal_request_code_scanning", + "subcategory": "dismissal_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -741911,11 +741296,11 @@ } } }, - "dismissal-request-secret-scanning-cancelled": { + "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 canceled.", - "operationId": "dismissal-request-secret-scanning/cancelled", + "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" }, @@ -741982,13 +741367,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": { @@ -743402,8 +742787,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -743525,33 +742909,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -743579,3895 +742936,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "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", - "description": "The responses to the exemption request.", - "nullable": true, - "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", - "description": "The comment the reviewer provided when responding to the exemption request.", - "nullable": true - }, - "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", - "example": "https://github.com/monalisa/smile/exemptions/1" - } - } - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "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", - "example": 1 - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "example": "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", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "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", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 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", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": 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", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": 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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "template_repository": { - "nullable": true, - "type": "object", - "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", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"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", - "description": "The number uniquely identifying the exemption request within it's repository.", - "nullable": true - }, - "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.", - "example": "827efc6d56897b048c772eb4087f854f46256132" - }, - "status": { - "type": "string", - "description": "The status of the exemption request.", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - "requester_comment": { - "type": "string", - "description": "The comment the requester provided when creating the exemption request.", - "nullable": true - }, - "metadata": { - "type": "object", - "description": "Metadata about the exemption request.", - "nullable": true, - "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", - "description": "The responses to the exemption request.", - "nullable": true, - "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", - "description": "The comment the reviewer provided when responding to the exemption request.", - "nullable": true - }, - "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", - "example": "https://github.com/monalisa/smile/exemptions/1" - } - } - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - }, - "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 created event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "created" - ] - }, - "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", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "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", - "example": 1 - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "example": "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", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "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", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 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", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": 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", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": 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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "template_repository": { - "nullable": true, - "type": "object", - "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", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"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", - "description": "The number uniquely identifying the exemption request within it's repository.", - "nullable": true - }, - "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.", - "example": "827efc6d56897b048c772eb4087f854f46256132" - }, - "status": { - "type": "string", - "description": "The status of the exemption request.", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - "requester_comment": { - "type": "string", - "description": "The comment the requester provided when creating the exemption request.", - "nullable": true - }, - "metadata": { - "type": "object", - "description": "Metadata about the exemption request.", - "nullable": true, - "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -747508,26 +742977,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -749234,8 +744683,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -749357,33 +744805,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -749411,7 +744832,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -749452,26 +744873,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -751217,8 +746618,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -751340,33 +746740,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -751394,7 +746767,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -751435,26 +746808,6 @@ ] } } - }, - { - "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/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index b34e51456d..7615e61e0c 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -9084,11 +9084,11 @@ paths: type: object properties: id: - description: The ID of the runner. + description: The id of the runner. type: integer example: 5 runner_group_id: - description: The ID of the runner group. + description: The id of the runner group. type: integer example: 1 name: @@ -97665,7 +97665,6 @@ paths: description: |- > [!WARNING] > **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025. - > You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/). tags: - search operationId: search/issues-and-pull-requests @@ -111208,7 +111207,6 @@ x-webhooks: - push_ruleset_bypass - secret_scanning - secret_scanning_closure - - code_scanning_alert_dismissal exemption_request_data: oneOf: - title: Push ruleset bypass exemption request data @@ -111302,25 +111300,6 @@ x-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 @@ -111343,7 +111322,7 @@ x-webhooks: type: object description: Metadata about the exemption request. nullable: true - anyOf: + oneOf: - title: Secret Scanning Push Protection Exemption Request Metadata description: Metadata for a secret scanning push protection exemption request. @@ -111375,21 +111354,6 @@ x-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 @@ -127101,138 +127065,6 @@ x-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: *756 - 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: *758 - 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/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index 09c2e8934a..8a01eeefd3 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -20529,12 +20529,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -20939,12 +20939,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -21301,12 +21301,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -23171,12 +23171,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -83785,12 +83785,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -84195,12 +84195,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -84557,12 +84557,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -86427,12 +86427,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -199505,12 +199505,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -199885,12 +199885,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -201782,12 +201782,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -490560,7 +490560,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.\n> You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/).", + "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.", "tags": [ "search" ], @@ -597248,8 +597248,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -597371,33 +597370,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -597425,7 +597397,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -597466,26 +597438,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -599192,8 +599144,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -599315,33 +599266,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -599369,7 +599293,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -599410,26 +599334,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -601136,8 +601040,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -601259,33 +601162,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -601313,7 +601189,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -601354,26 +601230,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -603080,8 +602936,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -603203,33 +603058,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -603257,7 +603085,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -603298,26 +603126,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -605063,8 +604871,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -605186,33 +604993,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -605240,7 +605020,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -605281,26 +605061,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -607046,8 +606806,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -607169,33 +606928,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -607223,7 +606955,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -607264,26 +606996,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -608990,8 +608702,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -609113,33 +608824,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -609167,7 +608851,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -609208,26 +608892,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -610934,8 +610598,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -611057,33 +610720,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -611111,7 +610747,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -611152,26 +610788,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -612878,8 +612494,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -613001,33 +612616,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -613055,7 +612643,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -613096,26 +612684,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -614861,8 +614429,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -614984,33 +614551,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -615038,7 +614578,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -615079,26 +614619,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -737984,13 +737504,13 @@ } } }, - "dismissal-request-code-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 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", + "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", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -738055,13 +737575,13 @@ "content": { "application/json": { "schema": { - "title": "Exemption request created event", + "title": "Exemption request cancellation event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "cancelled" ] }, "enterprise": { @@ -739475,8 +738995,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -739598,33 +739117,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -739652,7 +739144,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -739693,26 +739185,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -739919,7 +739391,7 @@ "x-github": { "githubCloudOnly": true, "category": "webhooks", - "subcategory": "dismissal_request_code_scanning", + "subcategory": "dismissal_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -739928,13 +739400,13 @@ } } }, - "dismissal-request-code-scanning-response-submitted": { + "dismissal-request-secret-scanning-completed": { "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", + "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_code_scanning" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { @@ -739999,13 +739471,13 @@ "content": { "application/json": { "schema": { - "title": "Exemption response submitted event", + "title": "Exemption request completed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "response_submitted" + "completed" ] }, "enterprise": { @@ -741419,8 +740891,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -741542,33 +741013,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -741596,7 +741040,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -741637,26 +741081,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -741721,44 +741145,6 @@ } } }, - "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", - "description": "The comment the reviewer provided when responding to the exemption request.", - "nullable": true - }, - "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.", @@ -741887,7 +741273,6 @@ "required": [ "action", "exemption_request", - "exemption_response", "sender" ] } @@ -741902,7 +741287,7 @@ "x-github": { "githubCloudOnly": true, "category": "webhooks", - "subcategory": "dismissal_request_code_scanning", + "subcategory": "dismissal_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -741911,11 +741296,11 @@ } } }, - "dismissal-request-secret-scanning-cancelled": { + "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 canceled.", - "operationId": "dismissal-request-secret-scanning/cancelled", + "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" }, @@ -741982,13 +741367,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": { @@ -743402,8 +742787,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -743525,33 +742909,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -743579,3895 +742936,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "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", - "description": "The responses to the exemption request.", - "nullable": true, - "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", - "description": "The comment the reviewer provided when responding to the exemption request.", - "nullable": true - }, - "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", - "example": "https://github.com/monalisa/smile/exemptions/1" - } - } - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "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", - "example": 1 - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "example": "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", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "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", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 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", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": 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", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": 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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "template_repository": { - "nullable": true, - "type": "object", - "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", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"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", - "description": "The number uniquely identifying the exemption request within it's repository.", - "nullable": true - }, - "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.", - "example": "827efc6d56897b048c772eb4087f854f46256132" - }, - "status": { - "type": "string", - "description": "The status of the exemption request.", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - "requester_comment": { - "type": "string", - "description": "The comment the requester provided when creating the exemption request.", - "nullable": true - }, - "metadata": { - "type": "object", - "description": "Metadata about the exemption request.", - "nullable": true, - "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", - "description": "The responses to the exemption request.", - "nullable": true, - "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", - "description": "The comment the reviewer provided when responding to the exemption request.", - "nullable": true - }, - "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", - "example": "https://github.com/monalisa/smile/exemptions/1" - } - } - }, - "sender": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - }, - "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 created event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "created" - ] - }, - "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", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "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", - "example": 1 - }, - "node_id": { - "description": "The global node ID of the installation.", - "type": "string", - "example": "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", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "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", - "example": 42, - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "organization": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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" - ], - "nullable": true - }, - "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": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "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", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 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", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": 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", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": 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", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "template_repository": { - "nullable": true, - "type": "object", - "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", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": 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", - "example": 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", - "example": 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", - "example": "\"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", - "description": "The number uniquely identifying the exemption request within it's repository.", - "nullable": true - }, - "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.", - "example": "827efc6d56897b048c772eb4087f854f46256132" - }, - "status": { - "type": "string", - "description": "The status of the exemption request.", - "enum": [ - "pending", - "rejected", - "cancelled", - "completed" - ] - }, - "requester_comment": { - "type": "string", - "description": "The comment the requester provided when creating the exemption request.", - "nullable": true - }, - "metadata": { - "type": "object", - "description": "Metadata about the exemption request.", - "nullable": true, - "anyOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -747508,26 +742977,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -749234,8 +744683,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -749357,33 +744805,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -749411,7 +744832,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -749452,26 +744873,6 @@ ] } } - }, - { - "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" - ] - } - } } ] }, @@ -751217,8 +746618,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -751340,33 +746740,6 @@ } } } - }, - { - "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" - } - } - } - } - } } ] }, @@ -751394,7 +746767,7 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", @@ -751435,26 +746808,6 @@ ] } } - }, - { - "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/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index b34e51456d..7615e61e0c 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -9084,11 +9084,11 @@ paths: type: object properties: id: - description: The ID of the runner. + description: The id of the runner. type: integer example: 5 runner_group_id: - description: The ID of the runner group. + description: The id of the runner group. type: integer example: 1 name: @@ -97665,7 +97665,6 @@ paths: description: |- > [!WARNING] > **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025. - > You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/). tags: - search operationId: search/issues-and-pull-requests @@ -111208,7 +111207,6 @@ x-webhooks: - push_ruleset_bypass - secret_scanning - secret_scanning_closure - - code_scanning_alert_dismissal exemption_request_data: oneOf: - title: Push ruleset bypass exemption request data @@ -111302,25 +111300,6 @@ x-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 @@ -111343,7 +111322,7 @@ x-webhooks: type: object description: Metadata about the exemption request. nullable: true - anyOf: + oneOf: - title: Secret Scanning Push Protection Exemption Request Metadata description: Metadata for a secret scanning push protection exemption request. @@ -111375,21 +111354,6 @@ x-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 @@ -127101,138 +127065,6 @@ x-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: *756 - 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: *758 - 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/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index a4ebcb43d6..903003b142 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -69367,7 +69367,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.\n> You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/).", + "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.", "tags": [ "search" ], @@ -86803,192 +86803,6 @@ } } }, - "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.", @@ -109698,12 +109512,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -143410,33 +143224,6 @@ } } }, - "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.", @@ -143478,26 +143265,6 @@ } } }, - "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.", @@ -143568,8 +143335,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -143582,9 +143348,6 @@ }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning" - }, - { - "$ref": "#/components/schemas/dismissal-request-code-scanning" } ] }, @@ -143612,15 +143375,12 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "$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/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index e2b6a66047..5c0752bd5a 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -50293,7 +50293,6 @@ paths: description: |- > [!WARNING] > **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025. - > You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/). tags: - search operationId: search/issues-and-pull-requests @@ -62971,140 +62970,6 @@ x-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: |- @@ -79691,11 +79556,11 @@ components: type: object properties: id: - description: The ID of the runner. + description: The id of the runner. type: integer example: 5 runner_group_id: - description: The ID of the runner group. + description: The id of the runner group. type: integer example: 1 name: @@ -105834,26 +105699,6 @@ 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. @@ -105885,21 +105730,6 @@ 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. @@ -105959,13 +105789,11 @@ 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 @@ -105988,10 +105816,9 @@ components: type: object description: Metadata about the exemption request. nullable: true - anyOf: + oneOf: - "$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/ghec/ghec.json b/descriptions/ghec/ghec.json index a4ebcb43d6..903003b142 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -69367,7 +69367,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.\n> You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/).", + "description": "> [!WARNING]\n> **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.", "tags": [ "search" ], @@ -86803,192 +86803,6 @@ } } }, - "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.", @@ -109698,12 +109512,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -143410,33 +143224,6 @@ } } }, - "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.", @@ -143478,26 +143265,6 @@ } } }, - "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.", @@ -143568,8 +143335,7 @@ "enum": [ "push_ruleset_bypass", "secret_scanning", - "secret_scanning_closure", - "code_scanning_alert_dismissal" + "secret_scanning_closure" ] }, "exemption_request_data": { @@ -143582,9 +143348,6 @@ }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning" - }, - { - "$ref": "#/components/schemas/dismissal-request-code-scanning" } ] }, @@ -143612,15 +143375,12 @@ "type": "object", "description": "Metadata about the exemption request.", "nullable": true, - "anyOf": [ + "oneOf": [ { "$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/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index e2b6a66047..5c0752bd5a 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -50293,7 +50293,6 @@ paths: description: |- > [!WARNING] > **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025. - > You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/). tags: - search operationId: search/issues-and-pull-requests @@ -62971,140 +62970,6 @@ x-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: |- @@ -79691,11 +79556,11 @@ components: type: object properties: id: - description: The ID of the runner. + description: The id of the runner. type: integer example: 5 runner_group_id: - description: The ID of the runner group. + description: The id of the runner group. type: integer example: 1 name: @@ -105834,26 +105699,6 @@ 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. @@ -105885,21 +105730,6 @@ 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. @@ -105959,13 +105789,11 @@ 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 @@ -105988,10 +105816,9 @@ components: type: object description: Metadata about the exemption request. nullable: true - anyOf: + oneOf: - "$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/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json b/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json index ca41759349..9a2a0a8361 100644 --- a/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json +++ b/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json @@ -32855,12 +32855,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -33265,12 +33265,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -33637,12 +33637,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -35507,12 +35507,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -74094,12 +74094,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -74504,12 +74504,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -74876,12 +74876,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -76746,12 +76746,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -154908,12 +154908,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -155298,12 +155298,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -157195,12 +157195,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, diff --git a/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml b/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml index 1e72161411..6ae6540342 100644 --- a/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml +++ b/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml @@ -11007,11 +11007,11 @@ paths: type: object properties: id: - description: The ID of the runner. + description: The id of the runner. type: integer example: 5 runner_group_id: - description: The ID of the runner group. + description: The id of the runner group. type: integer example: 1 name: diff --git a/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.json b/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.json index ca41759349..9a2a0a8361 100644 --- a/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.json +++ b/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.json @@ -32855,12 +32855,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -33265,12 +33265,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -33637,12 +33637,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -35507,12 +35507,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -74094,12 +74094,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -74504,12 +74504,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -74876,12 +74876,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -76746,12 +76746,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -154908,12 +154908,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -155298,12 +155298,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, @@ -157195,12 +157195,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, diff --git a/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.yaml b/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.yaml index 1e72161411..6ae6540342 100644 --- a/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.yaml +++ b/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.yaml @@ -11007,11 +11007,11 @@ paths: type: object properties: id: - description: The ID of the runner. + description: The id of the runner. type: integer example: 5 runner_group_id: - description: The ID of the runner group. + description: The id of the runner group. type: integer example: 1 name: diff --git a/descriptions/ghes-3.12/ghes-3.12.2022-11-28.json b/descriptions/ghes-3.12/ghes-3.12.2022-11-28.json index e95d0929c5..c98039ca6a 100644 --- a/descriptions/ghes-3.12/ghes-3.12.2022-11-28.json +++ b/descriptions/ghes-3.12/ghes-3.12.2022-11-28.json @@ -93938,12 +93938,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, diff --git a/descriptions/ghes-3.12/ghes-3.12.2022-11-28.yaml b/descriptions/ghes-3.12/ghes-3.12.2022-11-28.yaml index cad89a7127..5ac99efb4c 100644 --- a/descriptions/ghes-3.12/ghes-3.12.2022-11-28.yaml +++ b/descriptions/ghes-3.12/ghes-3.12.2022-11-28.yaml @@ -67616,11 +67616,11 @@ components: type: object properties: id: - description: The ID of the runner. + description: The id of the runner. type: integer example: 5 runner_group_id: - description: The ID of the runner group. + description: The id of the runner group. type: integer example: 1 name: diff --git a/descriptions/ghes-3.12/ghes-3.12.json b/descriptions/ghes-3.12/ghes-3.12.json index e95d0929c5..c98039ca6a 100644 --- a/descriptions/ghes-3.12/ghes-3.12.json +++ b/descriptions/ghes-3.12/ghes-3.12.json @@ -93938,12 +93938,12 @@ "type": "object", "properties": { "id": { - "description": "The ID of the runner.", + "description": "The id of the runner.", "type": "integer", "example": 5 }, "runner_group_id": { - "description": "The ID of the runner group.", + "description": "The id of the runner group.", "type": "integer", "example": 1 }, diff --git a/descriptions/ghes-3.12/ghes-3.12.yaml b/descriptions/ghes-3.12/ghes-3.12.yaml index cad89a7127..5ac99efb4c 100644 --- a/descriptions/ghes-3.12/{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}